@smthrs/plan 0.0.0-stage → 1.0.0-rc.3

package/src/test/PlanFixtures.ts

@@ -0,0 +1,76 @@
+/**
+ * Graph fixtures shared by every suite that needs a compiled plan.
+ *
+ * These live outside a `*.test.ts` file on purpose. `PlanStore.test.ts` used to
+ * import `compile` and `draft` from `Plan.test.ts`, and importing a test module
+ * REGISTERS ITS SUITES in the importer: every case in `Plan.test.ts` ran a
+ * second time under `PlanStore.test.ts`, including the 10,000-node chain, which
+ * is the most expensive case in the package. CI reported it as
+ * `PlanStore.test.ts > Plan.compile > compiles a 10,000-node Ref chain` and it
+ * timed out there, on a slower runner, for work `PlanStore` never asked for.
+ *
+ * They ship from `src/test` rather than `test/` because `@smthrs/plan-store`
+ * drives the same fixtures against the persisted form, the way
+ * `@smthrs/database` ships `test/TestDatabase` and `@smthrs/engine-store`
+ * ships `test/TestStores`. One definition, two packages.
+ *
+ * @since 0.1.0
+ */
+
+import * as KeyMaterial from "../KeyMaterial.ts"
+import * as Plan from "../Plan.ts"
+
+/**
+ * A hard-boundary effect declaration over plain path lists.
+ *
+ * @category models
+ * @since 0.1.0
+ */
+export const effects = (
+  reads: ReadonlyArray<string>,
+  writes: ReadonlyArray<string>
+): Plan.NodeEffects => ({ reads, writes, boundaryMode: "hard" })
+
+/**
+ * A sealed node draft whose body defaults to `{ action: id }`.
+ *
+ * @category constructors
+ * @since 0.1.0
+ */
+export const draft = (
+  id: string,
+  options: {
+    readonly body?: unknown
+    readonly inputs?: ReadonlyArray<KeyMaterial.InputRef>
+    readonly reads?: ReadonlyArray<string>
+    readonly writes?: ReadonlyArray<string>
+    readonly removes?: ReadonlyArray<string>
+  } & Omit<Plan.NodeDraft, "id" | "material" | "effects"> = {}
+): Plan.NodeDraft => ({
+  id,
+  material: {
+    version: KeyMaterial.version,
+    kind: "sealed",
+    body: options.body ?? { action: id },
+    inputs: options.inputs ?? [],
+    layers: [],
+    capabilities: []
+  },
+  effects: {
+    ...effects(options.reads ?? [], options.writes ?? []),
+    ...(options.removes === undefined ? {} : { removes: options.removes })
+  },
+  ...(options.kind === undefined ? {} : { kind: options.kind }),
+  ...(options.priority === undefined ? {} : { priority: options.priority }),
+  ...(options.conflictStrategy === undefined ? {} : { conflictStrategy: options.conflictStrategy }),
+  ...(options.runtimeStrategy === undefined ? {} : { runtimeStrategy: options.runtimeStrategy })
+})
+
+/**
+ * Compiles drafts into a plan under the `example/Build` flow.
+ *
+ * @category constructors
+ * @since 0.1.0
+ */
+export const compile = (nodes: ReadonlyArray<Plan.NodeDraft>, planId = "plan-1") =>
+  Plan.compile({ planId, flow: "example/Build", nodes })