feat: isNewerMajor + store write-refusal backstop (F5 SLICE-2, INV-16, #14)
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
@@ -116,6 +116,14 @@ export function emptyArtifact(docPath: string): Artifact {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* INV-16 fail-safe: schemaVersion IS the major. A sidecar from a future major
|
||||||
|
* is render-only — a conforming writer never rewrites what it can't fully read.
|
||||||
|
*/
|
||||||
|
export function isNewerMajor(a: Pick<Artifact, "schemaVersion">): boolean {
|
||||||
|
return a.schemaVersion > SCHEMA_VERSION;
|
||||||
|
}
|
||||||
|
|
||||||
/** Stable, generated id (spec §6.3). */
|
/** Stable, generated id (spec §6.3). */
|
||||||
export function newId(prefix: string): string {
|
export function newId(prefix: string): string {
|
||||||
return `${prefix}_${randomUUID()}`;
|
return `${prefix}_${randomUUID()}`;
|
||||||
|
|||||||
+8
-1
@@ -8,7 +8,7 @@
|
|||||||
*/
|
*/
|
||||||
import * as fs from "node:fs";
|
import * as fs from "node:fs";
|
||||||
import * as path from "node:path";
|
import * as path from "node:path";
|
||||||
import { emptyArtifact, serializeArtifact, type Artifact } from "./model";
|
import { SCHEMA_VERSION, emptyArtifact, isNewerMajor, serializeArtifact, type Artifact } from "./model";
|
||||||
|
|
||||||
export class CoauthorStore {
|
export class CoauthorStore {
|
||||||
/**
|
/**
|
||||||
@@ -67,6 +67,13 @@ export class CoauthorStore {
|
|||||||
*/
|
*/
|
||||||
update(docPath: string, mutate: (artifact: Artifact) => void): Artifact {
|
update(docPath: string, mutate: (artifact: Artifact) => void): Artifact {
|
||||||
const artifact = this.load(docPath) ?? emptyArtifact(docPath);
|
const artifact = this.load(docPath) ?? emptyArtifact(docPath);
|
||||||
|
if (isNewerMajor(artifact)) {
|
||||||
|
// INV-16 backstop: the controllers gate first (VersionGuard); this throw
|
||||||
|
// guarantees no missed write path can ever destroy a newer rung's data.
|
||||||
|
throw new Error(
|
||||||
|
`refusing to write ${docPath}: sidecar schemaVersion ${artifact.schemaVersion} > supported ${SCHEMA_VERSION} (INV-16)`,
|
||||||
|
);
|
||||||
|
}
|
||||||
mutate(artifact);
|
mutate(artifact);
|
||||||
const referenced = new Set<string>([
|
const referenced = new Set<string>([
|
||||||
...artifact.threads.map((t) => t.anchorId),
|
...artifact.threads.map((t) => t.anchorId),
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ import { describe, it, expect } from "vitest";
|
|||||||
import {
|
import {
|
||||||
SCHEMA_VERSION,
|
SCHEMA_VERSION,
|
||||||
emptyArtifact,
|
emptyArtifact,
|
||||||
|
isNewerMajor,
|
||||||
serializeArtifact,
|
serializeArtifact,
|
||||||
type Artifact,
|
type Artifact,
|
||||||
} from "../src/model";
|
} from "../src/model";
|
||||||
@@ -103,6 +104,13 @@ describe("cross-rung identity (F5 SLICE-2)", () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe("isNewerMajor (F5 SLICE-2, INV-16)", () => {
|
||||||
|
it("is false for v1 and true for a newer major", () => {
|
||||||
|
expect(isNewerMajor(emptyArtifact("d.md"))).toBe(false);
|
||||||
|
expect(isNewerMajor({ schemaVersion: 2 })).toBe(true);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
describe("unknown-field preservation (F5 SLICE-2, INV-15)", () => {
|
describe("unknown-field preservation (F5 SLICE-2, INV-15)", () => {
|
||||||
it("a rewrite preserves unknown fields at every level, after known keys, sorted", () => {
|
it("a rewrite preserves unknown fields at every level, after known keys, sorted", () => {
|
||||||
const foreign = {
|
const foreign = {
|
||||||
|
|||||||
@@ -107,3 +107,20 @@ describe("CoauthorStore", () => {
|
|||||||
expect(store.consumeSelfWrite(p)).toBe(false);
|
expect(store.consumeSelfWrite(p)).toBe(false);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe("newer-major write refusal (F5 SLICE-2, INV-16 backstop)", () => {
|
||||||
|
it("update REFUSES to write a sidecar from a newer major, leaving bytes untouched", () => {
|
||||||
|
const store = new CoauthorStore(root);
|
||||||
|
const p = store.sidecarPath("docs/v2.md");
|
||||||
|
fs.mkdirSync(path.dirname(p), { recursive: true });
|
||||||
|
const v2 = { ...emptyArtifact("docs/v2.md"), schemaVersion: 2 };
|
||||||
|
fs.writeFileSync(p, serializeArtifact(v2), "utf8");
|
||||||
|
const before = fs.readFileSync(p, "utf8");
|
||||||
|
expect(() =>
|
||||||
|
store.update("docs/v2.md", (a) => {
|
||||||
|
a.threads = [];
|
||||||
|
}),
|
||||||
|
).toThrow(/INV-16/);
|
||||||
|
expect(fs.readFileSync(p, "utf8")).toBe(before);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|||||||
Reference in New Issue
Block a user