@sanity/workflow-engine-test 0.7.0 → 0.9.0

package/README.md

@@ -17,19 +17,24 @@ npm install -D @sanity/workflow-engine-test
 
 A workflow stage can deploy **mutation guards** — `temp.system.guard` documents
 that lock the documents it governs while the stage is active, and lift when it
-exits. There are two distinct things you test, and the bench gives you a helper
-for each:
-
-- **Write-time enforcement** — `bench.editDocument(id, patch)` writes through the
-  bench client, which **simulates the lake's server-side guard rejection**: a
-  write a deployed guard denies throws `MutationGuardDeniedError`. In production
-  the lake enforces this for _any_ client; the bench reproduces it on the
+exits. The lake does not enforce this doc type yet: in production, guard
+enforcement is the engine's own **optimistic** evaluation (advisory verdicts
+and engine-side write denials), and the lake ACL is the only hard boundary.
+The bench installs the _intended_ lake-side contract at its client's write
+seam, so tests exercise the rejection semantics guards are designed to have
+once the lake enforces them. There are two distinct things you test, and the
+bench gives you a helper for each:
+
+- **Write-time rejection (simulated)** — `bench.editDocument({documentId, patch})`
+  writes through the bench client, and a write a deployed guard denies throws
+  `MutationGuardDeniedError` — the rejection the lake is designed to apply to
+  _any_ client once guard enforcement ships; the bench reproduces it on the
   client it mints.
 - **Read-time preflight** — `bench.activeGuardsForDocument(id)` answers "_would_
   a write be denied right now?" _without_ writing. This is the check a UI uses
   to disable a button or show a lock ahead of time. It's a pure read over the
-  same evaluation path as enforcement, so its verdict matches what a write would
-  actually do — and it works against any client.
+  same evaluation path as the bench's write rejection, so its verdict matches
+  what a bench write would actually do — and it works against any client.
 
 `bench.listGuards()` returns the deployed guard docs for inspection.
 
