@sanity-labs/client-fake-for-test 0.4.0 → 0.5.0

package/dist/index.d.cts

@@ -268,6 +268,8 @@ export declare type FakeMutation =
  *
  * - `seed`, `add`, `reset`, `snapshot`, `store` — bulk-load helpers,
  *   scoped to the current dataset.
+ * - `simulateConcurrentEdit()` — force the next N revision-guarded writes
+ *   to a document to 409, for optimistic-locking retry tests.
  * - `datasets()` — lists known dataset keys in this registry.
  *
  * Methods deliberately omitted:
@@ -785,6 +787,15 @@ export declare interface TestClient {
   snapshot: () => readonly SanityDocument[];
   /** Direct store access for the current dataset. */
   store: () => TestStore;
+  /**
+   * Simulate `count` concurrent edits to `id` in the current dataset: the
+   * next `count` revision-guarded mutations (those passing `ifRevisionId`)
+   * to that document throw a 409-shaped conflict, as if another client
+   * committed between the caller's read and write. Lets a test exercise
+   * optimistic-locking retry paths deterministically, without timing or
+   * interleaving. Mutations that don't pass `ifRevisionId` are unaffected.
+   */
+  simulateConcurrentEdit: (id: string, count?: number) => void;
   /** List `(projectId, dataset)` pairs known in this registry. */
   datasets: () => {
     projectId: string;

package/dist/index.d.ts

@@ -268,6 +268,8 @@ export declare type FakeMutation =
  *
  * - `seed`, `add`, `reset`, `snapshot`, `store` — bulk-load helpers,
  *   scoped to the current dataset.
+ * - `simulateConcurrentEdit()` — force the next N revision-guarded writes
+ *   to a document to 409, for optimistic-locking retry tests.
  * - `datasets()` — lists known dataset keys in this registry.
  *
  * Methods deliberately omitted:
@@ -785,6 +787,15 @@ export declare interface TestClient {
   snapshot: () => readonly SanityDocument[];
   /** Direct store access for the current dataset. */
   store: () => TestStore;
+  /**
+   * Simulate `count` concurrent edits to `id` in the current dataset: the
+   * next `count` revision-guarded mutations (those passing `ifRevisionId`)
+   * to that document throw a 409-shaped conflict, as if another client
+   * committed between the caller's read and write. Lets a test exercise
+   * optimistic-locking retry paths deterministically, without timing or
+   * interleaving. Mutations that don't pass `ifRevisionId` are unaffected.
+   */
+  simulateConcurrentEdit: (id: string, count?: number) => void;
   /** List `(projectId, dataset)` pairs known in this registry. */
   datasets: () => {
     projectId: string;

package/dist/index.js

@@ -859,7 +859,13 @@ const RECORDED_METHODS = /* @__PURE__ */ new Set([
   return { projectId, dataset };
 };
 function createTestClient(options = {}) {
-  const defaultProjectId = options.projectId ?? DEFAULT_PROJECT_ID, defaultDataset = options.dataset ?? DEFAULT_DATASET, backend = { registry: /* @__PURE__ */ new Map(), log: [], stubs: /* @__PURE__ */ new Map(), calls: [] }, registry = backend.registry, ensureStore = (projectId, dataset) => {
+  const defaultProjectId = options.projectId ?? DEFAULT_PROJECT_ID, defaultDataset = options.dataset ?? DEFAULT_DATASET, backend = {
+    registry: /* @__PURE__ */ new Map(),
+    log: [],
+    stubs: /* @__PURE__ */ new Map(),
+    calls: [],
+    concurrentEdits: /* @__PURE__ */ new Map()
+  }, registry = backend.registry, ensureStore = (projectId, dataset) => {
     const key = registryKey(projectId, dataset);
     let store = registry.get(key);
     return store === void 0 && (store = createTestStore(), registry.set(key, store)), store;
@@ -933,7 +939,7 @@ function makeHandle(backend, projectId, dataset, accessControl, perspective, mut
     const key = registryKey(projectId, dataset);
     let s = registry.get(key);
     return s === void 0 && (s = createTestStore(), registry.set(key, s)), s;
-  })(), record = (transactionId, mutations) => {
+  })(), concurrentEditKey = (id) => registryKey(projectId, dataset) + " " + id, record = (transactionId, mutations) => {
     backend.log.push({ transactionId, projectId, dataset, mutations });
   }, writeResult = (documents, results, transactionId, opts) => formatMutationResult(
     documents,
@@ -961,6 +967,11 @@ function makeHandle(backend, projectId, dataset, accessControl, perspective, mut
     };
   }, checkRevision = (id, ifRevisionId) => {
     if (ifRevisionId === void 0) return;
+    const editKey = concurrentEditKey(id), pendingEdits = backend.concurrentEdits.get(editKey) ?? 0;
+    if (pendingEdits > 0)
+      throw backend.concurrentEdits.set(editKey, pendingEdits - 1), fakeError(
+        `ifRevisionId check failed: document "${id}" was concurrently edited (simulated via simulateConcurrentEdit) \u2014 the revision-guarded mutation lost the race; re-read and retry. (This mirrors Sanity's optimistic-locking 409.)`
+      );
     const existing = store.get(id);
     if (existing === void 0)
       throw fakeError(
@@ -1230,6 +1241,10 @@ function makeHandle(backend, projectId, dataset, accessControl, perspective, mut
     reset: () => store.reset(),
     snapshot: () => store.snapshot(),
     store: () => store,
+    simulateConcurrentEdit: (id, count = 1) => {
+      const editKey = concurrentEditKey(id);
+      backend.concurrentEdits.set(editKey, (backend.concurrentEdits.get(editKey) ?? 0) + count);
+    },
     datasets: () => [...registry.keys()].map(parseRegistryKey),
     stub: (name, handler) => {
       backend.stubs.set(name, handler);