GitHubivarvong
ply
main
1// Resumable transfer (#238), the names: a transfer's key, its temp ref, the target ref, and the checks a plan read back
2// from storage gets. Branded here only, so a target ref never stands where a temp ref is deleted, and the reverse.
3import type { PlyError } from './errors.js';
4import { fail } from './errors.js';
5import type { Result } from './result.js';
6import { ok } from './result.js';
7import { parseOid } from './oid.js';
8import type { Refname } from './refname.js';
9import { validatePushRef } from './validate.js';
10import { Sha1 } from './sha1.js';
11import { te } from './bytes.js';
13export type { Refname };
14declare const tempRefBrand: unique symbol;
15// A temp ref: a pushable ref under the transfer prefix, named by the plan's key (tempRefOf).
16export type TempRef = Refname & { readonly [tempRefBrand]: typeof tempRefBrand };
17const isUnder = (r: Refname, prefix: string): r is TempRef => prefix.endsWith('/') && r.length > prefix.length && r.startsWith(prefix);
19export const sha1Hex = (s: string): string => new Sha1().update(te.encode(s)).hex();
21// The target ref, as git would push it (a ref under refs/ with two components there, never refs/@). Any value.
22export function targetRef(value: unknown): Result<Refname, PlyError> {
23 const r = validatePushRef(value, false);
24 return r.ok ? r : fail('bad_request', `transfer: ref: ${r.error.message}`, { what: 'ref', cause: r.error });
25}
26// The temp ref for `key` under `prefix`, checked as a ref git would push and as one under the prefix.
27export function tempRefOf(prefix: string, key: string): Result<TempRef, PlyError> {
28 const r = validatePushRef(`${prefix}${key}`, false);
29 if (!r.ok) return fail('bad_request', `transfer: tempPrefix: ${r.error.message}`, { what: 'tempPrefix', cause: r.error });
30 return isUnder(r.value, prefix) ? ok(r.value) : fail('bad_request', 'transfer: tempPrefix must end in "/"', { what: 'tempPrefix' });
31}
32export const isOid = (v: unknown): boolean => parseOid(v).ok;
33// An Option of an id, as JSON gives it back: {"tag":"none"} or {"tag":"some","value":<id>}.
34export function isOptionOid(o: unknown): boolean {
35 if (typeof o !== 'object' || o === null) return false;
36 const tag: unknown = Reflect.get(o, 'tag');
37 return tag === 'none' || (tag === 'some' && isOid(Reflect.get(o, 'value')));
38}
39export const isList = (v: unknown): boolean => Array.isArray(v);
41// A temp ref's last segment: the plan's key, a SHA-1 in lowercase hex (sha1Hex), so the shape of an id.
42export const isTempKey = (s: string): boolean => parseOid(s).ok;
43// The prefix a sweep may delete under: `root` (refs/ply/transfer/) or a namespace below it, whole segments ending in '/', each
44// one git would push. Anything else (refs/, refs/heads/, a name without its '/', a sibling namespace) is not ply's.
45export function sweepPrefix(prefix: unknown, root: string): Result<string, PlyError> {
46 const refuse = (why: string): Result<string, PlyError> => fail('bad_request', `sweepTransfers: prefix ${JSON.stringify(prefix)} ${why}`, { what: 'prefix' });
47 if (typeof prefix !== 'string') return refuse('is not a string');
48 if (!prefix.startsWith(root) || !prefix.endsWith('/')) return refuse(`is not ${root} or a namespace ending in '/' below it`);
49 // Stryker disable next-line BooleanLiteral: every prefix reaching here starts with root (refs/ply/transfer/), so the name has a '/' and deleting's only effect (allowing a slashless name) never applies
50 return validatePushRef(`${prefix}${'0'.repeat(40)}`, false).ok ? ok(prefix) : refuse('is not a ref namespace git would push');
51}
Diagnostics6 git calls · 216 ms
CallStatusSizeTime0216 ms
discover200191 B3 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=3 git.response.bytes=191 git.server.agent=git/github-9922ec520325-Linux git.server.object_format=sha1 git.server.caps=agent ls-refs fetch server-option object-format git.server.fetch=shallow wait-for-done filter git.protocol.version=2 git.pkt.frames=9 git.pkt.data=7 git.pkt.flush=2 git.pkt.delim=0 git.pkt.bytes=191 git.pkt.payload.max=36
ls-refs20012 KiB88 ms
git.upload-pack ls-refs http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=88 git.response.bytes=11990 git.response.cache=EXPIRED git.response.duration_ms=88 git.protocol.version=2 git.pkt.frames=152 git.pkt.data=151 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=11990 git.pkt.payload.max=122 git.ls_refs.count=151 git.ls_refs.head=refs/heads/main
fetchtree:0 · deepen 102004.2 KiB · hit2 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=2 git.response.bytes=4347 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 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=7 git.pkt.data=5 git.pkt.flush=1 git.pkt.delim=1 git.pkt.bytes=4347 git.pkt.payload.max=4247 git.sideband.band1.bytes=4247 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=10 git.pack.bytes=4247 git.pack.ofs_delta=0 git.pack.ref_delta=0 git.pack.chain.max=0 git.pack.trailer=a6caf8e129bea82c9bae4cbc7c130c9205add400 git.pack.full=10Open pack map
fetchtree:0200919 B · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=3 git.response.bytes=919 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=800d30ba8923860bfc460ca884b7f9ba22083588 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=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=919 git.pkt.payload.max=892 git.sideband.band1.bytes=892 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=892 git.pack.trailer=5323b9266eea5ded637285d1c5320699f12be76eOpen pack map
fetchtree:02002.4 KiB · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=3 git.response.bytes=2507 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=8f720d29ff85ce682ffdad9c393b04a3834c3203 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=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=2507 git.pkt.payload.max=2480 git.sideband.band1.bytes=2480 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=2480 git.pack.trailer=723b6bf1d4d6021fe5eb940c622b9ff00ee4a381Open pack map
fetch2001.5 KiB120 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=120 git.response.bytes=1491 git.response.cache=MISS git.response.duration_ms=120 git.fetch.wants=e65254bb89e97973ac41dee9ab44814b3b41009e 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=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=1491 git.pkt.payload.max=1464 git.sideband.band1.bytes=1464 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://github.com/ivarvong/ply
- Ref
- refs/heads/main
- Commit
- 19912563f540228593df0c489082e5e2508e21e4
- cf-ray
- a5e2b9618884cf33
- Request
- e323c88c…
- Protocol
- v2 · sha1
- Agent
- git/github-9922ec520325-Linux
- Filter
- advertised
- Fetch
- shallow wait-for-done filter
- Capabilities
- agent ls-refs fetch server-option object-format