@@ -40,15 +45,15 @@ const bench = createBench({documents: [{_id: 'doc-1', _type: 'article', body: 'b
 // Preflight: is the doc locked for this user right now?
 const active = await bench.activeGuardsForDocument('doc-1')
 
-// Enforcement: a guard-violating write is rejected.
-await expect(bench.editDocument('doc-1', {body: 'edited'})).rejects.toThrow(
+// Rejection: a guard-violating write throws (bench-simulated lake contract).
+await expect(bench.editDocument({documentId: 'doc-1', patch: {body: 'edited'}})).rejects.toThrow(
   MutationGuardDeniedError,
 )
 ```
 
-> To share one store across benches with enforcement intact, pass another
-> bench's already-wired client: `createBench({client: other.client, tags})`. The
-> `mutationGuard` rides along, so the second bench enforces the same locks. Only
+> To share one store across benches with the write seam intact, pass another
+> bench's already-wired client: `createBench({client: other.client, tag})`. The
+> `mutationGuard` rides along, so the second bench denies the same locks. Only
 > a bare hand-built `createTestClient()` opts out of write rejection — the
 > read-time preflight needs no wiring either way.
 

package/dist/index.cjs

@@ -5014,7 +5014,7 @@ const DEFAULT_WORKFLOW_RESOURCE = {
   type: "dataset",
   id: "test.test"
 }, ALL_ACCESS_USER = {
-  kind: "user",
+  kind: "person",
   id: "bench-user",
   roles: ["*"]
 }, WILDCARD_GRANTS = [
@@ -5073,7 +5073,11 @@ function resolveBenchAccess(options) {
     grants: options.grants ?? WILDCARD_GRANTS
   };
 }
-function accessFor(access, args, canTokenResolve) {
+function accessFor({
+  access,
+  args,
+  canTokenResolve
+}) {
   if (args.access !== void 0) return args.access;
   if (args.actor === void 0 && args.grants === void 0) return access;
   const inheritedGrants = canTokenResolve ? void 0 : access.grants, grants = args.grants ?? inheritedGrants;
@@ -5086,10 +5090,14 @@ function stripAccessShortcuts(args) {
   const rest = { ...args };
   return delete rest.access, delete rest.actor, delete rest.grants, rest;
 }
-function createEngineWrappers(scope, access, clock) {
+function createEngineWrappers({
+  scope,
+  access,
+  clock
+}) {
   const canTokenResolve = "request" in scope.client, withAccess = (args) => ({
     ...scope,
-    access: accessFor(access, args, canTokenResolve),
+    access: accessFor({ access, args, canTokenResolve }),
     clock,
     ...stripAccessShortcuts(args)
   });
@@ -5121,8 +5129,8 @@ function createGuardHelpers(client) {
         ...as ? { identity: as.id } : {}
       });
     },
-    editDocument: async (documentId, patch, editOptions) => {
-      const action = editOptions?.action ?? "update", as = editOptions?.as, writer = as ? client.withConfig({
+    editDocument: async ({ documentId, patch, action: editAction, as }) => {
+      const action = editAction ?? "update", writer = as ? client.withConfig({
         accessControl: { currentUser: { id: as.id }, grants: WILDCARD_GRANTS }
       }) : client;
       return action === "delete" ? await writer.delete(documentId) : await writer.patch(documentId).set(patch).commit(), await client.getDocument(documentId);
@@ -5133,7 +5141,11 @@ function createQueryHelpers(scope) {
   const withParams = (params) => params !== void 0 ? { params } : {};
   return {
     query: (groq, params) => workflowEngine.workflow.query({ ...scope, groq, ...withParams(params) }),
-    queryInScope: (instanceId, groq, params) => workflowEngine.workflow.queryInScope({ ...scope, instanceId, groq, ...withParams(params) })
+    queryInScope: ({
+      instanceId,
+      groq,
+      params
+    }) => workflowEngine.workflow.queryInScope({ ...scope, instanceId, groq, ...withParams(params) })
   };
 }
 function createReadHelpers(scope) {
@@ -5172,24 +5184,49 @@ function createReadHelpers(scope) {
         { ref: subjectRef, entry: entryName, tag }
       )
     ),
-    instancesByStage: async (workflowName, stage, queryOptions) => {
-      const filter = queryOptions?.openOnly ? " && completedAt == null" : "";
-      return client.fetch(
-        `*[_type == "${workflowEngine.WORKFLOW_INSTANCE_TYPE}" && definition == $wf && currentStage == $stage && ${workflowEngine.tagScopeFilter()}${filter}]
-          | order(startedAt asc)`,
-        { wf: workflowName, stage, tag }
-      );
+    instancesByStage: async ({ workflowName, stage, openOnly }) => {
+      const { query, params } = workflowEngine.instancesQuery({
+        tag,
+        filter: { definition: workflowName, stage, includeCompleted: !openOnly }
+      });
+      return client.fetch(query, params);
     },
     instancesForDocument: async (document2) => workflowEngine.workflow.instancesForDocument({ ...scope, document: document2 }),
     snapshot: () => client.snapshot()
   };
 }
+function subjectField(documentId, opts) {
+  return {
+    type: "doc.ref",
+    name: opts?.name ?? "subject",
+    value: workflowEngine.gdrRef({
+      res: DEFAULT_WORKFLOW_RESOURCE,
+      documentId,
+      type: opts?.type ?? "document"
+    })
+  };
+}
+function releaseField(releaseName, opts) {
+  return {
+    type: "release.ref",
+    name: opts?.name ?? "release",
+    value: {
+      id: workflowEngine.gdrFromResource(DEFAULT_WORKFLOW_RESOURCE, `_.releases.${releaseName}`),
+      type: "system.release",
+      releaseName
+    }
+  };
+}
 function createBench(options = {}) {
   const tag = options.tag ?? "bench";
   workflowEngine.validateTag(tag);
-  const workflowResource = options.workflowResource ?? DEFAULT_WORKFLOW_RESOURCE, client = resolveBenchClient(options), scope = { client, tag, workflowResource }, access = resolveBenchAccess(options);
+  const workflowResource = options.workflowResource ?? DEFAULT_WORKFLOW_RESOURCE, client = resolveBenchClient(options), scope = {
+    client,
+    tag,
+    workflowResource
+  }, access = resolveBenchAccess(options);
   let frozenNow = options.now !== void 0 ? assertIsoInstant(options.now) : void 0;
-  const clock = () => frozenNow ?? (/* @__PURE__ */ new Date()).toISOString();
+  const clock = () => frozenNow ?? (/* @__PURE__ */ new Date()).toISOString(), engine = createEngineWrappers({ scope, access, clock }), reads = createReadHelpers(scope);
   return {
     client,
     access,
@@ -5205,10 +5242,16 @@ function createBench(options = {}) {
         throw new Error(`bench.advance: ms must be a finite number, got ${ms2}`);
       frozenNow = new Date(Date.parse(frozenNow ?? (/* @__PURE__ */ new Date()).toISOString()) + ms2).toISOString();
     },
-    ...createEngineWrappers(scope, access, clock),
-    ...createReadHelpers(scope),
+    ...engine,
+    ...reads,
     ...createGuardHelpers(client),
-    ...createQueryHelpers(scope)
+    ...createQueryHelpers(scope),
+    completePendingEffect: async ({ effect, ...rest }) => {
+      const match = (await reads.pendingEffects(rest.instanceId)).find((e) => e.name === effect);
+      if (match === void 0)
+        throw new Error(`completePendingEffect: no pending effect named "${effect}"`);
+      return engine.completeEffect({ ...rest, effectKey: match._key });
+    }
   };
 }
 function assertIsoInstant(iso) {
@@ -5222,4 +5265,6 @@ exports.ALL_ACCESS_USER = ALL_ACCESS_USER;
 exports.DEFAULT_WORKFLOW_RESOURCE = DEFAULT_WORKFLOW_RESOURCE;
 exports.WILDCARD_GRANTS = WILDCARD_GRANTS;
 exports.createBench = createBench;
+exports.releaseField = releaseField;
+exports.subjectField = subjectField;
 //# sourceMappingURL=index.cjs.map