main
1// GENERATED from README.md "Custom exchanges on a transport" by test/custom-exchange.test.js (UPDATE_README_TYPETEST=1
2// rewrites it). The block as a TypeScript consumer writes it: `npm run typecheck` compiles it.
3const url: string = 'https://git.example.com/acme/site.git';
4const opts = { auth: { token: process.env['GIT_TOKEN'] ?? '' } };
5import { createTransport, Tracer, KIND, ZERO_OID, TYPE, buildPack, hashObject, encodeTree, encodeCommit } from '../../src/index.js';
6import type { EndedSpan } from '../../src/index.js';
7import { frames } from '../../src/transport.js';
8import { pushBody, streamInit, streamStep, streamFinish, classifyReport } from '../../src/push.js';
9import type { StreamState } from '../../src/push.js';
11// what to send: a root commit holding one file
12const file = new TextEncoder().encode('hello\n');
13const tree = encodeTree([{ mode: '100644', name: 'hello.txt', oid: hashObject('blob', file) }]);
14if (!tree.ok) throw tree.error;
15const made = encodeCommit({ tree: hashObject('tree', tree.value), author: 'Me <me@example.com> 1700000000 +0000', message: 'hello\n' });
16if (!made.ok) throw made.error;
17const commit = hashObject('commit', made.value);
18const objects = [{ type: TYPE.BLOB, data: file }, { type: TYPE.TREE, data: tree.value }, { type: TYPE.COMMIT, data: made.value }];
20const spans: EndedSpan[] = [];
21const t = createTransport(url, { ...opts, tracer: new Tracer({ onEnd: s => spans.push(s) }) });
22if (!t.ok) throw t.error;
23// the request: the commands as pkt-lines and a flush, then the pack, as one stream of known length
24const commands = [{ ref: 'refs/heads/main', oldOid: ZERO_OID, newOid: commit }];
25const prefix = pushBody({ commands, caps: ['report-status', 'side-band-64k', 'agent=me/1'] });
26if (!prefix.ok) throw prefix.error;
27const { pack } = await buildPack(objects);
28const stream = new ReadableStream({ start(c) { c.enqueue(prefix.value); c.enqueue(pack); c.close(); } });
29const body = { stream, length: prefix.value.length + pack.length };
30const span = t.value.tracer.start('custom receive-pack', { kind: KIND.CLIENT, scrub: t.value.scrub });
31let reply: StreamState = streamInit(true); // side-band-64k: the report in band 1, progress in band 2
32try {
33 for await (const f of frames(t.value, 'git-receive-pack', body, span)) {
34 const stepped = streamStep(reply, f);
35 if (!stepped.ok) throw stepped.error;
36 reply = stepped.value;
37 }
38} catch (e) { span.error(e); throw e; } finally { span.end(); }
39const done = streamFinish(reply);
40if (done.tag !== 'report') throw new Error(`no report: ${done.why}`);
41const report = classifyReport(done.lines, commands); // { tag: 'statuses', refs: [{ ref, ok: true, reason: '' }] }
42if (report.tag !== 'statuses' || !report.refs.every(r => r.ok)) throw new Error(`refused: ${JSON.stringify(report)}`);
Diagnostics4 git calls · 422 ms
CallStatusSizeTime0422 ms
discover200152 B3 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=3 git.response.bytes=152 git.server.agent=gitty/1.0 git.server.object_format=sha1 git.server.caps=agent ls-refs fetch object-format git.server.fetch=shallow filter sideband-all git.protocol.version=2 git.pkt.frames=8 git.pkt.data=6 git.pkt.flush=2 git.pkt.delim=0 git.pkt.bytes=152 git.pkt.payload.max=34
ls-refs200145 B · hit3 ms
git.upload-pack ls-refs http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=3 git.response.bytes=145 git.response.cache=HIT git.response.duration_ms=3 git.protocol.version=2 git.pkt.frames=3 git.pkt.data=2 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=145 git.pkt.payload.max=76 git.ls_refs.count=2 git.ls_refs.head=refs/heads/main
fetchblob:none · deepen 1020038 KiB · hit7 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=412 git.response.bytes=38434 git.response.cache=HIT git.response.duration_ms=7 git.fetch.filter=blob:none git.fetch.filter.requested=tree:0 git.fetch.filter.fallback=blob:none git.fetch.filter.learned=false git.fetch.wants=19912563f540228593df0c489082e5e2508e21e4 git.fetch.haves.count=0 git.fetch.deepen=10 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=6 git.pkt.data=4 git.pkt.flush=1 git.pkt.delim=1 git.pkt.bytes=38434 git.pkt.payload.max=38339 git.sideband.band1.bytes=38338 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=63 git.pack.bytes=38338 git.pack.ofs_delta=0 git.pack.ref_delta=8 git.pack.chain.max=8 git.pack.trailer=0bc36ab7adf82d3109177f11f1ea93f1ce071f77 git.pack.full=55Open pack map
fetch2001.4 KiB412 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1403 git.response.cache=MISS git.response.duration_ms=412 git.fetch.wants=7b1e44e0feb75291a8e5a5c27e185276e6fc8c3c git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=3 git.pkt.data=2 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=1403 git.pkt.payload.max=1382 git.sideband.band1.bytes=1381 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0
Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.
- Remote
- https://5ad2236b39de4c8bd8f6270ea63f3ea9.artifacts.cloudflare.net/git/public-v0/ply.git
- Ref
- refs/heads/main
- Commit
- 19912563f540228593df0c489082e5e2508e21e4
- cf-ray
- a5e355dc18f1994c
- Request
- c445df81…
- Protocol
- v2 · sha1
- Agent
- gitty/1.0
- Filter
- advertised
- Fetch
- shallow filter sideband-all
- Capabilities
- agent ls-refs fetch object-format