@sanity/workflow-engine-test 0.3.1 → 0.4.0

package/dist/index.d.cts

@@ -51,7 +51,7 @@ export declare type Bench = BenchState &
 
 declare type BenchCompleteEffectArgs = Omit<
   CompleteEffectArgs,
-  "client" | "tags" | "workflowResource" | "access"
+  "client" | "tag" | "workflowResource" | "access"
 > & {
   access?: WorkflowAccess;
   /** Shortcut for `access.actor`. */
@@ -60,7 +60,7 @@ declare type BenchCompleteEffectArgs = Omit<
 
 declare type BenchEvaluateArgs = Omit<
   EvaluateArgs,
-  "client" | "tags" | "workflowResource" | "access"
+  "client" | "tag" | "workflowResource" | "access"
 > & {
   access?: WorkflowAccess;
   /** Shortcut for `access.actor`. */
@@ -71,7 +71,7 @@ declare type BenchEvaluateArgs = Omit<
 
 declare type BenchFireActionArgs = Omit<
   FireActionArgs,
-  "client" | "tags" | "workflowResource" | "access"
+  "client" | "tag" | "workflowResource" | "access"
 > & {
   access?: WorkflowAccess;
   /** Shortcut for `access.actor`. */
@@ -82,7 +82,7 @@ declare type BenchFireActionArgs = Omit<
 
 declare type BenchStartInstanceArgs = Omit<
   StartInstanceArgs,
-  "client" | "tags" | "workflowResource" | "access"
+  "client" | "tag" | "workflowResource" | "access"
 > & {
   access?: WorkflowAccess;
   /** Shortcut for `access.actor`. */
@@ -129,7 +129,7 @@ declare interface BenchState {
 
 declare type BenchTickArgs = Omit<
   OperationArgs,
-  "client" | "tags" | "workflowResource" | "access"
+  "client" | "tag" | "workflowResource" | "access"
 > & {
   access?: WorkflowAccess;
   /** Shortcut for `access.actor`. */
@@ -158,7 +158,7 @@ declare interface CallRecord {
 
 /**
  * Create a fresh bench. By default the bench is fully isolated — two
- * `createBench()` calls have no shared state. Pass `client` + `tags`
+ * `createBench()` calls have no shared state. Pass `client` + `tag`
  * to two benches to share a store and exercise tag scoping.
  */
 export declare function createBench(options?: CreateBenchOptions): Bench;
@@ -202,18 +202,19 @@ export declare interface CreateBenchOptions {
    */
   accessControl?: TestClientAccessControl;
   /**
-   * Engine-scope tags. Defaults to `["bench"]`. Pass disjoint sets to two
-   * benches sharing a `client` to assert multi-tenant isolation; pass an
-   * overlapping set to assert visibility through a shared tag.
+   * Engine-scope environment partition. Defaults to `"bench"`. Pass
+   * different tags to two benches sharing a `client` to assert partition
+   * isolation; pass the same tag to assert visibility through a shared
+   * partition.
    *
-   * Tags must be ASCII lowercase + digits + dashes, no leading dash,
+   * The tag must be ASCII lowercase + digits + dashes, no leading dash,
    * no dots — validated at construction.
    */
-  tags?: string[];
+  tag?: string;
   /**
    * Shared TestClient. If omitted, the bench creates its own — two
    * benches without a shared client are completely isolated, regardless
-   * of tags. Pass the same client to two benches to test tag-scoped
+   * of tag. Pass the same client to two benches to test tag-scoped
    * visibility across a shared store.
    */
   client?: TestClient;
@@ -263,10 +264,10 @@ declare interface DocumentBody {
 
 declare type DocumentValuePermission = "create" | "read" | "update";
 
-/** Engine-call wrappers that inject the bench-owned client + tags + access. */
+/** Engine-call wrappers that inject the bench-owned client + tag + access. */
 declare type EngineWrappers = {
   deployDefinitions: (
-    args: Omit<DeployDefinitionsArgs, "client" | "tags" | "workflowResource">,
+    args: Omit<DeployDefinitionsArgs, "client" | "tag" | "workflowResource">,
   ) => Promise<DeployDefinitionsResult>;
   startInstance: (args: BenchStartInstanceArgs) => Promise<WorkflowInstance>;
   fireAction: (args: BenchFireActionArgs) => Promise<DispatchResult>;
@@ -500,10 +501,9 @@ declare type Perspective = "raw" | "published" | "drafts" | string[];
 declare type QueryHelpers = {
   /**
    * Run an arbitrary GROQ query through `workflow.query`. The query MUST
-   * filter on the auto-injected `$engineTags` param (e.g.
-   * `*[... && count(tags[@ in $engineTags]) > 0]`) or it throws — the
-   * engine refuses to run a query that could read across tenant tags.
-   * Caller is responsible for narrowing the result.
+   * filter on the auto-injected `$tag` param (e.g. `*[... && tag == $tag]`)
+   * or it throws — the engine refuses to run a query that could read
+   * across partitions. Caller is responsible for narrowing the result.
    */
   query: <T = unknown>(
     groq: string,

package/dist/index.d.ts

@@ -51,7 +51,7 @@ export declare type Bench = BenchState &
 
 declare type BenchCompleteEffectArgs = Omit<
   CompleteEffectArgs,
-  "client" | "tags" | "workflowResource" | "access"
+  "client" | "tag" | "workflowResource" | "access"
 > & {
   access?: WorkflowAccess;
   /** Shortcut for `access.actor`. */
@@ -60,7 +60,7 @@ declare type BenchCompleteEffectArgs = Omit<
 
 declare type BenchEvaluateArgs = Omit<
   EvaluateArgs,
-  "client" | "tags" | "workflowResource" | "access"
+  "client" | "tag" | "workflowResource" | "access"
 > & {
   access?: WorkflowAccess;
   /** Shortcut for `access.actor`. */
@@ -71,7 +71,7 @@ declare type BenchEvaluateArgs = Omit<
 
 declare type BenchFireActionArgs = Omit<
   FireActionArgs,
-  "client" | "tags" | "workflowResource" | "access"
+  "client" | "tag" | "workflowResource" | "access"
 > & {
   access?: WorkflowAccess;
   /** Shortcut for `access.actor`. */
@@ -82,7 +82,7 @@ declare type BenchFireActionArgs = Omit<
 
 declare type BenchStartInstanceArgs = Omit<
   StartInstanceArgs,
-  "client" | "tags" | "workflowResource" | "access"
+  "client" | "tag" | "workflowResource" | "access"
 > & {
   access?: WorkflowAccess;
   /** Shortcut for `access.actor`. */
@@ -129,7 +129,7 @@ declare interface BenchState {
 
 declare type BenchTickArgs = Omit<
   OperationArgs,
-  "client" | "tags" | "workflowResource" | "access"
+  "client" | "tag" | "workflowResource" | "access"
 > & {
   access?: WorkflowAccess;
   /** Shortcut for `access.actor`. */
@@ -158,7 +158,7 @@ declare interface CallRecord {
 
 /**
  * Create a fresh bench. By default the bench is fully isolated — two
- * `createBench()` calls have no shared state. Pass `client` + `tags`
+ * `createBench()` calls have no shared state. Pass `client` + `tag`
  * to two benches to share a store and exercise tag scoping.
  */
 export declare function createBench(options?: CreateBenchOptions): Bench;
@@ -202,18 +202,19 @@ export declare interface CreateBenchOptions {
    */
   accessControl?: TestClientAccessControl;
   /**
-   * Engine-scope tags. Defaults to `["bench"]`. Pass disjoint sets to two
-   * benches sharing a `client` to assert multi-tenant isolation; pass an
-   * overlapping set to assert visibility through a shared tag.
+   * Engine-scope environment partition. Defaults to `"bench"`. Pass
+   * different tags to two benches sharing a `client` to assert partition
+   * isolation; pass the same tag to assert visibility through a shared
+   * partition.
    *
-   * Tags must be ASCII lowercase + digits + dashes, no leading dash,
+   * The tag must be ASCII lowercase + digits + dashes, no leading dash,
    * no dots — validated at construction.
    */
-  tags?: string[];
+  tag?: string;
   /**
    * Shared TestClient. If omitted, the bench creates its own — two
    * benches without a shared client are completely isolated, regardless
-   * of tags. Pass the same client to two benches to test tag-scoped
+   * of tag. Pass the same client to two benches to test tag-scoped
    * visibility across a shared store.
    */
   client?: TestClient;
@@ -263,10 +264,10 @@ declare interface DocumentBody {
 
 declare type DocumentValuePermission = "create" | "read" | "update";
 
-/** Engine-call wrappers that inject the bench-owned client + tags + access. */
+/** Engine-call wrappers that inject the bench-owned client + tag + access. */
 declare type EngineWrappers = {
   deployDefinitions: (
-    args: Omit<DeployDefinitionsArgs, "client" | "tags" | "workflowResource">,
+    args: Omit<DeployDefinitionsArgs, "client" | "tag" | "workflowResource">,
   ) => Promise<DeployDefinitionsResult>;
   startInstance: (args: BenchStartInstanceArgs) => Promise<WorkflowInstance>;
   fireAction: (args: BenchFireActionArgs) => Promise<DispatchResult>;
@@ -500,10 +501,9 @@ declare type Perspective = "raw" | "published" | "drafts" | string[];
 declare type QueryHelpers = {
   /**
    * Run an arbitrary GROQ query through `workflow.query`. The query MUST
-   * filter on the auto-injected `$engineTags` param (e.g.
-   * `*[... && count(tags[@ in $engineTags]) > 0]`) or it throws — the
-   * engine refuses to run a query that could read across tenant tags.
-   * Caller is responsible for narrowing the result.
+   * filter on the auto-injected `$tag` param (e.g. `*[... && tag == $tag]`)
+   * or it throws — the engine refuses to run a query that could read
+   * across partitions. Caller is responsible for narrowing the result.
    */
   query: <T = unknown>(
     groq: string,

package/dist/index.js

@@ -1,4 +1,4 @@
-import { guardsForResource, denyingGuards, MutationGuardDeniedError, workflow, WORKFLOW_INSTANCE_TYPE, tagScopeFilter, effectsContextMap, validateTags } from "@sanity/workflow-engine";
+import { guardsForResource, denyingGuards, MutationGuardDeniedError, workflow, WORKFLOW_INSTANCE_TYPE, tagScopeFilter, effectsContextMap, validateTag } from "@sanity/workflow-engine";
 import require$$0 from "tty";
 import require$$1 from "util";
 function escapeRegExp(string2) {
@@ -5132,10 +5132,10 @@ function createQueryHelpers(scope) {
   };
 }
 function createReadHelpers(scope) {
-  const { client, tags } = scope, intersectsTags = (docTags) => docTags !== void 0 && tags.some((t) => docTags.includes(t)), getInstance = async (instanceId) => {
+  const { client, tag } = scope, getInstance = async (instanceId) => {
     const doc = await client.getDocument(instanceId);
     if (!doc) throw new Error(`Workflow instance ${instanceId} not found`);
-    if (!intersectsTags(doc.tags))
+    if (doc.tag !== tag)
       throw new Error(`Workflow instance ${instanceId} not visible to this engine (tag mismatch)`);
     return doc;
   };
@@ -5164,7 +5164,7 @@ function createReadHelpers(scope) {
         `*[_type == "${WORKFLOW_INSTANCE_TYPE}"
           && state[_type == "doc.ref" && name == $entry][0].value.id == $ref
           && ${tagScopeFilter()}] | order(startedAt asc)`,
-        { ref: subjectRef, entry: entryName, engineTags: tags }
+        { ref: subjectRef, entry: entryName, tag }
       )
     ),
     instancesByStage: async (workflowName, stage, queryOptions) => {
@@ -5172,16 +5172,16 @@ function createReadHelpers(scope) {
       return client.fetch(
         `*[_type == "${WORKFLOW_INSTANCE_TYPE}" && definition == $wf && currentStage == $stage && ${tagScopeFilter()}${filter}]
           | order(startedAt asc)`,
-        { wf: workflowName, stage, engineTags: tags }
+        { wf: workflowName, stage, tag }
       );
     },
     snapshot: () => client.snapshot()
   };
 }
 function createBench(options = {}) {
-  const tags = options.tags ?? ["bench"];
-  validateTags(tags);
-  const workflowResource = options.workflowResource ?? DEFAULT_WORKFLOW_RESOURCE, client = resolveBenchClient(options), scope = { client, tags, workflowResource }, access = resolveBenchAccess(options);
+  const tag = options.tag ?? "bench";
+  validateTag(tag);
+  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();
   return {