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}
Diagnostics4 git calls · 277 ms
CallStatusSizeTime0277 ms
discover200152 B4 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 · hit4 ms
git.upload-pack ls-refs http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=4 git.response.bytes=145 git.response.cache=HIT git.response.duration_ms=4 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 · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=270 git.response.bytes=38434 git.response.cache=HIT git.response.duration_ms=3 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 KiB270 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1479 git.response.cache=MISS git.response.duration_ms=270 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=3 git.pkt.data=2 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=1479 git.pkt.payload.max=1458 git.sideband.band1.bytes=1457 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
- a5e19380cd8bddf0
- Request
- a90c1b8f…
- Protocol
- v2 · sha1
- Agent
- gitty/1.0
- Filter
- advertised
- Fetch
- shallow filter sideband-all
- Capabilities
- agent ls-refs fetch object-format