Publish quixos-protocol from abc91ab1cbbd61ffd7f0a49dbc5768598ac8745c
This commit is contained in:
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"version": 1,
|
"version": 1,
|
||||||
"sourceRepo": "https://gitea-external.egads.tutti.syntaxblitz.net/quixos/quixos",
|
"sourceRepo": "https://gitea-external.egads.tutti.syntaxblitz.net/quixos/quixos",
|
||||||
"sourceCommit": "452f3c48aadceaf08e56ae9c226e98a7f9df4900",
|
"sourceCommit": "abc91ab1cbbd61ffd7f0a49dbc5768598ac8745c",
|
||||||
"sourcePath": "quixos-protocol",
|
"sourcePath": "quixos-protocol",
|
||||||
"exportName": "quixos-protocol",
|
"exportName": "quixos-protocol",
|
||||||
"mirrorRemote": "https://gitea-external.egads.tutti.syntaxblitz.net/quixos/quixos-protocol.git"
|
"mirrorRemote": "https://gitea-external.egads.tutti.syntaxblitz.net/quixos/quixos-protocol.git"
|
||||||
|
|||||||
+139
-104
@@ -1,18 +1,27 @@
|
|||||||
import { graphExecutionRepresentation } from "./graph-execution.js";
|
import { graphExecutionRepresentation } from "./graph-execution.js";
|
||||||
import { open, lstat } from "node:fs/promises";
|
import { lstat } from "node:fs/promises";
|
||||||
import { constants } from "node:fs";
|
|
||||||
import { join } from "node:path";
|
import { join } from "node:path";
|
||||||
import { hexDigest, ExecutionPlanError, type ExecutionPlan } from "./plan.js";
|
import { hexDigest, ExecutionPlanError, type ExecutionPlan } from "./plan.js";
|
||||||
import { loadExecutionInstallation, type PackageInstallationSelection } from "./installation.js";
|
import { loadExecutionInstallation, type PackageInstallationSelection } from "./installation.js";
|
||||||
|
import {
|
||||||
|
candidateMetadataBudget,
|
||||||
|
readCandidateMetadata,
|
||||||
|
type CandidateMetadataBudget,
|
||||||
|
type CandidateMetadataScope,
|
||||||
|
} from "./metadata.js";
|
||||||
const rootPattern = /^\/nix\/store\/[a-z0-9]{32}-[^/\s]+$/;
|
const rootPattern = /^\/nix\/store\/[a-z0-9]{32}-[^/\s]+$/;
|
||||||
async function readJson(root: string, file: string): Promise<any> {
|
async function readJson(root: string, file: string, scope: CandidateMetadataScope) {
|
||||||
const handle = await open(join(root, file), constants.O_RDONLY | constants.O_NOFOLLOW);
|
const input = await readCandidateMetadata(join(root, file), scope, 32 * 1024 * 1024);
|
||||||
try {
|
try {
|
||||||
const metadata = await handle.stat();
|
return {
|
||||||
if (!metadata.isFile() || metadata.size > 32 * 1024 * 1024) throw Error(`Invalid checked candidate file: ${file}`);
|
value: JSON.parse(new TextDecoder("utf-8", { fatal: true }).decode(input.bytes)),
|
||||||
return JSON.parse(await handle.readFile("utf8"));
|
releaseTree: input.releaseTree,
|
||||||
|
};
|
||||||
|
} catch (error) {
|
||||||
|
input.releaseTree();
|
||||||
|
throw error;
|
||||||
} finally {
|
} finally {
|
||||||
await handle.close();
|
input.releaseInput();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
/** Load the checked Nix output, preserving its original compilation and provenance.
|
/** Load the checked Nix output, preserving its original compilation and provenance.
|
||||||
@@ -22,113 +31,139 @@ async function readJson(root: string, file: string): Promise<any> {
|
|||||||
export async function loadCheckedInstallationCandidate(
|
export async function loadCheckedInstallationCandidate(
|
||||||
root: string,
|
root: string,
|
||||||
selections: Readonly<Record<string, PackageInstallationSelection>> = {},
|
selections: Readonly<Record<string, PackageInstallationSelection>> = {},
|
||||||
|
resources: { budget?: CandidateMetadataBudget; owner?: string } = {},
|
||||||
) {
|
) {
|
||||||
if (!rootPattern.test(root) || !(await lstat(root)).isDirectory())
|
if (!rootPattern.test(root) || !(await lstat(root)).isDirectory())
|
||||||
throw Error("Candidate must be an immutable Nix output directory");
|
throw Error("Candidate must be an immutable Nix output directory");
|
||||||
const [candidate, plan, artifacts, source, entryRequest, kernel, queries, graph] = await Promise.all([
|
const scope = (resources.budget ?? candidateMetadataBudget).acquire(resources.owner ?? root);
|
||||||
readJson(root, "candidate.json"),
|
let releaseValidation = () => {};
|
||||||
readJson(root, "execution-plan.json"),
|
try {
|
||||||
readJson(root, "execution-artifacts.json"),
|
// Sequential reads avoid partially rejected Promise.all() work allocating
|
||||||
readJson(root, "source.json"),
|
// after the failed candidate's reservation has been released.
|
||||||
readJson(root, "entry.json"),
|
const values = [];
|
||||||
readJson(root, "kernel.json"),
|
for (const file of [
|
||||||
readJson(root, "queries.json"),
|
"candidate.json",
|
||||||
readJson(root, "graph-execution.json"),
|
"execution-plan.json",
|
||||||
]);
|
"execution-artifacts.json",
|
||||||
const { executionContracts: _legacyContracts, ...workspace } = candidate;
|
"source.json",
|
||||||
if (
|
"entry.json",
|
||||||
plan?.definition?.codec !== "camino-execution-plan-v1" ||
|
"kernel.json",
|
||||||
hexDigest(plan.definition) !== plan.digest ||
|
"queries.json",
|
||||||
hexDigest(workspace) !== hexDigest(plan.definition.workspace)
|
"graph-execution.json",
|
||||||
)
|
]) {
|
||||||
throw new ExecutionPlanError(
|
const parsed = await readJson(root, file, scope);
|
||||||
"CANDIDATE_PLAN_MISMATCH",
|
values.push(parsed.value);
|
||||||
root,
|
// candidate.json duplicates the checked plan for validation. Nothing in
|
||||||
"Stored plan must match its digest and exact workspace source contract",
|
// the installed candidate retains this input tree after validation.
|
||||||
);
|
if (file === "candidate.json") releaseValidation = parsed.releaseTree;
|
||||||
if (
|
}
|
||||||
source.kind !== "workspace" ||
|
const [candidate, plan, artifacts, source, entryRequest, kernel, queries, graph] = values;
|
||||||
source.commit !== plan.definition.workspace.sourceRootCommit ||
|
const { executionContracts: _legacyContracts, ...workspace } = candidate;
|
||||||
typeof source.repository !== "string"
|
if (
|
||||||
)
|
plan?.definition?.codec !== "camino-execution-plan-v1" ||
|
||||||
throw new ExecutionPlanError("CANDIDATE_SOURCE_MISMATCH", root, "Expected exact workspace source provenance");
|
hexDigest(plan.definition) !== plan.digest ||
|
||||||
const repository = new URL(source.repository);
|
hexDigest(workspace) !== hexDigest(plan.definition.workspace)
|
||||||
if (
|
)
|
||||||
!["https:", "ssh:"].includes(repository.protocol) ||
|
|
||||||
repository.username ||
|
|
||||||
repository.password ||
|
|
||||||
repository.hash ||
|
|
||||||
repository.search
|
|
||||||
)
|
|
||||||
throw new ExecutionPlanError("CANDIDATE_SOURCE_INVALID", root, "Expected a source URL without credentials");
|
|
||||||
if (
|
|
||||||
artifacts.codec !== "camino-checked-execution-v2" ||
|
|
||||||
typeof artifacts.generator !== "string" ||
|
|
||||||
!/^[0-9a-f]{64}$/.test(artifacts.generator) ||
|
|
||||||
!artifacts.roots ||
|
|
||||||
typeof artifacts.roots !== "object" ||
|
|
||||||
Array.isArray(artifacts.roots)
|
|
||||||
)
|
|
||||||
throw new ExecutionPlanError("CANDIDATE_ARTIFACTS_INVALID", root, "Expected checked package roots");
|
|
||||||
for (const entry of Object.values(artifacts.roots))
|
|
||||||
if (typeof entry !== "string" || !rootPattern.test(entry))
|
|
||||||
throw new ExecutionPlanError(
|
throw new ExecutionPlanError(
|
||||||
"CANDIDATE_ARTIFACTS_INVALID",
|
"CANDIDATE_PLAN_MISMATCH",
|
||||||
root,
|
root,
|
||||||
"Package artifacts must be immutable Nix roots",
|
"Stored plan must match its digest and exact workspace source contract",
|
||||||
);
|
);
|
||||||
const installation = await loadExecutionInstallation(plan, artifacts.roots, selections);
|
if (
|
||||||
const entry = compileWorkspaceEntry(plan, entryRequest);
|
source.kind !== "workspace" ||
|
||||||
for (const [name, program, codec] of [
|
source.commit !== plan.definition.workspace.sourceRootCommit ||
|
||||||
["kernel", kernel, "camino-kernel-program-v1"],
|
typeof source.repository !== "string"
|
||||||
["queries", queries, "camino-query-program-v1"],
|
)
|
||||||
] as const)
|
throw new ExecutionPlanError("CANDIDATE_SOURCE_MISMATCH", root, "Expected exact workspace source provenance");
|
||||||
if (program?.codec !== codec || program.plan !== kernel.plan || hexDigest(program) !== artifacts.programs?.[name])
|
const repository = new URL(source.repository);
|
||||||
|
if (
|
||||||
|
!["https:", "ssh:"].includes(repository.protocol) ||
|
||||||
|
repository.username ||
|
||||||
|
repository.password ||
|
||||||
|
repository.hash ||
|
||||||
|
repository.search
|
||||||
|
)
|
||||||
|
throw new ExecutionPlanError("CANDIDATE_SOURCE_INVALID", root, "Expected a source URL without credentials");
|
||||||
|
if (
|
||||||
|
artifacts.codec !== "camino-checked-execution-v2" ||
|
||||||
|
typeof artifacts.generator !== "string" ||
|
||||||
|
!/^[0-9a-f]{64}$/.test(artifacts.generator) ||
|
||||||
|
!artifacts.roots ||
|
||||||
|
typeof artifacts.roots !== "object" ||
|
||||||
|
Array.isArray(artifacts.roots)
|
||||||
|
)
|
||||||
|
throw new ExecutionPlanError("CANDIDATE_ARTIFACTS_INVALID", root, "Expected checked package roots");
|
||||||
|
for (const entry of Object.values(artifacts.roots))
|
||||||
|
if (typeof entry !== "string" || !rootPattern.test(entry))
|
||||||
|
throw new ExecutionPlanError(
|
||||||
|
"CANDIDATE_ARTIFACTS_INVALID",
|
||||||
|
root,
|
||||||
|
"Package artifacts must be immutable Nix roots",
|
||||||
|
);
|
||||||
|
const installation = await loadExecutionInstallation(plan, artifacts.roots, selections, scope);
|
||||||
|
const entry = compileWorkspaceEntry(plan, entryRequest);
|
||||||
|
for (const [name, program, codec] of [
|
||||||
|
["kernel", kernel, "camino-kernel-program-v1"],
|
||||||
|
["queries", queries, "camino-query-program-v1"],
|
||||||
|
] as const)
|
||||||
|
if (program?.codec !== codec || program.plan !== kernel.plan || hexDigest(program) !== artifacts.programs?.[name])
|
||||||
|
throw new ExecutionPlanError(
|
||||||
|
"CANDIDATE_PROGRAM_MISMATCH",
|
||||||
|
name,
|
||||||
|
"Stored interpreter input must match the checked build and plan",
|
||||||
|
);
|
||||||
|
const expectedGraph = graphExecutionRepresentation(plan, installation, kernel, queries);
|
||||||
|
if (hexDigest(graph) !== hexDigest(expectedGraph) || artifacts.execution !== hexDigest(graph))
|
||||||
throw new ExecutionPlanError(
|
throw new ExecutionPlanError(
|
||||||
"CANDIDATE_PROGRAM_MISMATCH",
|
"CANDIDATE_EXECUTION_MISMATCH",
|
||||||
name,
|
root,
|
||||||
"Stored interpreter input must match the checked build and plan",
|
"Stored graph execution differs from checked inputs",
|
||||||
);
|
);
|
||||||
const expectedGraph = graphExecutionRepresentation(plan, installation, kernel, queries);
|
const provenance = {
|
||||||
if (hexDigest(graph) !== hexDigest(expectedGraph) || artifacts.execution !== hexDigest(graph))
|
workspaceRevision: workspace.id as string,
|
||||||
throw new ExecutionPlanError(
|
source: { repository: source.repository as string, commit: source.commit as string },
|
||||||
"CANDIDATE_EXECUTION_MISMATCH",
|
generator: artifacts.generator as string,
|
||||||
|
packages: (plan as ExecutionPlan).definition.packages.map((pkg) => ({
|
||||||
|
revision: pkg.revision,
|
||||||
|
source: pkg.source,
|
||||||
|
})),
|
||||||
|
};
|
||||||
|
const reference = {
|
||||||
root,
|
root,
|
||||||
"Stored graph execution differs from checked inputs",
|
digest: hexDigest({
|
||||||
);
|
plan: plan.digest,
|
||||||
const provenance = {
|
world: installation.world,
|
||||||
workspaceRevision: workspace.id as string,
|
provenance,
|
||||||
source: { repository: source.repository as string, commit: source.commit as string },
|
roots: artifacts.roots,
|
||||||
generator: artifacts.generator as string,
|
entry,
|
||||||
packages: (plan as ExecutionPlan).definition.packages.map((pkg) => ({
|
programs: artifacts.programs,
|
||||||
revision: pkg.revision,
|
}),
|
||||||
source: pkg.source,
|
};
|
||||||
})),
|
return {
|
||||||
};
|
reference,
|
||||||
const reference = {
|
workspace: plan.definition.workspace.workspaceId,
|
||||||
root,
|
world: hexDigest(graph),
|
||||||
digest: hexDigest({
|
plan: kernel.plan as string,
|
||||||
plan: plan.digest,
|
graphExecution: graph,
|
||||||
world: installation.world,
|
|
||||||
provenance,
|
provenance,
|
||||||
roots: artifacts.roots,
|
|
||||||
entry,
|
entry,
|
||||||
programs: artifacts.programs,
|
kernel,
|
||||||
}),
|
queries,
|
||||||
};
|
installation,
|
||||||
return {
|
executionPlan: plan as ExecutionPlan,
|
||||||
reference,
|
metadata: {
|
||||||
workspace: plan.definition.workspace.workspaceId,
|
get bytes() {
|
||||||
world: hexDigest(graph),
|
return scope.bytes;
|
||||||
plan: kernel.plan as string,
|
},
|
||||||
graphExecution: graph,
|
release: scope.release,
|
||||||
provenance,
|
},
|
||||||
entry,
|
};
|
||||||
kernel,
|
} catch (error) {
|
||||||
queries,
|
scope.release();
|
||||||
installation,
|
throw error;
|
||||||
executionPlan: plan as ExecutionPlan,
|
} finally {
|
||||||
};
|
releaseValidation();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export function compileWorkspaceEntry(plan: ExecutionPlan, entryRequest: unknown): { operation: string } | null {
|
export function compileWorkspaceEntry(plan: ExecutionPlan, entryRequest: unknown): { operation: string } | null {
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ import {
|
|||||||
type CheckedWorld,
|
type CheckedWorld,
|
||||||
} from "./artifacts.js";
|
} from "./artifacts.js";
|
||||||
import { type ExecutionPlan, ExecutionPlanError } from "./plan.js";
|
import { type ExecutionPlan, ExecutionPlanError } from "./plan.js";
|
||||||
|
import { readCandidateMetadata, type CandidateMetadataScope } from "./metadata.js";
|
||||||
|
|
||||||
const maxFileBytes = 256 * 1024 * 1024;
|
const maxFileBytes = 256 * 1024 * 1024;
|
||||||
const metadataLimit = 16 * 1024 * 1024;
|
const metadataLimit = 16 * 1024 * 1024;
|
||||||
@@ -21,6 +22,18 @@ const fail = (where: string, message: string): never => {
|
|||||||
};
|
};
|
||||||
/** Roots must be trusted immutable output directories. Refuse symlinks, including
|
/** Roots must be trusted immutable output directories. Refuse symlinks, including
|
||||||
* interior directory links. Hash verification is still required before serving bytes. */
|
* interior directory links. Hash verification is still required before serving bytes. */
|
||||||
|
async function artifactFile(root: string, relative: string): Promise<string> {
|
||||||
|
artifactPath(relative);
|
||||||
|
const components = relative.split("/");
|
||||||
|
let resolved = root;
|
||||||
|
for (let index = 0; index < components.length; index++) {
|
||||||
|
resolved = path.join(resolved, components[index]!);
|
||||||
|
const stat = await lstat(resolved);
|
||||||
|
if (stat.isSymbolicLink() || (index < components.length - 1 ? !stat.isDirectory() : !stat.isFile()))
|
||||||
|
fail(relative, "Only real directories and regular files are allowed");
|
||||||
|
}
|
||||||
|
return resolved;
|
||||||
|
}
|
||||||
export async function artifactFileReader(roots: Readonly<Record<string, string>>): Promise<ArtifactReader> {
|
export async function artifactFileReader(roots: Readonly<Record<string, string>>): Promise<ArtifactReader> {
|
||||||
const directories = new Map<string, string>();
|
const directories = new Map<string, string>();
|
||||||
for (const [revision, root] of Object.entries(roots)) {
|
for (const [revision, root] of Object.entries(roots)) {
|
||||||
@@ -33,16 +46,8 @@ export async function artifactFileReader(roots: Readonly<Record<string, string>>
|
|||||||
return async (revision, relative, limit) => {
|
return async (revision, relative, limit) => {
|
||||||
const root = directories.get(revision);
|
const root = directories.get(revision);
|
||||||
if (!root) fail(revision, "Unknown package output");
|
if (!root) fail(revision, "Unknown package output");
|
||||||
artifactPath(relative);
|
|
||||||
if (!Number.isSafeInteger(limit) || limit < 0 || limit > maxFileBytes) fail(relative, "Invalid file byte limit");
|
if (!Number.isSafeInteger(limit) || limit < 0 || limit > maxFileBytes) fail(relative, "Invalid file byte limit");
|
||||||
const components = relative.split("/");
|
const resolved = await artifactFile(root!, relative);
|
||||||
let resolved = root!;
|
|
||||||
for (let index = 0; index < components.length; index++) {
|
|
||||||
resolved = path.join(resolved, components[index]!);
|
|
||||||
const stat = await lstat(resolved);
|
|
||||||
if (stat.isSymbolicLink() || (index < components.length - 1 ? !stat.isDirectory() : !stat.isFile()))
|
|
||||||
fail(relative, "Only real directories and regular files are allowed");
|
|
||||||
}
|
|
||||||
const handle = await open(resolved, constants.O_RDONLY | constants.O_NOFOLLOW | constants.O_NONBLOCK);
|
const handle = await open(resolved, constants.O_RDONLY | constants.O_NOFOLLOW | constants.O_NONBLOCK);
|
||||||
try {
|
try {
|
||||||
const stat = await handle.stat();
|
const stat = await handle.stat();
|
||||||
@@ -72,6 +77,7 @@ export interface LoadedArtifactWorld {
|
|||||||
export async function loadArtifactWorld(
|
export async function loadArtifactWorld(
|
||||||
plan: ExecutionPlan,
|
plan: ExecutionPlan,
|
||||||
roots: Readonly<Record<string, string>>,
|
roots: Readonly<Record<string, string>>,
|
||||||
|
metadata?: CandidateMetadataScope,
|
||||||
): Promise<LoadedArtifactWorld> {
|
): Promise<LoadedArtifactWorld> {
|
||||||
const read = await artifactFileReader(roots),
|
const read = await artifactFileReader(roots),
|
||||||
manifests: PackageArtifacts[] = [];
|
manifests: PackageArtifacts[] = [];
|
||||||
@@ -79,8 +85,16 @@ export async function loadArtifactWorld(
|
|||||||
if (JSON.stringify(Object.keys(roots).sort()) !== JSON.stringify(expected))
|
if (JSON.stringify(Object.keys(roots).sort()) !== JSON.stringify(expected))
|
||||||
fail("world", "Output roots must exactly match the installed plan");
|
fail("world", "Output roots must exactly match the installed plan");
|
||||||
for (const revision of expected) {
|
for (const revision of expected) {
|
||||||
const bytes = await read(revision, "share/quixos/package-artifacts.json", metadataLimit);
|
const file = "share/quixos/package-artifacts.json";
|
||||||
const manifest = parsePackageArtifacts(JSON.parse(new TextDecoder("utf-8", { fatal: true }).decode(bytes)));
|
const input = metadata
|
||||||
|
? await readCandidateMetadata(await artifactFile(roots[revision]!, file), metadata, metadataLimit)
|
||||||
|
: { bytes: await read(revision, file, metadataLimit), releaseInput: () => {} };
|
||||||
|
let manifest: PackageArtifacts;
|
||||||
|
try {
|
||||||
|
manifest = parsePackageArtifacts(JSON.parse(new TextDecoder("utf-8", { fatal: true }).decode(input.bytes)));
|
||||||
|
} finally {
|
||||||
|
input.releaseInput();
|
||||||
|
}
|
||||||
if (manifest.packageRevisionId !== revision) fail(revision, "Output belongs to another package revision");
|
if (manifest.packageRevisionId !== revision) fail(revision, "Output belongs to another package revision");
|
||||||
manifests.push(manifest);
|
manifests.push(manifest);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -17,6 +17,7 @@ export * from "./queries.js";
|
|||||||
export * from "./query-document.js";
|
export * from "./query-document.js";
|
||||||
export { generatePortableClientBindings } from "../bindings/portable-client.js";
|
export { generatePortableClientBindings } from "../bindings/portable-client.js";
|
||||||
export * from "./candidate.js";
|
export * from "./candidate.js";
|
||||||
|
export * from "./metadata.js";
|
||||||
|
|
||||||
export { reviewSemanticMajors } from "../capability-model/evolution.js";
|
export { reviewSemanticMajors } from "../capability-model/evolution.js";
|
||||||
|
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ import {
|
|||||||
type PublicQueryContract,
|
type PublicQueryContract,
|
||||||
} from "./client-contracts.js";
|
} from "./client-contracts.js";
|
||||||
import { resultInterfaces } from "./projections.js";
|
import { resultInterfaces } from "./projections.js";
|
||||||
|
import type { CandidateMetadataScope } from "./metadata.js";
|
||||||
|
|
||||||
/** Activation is assigned by graph authority, never by a package artifact. */
|
/** Activation is assigned by graph authority, never by a package artifact. */
|
||||||
export interface ActiveExecutionIdentity {
|
export interface ActiveExecutionIdentity {
|
||||||
@@ -159,8 +160,9 @@ export async function loadExecutionInstallation(
|
|||||||
plan: ExecutionPlan,
|
plan: ExecutionPlan,
|
||||||
roots: Readonly<Record<string, string>>,
|
roots: Readonly<Record<string, string>>,
|
||||||
selections: Readonly<Record<string, PackageInstallationSelection>> = {},
|
selections: Readonly<Record<string, PackageInstallationSelection>> = {},
|
||||||
|
metadata?: CandidateMetadataScope,
|
||||||
): Promise<ExecutionInstallation> {
|
): Promise<ExecutionInstallation> {
|
||||||
return assembleExecutionInstallation(plan, roots, await loadArtifactWorld(plan, roots), selections);
|
return assembleExecutionInstallation(plan, roots, await loadArtifactWorld(plan, roots, metadata), selections);
|
||||||
}
|
}
|
||||||
function assembleExecutionInstallation(
|
function assembleExecutionInstallation(
|
||||||
plan: ExecutionPlan,
|
plan: ExecutionPlan,
|
||||||
|
|||||||
@@ -0,0 +1,134 @@
|
|||||||
|
import { constants } from "node:fs";
|
||||||
|
import { open } from "node:fs/promises";
|
||||||
|
|
||||||
|
/** Admission estimates, not a hard V8 heap limit. A process/cgroup ceiling is
|
||||||
|
* still required. Charge input, parse trees and derived indexes before reading
|
||||||
|
* or parsing. Each live candidate retains its reservation until explicit close. */
|
||||||
|
export class CandidateMetadataBudget {
|
||||||
|
readonly limits: Readonly<{ bytes: number; ownerBytes: number; candidates: number }>;
|
||||||
|
private bytes = 0;
|
||||||
|
private scopes = 0;
|
||||||
|
private readonly owners = new Map<string, number>();
|
||||||
|
constructor(limits = { bytes: 512 * 1024 * 1024, ownerBytes: 256 * 1024 * 1024, candidates: 128 }) {
|
||||||
|
for (const value of Object.values(limits))
|
||||||
|
if (!Number.isSafeInteger(value) || value < 1) throw Error("INVALID_CANDIDATE_METADATA_BUDGET");
|
||||||
|
if (limits.ownerBytes > limits.bytes) throw Error("INVALID_CANDIDATE_METADATA_BUDGET");
|
||||||
|
this.limits = Object.freeze({ ...limits });
|
||||||
|
}
|
||||||
|
snapshot() {
|
||||||
|
return { bytes: this.bytes, candidates: this.scopes, owners: this.owners.size, limits: this.limits };
|
||||||
|
}
|
||||||
|
acquire(owner: string) {
|
||||||
|
if (!owner || owner.length > 4096) throw Error("INVALID_CANDIDATE_METADATA_OWNER");
|
||||||
|
if (this.scopes >= this.limits.candidates) throw Error("CANDIDATE_METADATA_LIMIT");
|
||||||
|
this.scopes++;
|
||||||
|
let bytes = 0,
|
||||||
|
closed = false;
|
||||||
|
const charge = (amount: number) => {
|
||||||
|
if (closed) throw Error("CANDIDATE_METADATA_CLOSED");
|
||||||
|
if (!Number.isSafeInteger(amount) || amount < 0) throw Error("INVALID_CANDIDATE_METADATA_CHARGE");
|
||||||
|
const owned = this.owners.get(owner) ?? 0;
|
||||||
|
if (this.bytes + amount > this.limits.bytes || owned + amount > this.limits.ownerBytes)
|
||||||
|
throw Error("CANDIDATE_METADATA_LIMIT");
|
||||||
|
bytes += amount;
|
||||||
|
this.bytes += amount;
|
||||||
|
this.owners.set(owner, owned + amount);
|
||||||
|
};
|
||||||
|
const subtract = (amount: number) => {
|
||||||
|
bytes -= amount;
|
||||||
|
this.bytes -= amount;
|
||||||
|
const remaining = (this.owners.get(owner) ?? 0) - amount;
|
||||||
|
if (remaining) this.owners.set(owner, remaining);
|
||||||
|
else this.owners.delete(owner);
|
||||||
|
};
|
||||||
|
return {
|
||||||
|
get bytes() {
|
||||||
|
return bytes;
|
||||||
|
},
|
||||||
|
charge,
|
||||||
|
/** Opaque, idempotent transient reservation; callers cannot subtract an
|
||||||
|
* arbitrary amount or release another candidate's charges. */
|
||||||
|
reserve: (amount: number) => {
|
||||||
|
charge(amount);
|
||||||
|
let released = false;
|
||||||
|
return () => {
|
||||||
|
if (closed || released) return;
|
||||||
|
released = true;
|
||||||
|
subtract(amount);
|
||||||
|
};
|
||||||
|
},
|
||||||
|
release: () => {
|
||||||
|
if (closed) return;
|
||||||
|
closed = true;
|
||||||
|
subtract(bytes);
|
||||||
|
this.scopes--;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
export type CandidateMetadataScope = ReturnType<CandidateMetadataBudget["acquire"]>;
|
||||||
|
export const candidateMetadataBudget = new CandidateMetadataBudget();
|
||||||
|
|
||||||
|
// Estimate JSON allocation without constructing its tree. Object/array headers,
|
||||||
|
// value slots and strings get explicit weights, with a multiplier for checked
|
||||||
|
// indexes/derived representations. Indentation must not multiply tree charges.
|
||||||
|
function jsonAllocation(bytes: Uint8Array): number {
|
||||||
|
let estimate = 0;
|
||||||
|
for (let i = 0; i < bytes.length; i++) {
|
||||||
|
const c = bytes[i]!;
|
||||||
|
if (c === 123) estimate += 64;
|
||||||
|
else if (c === 91) estimate += 32;
|
||||||
|
else if (c === 34) {
|
||||||
|
const start = ++i;
|
||||||
|
while (i < bytes.length && bytes[i] !== 34) {
|
||||||
|
if (bytes[i] === 92) i++;
|
||||||
|
i++;
|
||||||
|
}
|
||||||
|
estimate += 32 + 2 * (i - start);
|
||||||
|
} else if (c === 45 || (c >= 48 && c <= 57) || c === 116 || c === 102 || c === 110) {
|
||||||
|
estimate += 16;
|
||||||
|
while (i + 1 < bytes.length) {
|
||||||
|
const next = bytes[i + 1]!;
|
||||||
|
if (next === 9 || next === 10 || next === 13 || next === 32 || next === 44 || next === 93 || next === 125)
|
||||||
|
break;
|
||||||
|
i++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return estimate * 2;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Immutable regular files only. Fixed allocation plus an extra byte catches
|
||||||
|
* growth; readFile() would allocate before the admission check can intervene. */
|
||||||
|
export async function readCandidateMetadata(
|
||||||
|
path: string,
|
||||||
|
scope: CandidateMetadataScope,
|
||||||
|
limit: number,
|
||||||
|
): Promise<{ bytes: Uint8Array; releaseInput: () => void; releaseTree: () => void }> {
|
||||||
|
const handle = await open(path, constants.O_RDONLY | constants.O_NOFOLLOW | constants.O_NONBLOCK);
|
||||||
|
let releaseInput: (() => void) | undefined;
|
||||||
|
try {
|
||||||
|
const stat = await handle.stat();
|
||||||
|
if (!stat.isFile() || !Number.isSafeInteger(stat.size) || stat.size > limit)
|
||||||
|
throw Error("CANDIDATE_METADATA_FILE_LIMIT");
|
||||||
|
// Reserve the input buffer and UTF-16 decoding before allocating either.
|
||||||
|
releaseInput = scope.reserve((stat.size + 1) * 3);
|
||||||
|
const bytes = Buffer.alloc(stat.size + 1);
|
||||||
|
let offset = 0;
|
||||||
|
while (offset < bytes.length) {
|
||||||
|
const read = await handle.read(bytes, offset, bytes.length - offset, offset);
|
||||||
|
if (!read.bytesRead) break;
|
||||||
|
offset += read.bytesRead;
|
||||||
|
}
|
||||||
|
if (offset !== stat.size) throw Error("CANDIDATE_METADATA_CHANGED");
|
||||||
|
const content = bytes.subarray(0, offset);
|
||||||
|
// No JSON.parse/decoded tree exists until its shape-based charge succeeds.
|
||||||
|
const releaseTree = scope.reserve(jsonAllocation(content));
|
||||||
|
return { bytes: content, releaseInput, releaseTree };
|
||||||
|
} catch (error) {
|
||||||
|
releaseInput?.();
|
||||||
|
throw error;
|
||||||
|
} finally {
|
||||||
|
await handle.close();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -137,8 +137,9 @@ export function inspectJavaScriptSurface(source: string, checkedSDKImports: read
|
|||||||
}
|
}
|
||||||
|
|
||||||
/** Derived metadata only. Browser/server portability and available targets say
|
/** Derived metadata only. Browser/server portability and available targets say
|
||||||
* nothing about sandbox eligibility. No existing package artifact has a
|
* nothing about sandbox eligibility. Build reports have no platform approval
|
||||||
* qualified restricted runtime, so it conservatively requires its VM. */
|
* catalog, so they conservatively require VM placement. A host can override
|
||||||
|
* placement only for independently reviewed, exact restricted-code approvals. */
|
||||||
export async function reportExecutionPlacement(
|
export async function reportExecutionPlacement(
|
||||||
plan: ExecutionPlan,
|
plan: ExecutionPlan,
|
||||||
installation: ExecutionInstallation,
|
installation: ExecutionInstallation,
|
||||||
|
|||||||
@@ -29,6 +29,8 @@ export interface PackageInvocation {
|
|||||||
/** Capability arguments/receiver use the versioned managed-reference codec. */
|
/** Capability arguments/receiver use the versioned managed-reference codec. */
|
||||||
input: unknown;
|
input: unknown;
|
||||||
receiver: unknown | null;
|
receiver: unknown | null;
|
||||||
|
/** Host-owned remaining root resources, separate from authored input. */
|
||||||
|
budget?: { root: string; depth: number; calls: number; deadlineMs: number };
|
||||||
}
|
}
|
||||||
export type InvocationReply =
|
export type InvocationReply =
|
||||||
| { abi: typeof transactionPortAbi; invocation: string; status: "returned"; output: unknown }
|
| { abi: typeof transactionPortAbi; invocation: string; status: "returned"; output: unknown }
|
||||||
|
|||||||
@@ -0,0 +1,104 @@
|
|||||||
|
import test from "node:test";
|
||||||
|
import assert from "node:assert/strict";
|
||||||
|
import { mkdtemp, writeFile, symlink, rm } from "node:fs/promises";
|
||||||
|
import { join } from "node:path";
|
||||||
|
import { tmpdir } from "node:os";
|
||||||
|
import { CandidateMetadataBudget, readCandidateMetadata } from "../src/execution-world/metadata.js";
|
||||||
|
|
||||||
|
test("concurrent candidate reservations enforce aggregate and owner limits and release exactly once", () => {
|
||||||
|
const budget = new CandidateMetadataBudget({ bytes: 1000, ownerBytes: 600, candidates: 3 });
|
||||||
|
const first = budget.acquire("a"),
|
||||||
|
second = budget.acquire("a"),
|
||||||
|
third = budget.acquire("b");
|
||||||
|
assert.throws(() => budget.acquire("c"), /CANDIDATE_METADATA_LIMIT/);
|
||||||
|
first.charge(400);
|
||||||
|
second.charge(200);
|
||||||
|
third.charge(400);
|
||||||
|
assert.throws(() => second.charge(1), /CANDIDATE_METADATA_LIMIT/);
|
||||||
|
assert.throws(() => third.charge(1), /CANDIDATE_METADATA_LIMIT/);
|
||||||
|
assert.equal(budget.snapshot().bytes, 1000);
|
||||||
|
second.release();
|
||||||
|
second.release();
|
||||||
|
assert.equal(budget.snapshot().bytes, 800);
|
||||||
|
assert.throws(() => second.charge(1), /CANDIDATE_METADATA_CLOSED/);
|
||||||
|
first.release();
|
||||||
|
third.release();
|
||||||
|
assert.deepEqual(budget.snapshot(), { bytes: 0, candidates: 0, owners: 0, limits: budget.limits });
|
||||||
|
});
|
||||||
|
|
||||||
|
test("metadata files reserve parse/index space before allocation and refuse oversized or linked inputs", async () => {
|
||||||
|
const root = await mkdtemp(join(tmpdir(), "qx-metadata-budget-"));
|
||||||
|
const budget = new CandidateMetadataBudget({ bytes: 450, ownerBytes: 450, candidates: 2 });
|
||||||
|
const scope = budget.acquire("workspace");
|
||||||
|
try {
|
||||||
|
const file = join(root, "metadata.json");
|
||||||
|
await writeFile(file, '{"ok":true}');
|
||||||
|
const input = await readCandidateMetadata(file, scope, 100);
|
||||||
|
assert.equal(new TextDecoder().decode(input.bytes), '{"ok":true}');
|
||||||
|
const withInput = scope.bytes;
|
||||||
|
input.releaseInput();
|
||||||
|
input.releaseInput();
|
||||||
|
const first = scope.bytes;
|
||||||
|
assert.equal(withInput - first, (Buffer.byteLength('{"ok":true}') + 1) * 3);
|
||||||
|
assert.ok(first > 12 * 3, "Decoded tree and derived metadata are reserved before parsing");
|
||||||
|
await assert.rejects(readCandidateMetadata(file, scope, 100), /CANDIDATE_METADATA_LIMIT/);
|
||||||
|
assert.equal(scope.bytes, first, "Rejected tree allocation releases its transient input buffer");
|
||||||
|
await assert.rejects(readCandidateMetadata(file, scope, 5), /CANDIDATE_METADATA_FILE_LIMIT/);
|
||||||
|
await symlink(file, join(root, "linked"));
|
||||||
|
await assert.rejects(readCandidateMetadata(join(root, "linked"), scope, 100), { code: "ELOOP" });
|
||||||
|
await assert.rejects(readCandidateMetadata(root, scope, 100), /CANDIDATE_METADATA_FILE_LIMIT/);
|
||||||
|
assert.equal(scope.bytes, first);
|
||||||
|
input.releaseTree();
|
||||||
|
input.releaseTree();
|
||||||
|
assert.equal(scope.bytes, 0, "Discarded validation trees can release independently of the candidate");
|
||||||
|
} finally {
|
||||||
|
scope.release();
|
||||||
|
await rm(root, { recursive: true, force: true });
|
||||||
|
}
|
||||||
|
assert.equal(budget.snapshot().bytes, 0);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("JSON structure accounting is independent of indentation and covers strings, values and dense nodes", async () => {
|
||||||
|
const root = await mkdtemp(join(tmpdir(), "qx-metadata-shape-"));
|
||||||
|
const budget = new CandidateMetadataBudget();
|
||||||
|
try {
|
||||||
|
for (const value of [{}, [null, true, false, 1, -3.5e8], { 'a"b': '雪\\"', nodes: [{}, {}, {}] }]) {
|
||||||
|
const measured = [];
|
||||||
|
for (const spaces of [0, 4]) {
|
||||||
|
const file = join(root, "metadata.json"),
|
||||||
|
text = JSON.stringify(value, null, spaces);
|
||||||
|
await writeFile(file, text);
|
||||||
|
const scope = budget.acquire("test");
|
||||||
|
try {
|
||||||
|
const input = await readCandidateMetadata(file, scope, 10000);
|
||||||
|
assert.deepEqual(JSON.parse(new TextDecoder().decode(input.bytes)), value);
|
||||||
|
input.releaseInput();
|
||||||
|
measured.push(scope.bytes);
|
||||||
|
} finally {
|
||||||
|
scope.release();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
assert.equal(measured[0], measured[1], "Whitespace changes input storage, not the allocated JSON shape");
|
||||||
|
assert.ok(measured[0] >= 128);
|
||||||
|
}
|
||||||
|
} finally {
|
||||||
|
await rm(root, { recursive: true, force: true });
|
||||||
|
}
|
||||||
|
assert.equal(budget.snapshot().bytes, 0);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("transient leases release exactly once, including after their parent closes", () => {
|
||||||
|
const budget = new CandidateMetadataBudget({ bytes: 1000, ownerBytes: 600, candidates: 3 });
|
||||||
|
const scope = budget.acquire("a");
|
||||||
|
scope.charge(200);
|
||||||
|
const release = scope.reserve(300);
|
||||||
|
assert.throws(() => scope.reserve(101), /CANDIDATE_METADATA_LIMIT/);
|
||||||
|
release();
|
||||||
|
release();
|
||||||
|
assert.equal(scope.bytes, 200);
|
||||||
|
const afterClose = scope.reserve(100);
|
||||||
|
scope.release();
|
||||||
|
afterClose();
|
||||||
|
assert.equal(scope.bytes, 0);
|
||||||
|
assert.equal(budget.snapshot().bytes, 0);
|
||||||
|
});
|
||||||
Reference in New Issue
Block a user