GitHubivarvong
ply
main
1// Object ids as a type. A full SHA-1 name is 40 lowercase hex characters (gitformat-pack(5)). git's revision
2// parser also accepts a unique abbreviation, a ref name, and uppercase hex; parseOid does not. The zero id is a
3// real object name (a compare-and-swap "ref does not exist") and not a commit.
4import { getOrElse, ok } from './result.js';
5import { fromNullable } from './absent.js';
6import type { Result } from './result.js';
7import { fail } from './errors.js';
8import type { ErrorOf } from './errors.js';
9import { OID_HEX_CHARS, HEX_DIGIT_MIN, HEX_DIGIT_MAX, HEX_LOWER_MIN, HEX_LOWER_MAX, ZERO_OID as ZERO_OID_TEXT } from './format.js';
11declare const oidBrand: unique symbol;
12/** 40 lowercase hex characters. Not an abbreviation, a ref name, or uppercase. */
13export type Oid = string & { readonly [oidBrand]: typeof oidBrand };
15// The brand is a type: a string of OID_HEX_CHARS characters is an Oid. parseOid calls this only after the hex check.
16// Forty '0' characters are the zero id, so the fallback (a string that was not that long) is still an Oid.
17function isBrandedOid(value: string): value is Oid {
18 return value.length === OID_HEX_CHARS;
19}
20function oidOf(value: string): Oid {
21 if (isBrandedOid(value)) return value;
22 return oidOf(ZERO_OID_TEXT);
23}
25export const ZERO_OID: Oid = oidOf(ZERO_OID_TEXT);
27// The id of a SHA-1 digest in hand: sha1.ts toHex of the digest's OID_BYTES bytes, which is OID_HEX_CHARS lowercase hex
28// by construction. The one place an id is made without parseOid; only sha1.ts calls it (Sha1.hex, streamingSha1).
29export const digestOid = (hex: string): Oid => oidOf(hex);
31// codePointAt misses past the end; an index inside the string is a code point. -1 (the miss) is not hex.
32function codeAt(value: string, i: number): number {
33 return getOrElse(fromNullable(value.codePointAt(i)), -1);
34}
36// 40 lowercase hex. A String object is not a string. Anything else is bad_request: the wrong type, the wrong length,
37// or a character that is not `0-9` or `a-f`. A strict prefix of a valid id is the length error (prefix closure).
38// @decoder parseOid prefix=oid
39export function parseOid(value: unknown): Result<Oid, ErrorOf<'bad_request'>> {
40 if (typeof value !== 'string') return fail('bad_request', 'oid must be a string', { what: 'oid', got: value });
41 if (value.length !== OID_HEX_CHARS) return fail('bad_request', `oid must be ${OID_HEX_CHARS} lowercase hex characters`, { what: 'oid', got: value });
42 for (let i = 0; i < value.length; i++) {
43 const c = codeAt(value, i);
44 const digit = c >= HEX_DIGIT_MIN && c <= HEX_DIGIT_MAX;
45 const lower = c >= HEX_LOWER_MIN && c <= HEX_LOWER_MAX;
46 if (!digit && !lower) return fail('bad_request', 'oid must be lowercase hex', { what: 'oid', got: value });
47 }
48 return ok(oidOf(value));
49}
51// parseOid, and bad_request when the id is ZERO_OID. The zero id names no commit. A strict prefix is not a commit id.
52// @decoder parseCommitId prefix=commit-id
53export function parseCommitId(value: unknown): Result<Oid, ErrorOf<'bad_request'>> {
54 const parsed = parseOid(value);
55 if (!parsed.ok) return parsed;
56 if (parsed.value === ZERO_OID) return fail('bad_request', 'the zero oid is not a commit', { what: 'commit', got: value });
57 return ok(parsed.value);
58}
Diagnostics6 git calls · 132 ms
CallStatusSizeTime0132 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 KiB95 ms
git.upload-pack ls-refs http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=90 git.response.bytes=11990 git.response.cache=EXPIRED git.response.duration_ms=95 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 · 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=2507 git.response.cache=HIT git.response.duration_ms=2 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.3 KiB · hit30 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=30 git.response.bytes=1350 git.response.cache=HIT git.response.duration_ms=30 git.fetch.wants=5bcf2b61822c6e3c85bc2dbcf6ee6fe09fd60b1a 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=1350 git.pkt.payload.max=1323 git.sideband.band1.bytes=1323 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
- a5e15f2e7c4f725b
- Request
- 27fadefb…
- 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