logicsrc/packages/opencontext/src/examples.test.ts
Anthony Ettinger 3ab8a4b38b
Add the LogicSRC OpenContext specification (#132)
* Add the LogicSRC OpenContext specification

OpenContext is an open specification for durable, portable, permissioned,
provenance-aware context shared between humans and AI agents. It defines how
organizational knowledge is described, authorized, versioned, resolved,
audited, and handed between replaceable workers without losing institutional
state.

Follows the OpenPRD/OpenOntology pattern already in the repo: self-contained
JSON Schemas in @logicsrc/schemas, a reference implementation package, CLI
subcommands, docs, examples, and an OpenPRD record.

Schemas (8, all self-contained so a third party can fetch one file and
validate against it with no further resolution):
  manifest, object, bundle, role, provenance, decision, diagnostic,
  audit-event — registered in @logicsrc/validators and schemas:validate.

Reference implementation (@logicsrc/opencontext):
  loader with upward manifest discovery, the full resolution pipeline,
  authority/supersession, permissions, redaction, lifecycle, provenance,
  deterministic digests, doctor, search, graph, history/diff, guarded writes,
  audit events, and file/http/git/sqlite adapters.

CLI: all 15 specified commands, as a standalone `opencontext` binary and as
`logicsrc context`, sharing one implementation so the two cannot drift.

Design decisions worth noting:

- Supersession is declared, never inferred from version numbers. Inferring it
  would hide the governance failure it represents and make
  multiple-active-versions and duplicate-canonical impossible to detect.

- The bundle digest identifies the resolved context, not the moment it was
  computed, so generated_at/bundle_id/digest/as_of are excluded while objects,
  lifecycle states, exclusions and warnings are covered. That is what lets a
  decision record cite exactly the context that produced it.

- A role's own max_classification beats an inherited one, so a ceiling on a
  shared base role cannot silently cap a role deliberately granted more;
  requesting several roles at once still takes the lowest, so combining roles
  never escalates.

- Scope wildcards match whole dotted segments only. A trailing .* covers a
  subtree; an interior * matches exactly one segment. Substring matching here
  would be an access-control bug.

- --include narrows an existing scope and is applied after it, never merged
  into it, so a request can never widen what a role holds.

Verified: 226 tests across core primitives, permissions/redaction, the
resolution pipeline, security, the published conformance fixtures (13 valid,
35 invalid, 8 resolution scenarios), project behaviour, and the five shipped
examples — which are held to --strict and a 100% health score. Benchmarks meet
every published budget (resolve 1,000 objects in ~33ms against a 2s target).

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

* Point install docs at @logicsrc/opencontext; record the npm name collision

The unscoped `opencontext` name is already published on npm by an unrelated
third party (federicodeponte/opencontext, 2.0.0), so `npx opencontext` would
install a stranger's package. Docs now use `npx @logicsrc/opencontext`; the bin
stays named `opencontext` so the command reads as the PRD specifies once
installed.

Recorded in PRD 0003 as a blocker to resolve before any publication, along with
the fact that no @logicsrc spec package has ever been published, so there is no
existing release path to slot into.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

* Advance the logicsrc-mcp next-PRD-id assertion to 0004

standards.test.ts asserts prd_next_id against the live prd/ directory, so
adding PRD 0003 makes the next free id 0004. The test's own comment
anticipates this: "advances with every PRD added".

Caught by CI, not locally — the earlier verification ran per-package tests for
the packages this branch touches, and logicsrc-mcp is coupled to the PRD
directory without importing from it.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-09 11:46:11 -07:00

161 lines
6.8 KiB
TypeScript

/**
* Every shipped example must pass conformance.
*
* Examples are documentation that executes, which makes them the first thing to
* rot silently. Holding them to `--strict` and a 100% health score in CI means
* a change to the resolver that quietly degrades a published example fails the
* build rather than shipping.
*/
import { describe, expect, it } from "vitest";
import { readdirSync } from "node:fs";
import { dirname, join } from "node:path";
import { fileURLToPath } from "node:url";
import { OpenContext } from "./index.js";
import { hasFailure } from "./validate.js";
import { renderBundle } from "./bundle.js";
const EXAMPLES = join(dirname(fileURLToPath(import.meta.url)), "../../../examples/opencontext");
const names = readdirSync(EXAMPLES, { withFileTypes: true })
.filter((entry) => entry.isDirectory())
.map((entry) => entry.name)
.sort();
describe("shipped examples", () => {
it("ships the five examples the specification requires", () => {
expect(names).toEqual([
"engineering-team",
"minimal",
"multi-agent-company",
"startup",
"support-agent"
]);
});
it.each(names)("%s passes validate --strict", async (name) => {
const oc = await OpenContext.load(join(EXAMPLES, name));
const findings = oc.validate({ strict: true });
expect(findings, JSON.stringify(findings, null, 2)).toEqual([]);
expect(hasFailure(findings, "warning")).toBe(false);
});
it.each(names)("%s scores 100 on doctor", async (name) => {
const oc = await OpenContext.load(join(EXAMPLES, name));
const report = oc.doctor();
expect(report.ok).toBe(true);
expect(report.score).toBe(100);
});
it.each(names)("%s resolves deterministically in every required format", async (name) => {
const dir = join(EXAMPLES, name);
const role = Object.keys((await OpenContext.load(dir)).manifest.roles ?? {})[0]!;
const first = (await OpenContext.load(dir)).bundle({ role });
const second = (await OpenContext.load(dir)).bundle({ role });
expect(second.digest).toBe(first.digest);
expect(first.objects.length).toBeGreaterThan(0);
for (const format of ["json", "yaml", "markdown"] as const) {
expect(renderBundle(first, format).length).toBeGreaterThan(0);
}
});
});
describe("multi-agent-company: one repository, five different bundles", () => {
const AGENTS = ["sales-agent", "support-agent", "dev-agent", "finance-agent", "ops-agent"];
it("gives every agent a distinct bundle", async () => {
const oc = await OpenContext.load(join(EXAMPLES, "multi-agent-company"));
const digests = AGENTS.map((agent) => oc.bundle({ agent }).digest);
expect(new Set(digests).size).toBe(AGENTS.length);
});
it("never leaks a card number to anyone, including finance", async () => {
// Repository-wide redaction applies above every role.
const oc = await OpenContext.load(join(EXAMPLES, "multi-agent-company"));
for (const agent of AGENTS) {
expect(JSON.stringify(oc.bundle({ agent }))).not.toContain("4111111111111111");
}
});
it("confines payroll to finance", async () => {
const oc = await OpenContext.load(join(EXAMPLES, "multi-agent-company"));
for (const agent of AGENTS) {
const ids = oc.bundle({ agent }).objects.map((object) => object.id);
expect(ids.includes("policies.payroll")).toBe(agent === "finance-agent");
}
});
it("keeps an inferred churn score out of the sales conversation", async () => {
// sales includes customers.*, which matches the churn score; the interior
// wildcard exclusion is what keeps a model's opinion away from a customer.
const oc = await OpenContext.load(join(EXAMPLES, "multi-agent-company"));
const sales = oc.bundle({ agent: "sales-agent" }).objects.map((object) => object.id);
expect(sales).toContain("customers.acme");
expect(sales).not.toContain("customers.acme.churn-risk");
});
});
describe("support-agent: the trust boundary", () => {
it("carries the ticket as untrusted and delimits it in the prompt", async () => {
const oc = await OpenContext.load(join(EXAMPLES, "support-agent"));
const bundle = oc.bundle({ agent: "support-agent" });
const ticket = bundle.objects.find((object) => object.id === "operations.ticket-4821");
expect(ticket?.trust).toBe("untrusted");
const markdown = renderBundle(bundle, "markdown");
expect(markdown).toContain("<untrusted-content>");
// The injected instruction is present as data, inside the fence — the point
// is that it is quarantined and labelled, not that it was scrubbed.
expect(markdown).toContain("ignore your");
const fenced = markdown.slice(markdown.indexOf("<untrusted-content>"), markdown.indexOf("</untrusted-content>"));
expect(fenced).toContain("ignore your");
});
it("redacts PII from a record the agent is entitled to read", async () => {
const oc = await OpenContext.load(join(EXAMPLES, "support-agent"));
const bundle = oc.bundle({ agent: "support-agent" });
const raw = JSON.stringify(bundle);
const customer = bundle.objects.find((object) => object.id === "customers.acme");
expect(customer).toBeDefined();
expect(customer?.redacted).toEqual(["ssn", "payment.card", "contacts[*].email"]);
expect(raw).not.toContain("000-00-0000");
expect(raw).not.toContain("4111111111111111");
expect(raw).not.toContain("dana@acme.example");
});
it("excludes the confidential margin policy that policies.* would otherwise match", async () => {
const oc = await OpenContext.load(join(EXAMPLES, "support-agent"));
const result = oc.resolve({ agent: "support-agent", explain: true });
expect(result.bundle.objects.map((object) => object.id)).not.toContain("policies.internal.margins");
expect(result.excluded.some((item) => item.id === "policies.internal.margins" && item.reason === "scope-exclusion")).toBe(true);
expect(JSON.stringify(result.bundle)).not.toContain("62%");
});
});
describe("engineering-team: supersession as history", () => {
it("resolves only the current decision by default and both with history", async () => {
const oc = await OpenContext.load(join(EXAMPLES, "engineering-team"));
const current = oc.bundle({ role: "engineering" }).objects.map((object) => object.id);
expect(current).toContain("decisions.2026-08-01-postgres-ha");
expect(current).not.toContain("decisions.2026-02-01-postgres");
const historical = oc
.bundle({ role: "engineering", includeHistorical: true })
.objects.map((object) => object.id);
expect(historical).toContain("decisions.2026-02-01-postgres");
});
it("reports the supersession chain in history", async () => {
const oc = await OpenContext.load(join(EXAMPLES, "engineering-team"));
const history = await oc.history("decisions.2026-08-01-postgres-ha");
expect(history.entries.map((entry) => entry.id)).toContain("decisions.2026-02-01-postgres");
});
});