GitHubivarvong
ply
main
1// The built declarations compile for the consumers ply names as supported, with skipLibCheck false: a Node service
2// (lib ES2022 + @types/node, no DOM lib) on each supported @types/node major, a browser bundle (lib DOM) and a Worker
3// (@cloudflare/workers-types). tsc is the judge and the expected value is its own: zero `error TS` lines over a file
4// that imports every subpath export in package.json and a file that uses the signer and pack-cache types with the
5// consumer's own platform key. Before the first fix the Node consumer got 5 errors inside node_modules/ply
6// (TextEncoder, TextDecoder, Cache, CryptoKey, CryptoKeyPair: DOM-lib type names @types/node declares only as values or
7// not at all); after it, @types/node 20 and 22 still failed on sign.d.ts (they declare no global `CryptoKey` value;
8// 24 does), which a gate holding only the repo's own @types/node 24 could not see.
9// scripts/dist-check.mjs holds the build and the configs (npm run check:dist runs the same thing in CI).
10import { test, beforeAll as before, afterAll as after } from 'vitest';
11import assert from 'node:assert/strict';
12import { buildConsumer, compileVariant, VARIANTS, SUBPATHS } from '../scripts/dist-check.mjs';
14let consumer;
15before(() => { consumer = buildConsumer(); }, 300_000);
16after(() => { if (consumer) consumer.cleanup(); });
18test('package.json exports the root and 19 subpaths, three of them Node only', () => {
19 // counted by hand from package.json "exports"; a new subpath must be added here on purpose
20 assert.equal(SUBPATHS.length, 20);
21 assert.deepEqual(SUBPATHS.filter(name => name.endsWith('-node')), ['ply/tree-node', 'ply/checkout-node', 'ply/repo-node']);
22});
24// Written by hand, not read from the script: the consumers README names. @types/node 20 is the engines floor
25// (package.json "engines": node >=20), 22 is the Node CI runs, 24 is the repo's own @types/node. The major is checked
26// against the version of the package the compile really ran against, so an alias pointing at the wrong major, or a
27// variant dropped from the script, fails here.
28const EXPECTED = [
29 { name: 'node20', types: '@types/node', major: 20, subpaths: 20 },
30 { name: 'node22', types: '@types/node', major: 22, subpaths: 20 },
31 { name: 'node24', types: '@types/node', major: 24, subpaths: 20 },
32 { name: 'dom', types: '', major: 0, subpaths: 17 },
33 { name: 'workers', types: '@cloudflare/workers-types', major: 5, subpaths: 17 },
34];
36test('the variants are Node on @types/node 20, 22 and 24, DOM and Workers', () => {
37 assert.deepEqual(VARIANTS.map(variant => variant.name), EXPECTED.map(expected => expected.name));
38});
40for (const expected of EXPECTED) {
41 test(`dist d.ts compiles for a ${expected.name} consumer, skipLibCheck false, and no variant is skipped`, () => {
42 const variant = VARIANTS.find(candidate => candidate.name === expected.name);
43 assert.ok(variant, `no ${expected.name} variant in scripts/dist-check.mjs`);
44 assert.equal(variant.subpaths.length, expected.subpaths);
45 const { errors, provided } = compileVariant(consumer, variant);
46 assert.deepEqual(errors, []);
47 // what the compile ran against: exactly the one type package, at the expected major
48 const majors = Object.fromEntries(Object.entries(provided).map(([name, version]) => [name, Number(version.split('.')[0])]));
49 assert.deepEqual(majors, expected.types === '' ? {} : { [expected.types]: expected.major });
50 }, 300_000);
51}
53test('a variant whose type package is not installed is an error, never a skip', () => {
54 const { errors } = compileVariant(consumer, { name: 'absent', lib: ['es2022'], types: ['node'], provides: { '@types/node': 'types-node-not-installed' }, subpaths: SUBPATHS, use: '' });
55 assert.deepEqual(errors, ['absent: node_modules/types-node-not-installed is not installed (run npm ci); this variant is never skipped']);
56});
Diagnostics6 git calls · 133 ms
CallStatusSizeTime0133 ms
discover200191 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=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 KiB2 ms
git.upload-pack ls-refs http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=2 git.response.bytes=11990 git.response.cache=UPDATING git.response.duration_ms=2 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 · hit3 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=3 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 · 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=919 git.response.cache=HIT git.response.duration_ms=2 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:02005.6 KiB · hit2 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=123 git.response.bytes=5724 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=58fabb6768b3f737ee9cd8bac647bdc27405fb4d 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=5724 git.pkt.payload.max=5697 git.sideband.band1.bytes=5697 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=5697 git.pack.trailer=be7e0453974a5fe832f9065a33bb7e3434c10e9bOpen pack map
fetch2001.7 KiB123 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1696 git.response.cache=MISS git.response.duration_ms=123 git.fetch.wants=734eb4cf0003df940473089665c5b80bef768c8f 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=1696 git.pkt.payload.max=1669 git.sideband.band1.bytes=1669 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
- a5e9e3de1a87f3c9
- Request
- ecb0237a…
- 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