@volter/twin-standard 1.0.158 → 1.0.159

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/README.md +3 -2
  2. package/client-sdks/package.json +1 -0
  3. package/client-sdks/pnpm-lock.yaml +210 -0
  4. package/dist/client-sdks/package.json +1 -0
  5. package/dist/client-sdks/pnpm-lock.yaml +210 -0
  6. package/dist/src/assessment.d.ts +13 -3
  7. package/dist/src/assessment.js +10 -6
  8. package/dist/src/browser-assessment.js +16 -13
  9. package/dist/src/clients/harness.d.ts +25 -4
  10. package/dist/src/clients/harness.js +184 -22
  11. package/dist/src/clients/jira.js +11 -2
  12. package/dist/src/clients/run.js +19 -14
  13. package/dist/src/conformance.d.ts +2 -0
  14. package/dist/src/conformance.js +392 -184
  15. package/dist/src/consumer.d.ts +22 -1
  16. package/dist/src/consumer.js +91 -26
  17. package/dist/src/credential-issuer-import.d.ts +3 -0
  18. package/dist/src/credential-issuer-import.js +42 -0
  19. package/dist/src/derive.js +3 -0
  20. package/dist/src/gate.js +4 -0
  21. package/dist/src/lanes.d.ts +2 -0
  22. package/dist/src/lanes.js +7 -0
  23. package/dist/src/protocol-3.js +8 -3
  24. package/dist/src/spec-documents.d.ts +4 -0
  25. package/dist/src/spec-documents.js +110 -3
  26. package/dist/src/tools/life-coverage-walk.js +38 -26
  27. package/dist/src/tools/score-pack.js +6 -5
  28. package/dist/src/tools/vendor-examples.js +91 -80
  29. package/dist/src/walk/behavior-journey.d.ts +22 -14
  30. package/dist/src/walk/behavior-journey.js +182 -133
  31. package/dist/src/walk/journey-kit.d.ts +3 -2
  32. package/dist/src/walk/journey-kit.js +6 -2
  33. package/dist/src/walk/replay.d.ts +23 -0
  34. package/dist/src/walk/replay.js +118 -0
  35. package/dist/src/walk/serve-pack.d.ts +2 -2
  36. package/dist/src/walk/serve-pack.js +38 -2
  37. package/dist/src/walk/shape.d.ts +25 -4
  38. package/dist/src/walk/shape.js +166 -56
  39. package/dist/src/walk/vendor-fetch.d.ts +7 -2
  40. package/dist/src/walk/vendor-fetch.js +13 -2
  41. package/dist/src/walk/walk-database.d.ts +9 -1
  42. package/dist/src/walk/walk-database.js +35 -13
  43. package/dist/src/walk/xml-view.d.ts +3 -2
  44. package/dist/src/walk/xml-view.js +5 -4
  45. package/package.json +3 -3
  46. package/src/assessment.ts +12 -8
  47. package/src/browser-assessment.ts +12 -5
  48. package/src/clients/harness.ts +142 -19
  49. package/src/clients/jira.ts +4 -2
  50. package/src/clients/run.ts +17 -15
  51. package/src/conformance.ts +313 -128
  52. package/src/consumer.ts +83 -21
  53. package/src/credential-issuer-import.ts +38 -0
  54. package/src/derive.ts +3 -1
  55. package/src/gate.ts +3 -0
  56. package/src/lanes.ts +7 -0
  57. package/src/protocol-3.ts +7 -3
  58. package/src/spec-documents.ts +92 -3
  59. package/src/tools/life-coverage-walk.ts +32 -22
  60. package/src/tools/score-pack.ts +7 -6
  61. package/src/tools/vendor-examples.ts +88 -75
  62. package/src/walk/behavior-journey.ts +145 -109
  63. package/src/walk/journey-kit.ts +7 -5
  64. package/src/walk/replay.ts +103 -0
  65. package/src/walk/serve-pack.ts +25 -5
  66. package/src/walk/shape.ts +156 -54
  67. package/src/walk/vendor-fetch.ts +16 -4
  68. package/src/walk/walk-database.ts +41 -15
  69. package/src/walk/xml-view.ts +5 -4
