main
1// Branded refname types. A `Refname` is any fully qualified ref starting with `refs/`.
2// Branch and tag names are stricter subsets. Parsing uses the validate.ts rules, which grant the Refname brand.
3import { ok, mapErr } from './result.js';
4import type { Result } from './result.js';
5import { fail, plyError } from './errors.js';
6import type { ErrorOf } from './errors.js';
7import { validateRef, validatePushRef } from './validate.js';
9declare const refBrand: unique symbol;
10declare const branchBrand: unique symbol;
11declare const tagBrand: unique symbol;
13export type Refname = string & { readonly [refBrand]: typeof refBrand };
14export type BranchName = string & { readonly [branchBrand]: typeof branchBrand };
15export type TagName = string & { readonly [tagBrand]: typeof tagBrand };
17function isBranchName(value: string): value is BranchName { return value.startsWith('refs/heads/'); }
18function isTagName(value: string): value is TagName { return value.startsWith('refs/tags/'); }
20type Bad = ErrorOf<'bad_request'>;
21// Each parser re-labels a validator's refusal for the thing parsed (`what`), with the validator's error as its cause.
23// @decoder parseRefname prefix=refname
24export function parseRefname(value: unknown): Result<Refname, Bad> {
25 return mapErr(validateRef(value), e => plyError('bad_request', e.message, { what: 'ref', cause: e }));
26}
28// A pushable branch name (refs/heads/* with at least two levels after refs/).
29// @decoder parseBranchName prefix=refname
30export function parseBranchName(value: unknown): Result<BranchName, Bad> {
31 const ref = mapErr(validatePushRef(String(value), false), e => plyError('bad_request', e.message, { what: 'branch', cause: e }));
32 if (!ref.ok) return ref;
33 if (!isBranchName(ref.value)) return fail('bad_request', 'must start with refs/heads/', { what: 'branch' });
34 return ok(ref.value);
35}
37// A refname the source spells, checked once when the module loads. A bad literal is a programmer error.
38function constantRefname(value: string): Refname {
39 const r = parseRefname(value);
40 if (!r.ok) throw plyError('internal', `${value} is not a refname`);
41 return r.value;
42}
43// The branch an edit targets when the caller names none.
44export const DEFAULT_REF: Refname = constantRefname('refs/heads/main');
46// @decoder parseTagName prefix=refname
47export function parseTagName(value: unknown): Result<TagName, Bad> {
48 const ref = mapErr(validateRef(value), e => plyError('bad_request', e.message, { what: 'tag', cause: e }));
49 if (!ref.ok) return ref;
50 if (!isTagName(ref.value)) return fail('bad_request', 'must start with refs/tags/', { what: 'tag' });
51 return ok(ref.value);
52}
Diagnostics4 git calls · 39 ms
CallStatusSizeTime039 ms
discover200152 B12 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 · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=24 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
fetch200977 B · hit24 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=977 git.response.cache=HIT git.response.duration_ms=24 git.fetch.wants=41bafdfa158fe8cc48b568216e70a3831705cc48 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=977 git.pkt.payload.max=956 git.sideband.band1.bytes=955 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
- a5e299816b262407
- Request
- a07bdc72…
- Protocol
- v2 · sha1
- Agent
- gitty/1.0
- Filter
- advertised
- Fetch
- shallow filter sideband-all
- Capabilities
- agent ls-refs fetch object-format