@cloudbitmaps/core 0.20.0 → 0.21.0
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.
- package/README.md +85 -0
- package/dist/{chunk-YSC7NJWV.js → chunk-IGLIZBR7.js} +740 -137
- package/dist/chunk-IGLIZBR7.js.map +7 -0
- package/dist/core/absent-operands.d.ts +8 -0
- package/dist/core/audit.d.ts +12 -2
- package/dist/core/bit-route.d.ts +2 -1
- package/dist/core/blob.d.ts +12 -1
- package/dist/core/bulk-load.d.ts +148 -0
- package/dist/core/cas-retry.d.ts +27 -0
- package/dist/core/check.d.ts +22 -0
- package/dist/core/chunk-checks.d.ts +6 -1
- package/dist/core/chunk-window.d.ts +11 -4
- package/dist/core/combine-expr.d.ts +1 -3
- package/dist/core/combine-feed.d.ts +2 -16
- package/dist/core/combine-many.d.ts +12 -9
- package/dist/core/concurrency.d.ts +8 -0
- package/dist/core/consistency.d.ts +69 -17
- package/dist/core/crbm/fingerprint.d.ts +5 -0
- package/dist/core/crbm/format.d.ts +0 -1
- package/dist/core/crbm/plan-reads.d.ts +9 -3
- package/dist/core/crbm/reader.d.ts +52 -6
- package/dist/core/crbm/varint.d.ts +2 -1
- package/dist/core/crbm/writer.d.ts +5 -1
- package/dist/core/crbm-open.d.ts +154 -0
- package/dist/core/crbm-storage-source.d.ts +65 -452
- package/dist/core/crbm-write.d.ts +75 -0
- package/dist/core/crypto.d.ts +6 -1
- package/dist/core/engine.d.ts +222 -33
- package/dist/core/erase-id.d.ts +42 -7
- package/dist/core/erasure.d.ts +4 -3
- package/dist/core/errors.d.ts +8 -2
- package/dist/core/generation-gc.d.ts +129 -15
- package/dist/core/generation-list.d.ts +11 -0
- package/dist/core/id-window.d.ts +46 -0
- package/dist/core/invalidation-scope.d.ts +77 -0
- package/dist/core/known-generations-shape.d.ts +13 -0
- package/dist/core/known-generations.d.ts +147 -0
- package/dist/core/leases.d.ts +4 -3
- package/dist/core/ledger-seed.d.ts +17 -0
- package/dist/core/load.d.ts +17 -38
- package/dist/core/lru.d.ts +2 -15
- package/dist/core/metrics.d.ts +4 -2
- package/dist/core/order.d.ts +2 -0
- package/dist/core/pinned-storage-source.d.ts +4 -4
- package/dist/core/ports.d.ts +89 -16
- package/dist/core/publish.d.ts +207 -0
- package/dist/core/registry-scan.d.ts +0 -2
- package/dist/core/retention-sweep.d.ts +69 -65
- package/dist/core/retention.d.ts +1 -1
- package/dist/core/retry.d.ts +12 -19
- package/dist/core/rollback.d.ts +60 -31
- package/dist/core/summary.d.ts +50 -18
- package/dist/core/token.d.ts +2 -2
- package/dist/core/validate.d.ts +2 -0
- package/dist/driver-kit.d.ts +4 -0
- package/dist/driver-kit.js +80 -7
- package/dist/driver-kit.js.map +3 -3
- package/dist/drivers/_shared/bytes.d.ts +6 -0
- package/dist/drivers/_shared/faults.d.ts +15 -0
- package/dist/drivers/_shared/object-keys.d.ts +18 -0
- package/dist/drivers/_shared/object-registry-keys.d.ts +0 -2
- package/dist/drivers/_shared/object-registry.d.ts +2 -0
- package/dist/drivers/_shared/options.d.ts +19 -0
- package/dist/drivers/_shared/registry.d.ts +13 -10
- package/dist/drivers/localfs/exact-case.d.ts +0 -3
- package/dist/drivers/localfs/fs-util.d.ts +22 -0
- package/dist/drivers/localfs/registry.d.ts +10 -4
- package/dist/drivers/localfs/storage.d.ts +9 -2
- package/dist/drivers/memory.d.ts +7 -4
- package/dist/index.d.ts +1 -1
- package/dist/index.js +3647 -2410
- package/dist/index.js.map +4 -4
- package/package.json +1 -1
- package/dist/chunk-YSC7NJWV.js.map +0 -7
- package/dist/core/kept-generations.d.ts +0 -40
package/dist/driver-kit.js
CHANGED
|
@@ -26,14 +26,18 @@ import {
|
|
|
26
26
|
parseRegistryEnvelope,
|
|
27
27
|
pointerIdOf,
|
|
28
28
|
recordFromNew,
|
|
29
|
+
refuseUnknownOptions,
|
|
29
30
|
renewPointer,
|
|
30
31
|
renewsPointer,
|
|
32
|
+
requireBool,
|
|
33
|
+
requireInteger,
|
|
34
|
+
requirePositiveInt,
|
|
31
35
|
serializeRegistryEnvelope,
|
|
32
36
|
validateNewRegistryRecord,
|
|
33
37
|
validateRegistryPatch,
|
|
34
38
|
validateSegmentRef,
|
|
35
39
|
webCryptoEntropy
|
|
36
|
-
} from "./chunk-
|
|
40
|
+
} from "./chunk-IGLIZBR7.js";
|
|
37
41
|
|
|
38
42
|
// src/drivers/_shared/object-registry-keys.ts
|
|
39
43
|
var REGISTRY_SUFFIX = ".reg";
|
|
@@ -111,6 +115,8 @@ function parseRegistryKey(prefix, objectKey) {
|
|
|
111
115
|
|
|
112
116
|
// src/drivers/_shared/object-registry.ts
|
|
113
117
|
var MAX_ROW_BYTES = 1 * 1024 * 1024;
|
|
118
|
+
var UTF8 = new TextEncoder();
|
|
119
|
+
var UTF8_DECODER = new TextDecoder();
|
|
114
120
|
var MAX_DELETE_ATTEMPTS = 8;
|
|
115
121
|
var MAX_READ_ATTEMPTS = 8;
|
|
116
122
|
var LIST_READ_CONCURRENCY = 48;
|
|
@@ -120,6 +126,7 @@ var ObjectVersionRaced = class extends Error {
|
|
|
120
126
|
this.name = "ObjectVersionRaced";
|
|
121
127
|
}
|
|
122
128
|
};
|
|
129
|
+
var isVersionRaced = (err) => err instanceof Error && err.name === "ObjectVersionRaced";
|
|
123
130
|
var ObjectStoreRegistry = class {
|
|
124
131
|
/**
|
|
125
132
|
* `entropy` draws the random parts of every token: a new row's incarnation id, and each write's own part. It
|
|
@@ -140,6 +147,10 @@ var ObjectStoreRegistry = class {
|
|
|
140
147
|
const conditionalDelete = this.removesRows();
|
|
141
148
|
return entropyIsAvailable(this.entropy) ? { strongRead: true, conditionalDelete } : { strongRead: true, canWrite: false, conditionalDelete };
|
|
142
149
|
}
|
|
150
|
+
/** Every write reports its token to `onToken` before the request that carries it is sent. */
|
|
151
|
+
get reportsWriteTokens() {
|
|
152
|
+
return true;
|
|
153
|
+
}
|
|
143
154
|
/** Whether a delete removes a row: the store has a delete, and vouches for it. */
|
|
144
155
|
removesRows() {
|
|
145
156
|
return this.store.conditionalDelete === true && typeof this.store.delete === "function";
|
|
@@ -159,7 +170,7 @@ var ObjectStoreRegistry = class {
|
|
|
159
170
|
let lost;
|
|
160
171
|
if (options?.held === null) {
|
|
161
172
|
try {
|
|
162
|
-
return await this.createOver(key, ref, checked, void 0);
|
|
173
|
+
return await this.createOver(key, ref, checked, void 0, options);
|
|
163
174
|
} catch (err) {
|
|
164
175
|
if (!isWriteConflictError(err)) throw err;
|
|
165
176
|
lost = err;
|
|
@@ -170,11 +181,12 @@ var ObjectStoreRegistry = class {
|
|
|
170
181
|
throw new WriteConflictError(`registry row already exists for segment ${ref.segment}`);
|
|
171
182
|
}
|
|
172
183
|
if (lost !== void 0 && current === null) throw lost;
|
|
173
|
-
return this.createOver(key, ref, checked, current ?? void 0);
|
|
184
|
+
return this.createOver(key, ref, checked, current ?? void 0, options);
|
|
174
185
|
}
|
|
175
186
|
/** Write a new incarnation of the row: over `tombstone` under its version, or create-only when there is none. */
|
|
176
|
-
async createOver(key, ref, checked, tombstone) {
|
|
187
|
+
async createOver(key, ref, checked, tombstone, options) {
|
|
177
188
|
const token = newIncarnationToken(this.entropy, tombstone?.env.record);
|
|
189
|
+
options?.onToken?.(token);
|
|
178
190
|
const env = {
|
|
179
191
|
deleted: false,
|
|
180
192
|
record: recordFromNew(ref, checked, this.now(), token)
|
|
@@ -190,6 +202,7 @@ var ObjectStoreRegistry = class {
|
|
|
190
202
|
throw new WriteConflictError(`OCC token mismatch for registry row ${ref.segment}`);
|
|
191
203
|
}
|
|
192
204
|
const token = nextRegistryToken(current.env.record, this.entropy);
|
|
205
|
+
options?.onToken?.(token);
|
|
193
206
|
const env = {
|
|
194
207
|
deleted: false,
|
|
195
208
|
record: applyRegistryPatch(current.env.record, checked, this.now(), token)
|
|
@@ -288,7 +301,7 @@ var ObjectStoreRegistry = class {
|
|
|
288
301
|
);
|
|
289
302
|
}
|
|
290
303
|
const stored = parseRegistryKey(this.prefix, objectKey) ?? void 0;
|
|
291
|
-
const env = parseRegistryEnvelope(
|
|
304
|
+
const env = parseRegistryEnvelope(UTF8_DECODER.decode(row.bytes), objectKey, stored);
|
|
292
305
|
return { env, bytes: row.bytes, version: row.version };
|
|
293
306
|
}
|
|
294
307
|
/** {@link ObjectRegistryStore.read}, retrying the bounded number of times a mid-read overwrite allows. */
|
|
@@ -297,7 +310,7 @@ var ObjectStoreRegistry = class {
|
|
|
297
310
|
try {
|
|
298
311
|
return await this.store.read(objectKey);
|
|
299
312
|
} catch (err) {
|
|
300
|
-
if (!(err
|
|
313
|
+
if (!isVersionRaced(err)) throw err;
|
|
301
314
|
}
|
|
302
315
|
}
|
|
303
316
|
throw new TransientError(
|
|
@@ -306,13 +319,64 @@ var ObjectStoreRegistry = class {
|
|
|
306
319
|
}
|
|
307
320
|
/** Conditional write of an envelope. The store maps a lost precondition to {@link WriteConflictError}. */
|
|
308
321
|
async putRow(objectKey, env, expect) {
|
|
309
|
-
const body =
|
|
322
|
+
const body = UTF8.encode(serializeRegistryEnvelope(env));
|
|
310
323
|
if (body.length > MAX_ROW_BYTES) {
|
|
311
324
|
throw new ValidationError(`registry object ${body.length}B exceeds cap ${MAX_ROW_BYTES}B`);
|
|
312
325
|
}
|
|
313
326
|
await this.store.write(objectKey, body, expect);
|
|
314
327
|
}
|
|
315
328
|
};
|
|
329
|
+
|
|
330
|
+
// src/drivers/_shared/object-keys.ts
|
|
331
|
+
var SUFFIX = ".crbm";
|
|
332
|
+
function segmentObjectPrefix(prefix, ref) {
|
|
333
|
+
validateSegmentRef(ref);
|
|
334
|
+
return `${prefixPart(prefix)}${namespaceKeyPart(ref.namespace)}/segments/${encodeNameForKey(ref.segment)}.`;
|
|
335
|
+
}
|
|
336
|
+
function storageObjectKey(prefix, key) {
|
|
337
|
+
requireInteger(key.generation, { min: 0, what: "generation" });
|
|
338
|
+
return `${segmentObjectPrefix(prefix, key)}${key.generation}${SUFFIX}`;
|
|
339
|
+
}
|
|
340
|
+
function parseGenerationFromKey(segmentPrefix, objectKey) {
|
|
341
|
+
if (!objectKey.startsWith(segmentPrefix) || !objectKey.endsWith(SUFFIX)) return null;
|
|
342
|
+
const middle = objectKey.slice(segmentPrefix.length, objectKey.length - SUFFIX.length);
|
|
343
|
+
if (!/^(0|[1-9]\d*)$/.test(middle)) return null;
|
|
344
|
+
const generation = Number(middle);
|
|
345
|
+
return Number.isSafeInteger(generation) ? generation : null;
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
// src/drivers/_shared/faults.ts
|
|
349
|
+
var TRANSPORT_FAULT_CODES = /* @__PURE__ */ new Set([
|
|
350
|
+
"ECONNRESET",
|
|
351
|
+
"ECONNREFUSED",
|
|
352
|
+
"ECONNABORTED",
|
|
353
|
+
"ETIMEDOUT",
|
|
354
|
+
"ENOTFOUND",
|
|
355
|
+
"EAI_AGAIN",
|
|
356
|
+
"EHOSTUNREACH",
|
|
357
|
+
"ENETUNREACH",
|
|
358
|
+
"EPIPE"
|
|
359
|
+
]);
|
|
360
|
+
function isTransportFault(err) {
|
|
361
|
+
const code = err?.code;
|
|
362
|
+
return typeof code === "string" && TRANSPORT_FAULT_CODES.has(code);
|
|
363
|
+
}
|
|
364
|
+
function toTransient(err, isTransient, message) {
|
|
365
|
+
return isTransient(err) ? new TransientError(message(err), { cause: err }) : err;
|
|
366
|
+
}
|
|
367
|
+
|
|
368
|
+
// src/drivers/_shared/bytes.ts
|
|
369
|
+
function concatBytes(parts) {
|
|
370
|
+
let total = 0;
|
|
371
|
+
for (const p of parts) total += p.length;
|
|
372
|
+
const out = new Uint8Array(total);
|
|
373
|
+
let offset = 0;
|
|
374
|
+
for (const p of parts) {
|
|
375
|
+
out.set(p, offset);
|
|
376
|
+
offset += p.length;
|
|
377
|
+
}
|
|
378
|
+
return out;
|
|
379
|
+
}
|
|
316
380
|
export {
|
|
317
381
|
IntegrityError,
|
|
318
382
|
MAX_ROW_BYTES,
|
|
@@ -325,20 +389,29 @@ export {
|
|
|
325
389
|
ValidationError,
|
|
326
390
|
WriteConflictError,
|
|
327
391
|
brandAsBackend,
|
|
392
|
+
concatBytes,
|
|
328
393
|
encodeNameForKey,
|
|
329
394
|
encodeNameForPath,
|
|
330
395
|
isIntegrityError,
|
|
331
396
|
isNotFoundError,
|
|
332
397
|
isTransientError,
|
|
398
|
+
isTransportFault,
|
|
333
399
|
isValidationError,
|
|
334
400
|
isWriteConflictError,
|
|
335
401
|
namespaceKeyPart,
|
|
336
402
|
namespacePathPart,
|
|
337
403
|
normalizeObjectPrefix,
|
|
404
|
+
parseGenerationFromKey,
|
|
338
405
|
pointerIdOf,
|
|
339
406
|
prefixPart,
|
|
407
|
+
refuseUnknownOptions,
|
|
340
408
|
renewPointer,
|
|
341
409
|
renewsPointer,
|
|
410
|
+
requireBool,
|
|
411
|
+
requirePositiveInt,
|
|
412
|
+
segmentObjectPrefix,
|
|
413
|
+
storageObjectKey,
|
|
414
|
+
toTransient,
|
|
342
415
|
validateSegmentRef
|
|
343
416
|
};
|
|
344
417
|
//# sourceMappingURL=driver-kit.js.map
|
package/dist/driver-kit.js.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
|
-
"sources": ["../src/drivers/_shared/object-registry-keys.ts", "../src/drivers/_shared/object-registry.ts"],
|
|
4
|
-
"sourcesContent": ["/**\n * The registry object layout, shared by every object-store registry (S3, GCS, Azure Blob).\n *\n * One tiny JSON object per segment at `<prefix>registry/<ns>/<segment>.reg`, **registry-first** \u2014 separate\n * from the namespace-first storage layout (`<prefix><ns>/segments/\u2026`) \u2014 so discovery is a single list over\n * `registry/` for all namespaces, or `registry/<ns>/` for one, never entangled with the `.crbm` payloads.\n *\n * It lives here rather than in a driver because all three object stores encode names the same way\n * (`encodeNameForKey`, `namespaceKeyPart`) and build byte-identical keys. Three copies of this would be\n * three chances for one cloud's layout to drift from the others \u2014 and a drifted key is not a visible bug, it\n * is a segment that quietly cannot be found by a store pointed at the same bucket.\n */\nimport { ValidationError } from '@/core/errors';\nimport { validateSegmentRef } from '@/core/validate';\nimport type { SegmentRef } from '@/core/ports';\nimport { DEFAULT_NAMESPACE, decodeNameFromKey, encodeNameForKey, namespaceKeyPart } from './keys';\n\nconst REGISTRY_SUFFIX = '.reg';\n\n/** Normalize an optional caller prefix to either `''` or `trimmed/` (no leading/trailing slashes). */\nexport function prefixPart(prefix: string | undefined): string {\n if (prefix === undefined) return '';\n // Index scans, not a regex: `/\\/+$/` retries from every slash of a run that is not at the end, which is\n // quadratic in the run's length.\n let start = 0;\n let end = prefix.length;\n while (start < end && prefix.charCodeAt(start) === 0x2f) start++;\n while (end > start && prefix.charCodeAt(end - 1) === 0x2f) end--;\n const trimmed = prefix.slice(start, end);\n return trimmed === '' ? '' : `${trimmed}/`;\n}\n\n/**\n * Validate a caller-supplied key prefix (trusted config, but make it a real containment boundary): reject\n * control characters and `.`/`..` path segments so a prefix cannot traverse out of its intended space.\n * Returns it unchanged \u2014 the key builders normalize slashes.\n *\n * The traversal check covers three spellings, because the tools that walk these buckets do. A bare `..` is\n * the obvious one. A **backslash** segment matters on ADLS Gen2 and to Windows-side tooling, which treat it\n * as a separator this code otherwise would not. And a percent-encoded `..` matters because `gsutil`,\n * `s3fs`, `gcsfuse` and `azcopy` decode a key on their way to a local path \u2014 the same reasoning\n * `name-codec.ts` already applies to segment names, which a prefix has no reason to be exempt from.\n */\nexport function normalizeObjectPrefix(prefix: string | undefined): string | undefined {\n if (prefix === undefined) return undefined;\n for (const ch of prefix) {\n const code = ch.charCodeAt(0);\n // C0 plus DEL: a bare `< 0x20` lets U+007F through, and it is as unprintable as the rest.\n if (code < 0x20 || code === 0x7f) {\n throw new ValidationError('prefix must not contain control characters');\n }\n }\n if (prefix.includes('\\\\')) {\n throw new ValidationError(\n `prefix must not contain backslashes (a path separator on some backends): ${JSON.stringify(prefix)}`,\n );\n }\n // Check the decoded spelling too, so an encoded `..` cannot slip past the literal comparison.\n let decoded: string;\n try {\n decoded = decodeURIComponent(prefix);\n } catch {\n decoded = prefix; // not valid percent-encoding; the literal check still applies\n }\n for (const source of decoded === prefix ? [prefix] : [prefix, decoded]) {\n for (const segment of source.split('/')) {\n if (segment === '.' || segment === '..') {\n throw new ValidationError(\n `prefix must not contain \".\" or \"..\" path segments: ${JSON.stringify(prefix)}`,\n );\n }\n }\n }\n return prefix;\n}\n\n/** The key prefix under which every registry object lives: `<prefix>registry/`. */\nexport function registryPrefix(prefix: string | undefined): string {\n return `${prefixPart(prefix)}registry/`;\n}\n\n/** The full key of one segment's registry object: `<prefix>registry/<ns>/<segment>.reg`. */\nexport function registryObjectKey(prefix: string | undefined, ref: SegmentRef): string {\n validateSegmentRef(ref);\n return `${registryPrefix(prefix)}${namespaceKeyPart(ref.namespace)}/${encodeNameForKey(ref.segment)}${REGISTRY_SUFFIX}`;\n}\n\n/** The list prefix for discovery: registry-wide, or scoped to one namespace. */\nexport function registryListPrefix(prefix: string | undefined, namespace?: string): string {\n const base = registryPrefix(prefix);\n return namespace === undefined ? base : `${base}${namespaceKeyPart(namespace)}/`;\n}\n\n/**\n * Parse a `<prefix>registry/<ns>/<segment>.reg` key back to its {@link SegmentRef}, or `null` if it does not\n * match \u2014 a stray or foreign object under the prefix, or one whose parsed ref fails the round-trip check.\n * `_default` maps back to the absent namespace. A name is percent-encoded on the way in, so no encoded name\n * can contain `/` and the split stays unambiguous whatever the caller named their segment.\n */\nexport function parseRegistryKey(prefix: string | undefined, objectKey: string): SegmentRef | null {\n const base = registryPrefix(prefix);\n if (!objectKey.startsWith(base) || !objectKey.endsWith(REGISTRY_SUFFIX)) return null;\n const rest = objectKey.slice(base.length, objectKey.length - REGISTRY_SUFFIX.length);\n const slash = rest.indexOf('/');\n if (slash < 0) return null;\n const nsPart = rest.slice(0, slash);\n const encodedSegment = rest.slice(slash + 1);\n if (encodedSegment.length === 0 || encodedSegment.includes('/')) return null;\n const segment = decodeNameFromKey(encodedSegment);\n const namespace = nsPart === DEFAULT_NAMESPACE ? undefined : decodeNameFromKey(nsPart);\n // The encoding must ROUND-TRIP, not merely decode: a foreign object placed under our prefix could spell a\n // name two ways, and reporting both would hand a sweep one segment under two identities.\n if (encodeNameForKey(segment) !== encodedSegment) return null;\n if (namespace !== undefined && encodeNameForKey(namespace) !== nsPart) return null;\n const ref: SegmentRef = { segment, namespace };\n try {\n validateSegmentRef(ref); // reject a hostile/foreign key that isn't a valid ref\n } catch {\n return null;\n }\n return ref;\n}\n", "/**\n * `ObjectStoreRegistry` \u2014 an {@link IRegistryDriver} over any object store with conditional writes.\n *\n * Lets a **read-mostly deployment run on one bucket alone** \u2014 storage `.crbm` generations plus the registry in\n * the same place, with no separate database. One tiny JSON object per segment at\n * `<prefix>registry/<ns>/<segment>.reg` holding the `{ deleted, record }` envelope (the same shape LocalFs\n * persists). The OCC token is a random incarnation id drawn when the row is created, a counter advanced on every\n * mutation, and a random part drawn for every write, so with overwhelming probability a deleted-then-recreated row, or\n * one restored from a backup, never re-issues an old token (ABA-safe) \u2014 identical semantics to the LocalFs registry, so it passes the same\n * conformance suite.\n *\n * **`delete` removes a row for good where the store vouches for a conditional delete** (`If-Match: <etag>`,\n * `ifGenerationMatch: <generation>`): a re-create draws a new incarnation, so nothing of the old row is needed to keep\n * its tokens apart, and a full `list()` no longer reads a row for every name it ever held. On a store that cannot\n * vouch for one, the row is **tombstoned**: the object stays, its counter advanced, and a re-create carries the counter\n * on.\n *\n * **The atomic swap is offloaded to the store's conditional writes.** `create` writes only if absent (or\n * over a tombstone under its version), and `compareAndSwap`/`delete` write (or delete) only if the object still\n * carries the version we read \u2014 so a concurrent writer between our read and our write loses, and the loss surfaces\n * as {@link WriteConflictError}. No in-process lock is needed (unlike LocalFs): the precondition fences\n * writers *across processes*.\n *\n * **A caller that already read the row can spare the read before its write.** `get` remembers the version of the\n * object it read, against the record it returned. A `compareAndSwap` handed that very record as `held` conditions its\n * write on that version and sends it at once, and a `create` handed `null` (the caller found no row) sends its\n * create-only write at once. The store's condition stays the fence: a row that changed since fails the write as a lost\n * race, so a stale `held` can lose a write and never land one. A record this registry did not return (a copy, another\n * registry's) is read for as without the hint.\n *\n * **Why this is shared rather than written per cloud.** Every object store worth using has the same two\n * primitives under different names \u2014 S3 `If-None-Match: *` / `If-Match: <etag>`, GCS `ifGenerationMatch: 0`\n * / `ifGenerationMatch: <generation>`, Azure `If-None-Match: *` / `If-Match: <etag>` \u2014 so the only thing\n * that differs is a few I/O calls, which is what {@link ObjectRegistryStore} abstracts. The parts that are\n * genuinely hard (the ABA-safe token, the delete and its tombstone, the bounded delete retry, the round-trip key check)\n * exist once. Three copies would be three chances for one cloud to drift, and a drifted registry is not a\n * visible bug \u2014 it is a lost `currentGen` swap.\n *\n * **Deployment requirements** (a backend that violates these silently corrupts the registry):\n * - The store **must honor the conditional write**. One that accepts the precondition header and ignores it\n * degrades compare-and-swap to last-write-wins \u2192 lost `currentGen` swaps.\n * - Reads must be **strongly consistent** \u2014 true of S3 (since 2020), GCS and Azure Blob \u2014 since the registry\n * advertises `strongRead` and generation resolution depends on it.\n * - **Do not apply a lifecycle-expiration rule to the `registry/` prefix that expires a current version.**\n * Expiring a live row loses its pointer. A tombstone `delete` left keeps the counter for a re-create; one expired\n * by a rule is no worse than a row removed for good, since a recreate draws a fresh incarnation and its tokens are\n * new but for a collision of probability 2^-128 per pair of incarnations, but a rule cannot tell a tombstone from a\n * live row.\n * - **A store's conditional delete must be honoured by its backend** before the store sets `conditionalDelete`.\n * One that ignores the precondition lets two sweepers and a re-create delete a live row.\n *\n * **`list()` is fail-closed, and one bad object stops it for everyone.** An object under the `registry/`\n * prefix whose key parses but whose body does not aborts the whole enumeration \u2014 every namespace, not just\n * the affected segment \u2014 and it stays that way until an operator removes the object. The error names the\n * offending key.\n *\n * That is the deliberate choice, and it is the *safer* one rather than the more convenient one. Skipping the\n * unreadable row would keep discovery running, but `list()` is what tells orphan generation collection which\n * segments exist: a row missing from the enumeration makes its storage `.crbm` generations look unreferenced,\n * and the next GC pass would delete them. Silently skipping turns a parse error into data loss. Refusing to\n * enumerate keeps every sweep off a set it cannot vouch for (invariant 5 \u2014 bytes from the tier are\n * untrusted). **Recovery:** read the named object, and either restore a valid envelope or delete it; nothing\n * else is damaged, and discovery resumes on its own.\n */\nimport {\n IntegrityError,\n TransientError,\n ValidationError,\n WriteConflictError,\n isWriteConflictError,\n} from '@/core/errors';\nimport type {\n IRegistryDriver,\n NewRegistryRecord,\n RegCaps,\n RegistryPatch,\n RegistryRecord,\n RegistryWriteOptions,\n SegmentRef,\n Token,\n} from '@/core/ports';\nimport type { Entropy } from '@/core/determinism';\nimport { mapWithConcurrency } from '@/core/concurrency';\nimport {\n applyRegistryPatch,\n newIncarnationToken,\n nextRegistryToken,\n parseRegistryEnvelope,\n recordFromNew,\n serializeRegistryEnvelope,\n validateNewRegistryRecord,\n validateRegistryPatch,\n type RegistryEnvelope,\n} from './registry';\nimport { entropyIsAvailable, webCryptoEntropy } from './entropy';\nimport { parseRegistryKey, registryListPrefix, registryObjectKey } from './object-registry-keys';\nimport { validateSegmentRef } from '@/core/validate';\n\n/** Defensive cap on a single registry object read from storage, before allocation (rows are tiny; ~1 KB). */\nexport const MAX_ROW_BYTES = 1 * 1024 * 1024;\n/** Bounded retry for `delete`'s read then delete or tombstone, under cross-process contention (then fails typed). */\nconst MAX_DELETE_ATTEMPTS = 8;\n/** Bounded re-read when a store's pinned version is overwritten mid-read (see {@link ObjectVersionRaced}). */\nconst MAX_READ_ATTEMPTS = 8;\n/** In-flight reads per `list()` page \u2014 turns the serial N+1 into one list plus bounded parallel reads. */\nconst LIST_READ_CONCURRENCY = 48;\n\n/**\n * Raised by a store when the version it pinned for a read vanished before it could fetch the bytes \u2014\n * a concurrent writer overwrote or deleted the object in between.\n *\n * This is deliberately **neither** of the two things it superficially resembles. It is not absence: the row\n * is very likely still live, just one version further on. And it is not a write conflict: the caller may be\n * a read-only `get()`, which has nothing to conflict with. Either is an easy misreading for a store that reads a\n * row in two calls, metadata and then bytes pinned to it, which is why the signal is part of the port rather than\n * left to each store's judgement. {@link ObjectStoreRegistry} answers it the only way that is correct for every\n * caller: it reads again.\n *\n * Stores whose read is atomic can never raise it, and every shipped store's is: S3 serves bytes and `ETag` from one\n * `GetObject`, GCS bytes and `generation` from one GET, and Azure Blob bytes and `ETag` from one GET.\n */\nexport class ObjectVersionRaced extends Error {\n constructor(objectKey: string) {\n super(`registry object was overwritten mid-read: ${objectKey}`);\n this.name = 'ObjectVersionRaced';\n }\n}\n\n/** One object as read, with the opaque version that fences a later conditional write. */\nexport interface ObjectRow {\n readonly bytes: Uint8Array;\n /** The store's version fence \u2014 an S3/Azure ETag, a GCS generation. Opaque to this class. */\n readonly version: string;\n}\n\n/**\n * The I/O calls an object store must provide to host a registry: three, and an optional conditional delete. Everything\n * else \u2014 the OCC token, tombstones, the delete retry, key parsing \u2014 is implemented once above.\n */\nexport interface ObjectRegistryStore {\n /** A label for error messages, e.g. `GCS` or `Azure Blob`. */\n readonly label: string;\n /**\n * Read one object, or `null` when it is absent.\n *\n * **`null` means the object does not exist** \u2014 nothing weaker. A store that reads in two round trips\n * (metadata for the version fence, then the bytes pinned to it) can find that version already gone; it\n * MUST report that with {@link ObjectVersionRaced} rather than `null` or {@link WriteConflictError}, and\n * the caller re-reads. Retryable faults throw {@link TransientError}.\n *\n * `bytes` and `version` MUST describe the **same** observation of the object: `version` is the fence a\n * later conditional write is conditioned on, so a pair drawn from two different versions would either\n * fail a write that should have succeeded or, worse, pass one that should not.\n */\n read(key: string): Promise<ObjectRow | null>;\n /**\n * Write one object under a precondition: `'absent'` means create-only, a version means\n * compare-and-swap against exactly that version. A lost race MUST throw {@link WriteConflictError}.\n *\n * A store must not replay this write after a lost response without telling the replay apart: the replay meets\n * the row it just wrote and its precondition fails, which would read as a lost race. Send it once, or store a\n * write id with the row and treat a conflict whose stored row carries it as success. Retryable faults throw\n * {@link TransientError}.\n */\n write(key: string, body: Uint8Array, expect: 'absent' | { version: string }): Promise<void>;\n /** Every object key under `prefix`, paginated internally. */\n listKeys(prefix: string): AsyncIterable<string>;\n /**\n * Optional: delete one object, and only while it is still at exactly `expect.version`, by a precondition the\n * backend applies (`If-Match: <etag>`, `ifGenerationMatch: <generation>`). An object that was overwritten, or is\n * gone, MUST throw {@link WriteConflictError} and delete nothing. Retryable faults throw {@link TransientError}.\n *\n * Sending it again after a lost response is safe, unlike a write: the precondition names one version, so a second\n * copy can remove nothing the first was not allowed to. A copy that meets its own landed delete fails the\n * precondition and reports a conflict; the registry re-reads, and finds the row gone.\n *\n * The registry calls it only when {@link conditionalDelete} is `true`.\n */\n delete?(key: string, expect: { version: string }): Promise<void>;\n /**\n * Whether {@link delete} may be relied on: `true` only where the backend is known to apply the precondition. A\n * backend that accepts the header and ignores it would let a delete remove a row written after the delete read it,\n * a live one included. Absent or `false`, the registry never calls `delete` and tombstones every row instead.\n */\n readonly conditionalDelete?: boolean;\n}\n\n/** A row as read: its envelope, the bytes it was parsed from, and the version that fences a write to it. */\ninterface ReadRow extends ObjectRow {\n readonly env: RegistryEnvelope;\n}\n\n/** What a record `get` returned was read from. */\ninterface ObservedRow extends ObjectRow {\n readonly key: string;\n}\n\nexport class ObjectStoreRegistry implements IRegistryDriver {\n /**\n * `entropy` draws the random parts of every token: a new row's incarnation id, and each write's own part. It\n * defaults to the platform's Web Crypto. Inject one only to make a test replayable: a seeded source in production\n * gives every process the same ids.\n */\n constructor(\n private readonly store: ObjectRegistryStore,\n private readonly prefix: string | undefined,\n private readonly now: () => number,\n private readonly entropy: Entropy = webCryptoEntropy,\n ) {}\n\n capabilities(): RegCaps {\n const conditionalDelete = this.removesRows();\n return entropyIsAvailable(this.entropy)\n ? { strongRead: true, conditionalDelete }\n : { strongRead: true, canWrite: false, conditionalDelete };\n }\n\n /** Whether a delete removes a row: the store has a delete, and vouches for it. */\n private removesRows(): boolean {\n return this.store.conditionalDelete === true && typeof this.store.delete === 'function';\n }\n\n /** The object each record `get` returned was read from, to fence a write made against it ({@link RegistryWriteOptions.held}). */\n private readonly observed = new WeakMap<RegistryRecord, ObservedRow>();\n\n async get(ref: SegmentRef): Promise<RegistryRecord | null> {\n const key = registryObjectKey(this.prefix, ref);\n const row = await this.readRow(key);\n if (row === null || row.env.deleted) return null;\n this.observed.set(row.env.record, { key, bytes: row.bytes, version: row.version });\n return row.env.record;\n }\n\n async create(\n ref: SegmentRef,\n record: NewRegistryRecord,\n options?: RegistryWriteOptions,\n ): Promise<{ token: Token }> {\n const checked = validateNewRegistryRecord(record);\n const key = registryObjectKey(this.prefix, ref);\n let lost: unknown;\n if (options?.held === null) {\n // The caller found no row: send the create-only write without reading. One that loses to a row, or to a tombstone\n // (which a create-only write cannot go over), is told apart by the read below.\n try {\n return await this.createOver(key, ref, checked, undefined);\n } catch (err) {\n if (!isWriteConflictError(err)) throw err;\n lost = err;\n }\n }\n const current = await this.readRow(key);\n if (current !== null && !current.env.deleted) {\n throw new WriteConflictError(`registry row already exists for segment ${ref.segment}`);\n }\n // No row at all now: the create-only write lost to something that has gone since, and it is not sent again.\n if (lost !== undefined && current === null) throw lost;\n return this.createOver(key, ref, checked, current ?? undefined);\n }\n\n /** Write a new incarnation of the row: over `tombstone` under its version, or create-only when there is none. */\n private async createOver(\n key: string,\n ref: SegmentRef,\n checked: NewRegistryRecord,\n tombstone: ReadRow | undefined,\n ): Promise<{ token: Token }> {\n // A new incarnation, whose counter continues across a tombstone, so with overwhelming probability a recreate never re-issues an old token.\n const token = newIncarnationToken(this.entropy, tombstone?.env.record);\n const env: RegistryEnvelope = {\n deleted: false,\n record: recordFromNew(ref, checked, this.now(), token),\n };\n // Create-only when truly absent; overwrite the tombstone under its version when recreating. Either way\n // a concurrent create loses the precondition and surfaces as a conflict.\n await this.putRow(key, env, tombstone ? { version: tombstone.version } : 'absent');\n return { token };\n }\n\n async compareAndSwap(\n ref: SegmentRef,\n expected: Token,\n patch: RegistryPatch,\n options?: RegistryWriteOptions,\n ): Promise<{ token: Token }> {\n const checked = validateRegistryPatch(patch);\n const key = registryObjectKey(this.prefix, ref);\n // The row the caller read, as this registry read it, when it is the row `expected` names; otherwise read it now.\n const current = this.observedRow(key, expected, options?.held) ?? (await this.readRow(key));\n if (current === null || current.env.deleted || current.env.record.token !== expected) {\n throw new WriteConflictError(`OCC token mismatch for registry row ${ref.segment}`);\n }\n const token = nextRegistryToken(current.env.record, this.entropy);\n const env: RegistryEnvelope = {\n deleted: false,\n record: applyRegistryPatch(current.env.record, checked, this.now(), token),\n };\n // The version we read fences a concurrent writer between that read and this write.\n await this.putRow(key, env, { version: current.version });\n return { token };\n }\n\n /**\n * The row a caller's `held` record was read as, decoded again from the bytes `get` saw so that nothing the caller did\n * to its copy reaches the write, or `undefined` when `held` is not a record this registry returned for this row under\n * the token the write expects. The version it carries is the store's fence, so a row that has moved on since fails\n * the write.\n */\n private observedRow(\n key: string,\n expected: Token,\n held: RegistryRecord | null | undefined,\n ): ReadRow | undefined {\n const seen = held ? this.observed.get(held) : undefined;\n if (seen === undefined || seen.key !== key || held?.token !== expected) return undefined;\n return this.decodeRow(key, seen);\n }\n\n async *list(namespace?: string): AsyncIterable<RegistryRecord> {\n // A namespace that is given is checked as every other name is: `''` names none, and reads as an error, not as empty.\n if (namespace !== undefined) validateSegmentRef({ segment: 'x', namespace });\n const prefix = registryListPrefix(this.prefix, namespace);\n // One list plus bounded parallel reads. A serial await-in-loop made this O(N) sequential round trips.\n let page: string[] = [];\n const flush = async function* (\n this: ObjectStoreRegistry,\n keys: string[],\n ): AsyncIterable<RegistryRecord> {\n const rows = await mapWithConcurrency(keys, LIST_READ_CONCURRENCY, (key) =>\n this.readRow(key),\n );\n for (const current of rows) {\n if (current && !current.env.deleted) yield current.env.record;\n }\n }.bind(this);\n\n for await (const key of this.store.listKeys(prefix)) {\n if (parseRegistryKey(this.prefix, key) === null) continue; // stray or foreign object\n page.push(key);\n if (page.length >= LIST_READ_CONCURRENCY) {\n yield* flush(page);\n page = [];\n }\n }\n if (page.length > 0) yield* flush(page);\n }\n\n async delete(ref: SegmentRef, expected?: Token): Promise<void> {\n const key = registryObjectKey(this.prefix, ref);\n // Where the store vouches for a conditional delete, the row is removed from it, by a delete the store applies only\n // while the object is still the version read here: a later create draws a new incarnation, so nothing of this row\n // is needed to keep its tokens apart. Otherwise it is tombstoned (the counter advanced, the object kept), so a\n // re-create carries the counter on. Retry the read and the write on a cross-process race; it converges, then fails\n // typed rather than silently leaving the row live.\n for (let attempt = 0; attempt < MAX_DELETE_ATTEMPTS; attempt++) {\n const current = await this.readRow(key);\n if (expected !== undefined) {\n // Fenced: the row must still carry the token the caller read. Re-checked on every attempt, so a row\n // that was swapped, or deleted and re-created, between two attempts is refused rather than tombstoned.\n if (current === null || current.env.deleted || current.env.record.token !== expected) {\n throw new WriteConflictError(`OCC token mismatch for registry row ${ref.segment}`);\n }\n } else if (current === null || current.env.deleted) {\n return; // idempotent \u2014 already gone\n }\n try {\n const remove = this.removesRows() ? this.store.delete : undefined;\n if (remove !== undefined) {\n // The version read above is the row the caller's token names, so this removes that row and no later one.\n await remove.call(this.store, key, { version: current.version });\n return;\n }\n const token = nextRegistryToken(current.env.record, this.entropy);\n const env: RegistryEnvelope = {\n deleted: true,\n record: { ...current.env.record, token, updatedAt: this.now() },\n };\n await this.putRow(key, env, { version: current.version });\n return;\n } catch (err) {\n if (isWriteConflictError(err)) continue; // raced \u2014 re-read and try again\n throw err;\n }\n }\n throw new WriteConflictError(`registry delete: contention deleting \"${ref.segment}\" \u2014 retry`);\n }\n\n /**\n * Read + parse a registry object, returning its envelope and version fence, or null if absent.\n *\n * A store that pins a version to read consistently ({@link ObjectVersionRaced}) loses that pin whenever a\n * concurrent writer lands mid-read. Re-reading is the whole answer \u2014 the next read simply observes the\n * newer version \u2014 and it is bounded so a row under permanent write saturation fails typed instead of\n * spinning. Only a store that reads in two calls gets here; none of the shipped stores does.\n */\n private async readRow(objectKey: string): Promise<ReadRow | null> {\n const row = await this.readRaced(objectKey);\n return row === null ? null : this.decodeRow(objectKey, row);\n }\n\n /** Check and parse the bytes of a registry object. */\n private decodeRow(objectKey: string, row: ObjectRow): ReadRow {\n if (row.bytes.length > MAX_ROW_BYTES) {\n throw new IntegrityError(\n `registry object ${row.bytes.length}B exceeds cap ${MAX_ROW_BYTES}B`,\n );\n }\n if (row.version.length === 0) {\n // The version is the OCC fence for CAS; a backend that omits it cannot be used safely as a registry.\n throw new IntegrityError(\n `registry object has no version fence (needed for compare-and-swap): ${objectKey}`,\n );\n }\n // The name the key spells is the name the row must carry: a key outside the layout has none to hold it to.\n const stored = parseRegistryKey(this.prefix, objectKey) ?? undefined;\n const env = parseRegistryEnvelope(new TextDecoder().decode(row.bytes), objectKey, stored);\n return { env, bytes: row.bytes, version: row.version };\n }\n\n /** {@link ObjectRegistryStore.read}, retrying the bounded number of times a mid-read overwrite allows. */\n private async readRaced(objectKey: string): Promise<ObjectRow | null> {\n for (let attempt = 0; attempt < MAX_READ_ATTEMPTS; attempt++) {\n try {\n return await this.store.read(objectKey);\n } catch (err) {\n if (!(err instanceof ObjectVersionRaced)) throw err;\n }\n }\n throw new TransientError(\n `registry read: ${this.store.label} object \"${objectKey}\" was overwritten on every one of ` +\n `${MAX_READ_ATTEMPTS} attempts \u2014 retry`,\n );\n }\n\n /** Conditional write of an envelope. The store maps a lost precondition to {@link WriteConflictError}. */\n private async putRow(\n objectKey: string,\n env: RegistryEnvelope,\n expect: 'absent' | { version: string },\n ): Promise<void> {\n const body = new TextEncoder().encode(serializeRegistryEnvelope(env));\n if (body.length > MAX_ROW_BYTES) {\n // Belt-and-braces: the governance/DEK fields are already capped by validate*, so this cannot fire for\n // valid input \u2014 but never write a row that would later be unreadable.\n throw new ValidationError(`registry object ${body.length}B exceeds cap ${MAX_ROW_BYTES}B`);\n }\n await this.store.write(objectKey, body, expect);\n }\n}\n"],
|
|
5
|
-
"mappings": "
|
|
3
|
+
"sources": ["../src/drivers/_shared/object-registry-keys.ts", "../src/drivers/_shared/object-registry.ts", "../src/drivers/_shared/object-keys.ts", "../src/drivers/_shared/faults.ts", "../src/drivers/_shared/bytes.ts"],
|
|
4
|
+
"sourcesContent": ["/**\n * The registry object layout, shared by every object-store registry (S3, GCS, Azure Blob).\n *\n * One tiny JSON object per segment at `<prefix>registry/<ns>/<segment>.reg`, **registry-first** \u2014 separate\n * from the namespace-first storage layout (`<prefix><ns>/segments/\u2026`) \u2014 so discovery is a single list over\n * `registry/` for all namespaces, or `registry/<ns>/` for one, never entangled with the `.crbm` payloads.\n *\n * It lives here rather than in a driver because all three object stores encode names the same way\n * (`encodeNameForKey`, `namespaceKeyPart`) and build byte-identical keys. Three copies of this would be\n * three chances for one cloud's layout to drift from the others \u2014 and a drifted key is not a visible bug, it\n * is a segment that quietly cannot be found by a store pointed at the same bucket.\n */\nimport { ValidationError } from '@/core/errors';\nimport { validateSegmentRef } from '@/core/validate';\nimport type { SegmentRef } from '@/core/ports';\nimport { DEFAULT_NAMESPACE, decodeNameFromKey, encodeNameForKey, namespaceKeyPart } from './keys';\n\nconst REGISTRY_SUFFIX = '.reg';\n\n/** Normalize an optional caller prefix to either `''` or `trimmed/` (no leading/trailing slashes). */\nexport function prefixPart(prefix: string | undefined): string {\n if (prefix === undefined) return '';\n // Index scans, not a regex: `/\\/+$/` retries from every slash of a run that is not at the end, which is\n // quadratic in the run's length.\n let start = 0;\n let end = prefix.length;\n while (start < end && prefix.charCodeAt(start) === 0x2f) start++;\n while (end > start && prefix.charCodeAt(end - 1) === 0x2f) end--;\n const trimmed = prefix.slice(start, end);\n return trimmed === '' ? '' : `${trimmed}/`;\n}\n\n/**\n * Validate a caller-supplied key prefix (trusted config, but make it a real containment boundary): reject\n * control characters and `.`/`..` path segments so a prefix cannot traverse out of its intended space.\n * Returns it unchanged \u2014 the key builders normalize slashes.\n *\n * The traversal check covers three spellings, because the tools that walk these buckets do. A bare `..` is\n * the obvious one. A **backslash** segment matters on ADLS Gen2 and to Windows-side tooling, which treat it\n * as a separator this code otherwise would not. And a percent-encoded `..` matters because `gsutil`,\n * `s3fs`, `gcsfuse` and `azcopy` decode a key on their way to a local path \u2014 the same reasoning\n * `name-codec.ts` already applies to segment names, which a prefix has no reason to be exempt from.\n */\nexport function normalizeObjectPrefix(prefix: string | undefined): string | undefined {\n if (prefix === undefined) return undefined;\n for (const ch of prefix) {\n const code = ch.charCodeAt(0);\n // C0 plus DEL: a bare `< 0x20` lets U+007F through, and it is as unprintable as the rest.\n if (code < 0x20 || code === 0x7f) {\n throw new ValidationError('prefix must not contain control characters');\n }\n }\n if (prefix.includes('\\\\')) {\n throw new ValidationError(\n `prefix must not contain backslashes (a path separator on some backends): ${JSON.stringify(prefix)}`,\n );\n }\n // Check the decoded spelling too, so an encoded `..` cannot slip past the literal comparison.\n let decoded: string;\n try {\n decoded = decodeURIComponent(prefix);\n } catch {\n decoded = prefix; // not valid percent-encoding; the literal check still applies\n }\n for (const source of decoded === prefix ? [prefix] : [prefix, decoded]) {\n for (const segment of source.split('/')) {\n if (segment === '.' || segment === '..') {\n throw new ValidationError(\n `prefix must not contain \".\" or \"..\" path segments: ${JSON.stringify(prefix)}`,\n );\n }\n }\n }\n return prefix;\n}\n\n/** The key prefix under which every registry object lives: `<prefix>registry/`. */\nfunction registryPrefix(prefix: string | undefined): string {\n return `${prefixPart(prefix)}registry/`;\n}\n\n/** The full key of one segment's registry object: `<prefix>registry/<ns>/<segment>.reg`. */\nexport function registryObjectKey(prefix: string | undefined, ref: SegmentRef): string {\n validateSegmentRef(ref);\n return `${registryPrefix(prefix)}${namespaceKeyPart(ref.namespace)}/${encodeNameForKey(ref.segment)}${REGISTRY_SUFFIX}`;\n}\n\n/** The list prefix for discovery: registry-wide, or scoped to one namespace. */\nexport function registryListPrefix(prefix: string | undefined, namespace?: string): string {\n const base = registryPrefix(prefix);\n return namespace === undefined ? base : `${base}${namespaceKeyPart(namespace)}/`;\n}\n\n/**\n * Parse a `<prefix>registry/<ns>/<segment>.reg` key back to its {@link SegmentRef}, or `null` if it does not\n * match \u2014 a stray or foreign object under the prefix, or one whose parsed ref fails the round-trip check.\n * `_default` maps back to the absent namespace. A name is percent-encoded on the way in, so no encoded name\n * can contain `/` and the split stays unambiguous whatever the caller named their segment.\n */\nexport function parseRegistryKey(prefix: string | undefined, objectKey: string): SegmentRef | null {\n const base = registryPrefix(prefix);\n if (!objectKey.startsWith(base) || !objectKey.endsWith(REGISTRY_SUFFIX)) return null;\n const rest = objectKey.slice(base.length, objectKey.length - REGISTRY_SUFFIX.length);\n const slash = rest.indexOf('/');\n if (slash < 0) return null;\n const nsPart = rest.slice(0, slash);\n const encodedSegment = rest.slice(slash + 1);\n if (encodedSegment.length === 0 || encodedSegment.includes('/')) return null;\n const segment = decodeNameFromKey(encodedSegment);\n const namespace = nsPart === DEFAULT_NAMESPACE ? undefined : decodeNameFromKey(nsPart);\n // The encoding must ROUND-TRIP, not merely decode: a foreign object placed under our prefix could spell a\n // name two ways, and reporting both would hand a sweep one segment under two identities.\n if (encodeNameForKey(segment) !== encodedSegment) return null;\n if (namespace !== undefined && encodeNameForKey(namespace) !== nsPart) return null;\n const ref: SegmentRef = { segment, namespace };\n try {\n validateSegmentRef(ref); // reject a hostile/foreign key that isn't a valid ref\n } catch {\n return null;\n }\n return ref;\n}\n", "/**\n * `ObjectStoreRegistry` \u2014 an {@link IRegistryDriver} over any object store with conditional writes.\n *\n * Lets a **read-mostly deployment run on one bucket alone** \u2014 storage `.crbm` generations plus the registry in\n * the same place, with no separate database. One tiny JSON object per segment at\n * `<prefix>registry/<ns>/<segment>.reg` holding the `{ deleted, record }` envelope (the same shape LocalFs\n * persists). The OCC token is a random incarnation id drawn when the row is created, a counter advanced on every\n * mutation, and a random part drawn for every write, so with overwhelming probability a deleted-then-recreated row, or\n * one restored from a backup, never re-issues an old token (ABA-safe) \u2014 identical semantics to the LocalFs registry, so it passes the same\n * conformance suite.\n *\n * **`delete` removes a row for good where the store vouches for a conditional delete** (`If-Match: <etag>`,\n * `ifGenerationMatch: <generation>`): a re-create draws a new incarnation, so nothing of the old row is needed to keep\n * its tokens apart, and a full `list()` no longer reads a row for every name it ever held. On a store that cannot\n * vouch for one, the row is **tombstoned**: the object stays, its counter advanced, and a re-create carries the counter\n * on.\n *\n * **The atomic swap is offloaded to the store's conditional writes.** `create` writes only if absent (or\n * over a tombstone under its version), and `compareAndSwap`/`delete` write (or delete) only if the object still\n * carries the version we read \u2014 so a concurrent writer between our read and our write loses, and the loss surfaces\n * as {@link WriteConflictError}. No in-process lock is needed (unlike LocalFs): the precondition fences\n * writers *across processes*.\n *\n * **A caller that already read the row can spare the read before its write.** `get` remembers the version of the\n * object it read, against the record it returned. A `compareAndSwap` handed that very record as `held` conditions its\n * write on that version and sends it at once, and a `create` handed `null` (the caller found no row) sends its\n * create-only write at once. The store's condition stays the fence: a row that changed since fails the write as a lost\n * race, so a stale `held` can lose a write and never land one. A record this registry did not return (a copy, another\n * registry's) is read for as without the hint.\n *\n * **Why this is shared rather than written per cloud.** Every object store worth using has the same two\n * primitives under different names \u2014 S3 `If-None-Match: *` / `If-Match: <etag>`, GCS `ifGenerationMatch: 0`\n * / `ifGenerationMatch: <generation>`, Azure `If-None-Match: *` / `If-Match: <etag>` \u2014 so the only thing\n * that differs is a few I/O calls, which is what {@link ObjectRegistryStore} abstracts. The parts that are\n * genuinely hard (the ABA-safe token, the delete and its tombstone, the bounded delete retry, the round-trip key check)\n * exist once. Three copies would be three chances for one cloud to drift, and a drifted registry is not a\n * visible bug \u2014 it is a lost `currentGen` swap.\n *\n * **Deployment requirements** (a backend that violates these silently corrupts the registry):\n * - The store **must honor the conditional write**. One that accepts the precondition header and ignores it\n * degrades compare-and-swap to last-write-wins \u2192 lost `currentGen` swaps.\n * - Reads must be **strongly consistent** \u2014 true of S3 (since 2020), GCS and Azure Blob \u2014 since the registry\n * advertises `strongRead` and generation resolution depends on it.\n * - **Do not apply a lifecycle-expiration rule to the `registry/` prefix that expires a current version.**\n * Expiring a live row loses its pointer. A tombstone `delete` left keeps the counter for a re-create; one expired\n * by a rule is no worse than a row removed for good, since a recreate draws a fresh incarnation and its tokens are\n * new but for a collision of probability 2^-128 per pair of incarnations, but a rule cannot tell a tombstone from a\n * live row.\n * - **A store's conditional delete must be honoured by its backend** before the store sets `conditionalDelete`.\n * One that ignores the precondition lets two sweepers and a re-create delete a live row.\n *\n * **`list()` is fail-closed, and one bad object stops it for everyone.** An object under the `registry/`\n * prefix whose key parses but whose body does not aborts the whole enumeration \u2014 every namespace, not just\n * the affected segment \u2014 and it stays that way until an operator removes the object. The error names the\n * offending key.\n *\n * That is the deliberate choice, and it is the *safer* one rather than the more convenient one. Skipping the\n * unreadable row would keep discovery running, but `list()` is what tells orphan generation collection which\n * segments exist: a row missing from the enumeration makes its storage `.crbm` generations look unreferenced,\n * and the next GC pass would delete them. Silently skipping turns a parse error into data loss. Refusing to\n * enumerate keeps every sweep off a set it cannot vouch for (invariant 5 \u2014 bytes from the tier are\n * untrusted). **Recovery:** read the named object, and either restore a valid envelope or delete it; nothing\n * else is damaged, and discovery resumes on its own.\n */\nimport {\n IntegrityError,\n TransientError,\n ValidationError,\n WriteConflictError,\n isWriteConflictError,\n} from '@/core/errors';\nimport type {\n IRegistryDriver,\n NewRegistryRecord,\n RegCaps,\n RegistryPatch,\n RegistryRecord,\n RegistryWriteOptions,\n SegmentRef,\n Token,\n} from '@/core/ports';\nimport type { Entropy } from '@/core/determinism';\nimport { mapWithConcurrency } from '@/core/concurrency';\nimport {\n applyRegistryPatch,\n newIncarnationToken,\n nextRegistryToken,\n parseRegistryEnvelope,\n recordFromNew,\n serializeRegistryEnvelope,\n validateNewRegistryRecord,\n validateRegistryPatch,\n type RegistryEnvelope,\n} from './registry';\nimport { entropyIsAvailable, webCryptoEntropy } from './entropy';\nimport { parseRegistryKey, registryListPrefix, registryObjectKey } from './object-registry-keys';\nimport { validateSegmentRef } from '@/core/validate';\n\n/** Defensive cap on a single registry object read from storage, before allocation (rows are tiny; ~1 KB). */\nexport const MAX_ROW_BYTES = 1 * 1024 * 1024;\nconst UTF8 = new TextEncoder();\nconst UTF8_DECODER = new TextDecoder();\n\n/** Bounded retry for `delete`'s read then delete or tombstone, under cross-process contention (then fails typed). */\nconst MAX_DELETE_ATTEMPTS = 8;\n/** Bounded re-read when a store's pinned version is overwritten mid-read (see {@link ObjectVersionRaced}). */\nconst MAX_READ_ATTEMPTS = 8;\n/** In-flight reads per `list()` page \u2014 turns the serial N+1 into one list plus bounded parallel reads. */\nconst LIST_READ_CONCURRENCY = 48;\n\n/**\n * Raised by a store when the version it pinned for a read vanished before it could fetch the bytes \u2014\n * a concurrent writer overwrote or deleted the object in between.\n *\n * This is deliberately **neither** of the two things it superficially resembles. It is not absence: the row\n * is very likely still live, just one version further on. And it is not a write conflict: the caller may be\n * a read-only `get()`, which has nothing to conflict with. Either is an easy misreading for a store that reads a\n * row in two calls, metadata and then bytes pinned to it, which is why the signal is part of the port rather than\n * left to each store's judgement. {@link ObjectStoreRegistry} answers it the only way that is correct for every\n * caller: it reads again.\n *\n * Stores whose read is atomic can never raise it, and every shipped store's is: S3 serves bytes and `ETag` from one\n * `GetObject`, GCS bytes and `generation` from one GET, and Azure Blob bytes and `ETag` from one GET.\n */\nexport class ObjectVersionRaced extends Error {\n constructor(objectKey: string) {\n super(`registry object was overwritten mid-read: ${objectKey}`);\n this.name = 'ObjectVersionRaced';\n }\n}\n\n/**\n * Whether `err` is an {@link ObjectVersionRaced}, by its name: a store built against another copy of this package raises\n * that copy's class, which `instanceof` does not recognise.\n */\nconst isVersionRaced = (err: unknown): boolean =>\n err instanceof Error && err.name === 'ObjectVersionRaced';\n\n/** One object as read, with the opaque version that fences a later conditional write. */\nexport interface ObjectRow {\n readonly bytes: Uint8Array;\n /** The store's version fence \u2014 an S3/Azure ETag, a GCS generation. Opaque to this class. */\n readonly version: string;\n}\n\n/**\n * The I/O calls an object store must provide to host a registry: three, and an optional conditional delete. Everything\n * else \u2014 the OCC token, tombstones, the delete retry, key parsing \u2014 is implemented once above.\n */\nexport interface ObjectRegistryStore {\n /** A label for error messages, e.g. `GCS` or `Azure Blob`. */\n readonly label: string;\n /**\n * Read one object, or `null` when it is absent.\n *\n * **`null` means the object does not exist** \u2014 nothing weaker. A store that reads in two round trips\n * (metadata for the version fence, then the bytes pinned to it) can find that version already gone; it\n * MUST report that with {@link ObjectVersionRaced} rather than `null` or {@link WriteConflictError}, and\n * the caller re-reads. Retryable faults throw {@link TransientError}.\n *\n * `bytes` and `version` MUST describe the **same** observation of the object: `version` is the fence a\n * later conditional write is conditioned on, so a pair drawn from two different versions would either\n * fail a write that should have succeeded or, worse, pass one that should not.\n */\n read(key: string): Promise<ObjectRow | null>;\n /**\n * Write one object under a precondition: `'absent'` means create-only, a version means\n * compare-and-swap against exactly that version. A lost race MUST throw {@link WriteConflictError}.\n *\n * A store must not replay this write after a lost response without telling the replay apart: the replay meets\n * the row it just wrote and its precondition fails, which would read as a lost race. Send it once, or store a\n * write id with the row and treat a conflict whose stored row carries it as success. Retryable faults throw\n * {@link TransientError}.\n */\n write(key: string, body: Uint8Array, expect: 'absent' | { version: string }): Promise<void>;\n /** Every object key under `prefix`, paginated internally. */\n listKeys(prefix: string): AsyncIterable<string>;\n /**\n * Optional: delete one object, and only while it is still at exactly `expect.version`, by a precondition the\n * backend applies (`If-Match: <etag>`, `ifGenerationMatch: <generation>`). An object that was overwritten, or is\n * gone, MUST throw {@link WriteConflictError} and delete nothing. Retryable faults throw {@link TransientError}.\n *\n * Sending it again after a lost response is safe, unlike a write: the precondition names one version, so a second\n * copy can remove nothing the first was not allowed to. A copy that meets its own landed delete fails the\n * precondition and reports a conflict; the registry re-reads, and finds the row gone.\n *\n * The registry calls it only when {@link conditionalDelete} is `true`.\n */\n delete?(key: string, expect: { version: string }): Promise<void>;\n /**\n * Whether {@link delete} may be relied on: `true` only where the backend is known to apply the precondition. A\n * backend that accepts the header and ignores it would let a delete remove a row written after the delete read it,\n * a live one included. Absent or `false`, the registry never calls `delete` and tombstones every row instead.\n */\n readonly conditionalDelete?: boolean;\n}\n\n/** A row as read: its envelope, the bytes it was parsed from, and the version that fences a write to it. */\ninterface ReadRow extends ObjectRow {\n readonly env: RegistryEnvelope;\n}\n\n/** What a record `get` returned was read from. */\ninterface ObservedRow extends ObjectRow {\n readonly key: string;\n}\n\nexport class ObjectStoreRegistry implements IRegistryDriver {\n /**\n * `entropy` draws the random parts of every token: a new row's incarnation id, and each write's own part. It\n * defaults to the platform's Web Crypto. Inject one only to make a test replayable: a seeded source in production\n * gives every process the same ids.\n */\n constructor(\n private readonly store: ObjectRegistryStore,\n private readonly prefix: string | undefined,\n private readonly now: () => number,\n private readonly entropy: Entropy = webCryptoEntropy,\n ) {}\n\n capabilities(): RegCaps {\n const conditionalDelete = this.removesRows();\n return entropyIsAvailable(this.entropy)\n ? { strongRead: true, conditionalDelete }\n : { strongRead: true, canWrite: false, conditionalDelete };\n }\n\n /** Every write reports its token to `onToken` before the request that carries it is sent. */\n get reportsWriteTokens(): true {\n return true;\n }\n\n /** Whether a delete removes a row: the store has a delete, and vouches for it. */\n private removesRows(): boolean {\n return this.store.conditionalDelete === true && typeof this.store.delete === 'function';\n }\n\n /** The object each record `get` returned was read from, to fence a write made against it ({@link RegistryWriteOptions.held}). */\n private readonly observed = new WeakMap<RegistryRecord, ObservedRow>();\n\n async get(ref: SegmentRef): Promise<RegistryRecord | null> {\n const key = registryObjectKey(this.prefix, ref);\n const row = await this.readRow(key);\n if (row === null || row.env.deleted) return null;\n this.observed.set(row.env.record, { key, bytes: row.bytes, version: row.version });\n return row.env.record;\n }\n\n async create(\n ref: SegmentRef,\n record: NewRegistryRecord,\n options?: RegistryWriteOptions,\n ): Promise<{ token: Token }> {\n const checked = validateNewRegistryRecord(record);\n const key = registryObjectKey(this.prefix, ref);\n let lost: unknown;\n if (options?.held === null) {\n // The caller found no row: send the create-only write without reading. One that loses to a row, or to a tombstone\n // (which a create-only write cannot go over), is told apart by the read below.\n try {\n return await this.createOver(key, ref, checked, undefined, options);\n } catch (err) {\n if (!isWriteConflictError(err)) throw err;\n lost = err;\n }\n }\n const current = await this.readRow(key);\n if (current !== null && !current.env.deleted) {\n throw new WriteConflictError(`registry row already exists for segment ${ref.segment}`);\n }\n // No row at all now: the create-only write lost to something that has gone since, and it is not sent again.\n if (lost !== undefined && current === null) throw lost;\n return this.createOver(key, ref, checked, current ?? undefined, options);\n }\n\n /** Write a new incarnation of the row: over `tombstone` under its version, or create-only when there is none. */\n private async createOver(\n key: string,\n ref: SegmentRef,\n checked: NewRegistryRecord,\n tombstone: ReadRow | undefined,\n options: RegistryWriteOptions | undefined,\n ): Promise<{ token: Token }> {\n // A new incarnation, whose counter continues across a tombstone, so with overwhelming probability a recreate never re-issues an old token.\n const token = newIncarnationToken(this.entropy, tombstone?.env.record);\n options?.onToken?.(token);\n const env: RegistryEnvelope = {\n deleted: false,\n record: recordFromNew(ref, checked, this.now(), token),\n };\n // Create-only when truly absent; overwrite the tombstone under its version when recreating. Either way\n // a concurrent create loses the precondition and surfaces as a conflict.\n await this.putRow(key, env, tombstone ? { version: tombstone.version } : 'absent');\n return { token };\n }\n\n async compareAndSwap(\n ref: SegmentRef,\n expected: Token,\n patch: RegistryPatch,\n options?: RegistryWriteOptions,\n ): Promise<{ token: Token }> {\n const checked = validateRegistryPatch(patch);\n const key = registryObjectKey(this.prefix, ref);\n // The row the caller read, as this registry read it, when it is the row `expected` names; otherwise read it now.\n const current = this.observedRow(key, expected, options?.held) ?? (await this.readRow(key));\n if (current === null || current.env.deleted || current.env.record.token !== expected) {\n throw new WriteConflictError(`OCC token mismatch for registry row ${ref.segment}`);\n }\n const token = nextRegistryToken(current.env.record, this.entropy);\n options?.onToken?.(token);\n const env: RegistryEnvelope = {\n deleted: false,\n record: applyRegistryPatch(current.env.record, checked, this.now(), token),\n };\n // The version we read fences a concurrent writer between that read and this write.\n await this.putRow(key, env, { version: current.version });\n return { token };\n }\n\n /**\n * The row a caller's `held` record was read as, decoded again from the bytes `get` saw so that nothing the caller did\n * to its copy reaches the write, or `undefined` when `held` is not a record this registry returned for this row under\n * the token the write expects. The version it carries is the store's fence, so a row that has moved on since fails\n * the write.\n */\n private observedRow(\n key: string,\n expected: Token,\n held: RegistryRecord | null | undefined,\n ): ReadRow | undefined {\n const seen = held ? this.observed.get(held) : undefined;\n if (seen === undefined || seen.key !== key || held?.token !== expected) return undefined;\n return this.decodeRow(key, seen);\n }\n\n async *list(namespace?: string): AsyncIterable<RegistryRecord> {\n // A namespace that is given is checked as every other name is: `''` names none, and reads as an error, not as empty.\n if (namespace !== undefined) validateSegmentRef({ segment: 'x', namespace });\n const prefix = registryListPrefix(this.prefix, namespace);\n // One list plus bounded parallel reads. A serial await-in-loop made this O(N) sequential round trips.\n let page: string[] = [];\n const flush = async function* (\n this: ObjectStoreRegistry,\n keys: string[],\n ): AsyncIterable<RegistryRecord> {\n const rows = await mapWithConcurrency(keys, LIST_READ_CONCURRENCY, (key) =>\n this.readRow(key),\n );\n for (const current of rows) {\n if (current && !current.env.deleted) yield current.env.record;\n }\n }.bind(this);\n\n for await (const key of this.store.listKeys(prefix)) {\n if (parseRegistryKey(this.prefix, key) === null) continue; // stray or foreign object\n page.push(key);\n if (page.length >= LIST_READ_CONCURRENCY) {\n yield* flush(page);\n page = [];\n }\n }\n if (page.length > 0) yield* flush(page);\n }\n\n async delete(ref: SegmentRef, expected?: Token): Promise<void> {\n const key = registryObjectKey(this.prefix, ref);\n // Where the store vouches for a conditional delete, the row is removed from it, by a delete the store applies only\n // while the object is still the version read here: a later create draws a new incarnation, so nothing of this row\n // is needed to keep its tokens apart. Otherwise it is tombstoned (the counter advanced, the object kept), so a\n // re-create carries the counter on. Retry the read and the write on a cross-process race; it converges, then fails\n // typed rather than silently leaving the row live.\n for (let attempt = 0; attempt < MAX_DELETE_ATTEMPTS; attempt++) {\n const current = await this.readRow(key);\n if (expected !== undefined) {\n // Fenced: the row must still carry the token the caller read. Re-checked on every attempt, so a row\n // that was swapped, or deleted and re-created, between two attempts is refused rather than tombstoned.\n if (current === null || current.env.deleted || current.env.record.token !== expected) {\n throw new WriteConflictError(`OCC token mismatch for registry row ${ref.segment}`);\n }\n } else if (current === null || current.env.deleted) {\n return; // idempotent \u2014 already gone\n }\n try {\n const remove = this.removesRows() ? this.store.delete : undefined;\n if (remove !== undefined) {\n // The version read above is the row the caller's token names, so this removes that row and no later one.\n await remove.call(this.store, key, { version: current.version });\n return;\n }\n const token = nextRegistryToken(current.env.record, this.entropy);\n const env: RegistryEnvelope = {\n deleted: true,\n record: { ...current.env.record, token, updatedAt: this.now() },\n };\n await this.putRow(key, env, { version: current.version });\n return;\n } catch (err) {\n if (isWriteConflictError(err)) continue; // raced \u2014 re-read and try again\n throw err;\n }\n }\n throw new WriteConflictError(`registry delete: contention deleting \"${ref.segment}\" \u2014 retry`);\n }\n\n /**\n * Read + parse a registry object, returning its envelope and version fence, or null if absent.\n *\n * A store that pins a version to read consistently ({@link ObjectVersionRaced}) loses that pin whenever a\n * concurrent writer lands mid-read. Re-reading is the whole answer \u2014 the next read simply observes the\n * newer version \u2014 and it is bounded so a row under permanent write saturation fails typed instead of\n * spinning. Only a store that reads in two calls gets here; none of the shipped stores does.\n */\n private async readRow(objectKey: string): Promise<ReadRow | null> {\n const row = await this.readRaced(objectKey);\n return row === null ? null : this.decodeRow(objectKey, row);\n }\n\n /** Check and parse the bytes of a registry object. */\n private decodeRow(objectKey: string, row: ObjectRow): ReadRow {\n if (row.bytes.length > MAX_ROW_BYTES) {\n throw new IntegrityError(\n `registry object ${row.bytes.length}B exceeds cap ${MAX_ROW_BYTES}B`,\n );\n }\n if (row.version.length === 0) {\n // The version is the OCC fence for CAS; a backend that omits it cannot be used safely as a registry.\n throw new IntegrityError(\n `registry object has no version fence (needed for compare-and-swap): ${objectKey}`,\n );\n }\n // The name the key spells is the name the row must carry: a key outside the layout has none to hold it to.\n const stored = parseRegistryKey(this.prefix, objectKey) ?? undefined;\n const env = parseRegistryEnvelope(UTF8_DECODER.decode(row.bytes), objectKey, stored);\n return { env, bytes: row.bytes, version: row.version };\n }\n\n /** {@link ObjectRegistryStore.read}, retrying the bounded number of times a mid-read overwrite allows. */\n private async readRaced(objectKey: string): Promise<ObjectRow | null> {\n for (let attempt = 0; attempt < MAX_READ_ATTEMPTS; attempt++) {\n try {\n return await this.store.read(objectKey);\n } catch (err) {\n if (!isVersionRaced(err)) throw err;\n }\n }\n throw new TransientError(\n `registry read: ${this.store.label} object \"${objectKey}\" was overwritten on every one of ` +\n `${MAX_READ_ATTEMPTS} attempts \u2014 retry`,\n );\n }\n\n /** Conditional write of an envelope. The store maps a lost precondition to {@link WriteConflictError}. */\n private async putRow(\n objectKey: string,\n env: RegistryEnvelope,\n expect: 'absent' | { version: string },\n ): Promise<void> {\n const body = UTF8.encode(serializeRegistryEnvelope(env));\n if (body.length > MAX_ROW_BYTES) {\n // Belt-and-braces: the governance/DEK fields are already capped by validate*, so this cannot fire for\n // valid input \u2014 but never write a row that would later be unreadable.\n throw new ValidationError(`registry object ${body.length}B exceeds cap ${MAX_ROW_BYTES}B`);\n }\n await this.store.write(objectKey, body, expect);\n }\n}\n", "/**\n * The storage object layout, shared by every object-store driver (S3, GCS, Azure Blob): one `.crbm` object per\n * generation at `<prefix><ns>/segments/<segment>.<gen>.crbm`, namespace-first, beside the registry's own layout\n * (`object-registry-keys.ts`) under the same caller prefix.\n *\n * One definition, so a segment written by one driver reads identically under another: two drivers disagreeing about\n * how a name becomes a key would be a silent cross-driver incompatibility on the same bucket, a segment that quietly\n * cannot be found. Pure string logic, no SDK. The names are re-validated here, because a driver can be constructed and\n * driven directly rather than through the engine that would otherwise have validated them. The default (absent)\n * namespace maps to `_default`, which cannot collide with a real namespace because a caller's `_default` encodes to\n * `%5Fdefault` while the sentinel is emitted literally.\n */\nimport { requireInteger } from '@/core/check';\nimport { validateSegmentRef } from '@/core/validate';\nimport type { GenKey, SegmentRef } from '@/core/ports';\nimport { encodeNameForKey, namespaceKeyPart } from './keys';\nimport { prefixPart } from './object-registry-keys';\n\nconst SUFFIX = '.crbm';\n\n/**\n * The key prefix shared by all of a segment's generations, `<prefix><ns>/segments/<segment>.`: the prefix a listing of\n * the segment's generations asks for, and the string {@link parseGenerationFromKey} strips.\n */\nexport function segmentObjectPrefix(prefix: string | undefined, ref: SegmentRef): string {\n validateSegmentRef(ref);\n return `${prefixPart(prefix)}${namespaceKeyPart(ref.namespace)}/segments/${encodeNameForKey(ref.segment)}.`;\n}\n\n/**\n * The full key of one generation's object, `<segmentPrefix><gen>.crbm`. A generation that is not a safe integer from 0\n * is refused, so every key built here is one {@link parseGenerationFromKey} reads back.\n */\nexport function storageObjectKey(prefix: string | undefined, key: GenKey): string {\n requireInteger(key.generation, { min: 0, what: 'generation' });\n return `${segmentObjectPrefix(prefix, key)}${key.generation}${SUFFIX}`;\n}\n\n/**\n * The generation number in a full object key, given its segment's prefix, or `null` when the key is not one of that\n * segment's generations. Canonical decimal only: no leading zeros (so `\u2026s.07.crbm` cannot alias `\u2026s.7.crbm`), within\n * the safe-integer range. A *different* segment whose name merely shares the prefix does not parse either: a key for\n * segment `s.x` under segment `s`'s prefix has a middle that is not all digits.\n */\nexport function parseGenerationFromKey(segmentPrefix: string, objectKey: string): number | null {\n if (!objectKey.startsWith(segmentPrefix) || !objectKey.endsWith(SUFFIX)) return null;\n const middle = objectKey.slice(segmentPrefix.length, objectKey.length - SUFFIX.length);\n if (!/^(0|[1-9]\\d*)$/.test(middle)) return null;\n const generation = Number(middle);\n return Number.isSafeInteger(generation) ? generation : null;\n}\n", "/**\n * Fault classification shared by the cloud drivers: which connection failures are transient whatever the service, and\n * how a driver hands a transient fault on as {@link TransientError}. Each driver keeps its own reading of its service's\n * statuses and error codes; what is the same for every service built on Node's networking lives here once, so a write\n * and a read, or two drivers, cannot disagree about it.\n */\nimport { TransientError } from '@/core/errors';\n\n/**\n * The codes Node gives a connection that failed or was cut off: refused, reset, aborted, timed out, a DNS failure, an\n * unreachable host or network, and a broken pipe. Only these: a missing or unreadable credentials file (`ENOENT`,\n * `EACCES`) and a TLS failure (`EPROTO`, a certificate error) carry codes of the same shape, and would fail the same\n * way again.\n */\nconst TRANSPORT_FAULT_CODES: ReadonlySet<string> = new Set([\n 'ECONNRESET',\n 'ECONNREFUSED',\n 'ECONNABORTED',\n 'ETIMEDOUT',\n 'ENOTFOUND',\n 'EAI_AGAIN',\n 'EHOSTUNREACH',\n 'ENETUNREACH',\n 'EPIPE',\n]);\n\n/**\n * Whether `err` is a connection that failed or was cut off before the service answered: its `code` is one of the\n * strings Node gives such a failure (`ECONNRESET`, `ECONNREFUSED`, `ECONNABORTED`, `ETIMEDOUT`, `ENOTFOUND`,\n * `EAI_AGAIN`, `EHOSTUNREACH`, `ENETUNREACH`, `EPIPE`). A retry on a fresh connection usually succeeds, so a driver\n * raises one as {@link TransientError}. It reads nothing else: a driver whose service also answers with a status\n * checks that first.\n */\nexport function isTransportFault(err: unknown): boolean {\n const code = (err as { code?: unknown } | null | undefined)?.code;\n return typeof code === 'string' && TRANSPORT_FAULT_CODES.has(code);\n}\n\n/**\n * `err` as a {@link TransientError} when `isTransient(err)` holds, with `message(err)` as its message and `err` as its\n * `cause`; any other error unchanged. The last step of a driver's error mapping, so the store's read retry can ride a\n * transient fault out and a write's caller can tell one from a deterministic failure. Run whatever scrubs credentials\n * from an error before it, since the error becomes the cause.\n */\nexport function toTransient(\n err: unknown,\n isTransient: (err: unknown) => boolean,\n message: (err: unknown) => string,\n): unknown {\n return isTransient(err) ? new TransientError(message(err), { cause: err }) : err;\n}\n", "/** Byte-buffer helpers shared by the drivers. */\n\n/**\n * The chunks of `parts`, in order, copied into one new `Uint8Array` that owns its bytes: no view of any part survives in\n * it, so a part's buffer can be reused or let go once this returns.\n */\nexport function concatBytes(parts: readonly Uint8Array[]): Uint8Array {\n let total = 0;\n for (const p of parts) total += p.length;\n const out = new Uint8Array(total);\n let offset = 0;\n for (const p of parts) {\n out.set(p, offset);\n offset += p.length;\n }\n return out;\n}\n"],
|
|
5
|
+
"mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiBA,IAAM,kBAAkB;AAGjB,SAAS,WAAW,QAAoC;AAC7D,MAAI,WAAW,OAAW,QAAO;AAGjC,MAAI,QAAQ;AACZ,MAAI,MAAM,OAAO;AACjB,SAAO,QAAQ,OAAO,OAAO,WAAW,KAAK,MAAM,GAAM;AACzD,SAAO,MAAM,SAAS,OAAO,WAAW,MAAM,CAAC,MAAM,GAAM;AAC3D,QAAM,UAAU,OAAO,MAAM,OAAO,GAAG;AACvC,SAAO,YAAY,KAAK,KAAK,GAAG,OAAO;AACzC;AAaO,SAAS,sBAAsB,QAAgD;AACpF,MAAI,WAAW,OAAW,QAAO;AACjC,aAAW,MAAM,QAAQ;AACvB,UAAM,OAAO,GAAG,WAAW,CAAC;AAE5B,QAAI,OAAO,MAAQ,SAAS,KAAM;AAChC,YAAM,IAAI,gBAAgB,4CAA4C;AAAA,IACxE;AAAA,EACF;AACA,MAAI,OAAO,SAAS,IAAI,GAAG;AACzB,UAAM,IAAI;AAAA,MACR,4EAA4E,KAAK,UAAU,MAAM,CAAC;AAAA,IACpG;AAAA,EACF;AAEA,MAAI;AACJ,MAAI;AACF,cAAU,mBAAmB,MAAM;AAAA,EACrC,QAAQ;AACN,cAAU;AAAA,EACZ;AACA,aAAW,UAAU,YAAY,SAAS,CAAC,MAAM,IAAI,CAAC,QAAQ,OAAO,GAAG;AACtE,eAAW,WAAW,OAAO,MAAM,GAAG,GAAG;AACvC,UAAI,YAAY,OAAO,YAAY,MAAM;AACvC,cAAM,IAAI;AAAA,UACR,sDAAsD,KAAK,UAAU,MAAM,CAAC;AAAA,QAC9E;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,SAAO;AACT;AAGA,SAAS,eAAe,QAAoC;AAC1D,SAAO,GAAG,WAAW,MAAM,CAAC;AAC9B;AAGO,SAAS,kBAAkB,QAA4B,KAAyB;AACrF,qBAAmB,GAAG;AACtB,SAAO,GAAG,eAAe,MAAM,CAAC,GAAG,iBAAiB,IAAI,SAAS,CAAC,IAAI,iBAAiB,IAAI,OAAO,CAAC,GAAG,eAAe;AACvH;AAGO,SAAS,mBAAmB,QAA4B,WAA4B;AACzF,QAAM,OAAO,eAAe,MAAM;AAClC,SAAO,cAAc,SAAY,OAAO,GAAG,IAAI,GAAG,iBAAiB,SAAS,CAAC;AAC/E;AAQO,SAAS,iBAAiB,QAA4B,WAAsC;AACjG,QAAM,OAAO,eAAe,MAAM;AAClC,MAAI,CAAC,UAAU,WAAW,IAAI,KAAK,CAAC,UAAU,SAAS,eAAe,EAAG,QAAO;AAChF,QAAM,OAAO,UAAU,MAAM,KAAK,QAAQ,UAAU,SAAS,gBAAgB,MAAM;AACnF,QAAM,QAAQ,KAAK,QAAQ,GAAG;AAC9B,MAAI,QAAQ,EAAG,QAAO;AACtB,QAAM,SAAS,KAAK,MAAM,GAAG,KAAK;AAClC,QAAM,iBAAiB,KAAK,MAAM,QAAQ,CAAC;AAC3C,MAAI,eAAe,WAAW,KAAK,eAAe,SAAS,GAAG,EAAG,QAAO;AACxE,QAAM,UAAU,kBAAkB,cAAc;AAChD,QAAM,YAAY,WAAW,oBAAoB,SAAY,kBAAkB,MAAM;AAGrF,MAAI,iBAAiB,OAAO,MAAM,eAAgB,QAAO;AACzD,MAAI,cAAc,UAAa,iBAAiB,SAAS,MAAM,OAAQ,QAAO;AAC9E,QAAM,MAAkB,EAAE,SAAS,UAAU;AAC7C,MAAI;AACF,uBAAmB,GAAG;AAAA,EACxB,QAAQ;AACN,WAAO;AAAA,EACT;AACA,SAAO;AACT;;;ACtBO,IAAM,gBAAgB,IAAI,OAAO;AACxC,IAAM,OAAO,IAAI,YAAY;AAC7B,IAAM,eAAe,IAAI,YAAY;AAGrC,IAAM,sBAAsB;AAE5B,IAAM,oBAAoB;AAE1B,IAAM,wBAAwB;AAgBvB,IAAM,qBAAN,cAAiC,MAAM;AAAA,EAC5C,YAAY,WAAmB;AAC7B,UAAM,6CAA6C,SAAS,EAAE;AAC9D,SAAK,OAAO;AAAA,EACd;AACF;AAMA,IAAM,iBAAiB,CAAC,QACtB,eAAe,SAAS,IAAI,SAAS;AAuEhC,IAAM,sBAAN,MAAqD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM1D,YACmB,OACA,QACA,KACA,UAAmB,kBACpC;AAJiB;AACA;AACA;AACA;AAAA,EAChB;AAAA,EAJgB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAGnB,eAAwB;AACtB,UAAM,oBAAoB,KAAK,YAAY;AAC3C,WAAO,mBAAmB,KAAK,OAAO,IAClC,EAAE,YAAY,MAAM,kBAAkB,IACtC,EAAE,YAAY,MAAM,UAAU,OAAO,kBAAkB;AAAA,EAC7D;AAAA;AAAA,EAGA,IAAI,qBAA2B;AAC7B,WAAO;AAAA,EACT;AAAA;AAAA,EAGQ,cAAuB;AAC7B,WAAO,KAAK,MAAM,sBAAsB,QAAQ,OAAO,KAAK,MAAM,WAAW;AAAA,EAC/E;AAAA;AAAA,EAGiB,WAAW,oBAAI,QAAqC;AAAA,EAErE,MAAM,IAAI,KAAiD;AACzD,UAAM,MAAM,kBAAkB,KAAK,QAAQ,GAAG;AAC9C,UAAM,MAAM,MAAM,KAAK,QAAQ,GAAG;AAClC,QAAI,QAAQ,QAAQ,IAAI,IAAI,QAAS,QAAO;AAC5C,SAAK,SAAS,IAAI,IAAI,IAAI,QAAQ,EAAE,KAAK,OAAO,IAAI,OAAO,SAAS,IAAI,QAAQ,CAAC;AACjF,WAAO,IAAI,IAAI;AAAA,EACjB;AAAA,EAEA,MAAM,OACJ,KACA,QACA,SAC2B;AAC3B,UAAM,UAAU,0BAA0B,MAAM;AAChD,UAAM,MAAM,kBAAkB,KAAK,QAAQ,GAAG;AAC9C,QAAI;AACJ,QAAI,SAAS,SAAS,MAAM;AAG1B,UAAI;AACF,eAAO,MAAM,KAAK,WAAW,KAAK,KAAK,SAAS,QAAW,OAAO;AAAA,MACpE,SAAS,KAAK;AACZ,YAAI,CAAC,qBAAqB,GAAG,EAAG,OAAM;AACtC,eAAO;AAAA,MACT;AAAA,IACF;AACA,UAAM,UAAU,MAAM,KAAK,QAAQ,GAAG;AACtC,QAAI,YAAY,QAAQ,CAAC,QAAQ,IAAI,SAAS;AAC5C,YAAM,IAAI,mBAAmB,2CAA2C,IAAI,OAAO,EAAE;AAAA,IACvF;AAEA,QAAI,SAAS,UAAa,YAAY,KAAM,OAAM;AAClD,WAAO,KAAK,WAAW,KAAK,KAAK,SAAS,WAAW,QAAW,OAAO;AAAA,EACzE;AAAA;AAAA,EAGA,MAAc,WACZ,KACA,KACA,SACA,WACA,SAC2B;AAE3B,UAAM,QAAQ,oBAAoB,KAAK,SAAS,WAAW,IAAI,MAAM;AACrE,aAAS,UAAU,KAAK;AACxB,UAAM,MAAwB;AAAA,MAC5B,SAAS;AAAA,MACT,QAAQ,cAAc,KAAK,SAAS,KAAK,IAAI,GAAG,KAAK;AAAA,IACvD;AAGA,UAAM,KAAK,OAAO,KAAK,KAAK,YAAY,EAAE,SAAS,UAAU,QAAQ,IAAI,QAAQ;AACjF,WAAO,EAAE,MAAM;AAAA,EACjB;AAAA,EAEA,MAAM,eACJ,KACA,UACA,OACA,SAC2B;AAC3B,UAAM,UAAU,sBAAsB,KAAK;AAC3C,UAAM,MAAM,kBAAkB,KAAK,QAAQ,GAAG;AAE9C,UAAM,UAAU,KAAK,YAAY,KAAK,UAAU,SAAS,IAAI,KAAM,MAAM,KAAK,QAAQ,GAAG;AACzF,QAAI,YAAY,QAAQ,QAAQ,IAAI,WAAW,QAAQ,IAAI,OAAO,UAAU,UAAU;AACpF,YAAM,IAAI,mBAAmB,uCAAuC,IAAI,OAAO,EAAE;AAAA,IACnF;AACA,UAAM,QAAQ,kBAAkB,QAAQ,IAAI,QAAQ,KAAK,OAAO;AAChE,aAAS,UAAU,KAAK;AACxB,UAAM,MAAwB;AAAA,MAC5B,SAAS;AAAA,MACT,QAAQ,mBAAmB,QAAQ,IAAI,QAAQ,SAAS,KAAK,IAAI,GAAG,KAAK;AAAA,IAC3E;AAEA,UAAM,KAAK,OAAO,KAAK,KAAK,EAAE,SAAS,QAAQ,QAAQ,CAAC;AACxD,WAAO,EAAE,MAAM;AAAA,EACjB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQQ,YACN,KACA,UACA,MACqB;AACrB,UAAM,OAAO,OAAO,KAAK,SAAS,IAAI,IAAI,IAAI;AAC9C,QAAI,SAAS,UAAa,KAAK,QAAQ,OAAO,MAAM,UAAU,SAAU,QAAO;AAC/E,WAAO,KAAK,UAAU,KAAK,IAAI;AAAA,EACjC;AAAA,EAEA,OAAO,KAAK,WAAmD;AAE7D,QAAI,cAAc,OAAW,oBAAmB,EAAE,SAAS,KAAK,UAAU,CAAC;AAC3E,UAAM,SAAS,mBAAmB,KAAK,QAAQ,SAAS;AAExD,QAAI,OAAiB,CAAC;AACtB,UAAM,QAAQ,iBAEZ,MAC+B;AAC/B,YAAM,OAAO,MAAM;AAAA,QAAmB;AAAA,QAAM;AAAA,QAAuB,CAAC,QAClE,KAAK,QAAQ,GAAG;AAAA,MAClB;AACA,iBAAW,WAAW,MAAM;AAC1B,YAAI,WAAW,CAAC,QAAQ,IAAI,QAAS,OAAM,QAAQ,IAAI;AAAA,MACzD;AAAA,IACF,EAAE,KAAK,IAAI;AAEX,qBAAiB,OAAO,KAAK,MAAM,SAAS,MAAM,GAAG;AACnD,UAAI,iBAAiB,KAAK,QAAQ,GAAG,MAAM,KAAM;AACjD,WAAK,KAAK,GAAG;AACb,UAAI,KAAK,UAAU,uBAAuB;AACxC,eAAO,MAAM,IAAI;AACjB,eAAO,CAAC;AAAA,MACV;AAAA,IACF;AACA,QAAI,KAAK,SAAS,EAAG,QAAO,MAAM,IAAI;AAAA,EACxC;AAAA,EAEA,MAAM,OAAO,KAAiB,UAAiC;AAC7D,UAAM,MAAM,kBAAkB,KAAK,QAAQ,GAAG;AAM9C,aAAS,UAAU,GAAG,UAAU,qBAAqB,WAAW;AAC9D,YAAM,UAAU,MAAM,KAAK,QAAQ,GAAG;AACtC,UAAI,aAAa,QAAW;AAG1B,YAAI,YAAY,QAAQ,QAAQ,IAAI,WAAW,QAAQ,IAAI,OAAO,UAAU,UAAU;AACpF,gBAAM,IAAI,mBAAmB,uCAAuC,IAAI,OAAO,EAAE;AAAA,QACnF;AAAA,MACF,WAAW,YAAY,QAAQ,QAAQ,IAAI,SAAS;AAClD;AAAA,MACF;AACA,UAAI;AACF,cAAM,SAAS,KAAK,YAAY,IAAI,KAAK,MAAM,SAAS;AACxD,YAAI,WAAW,QAAW;AAExB,gBAAM,OAAO,KAAK,KAAK,OAAO,KAAK,EAAE,SAAS,QAAQ,QAAQ,CAAC;AAC/D;AAAA,QACF;AACA,cAAM,QAAQ,kBAAkB,QAAQ,IAAI,QAAQ,KAAK,OAAO;AAChE,cAAM,MAAwB;AAAA,UAC5B,SAAS;AAAA,UACT,QAAQ,EAAE,GAAG,QAAQ,IAAI,QAAQ,OAAO,WAAW,KAAK,IAAI,EAAE;AAAA,QAChE;AACA,cAAM,KAAK,OAAO,KAAK,KAAK,EAAE,SAAS,QAAQ,QAAQ,CAAC;AACxD;AAAA,MACF,SAAS,KAAK;AACZ,YAAI,qBAAqB,GAAG,EAAG;AAC/B,cAAM;AAAA,MACR;AAAA,IACF;AACA,UAAM,IAAI,mBAAmB,yCAAyC,IAAI,OAAO,gBAAW;AAAA,EAC9F;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAc,QAAQ,WAA4C;AAChE,UAAM,MAAM,MAAM,KAAK,UAAU,SAAS;AAC1C,WAAO,QAAQ,OAAO,OAAO,KAAK,UAAU,WAAW,GAAG;AAAA,EAC5D;AAAA;AAAA,EAGQ,UAAU,WAAmB,KAAyB;AAC5D,QAAI,IAAI,MAAM,SAAS,eAAe;AACpC,YAAM,IAAI;AAAA,QACR,mBAAmB,IAAI,MAAM,MAAM,iBAAiB,aAAa;AAAA,MACnE;AAAA,IACF;AACA,QAAI,IAAI,QAAQ,WAAW,GAAG;AAE5B,YAAM,IAAI;AAAA,QACR,uEAAuE,SAAS;AAAA,MAClF;AAAA,IACF;AAEA,UAAM,SAAS,iBAAiB,KAAK,QAAQ,SAAS,KAAK;AAC3D,UAAM,MAAM,sBAAsB,aAAa,OAAO,IAAI,KAAK,GAAG,WAAW,MAAM;AACnF,WAAO,EAAE,KAAK,OAAO,IAAI,OAAO,SAAS,IAAI,QAAQ;AAAA,EACvD;AAAA;AAAA,EAGA,MAAc,UAAU,WAA8C;AACpE,aAAS,UAAU,GAAG,UAAU,mBAAmB,WAAW;AAC5D,UAAI;AACF,eAAO,MAAM,KAAK,MAAM,KAAK,SAAS;AAAA,MACxC,SAAS,KAAK;AACZ,YAAI,CAAC,eAAe,GAAG,EAAG,OAAM;AAAA,MAClC;AAAA,IACF;AACA,UAAM,IAAI;AAAA,MACR,kBAAkB,KAAK,MAAM,KAAK,YAAY,SAAS,qCAClD,iBAAiB;AAAA,IACxB;AAAA,EACF;AAAA;AAAA,EAGA,MAAc,OACZ,WACA,KACA,QACe;AACf,UAAM,OAAO,KAAK,OAAO,0BAA0B,GAAG,CAAC;AACvD,QAAI,KAAK,SAAS,eAAe;AAG/B,YAAM,IAAI,gBAAgB,mBAAmB,KAAK,MAAM,iBAAiB,aAAa,GAAG;AAAA,IAC3F;AACA,UAAM,KAAK,MAAM,MAAM,WAAW,MAAM,MAAM;AAAA,EAChD;AACF;;;AChcA,IAAM,SAAS;AAMR,SAAS,oBAAoB,QAA4B,KAAyB;AACvF,qBAAmB,GAAG;AACtB,SAAO,GAAG,WAAW,MAAM,CAAC,GAAG,iBAAiB,IAAI,SAAS,CAAC,aAAa,iBAAiB,IAAI,OAAO,CAAC;AAC1G;AAMO,SAAS,iBAAiB,QAA4B,KAAqB;AAChF,iBAAe,IAAI,YAAY,EAAE,KAAK,GAAG,MAAM,aAAa,CAAC;AAC7D,SAAO,GAAG,oBAAoB,QAAQ,GAAG,CAAC,GAAG,IAAI,UAAU,GAAG,MAAM;AACtE;AAQO,SAAS,uBAAuB,eAAuB,WAAkC;AAC9F,MAAI,CAAC,UAAU,WAAW,aAAa,KAAK,CAAC,UAAU,SAAS,MAAM,EAAG,QAAO;AAChF,QAAM,SAAS,UAAU,MAAM,cAAc,QAAQ,UAAU,SAAS,OAAO,MAAM;AACrF,MAAI,CAAC,iBAAiB,KAAK,MAAM,EAAG,QAAO;AAC3C,QAAM,aAAa,OAAO,MAAM;AAChC,SAAO,OAAO,cAAc,UAAU,IAAI,aAAa;AACzD;;;ACpCA,IAAM,wBAA6C,oBAAI,IAAI;AAAA,EACzD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC;AASM,SAAS,iBAAiB,KAAuB;AACtD,QAAM,OAAQ,KAA+C;AAC7D,SAAO,OAAO,SAAS,YAAY,sBAAsB,IAAI,IAAI;AACnE;AAQO,SAAS,YACd,KACA,aACA,SACS;AACT,SAAO,YAAY,GAAG,IAAI,IAAI,eAAe,QAAQ,GAAG,GAAG,EAAE,OAAO,IAAI,CAAC,IAAI;AAC/E;;;AC5CO,SAAS,YAAY,OAA0C;AACpE,MAAI,QAAQ;AACZ,aAAW,KAAK,MAAO,UAAS,EAAE;AAClC,QAAM,MAAM,IAAI,WAAW,KAAK;AAChC,MAAI,SAAS;AACb,aAAW,KAAK,OAAO;AACrB,QAAI,IAAI,GAAG,MAAM;AACjB,cAAU,EAAE;AAAA,EACd;AACA,SAAO;AACT;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/** Byte-buffer helpers shared by the drivers. */
|
|
2
|
+
/**
|
|
3
|
+
* The chunks of `parts`, in order, copied into one new `Uint8Array` that owns its bytes: no view of any part survives in
|
|
4
|
+
* it, so a part's buffer can be reused or let go once this returns.
|
|
5
|
+
*/
|
|
6
|
+
export declare function concatBytes(parts: readonly Uint8Array[]): Uint8Array;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Whether `err` is a connection that failed or was cut off before the service answered: its `code` is one of the
|
|
3
|
+
* strings Node gives such a failure (`ECONNRESET`, `ECONNREFUSED`, `ECONNABORTED`, `ETIMEDOUT`, `ENOTFOUND`,
|
|
4
|
+
* `EAI_AGAIN`, `EHOSTUNREACH`, `ENETUNREACH`, `EPIPE`). A retry on a fresh connection usually succeeds, so a driver
|
|
5
|
+
* raises one as {@link TransientError}. It reads nothing else: a driver whose service also answers with a status
|
|
6
|
+
* checks that first.
|
|
7
|
+
*/
|
|
8
|
+
export declare function isTransportFault(err: unknown): boolean;
|
|
9
|
+
/**
|
|
10
|
+
* `err` as a {@link TransientError} when `isTransient(err)` holds, with `message(err)` as its message and `err` as its
|
|
11
|
+
* `cause`; any other error unchanged. The last step of a driver's error mapping, so the store's read retry can ride a
|
|
12
|
+
* transient fault out and a write's caller can tell one from a deterministic failure. Run whatever scrubs credentials
|
|
13
|
+
* from an error before it, since the error becomes the cause.
|
|
14
|
+
*/
|
|
15
|
+
export declare function toTransient(err: unknown, isTransient: (err: unknown) => boolean, message: (err: unknown) => string): unknown;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { GenKey, SegmentRef } from '../../core/ports.js';
|
|
2
|
+
/**
|
|
3
|
+
* The key prefix shared by all of a segment's generations, `<prefix><ns>/segments/<segment>.`: the prefix a listing of
|
|
4
|
+
* the segment's generations asks for, and the string {@link parseGenerationFromKey} strips.
|
|
5
|
+
*/
|
|
6
|
+
export declare function segmentObjectPrefix(prefix: string | undefined, ref: SegmentRef): string;
|
|
7
|
+
/**
|
|
8
|
+
* The full key of one generation's object, `<segmentPrefix><gen>.crbm`. A generation that is not a safe integer from 0
|
|
9
|
+
* is refused, so every key built here is one {@link parseGenerationFromKey} reads back.
|
|
10
|
+
*/
|
|
11
|
+
export declare function storageObjectKey(prefix: string | undefined, key: GenKey): string;
|
|
12
|
+
/**
|
|
13
|
+
* The generation number in a full object key, given its segment's prefix, or `null` when the key is not one of that
|
|
14
|
+
* segment's generations. Canonical decimal only: no leading zeros (so `…s.07.crbm` cannot alias `…s.7.crbm`), within
|
|
15
|
+
* the safe-integer range. A *different* segment whose name merely shares the prefix does not parse either: a key for
|
|
16
|
+
* segment `s.x` under segment `s`'s prefix has a middle that is not all digits.
|
|
17
|
+
*/
|
|
18
|
+
export declare function parseGenerationFromKey(segmentPrefix: string, objectKey: string): number | null;
|
|
@@ -13,8 +13,6 @@ export declare function prefixPart(prefix: string | undefined): string;
|
|
|
13
13
|
* `name-codec.ts` already applies to segment names, which a prefix has no reason to be exempt from.
|
|
14
14
|
*/
|
|
15
15
|
export declare function normalizeObjectPrefix(prefix: string | undefined): string | undefined;
|
|
16
|
-
/** The key prefix under which every registry object lives: `<prefix>registry/`. */
|
|
17
|
-
export declare function registryPrefix(prefix: string | undefined): string;
|
|
18
16
|
/** The full key of one segment's registry object: `<prefix>registry/<ns>/<segment>.reg`. */
|
|
19
17
|
export declare function registryObjectKey(prefix: string | undefined, ref: SegmentRef): string;
|
|
20
18
|
/** The list prefix for discovery: registry-wide, or scoped to one namespace. */
|
|
@@ -92,6 +92,8 @@ export declare class ObjectStoreRegistry implements IRegistryDriver {
|
|
|
92
92
|
*/
|
|
93
93
|
constructor(store: ObjectRegistryStore, prefix: string | undefined, now: () => number, entropy?: Entropy);
|
|
94
94
|
capabilities(): RegCaps;
|
|
95
|
+
/** Every write reports its token to `onToken` before the request that carries it is sent. */
|
|
96
|
+
get reportsWriteTokens(): true;
|
|
95
97
|
/** Whether a delete removes a row: the store has a delete, and vouches for it. */
|
|
96
98
|
private removesRows;
|
|
97
99
|
/** The object each record `get` returned was read from, to fence a write made against it ({@link RegistryWriteOptions.held}). */
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Refuse an options bag that is not an object, or that holds a key not in `keys`, naming each such key and the keys it
|
|
3
|
+
* takes. `hint`, when given, ends the message, to point at where a likely mistake belongs (`an S3 client goes in
|
|
4
|
+
* \`client\``). Only the bag's own enumerable string keys are read.
|
|
5
|
+
*/
|
|
6
|
+
export declare function refuseUnknownOptions(name: string, options: unknown, keys: readonly string[], hint?: string): void;
|
|
7
|
+
/** Refuse a `now` that is present and not a function. */
|
|
8
|
+
export declare function checkNow(name: string, now: unknown): void;
|
|
9
|
+
/**
|
|
10
|
+
* The option `name`'s `value`, refused with `ValidationError` unless it is absent or a positive safe integer (a whole
|
|
11
|
+
* number from 1 to 2^53 - 1): `0`, a negative, a fraction, `NaN`, an infinity and a string are refused by name. An
|
|
12
|
+
* absent value comes back `undefined`, for the caller's default.
|
|
13
|
+
*/
|
|
14
|
+
export declare function requirePositiveInt(name: string, value: unknown): number | undefined;
|
|
15
|
+
/**
|
|
16
|
+
* The option `name`'s `value`, refused with `ValidationError` unless it is absent or a boolean: a truthy string or a
|
|
17
|
+
* `1` is not taken for `true`. An absent value comes back `undefined`, for the caller's default.
|
|
18
|
+
*/
|
|
19
|
+
export declare function requireBool(name: string, value: unknown): boolean | undefined;
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
import type { Entropy } from '../../core/determinism.js';
|
|
2
2
|
import { incarnationOf } from '../../core/token.js';
|
|
3
|
-
import {
|
|
3
|
+
import { usableKnownGens } from '../../core/known-generations.js';
|
|
4
4
|
import type { NewRegistryRecord, RegistryPatch, RegistryRecord, SegmentRef, Token } from '../../core/ports.js';
|
|
5
5
|
/**
|
|
6
6
|
* The fields a stored record may carry: {@link RegistryRecord}'s, and nothing else. A field no reader resolves
|
|
7
|
-
* through is refused on read-back like any other corruption (invariant 5), rather than ignored. A field
|
|
8
|
-
*
|
|
7
|
+
* through is refused on read-back like any other corruption (invariant 5), rather than ignored. A field the record
|
|
8
|
+
* gains is listed here with its validator; the registry test fails to compile when this list and the record disagree.
|
|
9
9
|
*/
|
|
10
|
-
export declare const RECORD_FIELDS: readonly ["namespace", "segment", "currentGen", "wrappedDeks", "keyId", "status", "retention", "residency", "summary", "createdAt", "updatedAt", "token", "
|
|
10
|
+
export declare const RECORD_FIELDS: readonly ["namespace", "segment", "currentGen", "wrappedDeks", "keyId", "status", "retention", "residency", "summary", "createdAt", "updatedAt", "token", "knownGens", "leases", "pointerId"];
|
|
11
11
|
/**
|
|
12
12
|
* Validate the caller-settable fields at `create`, and return the record to store: the caller's, with its summary
|
|
13
13
|
* replaced by the checked, frozen copy {@link validateSummary} builds.
|
|
@@ -42,20 +42,23 @@ export interface RegistryEnvelope {
|
|
|
42
42
|
* on a backward-incompatible change. Policy: any stamp but this one → `UnsupportedError` (fail-closed); an
|
|
43
43
|
* **absent** or malformed stamp → `IntegrityError`, since every row this build writes has one.
|
|
44
44
|
*
|
|
45
|
-
* Schema
|
|
46
|
-
*
|
|
47
|
-
*
|
|
45
|
+
* Schema 5 is the record with `knownGens`, the ledger of the generations a row made current (each with its object's footer
|
|
46
|
+
* checksum, in the order they were made current), and a summary that records `tailBytes`. This build reads schema 5 and
|
|
47
|
+
* nothing else: a row stamped lower carries no ledger and, below 4, no `pointerId` either, so nothing could say which
|
|
48
|
+
* generations the row published or which write set what it resolves to.
|
|
48
49
|
*/
|
|
49
|
-
export declare const REGISTRY_SCHEMA_VERSION =
|
|
50
|
+
export declare const REGISTRY_SCHEMA_VERSION = 5;
|
|
50
51
|
/**
|
|
51
52
|
* Validate a persisted registry row's `schemaVersion` (untrusted bytes, invariant 5) and return it: an absent or
|
|
52
53
|
* malformed value → `IntegrityError`; any version but {@link REGISTRY_SCHEMA_VERSION} → `UnsupportedError`
|
|
53
|
-
* (fail-closed rather than misread a format this build does not read), naming what to do for an earlier one.
|
|
54
|
+
* (fail-closed rather than misread a format this build does not read), naming what to do for an earlier one. The steps
|
|
55
|
+
* are in the changelog's entry for the release that introduced the schema; the message names that entry and no anchor,
|
|
56
|
+
* which cannot go stale.
|
|
54
57
|
*/
|
|
55
58
|
export declare function assertRegistrySchemaVersion(raw: unknown, ctx: string): number;
|
|
56
59
|
/** Serialize a registry envelope for persistence, stamping the current {@link REGISTRY_SCHEMA_VERSION}. */
|
|
57
60
|
export declare function serializeRegistryEnvelope(env: RegistryEnvelope): string;
|
|
58
|
-
export {
|
|
61
|
+
export { usableKnownGens };
|
|
59
62
|
export { incarnationOf };
|
|
60
63
|
/** A fresh incarnation id from `entropy`: 128 bits as 32 lowercase hex digits. */
|
|
61
64
|
export declare function drawIncarnation(entropy: Entropy): string;
|
|
@@ -1,12 +1,9 @@
|
|
|
1
|
-
import { ValidationError } from '../../core/errors.js';
|
|
2
1
|
/**
|
|
3
2
|
* The index of the first component of `actual` (the path as it is on disk, relative to the root) that equals the same
|
|
4
3
|
* component of `expected` ignoring case but not exactly, or `-1` when there is none. A component that is a different
|
|
5
4
|
* name altogether, or a path that is longer or shorter, is not a case difference.
|
|
6
5
|
*/
|
|
7
6
|
export declare function firstCaseDifference(expected: readonly string[], actual: readonly string[]): number;
|
|
8
|
-
/** What a path-resolving call needs of the filesystem: the error to refuse a write with. */
|
|
9
|
-
export declare function caseVariantError(): ValidationError;
|
|
10
7
|
export declare class ExactCase {
|
|
11
8
|
private readonly root;
|
|
12
9
|
/** `undefined` until the root holds an entry to try; then fixed, as a filesystem does not change its mind. */
|
|
@@ -19,6 +19,13 @@ export declare const mapFsError: (err: unknown) => unknown;
|
|
|
19
19
|
* Containment of symlinked *directory* components assumes the root itself is not attacker-writable.
|
|
20
20
|
*/
|
|
21
21
|
export declare const O_NOFOLLOW: number;
|
|
22
|
+
/**
|
|
23
|
+
* The modes LocalFs creates what it stores with: files readable and writable by their owner alone, directories
|
|
24
|
+
* searchable by it alone, so another user of the machine cannot read or list a segment. A process umask can only
|
|
25
|
+
* remove bits from these, never add any. On Windows Node ignores a mode apart from the read-only bit, so passing
|
|
26
|
+
* them there changes nothing.
|
|
27
|
+
*/
|
|
28
|
+
export declare const FILE_MODE = 384;
|
|
22
29
|
/**
|
|
23
30
|
* Best-effort parent-directory fsync, so a just-published `rename`/`link` survives a crash. Without it the
|
|
24
31
|
* directory entry can still be in the page cache when power goes: the generation's bytes are durable and
|
|
@@ -31,3 +38,18 @@ export declare function fsyncDir(dir: string): Promise<void>;
|
|
|
31
38
|
* or object as a whole one. A write that makes no progress is a full device.
|
|
32
39
|
*/
|
|
33
40
|
export declare function writeAll(handle: FileHandle, bytes: Uint8Array): Promise<void>;
|
|
41
|
+
/**
|
|
42
|
+
* Create `dir` and the directories missing above it, private from `top` down: what is missing above `top` is created
|
|
43
|
+
* with the default mode (another service may need to traverse it), `top` and everything below it {@link DIR_MODE}. A
|
|
44
|
+
* directory that exists keeps its mode.
|
|
45
|
+
*/
|
|
46
|
+
export declare function makeDirs(dir: string, top: string): Promise<void>;
|
|
47
|
+
/** The name of a temp file beside `finalPath`: `<finalPath>.<uuid>.tmp`. The only names {@link sweepOrphanTemps} removes. */
|
|
48
|
+
export declare const tempPathFor: (finalPath: string) => string;
|
|
49
|
+
/**
|
|
50
|
+
* Remove the temp files in `dir` named by {@link tempPathFor} that were last written more than a day ago, streaming the
|
|
51
|
+
* directory, and at most once an hour per directory in this process. Only regular files go (a symlink is never followed
|
|
52
|
+
* or removed). Best effort: a failure leaves the files for a later sweep and is never raised. Callers start it without
|
|
53
|
+
* awaiting it.
|
|
54
|
+
*/
|
|
55
|
+
export declare function sweepOrphanTemps(dir: string, now?: number): Promise<void>;
|
|
@@ -1,15 +1,18 @@
|
|
|
1
1
|
import type { Entropy } from '../../core/determinism.js';
|
|
2
|
-
import type { IRegistryDriver, NewRegistryRecord, RegCaps, RegistryPatch, RegistryRecord, SegmentRef, Token } from '../../core/ports.js';
|
|
2
|
+
import type { IRegistryDriver, NewRegistryRecord, RegCaps, RegistryPatch, RegistryRecord, RegistryWriteOptions, SegmentRef, Token } from '../../core/ports.js';
|
|
3
3
|
/** Entries in the process-wide row-lock map; the map is empty whenever no registry operation is in flight. */
|
|
4
4
|
export declare function localFsRowLockCount(): number;
|
|
5
|
-
|
|
5
|
+
interface LocalFsRegistryDriverOptions {
|
|
6
6
|
/** Injected clock for `createdAt`/`updatedAt`; defaults to `Date.now`. */
|
|
7
7
|
readonly now?: () => number;
|
|
8
8
|
/** Draws every token's random parts; defaults to Web Crypto. Inject one only to make a test replayable. */
|
|
9
9
|
readonly entropy?: Entropy;
|
|
10
|
+
/** The directory this root lives under, from which down directories are created private; defaults to the root. */
|
|
11
|
+
readonly privateRoot?: string;
|
|
10
12
|
}
|
|
11
13
|
export declare class LocalFsRegistryDriver implements IRegistryDriver {
|
|
12
14
|
private readonly root;
|
|
15
|
+
private readonly options;
|
|
13
16
|
private readonly now;
|
|
14
17
|
private readonly entropy;
|
|
15
18
|
private readonly exactCase;
|
|
@@ -19,15 +22,17 @@ export declare class LocalFsRegistryDriver implements IRegistryDriver {
|
|
|
19
22
|
* the root in this process takes, so no write can land between the check and the unlink.
|
|
20
23
|
*/
|
|
21
24
|
capabilities(): RegCaps;
|
|
25
|
+
/** Every write reports its token to `onToken` before the row's file is written. */
|
|
26
|
+
get reportsWriteTokens(): true;
|
|
22
27
|
get(ref: SegmentRef): Promise<RegistryRecord | null>;
|
|
23
|
-
create(ref: SegmentRef, record: NewRegistryRecord): Promise<{
|
|
28
|
+
create(ref: SegmentRef, record: NewRegistryRecord, options?: RegistryWriteOptions): Promise<{
|
|
24
29
|
token: Token;
|
|
25
30
|
}>;
|
|
26
31
|
/**
|
|
27
32
|
* A caller's `held` row (see `RegistryWriteOptions`) has no read to spare here: the row's file is read under its lock and its token compared
|
|
28
33
|
* there, a local read and no request, so a stale one fails exactly as a lost race does.
|
|
29
34
|
*/
|
|
30
|
-
compareAndSwap(ref: SegmentRef, expected: Token, patch: RegistryPatch): Promise<{
|
|
35
|
+
compareAndSwap(ref: SegmentRef, expected: Token, patch: RegistryPatch, options?: RegistryWriteOptions): Promise<{
|
|
31
36
|
token: Token;
|
|
32
37
|
}>;
|
|
33
38
|
list(namespace?: string): AsyncIterable<RegistryRecord>;
|
|
@@ -42,3 +47,4 @@ export declare class LocalFsRegistryDriver implements IRegistryDriver {
|
|
|
42
47
|
/** Serialize callbacks for a row so read-modify-write is atomic across every instance in the process. */
|
|
43
48
|
private withRowLock;
|
|
44
49
|
}
|
|
50
|
+
export {};
|