@@ -11,16 +11,38 @@ import { writeFileSync } from 'node:fs';
11
11
  /** The World's proxy in front of a pack served on `served`: it ends the caller's TLS (here, none was begun) and forwards
12
12
  * each request and socket upgrade to the pack with `x-forwarded-proto: https`, the vendor's Host unchanged, as a World's
13
13
  * proxy forwards a caller of the vendor's https host (twin-fetch.ts, twinPublicBase: the links and socket URLs the pack
14
- * answers are then the vendor's secure ones). Answers the proxy's port. */
15
- export async function worldProxy(served) {
14
+ * answers are then the vendor's secure ones). Its stop settles every connection it opened. */
15
+ export async function worldProxy(served, observe) {
16
+ const sockets = new Set();
17
+ const requests = new Set();
18
+ const track = (socket) => { if (sockets.has(socket))
19
+ return; sockets.add(socket); socket.once('close', () => sockets.delete(socket)); };
16
20
  const server = createServer((req, res) => {
17
21
  const forward = httpRequest({ host: '127.0.0.1', port: served, method: req.method, path: req.url, headers: { ...req.headers, 'x-forwarded-proto': 'https' } }, (answer) => {
22
+ if (observe) {
23
+ answer.on('end', () => {
24
+ const headers = new Headers();
25
+ for (const [name, value] of Object.entries(req.headers))
26
+ if (value !== undefined)
27
+ for (const one of Array.isArray(value) ? value : [value])
28
+ headers.append(name, one);
29
+ observe({ url: `https://${headers.get('x-volter-twin-original-host') ?? headers.get('host')}${req.url}`, headers }, { status: answer.statusCode ?? 502 });
30
+ });
31
+ }
32
+ answer.on('error', () => res.destroy());
18
33
  res.writeHead(answer.statusCode ?? 502, answer.headers);
19
34
  answer.pipe(res);
20
35
  });
21
- forward.on('error', () => { res.writeHead(502); res.end(); });
36
+ requests.add(forward);
37
+ forward.once('close', () => requests.delete(forward));
38
+ forward.on('error', () => { if (!res.headersSent)
39
+ res.writeHead(502); res.end(); });
40
+ forward.on('socket', track);
41
+ req.on('aborted', () => forward.destroy());
42
+ res.on('close', () => forward.destroy());
22
43
  req.pipe(forward);
23
44
  });
45
+ server.on('connection', track);
24
46
  server.on('upgrade', (req, socket, head) => {
25
47
  const upstream = connect(served, '127.0.0.1', () => {
26
48
  const lines = [`${req.method} ${req.url} HTTP/1.1`, ...Object.entries({ ...req.headers, 'x-forwarded-proto': 'https' }).flatMap(([k, v]) => (Array.isArray(v) ? v : [v]).map((x) => `${k}: ${x}`)), '', ''];
@@ -30,15 +52,115 @@ export async function worldProxy(served) {
30
52
  upstream.pipe(socket);
31
53
  socket.pipe(upstream);
32
54
  });
55
+ track(upstream);
33
56
  upstream.on('error', () => socket.destroy());
34
57
  socket.on('error', () => upstream.destroy());
58
+ socket.on('close', () => upstream.destroy());
59
+ });
60
+ await new Promise((done, reject) => {
61
+ server.once('error', reject);
62
+ server.listen(0, '127.0.0.1', () => { server.off('error', reject); done(); });
35
63
  });
36
- await new Promise((r) => server.listen(0, '127.0.0.1', () => r()));
37
64
  server.unref();
38
- return server.address().port;
65
+ let stopping;
66
+ return {
67
+ port: server.address().port,
68
+ stop: () => stopping ??= (async () => {
69
+ const closed = new Promise((done, reject) => server.close((error) => error ? reject(error) : done()));
70
+ const pending = [...requests].map((request) => new Promise((done) => { request.once('close', () => done()); request.destroy(); }));
71
+ const connections = [...sockets].map((socket) => new Promise((done) => { socket.once('close', () => done()); socket.destroy(); }));
72
+ await Promise.all([closed, ...pending, ...connections]);
73
+ })(),
74
+ };
39
75
  }
40
- /** HTTP to a served pack, with the vendor Host and manual redirects. Each call owns a fresh connection;
41
- * its caller's abort signal retires that request, including an unfinished response body. */
76
+ /** A served socket either opens within its five-second handshake or closes under the same owner. */
77
+ export function openWebSocket(socket) {
78
+ return new Promise((resolve, reject) => {
79
+ let settled = false;
80
+ const finish = (opened) => {
81
+ if (settled)
82
+ return;
83
+ settled = true;
84
+ clearTimeout(timer);
85
+ socket.removeEventListener('open', openedSocket);
86
+ socket.removeEventListener('error', failed);
87
+ socket.removeEventListener('close', failed);
88
+ try {
89
+ if (!opened)
90
+ socket.close();
91
+ }
92
+ catch (error) {
93
+ reject(error);
94
+ return;
95
+ }
96
+ resolve(opened);
97
+ };
98
+ const openedSocket = () => finish(true);
99
+ const failed = () => finish(false);
100
+ const timer = setTimeout(failed, 5000);
101
+ socket.addEventListener('open', openedSocket, { once: true });
102
+ socket.addEventListener('error', failed, { once: true });
103
+ socket.addEventListener('close', failed, { once: true });
104
+ });
105
+ }
106
+ /** One request and its complete body share the check's ten-second lifetime, including caller cancellation. */
107
+ export async function readHttpResponse(fetcher, request) {
108
+ request.signal.throwIfAborted();
109
+ const abort = new AbortController();
110
+ const signal = AbortSignal.any([request.signal, abort.signal]);
111
+ const timer = setTimeout(() => abort.abort(new DOMException('request exceeded 10 s', 'TimeoutError')), 10_000);
112
+ let cancel;
113
+ const interrupted = new Promise((_, reject) => {
114
+ cancel = () => reject(signal.reason);
115
+ signal.addEventListener('abort', cancel, { once: true });
116
+ if (signal.aborted)
117
+ cancel();
118
+ });
119
+ let reader;
120
+ try {
121
+ const arriving = fetcher(new Request(request, { signal })).then((response) => {
122
+ if (signal.aborted)
123
+ void response.body?.cancel(signal.reason).catch(() => undefined);
124
+ return response;
125
+ });
126
+ const response = await Promise.race([arriving, interrupted]);
127
+ reader = response.body?.getReader();
128
+ const chunks = [];
129
+ let size = 0;
130
+ let bodyError;
131
+ try {
132
+ if (reader)
133
+ for (;;) {
134
+ const chunk = await Promise.race([reader.read(), interrupted]);
135
+ if (chunk.done)
136
+ break;
137
+ chunks.push(chunk.value);
138
+ size += chunk.value.byteLength;
139
+ }
140
+ }
141
+ catch (error) {
142
+ bodyError = { message: String(error), cancelled: signal.aborted || error instanceof Error && ['AbortError', 'TimeoutError'].includes(error.name) };
143
+ void reader?.cancel(error).catch(() => undefined);
144
+ }
145
+ const bodyBytes = new Uint8Array(size);
146
+ let offset = 0;
147
+ for (const chunk of chunks) {
148
+ bodyBytes.set(chunk, offset);
149
+ offset += chunk.byteLength;
150
+ }
151
+ const cookies = response.headers.getSetCookie();
152
+ return { status: response.status, headers: { ...Object.fromEntries(response.headers), ...(cookies.length ? { 'set-cookie': cookies.join(', ') } : {}) },
153
+ text: new TextDecoder().decode(bodyBytes), bodyBytes, ...(bodyError ? { bodyError } : {}) };
154
+ }
155
+ finally {
156
+ clearTimeout(timer);
157
+ if (cancel)
158
+ signal.removeEventListener('abort', cancel);
159
+ reader?.releaseLock();
160
+ }
161
+ }
162
+ /** HTTP to a served pack, with the vendor Host and manual redirects. Headers resolve before the streamed body;
163
+ * its caller's abort signal owns the fresh connection until the body ends or is cancelled. */
42
164
  export function servedHttpFetch(port) {
43
165
  return (async (input, init) => {
44
166
  const request = new Request(input, init);
@@ -49,28 +171,68 @@ export function servedHttpFetch(port) {
49
171
  const signal = init?.signal ?? (input instanceof Request ? input.signal : request.signal);
50
172
  return new Promise((resolve, reject) => {
51
173
  const cleanup = () => signal.removeEventListener('abort', abort);
52
- const failed = (error) => { cleanup(); reject(error); };
174
+ let responseFailed;
175
+ const failed = (error) => { cleanup(); if (responseFailed)
176
+ responseFailed(error);
177
+ else
178
+ reject(error); };
53
179
  const sent = httpRequest({ host: '127.0.0.1', port, method: request.method, path: `${url.pathname}${url.search}`, headers, agent: false }, (res) => {
180
+ res.pause();
181
+ const answer = new Headers();
182
+ for (const [k, v] of Object.entries(res.headers))
183
+ if (v !== undefined)
184
+ for (const one of Array.isArray(v) ? v : [v])
185
+ answer.append(k, one);
54
186
  const chunks = [];
55
- res.on('data', (c) => chunks.push(c));
56
- res.on('end', () => {
57
- cleanup();
58
- const answer = new Headers();
59
- for (const [k, v] of Object.entries(res.headers))
60
- if (v !== undefined)
61
- for (const one of Array.isArray(v) ? v : [v])
62
- answer.append(k, one);
63
- try {
64
- resolve(new Response(request.method === 'HEAD' || res.statusCode === 204 || res.statusCode === 205 || res.statusCode === 304 ? null : Buffer.concat(chunks), { status: res.statusCode ?? 0, headers: answer }));
187
+ let controller;
188
+ let ended = false, cancelled = false, bodyError;
189
+ const pump = () => {
190
+ if (cancelled)
191
+ return;
192
+ while (chunks.length && (controller.desiredSize ?? 0) > 0)
193
+ controller.enqueue(chunks.shift());
194
+ if (chunks.length || (controller.desiredSize ?? 0) <= 0) {
195
+ res.pause();
196
+ return;
65
197
  }
66
- catch (error) {
67
- reject(error);
198
+ // Do not error until the reader has taken queued bytes: an errored web stream discards its queue.
199
+ if (bodyError) {
200
+ cancelled = true;
201
+ controller.error(bodyError);
68
202
  }
203
+ else if (ended) {
204
+ cancelled = true;
205
+ controller.close();
206
+ }
207
+ else
208
+ res.resume();
209
+ };
210
+ const body = new ReadableStream({
211
+ start(value) { controller = value; },
212
+ pull() { pump(); },
213
+ cancel() { cancelled = true; chunks.length = 0; cleanup(); res.destroy(); sent.destroy(); },
69
214
  });
70
- res.on('error', failed);
215
+ responseFailed = (error) => { bodyError ??= error; cleanup(); pump(); };
216
+ res.on('data', (chunk) => { chunks.push(chunk); pump(); });
217
+ res.on('end', () => { ended = true; cleanup(); pump(); });
218
+ res.on('error', responseFailed);
219
+ res.on('close', () => { if (!res.complete && !cancelled)
220
+ responseFailed(new Error('HTTP response closed before completion')); });
221
+ const noBody = request.method === 'HEAD' || res.statusCode === 204 || res.statusCode === 205 || res.statusCode === 304;
222
+ try {
223
+ resolve(new Response(noBody ? null : body, { status: res.statusCode ?? 0, headers: answer }));
224
+ if (noBody)
225
+ res.resume();
226
+ }
227
+ catch (error) {
228
+ cancelled = true;
229
+ cleanup();
230
+ res.destroy();
231
+ reject(error);
232
+ }
71
233
  });
72
234
  const abort = () => {
73
- const error = new Error('served HTTP request aborted');
235
+ const error = signal.reason instanceof Error ? signal.reason : new Error('served HTTP request aborted');
74
236
  sent.destroy(error);
75
237
  failed(error);
76
238
  };
@@ -1,3 +1,14 @@
1
+ var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExtension) || function (path, preserveJsx) {
2
+ if (typeof path === "string" && /^\.\.?\//.test(path)) {
3
+ return path.replace(/\.(tsx)$|((?:\.d)?)((?:\.[^./]+?)?)\.([cm]?)ts$/i, function (m, tsx, d, ext, cm) {
4
+ return tsx ? preserveJsx ? ".jsx" : ".js" : d && (!ext || !cm) ? m : (d + ext + "." + cm.toLowerCase() + "js");
5
+ });
6
+ }
7
+ return path;
8
+ };
9
+ import { standardPackageFile } from "../package-file.js";
10
+ const { importSdk } = await import(__rewriteRelativeImportExtension(new URL('import.mjs', standardPackageFile('client-sdks/')).href));
11
+ const { Version3Client, HttpException } = await importSdk('jira.js');
1
12
  const README = 'https://www.npmjs.com/package/jira.js/v/5.4.0';
2
13
  const CREATE = 'https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-post';
3
14
  const ADF = 'https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/';
@@ -12,7 +23,6 @@ async function site(c, slug, apiToken) {
12
23
  const email = `admin@${slug}.example`;
13
24
  const made = await door('/_twin/sites', { name: slug, admin: { name: 'Admin', email, password: 'sdk-case-2026' } });
14
25
  const token = apiToken ?? (await door('/_twin/api-token', { site: slug, email, password: 'sdk-case-2026' })).apiToken;
15
- const { Version3Client } = await import('jira.js');
16
26
  const jira = new Version3Client({ host: `https://${slug}.atlassian.net`, authentication: { basic: { email, apiToken: token } }, baseRequestConfig: { httpsAgent: c.agent } });
17
27
  return { jira, admin: made.admin };
18
28
  }
@@ -55,7 +65,6 @@ export const cases = [
55
65
  asks: 'a request with an API token the account never made is refused, and the client throws its HttpException carrying the status',
56
66
  source: `${README} "\`HttpException\`: Server responded with an error (includes parsed error details)"`,
57
67
  async run(c) {
58
- const { HttpException } = await import('jira.js');
59
68
  const { jira } = await site(c, 'sdk-refused', 'ATATT-not-a-token-this-account-made');
60
69
  try {
61
70
  await jira.projects.searchProjects({ maxResults: 50 });
@@ -20,19 +20,24 @@ if (!Array.isArray(cases) || cases.length === 0)
20
20
  throw new Error(`${job.vendor} client module declares no cases; there is no SDK execution evidence`);
21
21
  // every connection a case makes goes through the World's proxy, as an application's does in a World
22
22
  const proxy = await worldProxy(job.port);
23
- // Bind only this artifact's declared vendor hosts to the assessed server. The enclosing World's
24
- // injector stays active, and untwinned destinations keep its refusal policy.
25
- const require = createRequire(import.meta.url);
26
- require('@volter/world-core/pack-facts').extendPackFacts([job.packFacts]);
27
- const facts = JSON.parse(readFileSync(job.packFacts, 'utf8')).packs[job.vendor];
28
- const keys = [...new Set((facts.hosts ?? []).map((rule) => rule.key ?? job.vendor))];
29
- require('@volter/world-core/inject').install(Object.fromEntries(keys.map((key) => [key, `http://127.0.0.1:${proxy}`])));
30
- const context = clientContext(proxy, job.host, job.env, job.scenarioPath, job.raw ? job.port : undefined);
31
- for (const c of cases) {
32
- const failures = await Promise.race([
33
- c.run(context).catch((e) => [`the case threw: ${e.message}`]),
34
- new Promise((r) => setTimeout(() => r(['no outcome in 30 s']), 30_000)),
35
- ]);
36
- process.stdout.write(`${JSON.stringify({ id: c.id, asks: c.asks, failures })}\n`);
23
+ try {
24
+ // Bind only this artifact's declared vendor hosts to the assessed server. The enclosing World's
25
+ // injector stays active, and untwinned destinations keep its refusal policy.
26
+ const require = createRequire(import.meta.url);
27
+ require('@volter/world-core/pack-facts').extendPackFacts([job.packFacts]);
28
+ const facts = JSON.parse(readFileSync(job.packFacts, 'utf8')).packs[job.vendor];
29
+ const keys = [...new Set((facts.hosts ?? []).map((rule) => rule.key ?? job.vendor))];
30
+ require('@volter/world-core/inject').install(Object.fromEntries(keys.map((key) => [key, `http://127.0.0.1:${proxy.port}`])));
31
+ const context = clientContext(proxy.port, job.host, job.env, job.scenarioPath, job.raw ? job.port : undefined);
32
+ for (const c of cases) {
33
+ const failures = await Promise.race([
34
+ c.run(context).catch((e) => [`the case threw: ${e.message}`]),
35
+ new Promise((r) => setTimeout(() => r(['no outcome in 30 s']), 30_000)),
36
+ ]);
37
+ process.stdout.write(`${JSON.stringify({ id: c.id, asks: c.asks, failures })}\n`);
38
+ }
39
+ }
40
+ finally {
41
+ await proxy.stop();
37
42
  }
38
43
  process.exit(0);
@@ -1,3 +1,4 @@
1
+ import { type ConsumerResult } from './consumer.js';
1
2
  export type ConformanceResult = {
2
3
  id: string;
3
4
  asks: string;
@@ -33,5 +34,6 @@ export declare function decisionTableProblems(unit: string, byUnit: Record<strin
33
34
  /** `onCheck` hears each check's id as it starts, so a caller can show where a long run stands. */
34
35
  export declare function conformance(dir: string, options?: {
35
36
  onCheck?: (id: string) => void;
37
+ consumer?: ConsumerResult;
36
38
  }): Promise<ConformanceResult[]>;
37
39
  export {};