@sanity/sdk 3.0.0-rc.1 → 3.0.0

package/src/document/reducers.test.ts

@@ -4,6 +4,7 @@ import {parse} from 'groq-js'
 import {Subject} from 'rxjs'
 import {describe, expect, it} from 'vitest'
 
+import {UNVERIFIED_REVISION_RETENTION_TIME} from './documentConstants'
 import {type DocumentEvent} from './events'
 import {type RemoteDocument} from './listen'
 import {type DocumentSet} from './processMutations'
@@ -556,6 +557,118 @@ describe('cleanupOutgoingTransaction', () => {
   })
 })
 
+describe('document state retention between ack and echo', () => {
+  const docId = 'doc1'
+  const justNow = new Date().toISOString()
+  const longAgo = new Date(Date.now() - UNVERIFIED_REVISION_RETENTION_TIME - 1000).toISOString()
+
+  const outgoing: NonNullable<SyncTransactionState['outgoing']> = {
+    transactionId: 'txnOut',
+    actions: [
+      {
+        type: 'document.edit',
+        documentId: docId,
+        documentType: 'book',
+        liveEdit: true,
+        patches: [{set: {foo: 'changed'}}],
+      },
+    ],
+    disableBatching: false,
+    batchedTransactionIds: ['txnOut'],
+    outgoingActions: [],
+    outgoingMutations: [],
+    base: {},
+    working: {},
+    previous: {},
+    previousRevs: {},
+    timestamp: justNow,
+  }
+
+  const unverifiedRevision = (timestamp: string) => ({
+    txnOut: {transactionId: 'txnOut', documentId: docId, previousRev: 'txn0', timestamp},
+  })
+
+  const stateAfterAck = (timestamp: string): SyncTransactionState => ({
+    queued: [],
+    applied: [],
+    outgoing,
+    grants,
+    documentStates: {
+      [docId]: {
+        id: docId,
+        // the UI unsubscribed before the ack arrived, so the transaction's
+        // own subscription id is the only one left
+        subscriptions: ['txnOut'],
+        local: {...exampleDoc, _id: docId, foo: 'changed'},
+        remote: {...exampleDoc, _id: docId, foo: 'old'},
+        unverifiedRevisions: unverifiedRevision(timestamp),
+        recentOwnTransactionIds: ['txnOut'],
+      },
+    },
+  })
+
+  it('keeps echo-recognition memory alive through cleanup so a late echo still labels "local"', () => {
+    // the HTTP ack arrives and cleans up the outgoing transaction's
+    // subscription. previously this deleted the whole DocumentState
+    // immediately, before the listener echo had a chance to arrive
+    const afterCleanup = cleanupOutgoingTransaction(stateAfterAck(justNow))
+    expect(afterCleanup.outgoing).toBeUndefined()
+
+    const docStateAfterCleanup = afterCleanup.documentStates[docId]
+    expect(docStateAfterCleanup).toBeDefined()
+    expect(docStateAfterCleanup?.subscriptions).toEqual([])
+    expect(docStateAfterCleanup?.unverifiedRevisions?.['txnOut']).toBeDefined()
+
+    // now the echo finally arrives over the shared listener
+    const events = new Subject<DocumentEvent>()
+    const received: DocumentEvent[] = []
+    events.subscribe((e) => received.push(e))
+
+    const echo: RemoteDocument = {
+      type: 'mutation',
+      documentId: docId,
+      document: {...exampleDoc, _id: docId, foo: 'changed'},
+      revision: 'txnOut',
+      previousRev: 'txn0',
+      timestamp: new Date().toISOString(),
+      mutations: [{patch: {id: docId, set: {foo: 'changed'}}}],
+    }
+
+    const afterEcho = applyRemoteDocument(afterCleanup, echo, events)
+
+    const remotePatchesEvents = received.filter((e) => e.type === 'remote-patches')
+    expect(remotePatchesEvents).toHaveLength(1)
+    expect(remotePatchesEvents[0]).toMatchObject({origin: 'local', transactionId: 'txnOut'})
+
+    // the echo verified the revision and nothing was subscribed any more, so
+    // the now fully-idle document state can finally be evicted
+    expect(afterEcho.documentStates[docId]).toBeUndefined()
+  })
+
+  it('stops waiting for an echo that is older than the retention time', () => {
+    // an accepted transaction whose operations all no-op server-side never
+    // produces an echo, so the wait has to expire or the document (and its
+    // listener) would be pinned for the lifetime of the store
+    const afterCleanup = cleanupOutgoingTransaction(stateAfterAck(longAgo))
+    expect(afterCleanup.documentStates[docId]).toBeUndefined()
+  })
+
+  it('does not extend the wait on `recentOwnTransactionIds` alone', () => {
+    const state = stateAfterAck(justNow)
+    const documentState = state.documentStates[docId]!
+    const withoutUnverifiedRevisions: SyncTransactionState = {
+      ...state,
+      documentStates: {
+        [docId]: {...documentState, unverifiedRevisions: {}, recentOwnTransactionIds: ['txnOut']},
+      },
+    }
+
+    expect(
+      cleanupOutgoingTransaction(withoutUnverifiedRevisions).documentStates[docId],
+    ).toBeUndefined()
+  })
+})
+
 describe('revertOutgoingTransaction', () => {
   it('reverts the outgoing transaction and updates documentStates by removing unverified revisions', () => {
     const draftId = getDraftId(DocumentId('doc1'))
@@ -632,6 +745,171 @@ describe('revertOutgoingTransaction', () => {
     const docState = newState.documentStates[draftId]
     expect(docState?.unverifiedRevisions && docState.unverifiedRevisions['txnOut']).toBeUndefined()
   })
+
+  it('unregisters the reverted batch subscription ids, making documents with no other subscribers evictable', () => {
+    const draftId = getDraftId(DocumentId('doc1'))
+    const pubId = getPublishedId(DocumentId('doc1'))
+    const state: SyncTransactionState = {
+      queued: [],
+      applied: [],
+      outgoing: {
+        transactionId: 'txnRevert',
+        actions: [
+          {
+            type: 'document.edit',
+            documentId: 'doc1',
+            documentType: 'book',
+            patches: [{set: {foo: 'changed'}}],
+          },
+        ],
+        disableBatching: false,
+        batchedTransactionIds: ['txnRevert'],
+        outgoingActions: [],
+        outgoingMutations: [],
+        base: {},
+        working: {},
+        previous: {},
+        previousRevs: {},
+        timestamp: '2025-02-06T00:04:30.000Z',
+      },
+      grants,
+      documentStates: {
+        // only subscriber is the reverted transaction itself
+        [draftId]: {
+          id: draftId,
+          subscriptions: ['txnRevert'],
+          local: {...exampleDoc, _id: draftId, foo: 'changed', _rev: 'rev2'},
+          remote: {...exampleDoc, _id: draftId, foo: 'old', _rev: 'rev1'},
+        },
+        // also has a UI subscriber, so it should survive with only the
+        // transaction subscription removed
+        [pubId]: {
+          id: pubId,
+          subscriptions: ['txnRevert', 'sub-ui'],
+          local: {...exampleDoc, _id: pubId, foo: 'pub', _rev: 'revPub'},
+          remote: {...exampleDoc, _id: pubId, foo: 'pub', _rev: 'revPub'},
+        },
+      },
+    }
+    const newState = revertOutgoingTransaction(state)
+    expect(newState.outgoing).toBeUndefined()
+    // no subscribers remain, so the document state is evicted entirely
+    expect(newState.documentStates[draftId]).toBeUndefined()
+    // the UI subscription keeps the other document alive, but the reverted
+    // transaction id is gone from its subscriptions
+    expect(newState.documentStates[pubId]?.subscriptions).toEqual(['sub-ui'])
+  })
+
+  it('evicts a document left with no subscribers once its unverified revision is discarded', () => {
+    const docId = 'doc1'
+    const state: SyncTransactionState = {
+      queued: [],
+      applied: [],
+      outgoing: {
+        transactionId: 'txnOut',
+        actions: [
+          {
+            type: 'document.edit',
+            documentId: docId,
+            documentType: 'book',
+            liveEdit: true,
+            patches: [{set: {foo: 'changed'}}],
+          },
+        ],
+        disableBatching: false,
+        batchedTransactionIds: ['txnOut'],
+        outgoingActions: [],
+        outgoingMutations: [],
+        base: {},
+        working: {},
+        previous: {},
+        previousRevs: {},
+        timestamp: new Date().toISOString(),
+      },
+      grants,
+      documentStates: {
+        // the reverted transaction was this document's last subscriber, so the
+        // revision discarded below is the only thing keeping it around
+        [docId]: {
+          id: docId,
+          subscriptions: [],
+          local: {...exampleDoc, _id: docId, foo: 'changed'},
+          remote: {...exampleDoc, _id: docId, foo: 'old'},
+          unverifiedRevisions: {
+            txnOut: {
+              transactionId: 'txnOut',
+              documentId: docId,
+              previousRev: 'txn0',
+              timestamp: new Date().toISOString(),
+            },
+          },
+        },
+      },
+    }
+
+    expect(revertOutgoingTransaction(state).documentStates[docId]).toBeUndefined()
+  })
+
+  it('leaves `local` intact for a document still waiting on its own acked transaction', () => {
+    const revertedId = 'doc-reverted'
+    const retainedId = 'doc-retained'
+    const state: SyncTransactionState = {
+      queued: [],
+      applied: [],
+      outgoing: {
+        transactionId: 'txnOut',
+        actions: [
+          {
+            type: 'document.edit',
+            documentId: revertedId,
+            documentType: 'book',
+            liveEdit: true,
+            patches: [{set: {foo: 'changed'}}],
+          },
+        ],
+        disableBatching: false,
+        batchedTransactionIds: ['txnOut'],
+        outgoingActions: [],
+        outgoingMutations: [],
+        base: {},
+        working: {},
+        previous: {},
+        previousRevs: {},
+        timestamp: new Date().toISOString(),
+      },
+      grants,
+      documentStates: {
+        [revertedId]: {
+          id: revertedId,
+          subscriptions: ['txnOut'],
+          local: {...exampleDoc, _id: revertedId, foo: 'changed'},
+          remote: {...exampleDoc, _id: revertedId, foo: 'old'},
+        },
+        // unrelated to the reverted batch: acked, unsubscribed, and still
+        // waiting on the echo that will settle its optimistic value
+        [retainedId]: {
+          id: retainedId,
+          subscriptions: [],
+          local: {...exampleDoc, _id: retainedId, foo: 'acked'},
+          remote: {...exampleDoc, _id: retainedId, foo: 'old'},
+          unverifiedRevisions: {
+            txnAcked: {
+              transactionId: 'txnAcked',
+              documentId: retainedId,
+              previousRev: 'txn0',
+              timestamp: new Date().toISOString(),
+            },
+          },
+        },
+      },
+    }
+
+    const newState = revertOutgoingTransaction(state)
+    // the reverted document's only subscriber was the batch itself, so
+    // unregistering it evicts the state
+    expect(newState.documentStates[revertedId]).toBeUndefined()
+    expect(newState.documentStates[retainedId]?.local).toMatchObject({foo: 'acked'})
+  })
 })
 
 describe('applyRemoteDocument', () => {
@@ -1124,6 +1402,85 @@ describe('applyRemoteDocument', () => {
     })
   })
 
+  describe('rebase over multi-byte text', () => {
+    it('does not kill the pipeline when a plain edit rebases onto multi-byte text', () => {
+      // The reported production failure: a byte-offset throw from
+      // `@sanity/diff-match-patch` is a plain `Error`, and `createMutationApplier`
+      // only converts to `ActionError` when `preserveOperations` is set. So for an
+      // ordinary `editDocument` it escapes this rebase loop, reaches the rxjs
+      // subscription, and the outgoing-actions pipeline for the whole instance
+      // dies. Every later write is then dropped silently, for every document.
+      const docId = getDraftId(DocumentId('doc1'))
+      const originalDoc: SanityDocument = {
+        ...exampleDoc,
+        _id: docId,
+        _rev: 'rev1',
+        title: 'abcdefg\u00f8',
+      }
+      const locallyEditedDoc: SanityDocument = {
+        ...originalDoc,
+        title: 'abcdefg\u00f8!',
+        _rev: 'txnLocal',
+      }
+
+      const appliedTransaction: AppliedTransaction = {
+        transactionId: 'txnLocal',
+        actions: [
+          {
+            type: 'document.edit',
+            documentId: 'doc1',
+            documentType: 'author',
+            patches: [{diffMatchPatch: {title: '@@ -9,1 +9,2 @@\n \u00f8\n+!\n'}}],
+          },
+        ],
+        previous: {[docId]: originalDoc},
+        base: {[docId]: originalDoc},
+        working: {[docId]: locallyEditedDoc},
+        previousRevs: {[docId]: 'rev1'},
+        timestamp: '2025-02-06T00:16:00.000Z',
+        outgoingActions: [],
+        outgoingMutations: [],
+      }
+
+      const initialState: SyncTransactionState = {
+        queued: [],
+        applied: [appliedTransaction],
+        outgoing: undefined,
+        grants,
+        documentStates: {
+          [docId]: {
+            id: docId,
+            subscriptions: ['sub1'],
+            local: locallyEditedDoc,
+            remote: originalDoc,
+            unverifiedRevisions: {},
+          },
+        },
+      }
+
+      // someone else changed the same field, so the local patch is rebased onto
+      // a base its byte offsets were not computed against
+      const remoteDoc: SanityDocument = {
+        ...originalDoc,
+        title: '\u00f8\u00f8\u00f8\u00f8\u00f8\u00f8',
+        _rev: 'txnForeign',
+      }
+      const remote: RemoteDocument = {
+        type: 'mutation',
+        documentId: docId,
+        document: remoteDoc,
+        revision: 'txnForeign',
+        previousRev: 'rev1',
+        timestamp: '2025-02-06T00:17:00.000Z',
+        mutations: [{patch: {id: docId, set: {title: '\u00f8\u00f8\u00f8\u00f8\u00f8\u00f8'}}}],
+      }
+
+      const events = new Subject<DocumentEvent>()
+
+      expect(() => applyRemoteDocument(initialState, remote, events)).not.toThrow()
+    })
+  })
+
   describe('rebase with preserved operations', () => {
     it('skips a preserved-operations transaction that fails to re-apply and emits rebase-error', () => {
       const docId = getDraftId(DocumentId('doc1'))

package/src/document/reducers.ts

@@ -8,7 +8,7 @@ import {insecureRandomId} from '../utils/ids'
 import {isDeepEqual, omitProperty} from '../utils/object'
 import {setCleanupTimeout} from '../utils/setCleanupTimeout'
 import {type Action} from './actions'
-import {DOCUMENT_STATE_CLEAR_DELAY} from './documentConstants'
+import {DOCUMENT_STATE_CLEAR_DELAY, UNVERIFIED_REVISION_RETENTION_TIME} from './documentConstants'
 import {type DocumentState, type DocumentStoreState} from './documentStore'
 import {type RemoteDocument} from './listen'
 import {ActionError, processActions} from './processActions/processActions'
@@ -401,13 +401,34 @@ export function cleanupOutgoingTransaction(prev: SyncTransactionState): SyncTran
     }
   }
 
-  return {...next, outgoing: undefined}
+  // every ack is also when a previously retained document's echo may have
+  // stopped being expected, so re-make that eviction decision here
+  return {
+    ...next,
+    outgoing: undefined,
+    documentStates: evictOrphanedDocumentStates(next.documentStates),
+  }
 }
 
 export function revertOutgoingTransaction(prev: SyncTransactionState): SyncTransactionState {
   if (!prev.grants) return prev
+
+  // unregister the reverted batch's transaction-held subscriptions, symmetric
+  // with `cleanupOutgoingTransaction` on ack and `removeQueuedTransaction` on
+  // apply failure. without this, a reverted document's subscription IDs are
+  // never released and it can never be evicted
+  let base = prev
+  if (prev.outgoing) {
+    const ids = getDocumentIdsFromHandleLikes(prev.outgoing.actions)
+    for (const transactionId of prev.outgoing.batchedTransactionIds) {
+      for (const documentId of ids) {
+        base = removeSubscriptionIdFromDocument(base, documentId, transactionId)
+      }
+    }
+  }
+
   let working = Object.fromEntries(
-    Object.entries(prev.documentStates).map(([documentId, documentState]) => [
+    Object.entries(base.documentStates).map(([documentId, documentState]) => [
       documentId,
       documentState?.remote,
     ]),
@@ -428,23 +449,41 @@ export function revertOutgoingTransaction(prev: SyncTransactionState): SyncTrans
   }
 
   return {
-    ...prev,
+    ...base,
     applied: nextApplied,
     outgoing: undefined,
-    documentStates: Object.fromEntries(
-      Object.entries(prev.documentStates)
-        .filter((e): e is [string, DocumentState] => !!e[1])
-        .map(([documentId, {unverifiedRevisions = {}, local, ...documentState}]) => {
-          const next: DocumentState = {
-            ...documentState,
-            local: documentId in working ? working[documentId] : local,
-            unverifiedRevisions:
-              prev.outgoing && prev.outgoing.transactionId in unverifiedRevisions
-                ? omitProperty(unverifiedRevisions, prev.outgoing.transactionId)
-                : unverifiedRevisions,
-          }
-          return [documentId, next] as const
-        }),
+    // discarding the outgoing transaction drops its echo-recognition memory,
+    // which can leave a document that was only being kept alive for that echo
+    // with nothing left to wait for, so sweep afterwards
+    documentStates: evictOrphanedDocumentStates(
+      Object.fromEntries(
+        Object.entries(base.documentStates)
+          .filter((e): e is [string, DocumentState] => !!e[1])
+          .map(([documentId, documentState]) => {
+            const {unverifiedRevisions = {}} = documentState
+            const next: DocumentState = {
+              ...documentState,
+              unverifiedRevisions:
+                prev.outgoing && prev.outgoing.transactionId in unverifiedRevisions
+                  ? omitProperty(unverifiedRevisions, prev.outgoing.transactionId)
+                  : unverifiedRevisions,
+            }
+
+            // a document with no subscribers that is still waiting on the echo
+            // of a different, already acked transaction of its own is not
+            // represented in `working` (only `applied` transactions are
+            // re-applied above), so rebuilding its `local` from `remote` would
+            // drop that transaction's effect. leave it for the echo to resolve
+            if (!next.subscriptions.length && isAwaitingOwnEcho(next)) {
+              return [documentId, next] as const
+            }
+
+            return [
+              documentId,
+              {...next, local: documentId in working ? working[documentId] : next.local},
+            ] as const
+          }),
+      ),
     ),
   }
 }
@@ -564,7 +603,7 @@ export function applyRemoteDocument(
 
     return {
       ...prev,
-      documentStates: {
+      documentStates: evictOrphanedDocumentStates({
         ...prev.documentStates,
         [documentId]: {
           ...prevDocState,
@@ -573,7 +612,7 @@ export function applyRemoteDocument(
           local,
           unverifiedRevisions,
         },
-      },
+      }),
     }
   }
 
@@ -630,7 +669,7 @@ export function applyRemoteDocument(
   return {
     ...prev,
     applied: nextApplied,
-    documentStates: {
+    documentStates: evictOrphanedDocumentStates({
       ...prev.documentStates,
       [documentId]: {
         ...prevDocState,
@@ -639,7 +678,7 @@ export function applyRemoteDocument(
         local,
         unverifiedRevisions,
       },
-    },
+    }),
   }
 }
 
@@ -670,22 +709,81 @@ export function removeSubscriptionIdFromDocument(
   subscriptionId: string,
 ): SyncTransactionState {
   const prevDocState = prev.documentStates?.[documentId]
-  const prevSubscriptions = prevDocState?.subscriptions ?? []
-  const subscriptions = prevSubscriptions.filter((id) => id !== subscriptionId)
-
   if (!prevDocState) return prev
-  if (!subscriptions.length) {
+
+  const subscriptions = prevDocState.subscriptions.filter((id) => id !== subscriptionId)
+
+  // a document with no subscribers left is normally evicted below, but if a
+  // transaction was just submitted for it, its echo-recognition memory
+  // (`unverifiedRevisions`) is still waiting on the listener echo.
+  // `cleanupOutgoingTransaction` removes the outgoing transaction's own
+  // subscription right at HTTP ack, before the echo arrives, so deleting the
+  // state here would lose that memory and make the echo mislabel as
+  // `origin: 'remote'` (or, worse, get skipped outright). keep the state
+  // alive, unsubscribed, until the echo verifies or the wait expires
+  if (!subscriptions.length && !isAwaitingOwnEcho(prevDocState)) {
     return {...prev, documentStates: omitProperty(prev.documentStates, documentId)}
   }
+
   return {
     ...prev,
     documentStates: {
       ...prev.documentStates,
-      [documentId]: {...prevDocState, subscriptions: subscriptions},
+      [documentId]: {...prevDocState, subscriptions},
     },
   }
 }
 
+/**
+ * Whether this document still expects the listener echo of one of its own
+ * submitted transactions. That expectation is the only reason a document state
+ * with no subscribers is kept around.
+ *
+ * Revisions stop counting after `UNVERIFIED_REVISION_RETENTION_TIME` because an
+ * echo is not guaranteed to arrive at all: Content Lake records no transaction
+ * when every operation resolves to a no-op (e.g. a keyed path that no longer
+ * exists), while the client bumps `_rev` regardless and so tracks a revision
+ * for it. Without the expiry, such a document (and the listener keyed off its
+ * state) would be pinned for the lifetime of the store.
+ *
+ * `recentOwnTransactionIds` deliberately does not extend the wait: it is capped
+ * rather than drained, so honoring it would keep every edited document alive.
+ */
+function isAwaitingOwnEcho(documentState: DocumentState): boolean {
+  const expiresAfter = Date.now() - UNVERIFIED_REVISION_RETENTION_TIME
+  return Object.values(documentState.unverifiedRevisions ?? {}).some(
+    (revision) => !!revision && new Date(revision.timestamp).getTime() > expiresAfter,
+  )
+}
+
+/**
+ * Removes every document state that has no subscribers left and no own
+ * transaction still awaiting its echo.
+ *
+ * This is a sweep rather than a decision made where the last subscriber leaves
+ * because `removeSubscriptionIdFromDocument` defers that eviction while an echo
+ * is in flight, and both halves of the condition can change without a
+ * subscriber going anywhere: the echo can verify, be dropped by a sync, be
+ * discarded by a revert, or simply never arrive. Every reducer that can settle
+ * an in-flight transaction sweeps, so the deferred decision is always re-made.
+ *
+ * Note this can evict the very document whose remote event is being processed,
+ * which synchronously unsubscribes that document's listener from inside its own
+ * emission (see `subscribeToSubscriptionsAndListenToDocuments`).
+ */
+function evictOrphanedDocumentStates(
+  documentStates: SyncTransactionState['documentStates'],
+): SyncTransactionState['documentStates'] {
+  let next = documentStates
+  for (const [documentId, documentState] of Object.entries(documentStates)) {
+    if (!documentState) continue
+    if (documentState.subscriptions.length) continue
+    if (isAwaitingOwnEcho(documentState)) continue
+    next = omitProperty(next, documentId)
+  }
+  return next
+}
+
 export function manageSubscriberIds(
   {state}: StoreContext<SyncTransactionState>,
   handles: DocumentHandleLike[],

package/src/document/util.test.ts

@@ -0,0 +1,46 @@
+import {describe, expect, it} from 'vitest'
+
+import {getEditingDocumentId, getEffectiveDocumentId} from './util'
+
+const PUBLISHED = 'movie-1'
+const DRAFT = 'drafts.movie-1'
+const VERSION = 'versions.autumn.movie-1'
+
+describe('getEditingDocumentId', () => {
+  it('resolves the draft by default, which is what the Studio edits', () => {
+    expect(getEditingDocumentId({documentId: PUBLISHED})).toBe(DRAFT)
+  })
+
+  it("resolves the draft under the 'drafts' perspective", () => {
+    expect(getEditingDocumentId({documentId: PUBLISHED, perspective: 'drafts'})).toBe(DRAFT)
+  })
+
+  it("resolves the published document under the 'published' perspective", () => {
+    expect(getEditingDocumentId({documentId: PUBLISHED, perspective: 'published'})).toBe(PUBLISHED)
+  })
+
+  it('resolves the version under a release perspective', () => {
+    expect(
+      getEditingDocumentId({documentId: PUBLISHED, perspective: {releaseName: 'autumn'}}),
+    ).toBe(VERSION)
+  })
+
+  it('resolves the published document for live edit, which has no draft', () => {
+    expect(getEditingDocumentId({documentId: PUBLISHED, liveEdit: true})).toBe(PUBLISHED)
+  })
+
+  it('is idempotent when handed an already-specific id', () => {
+    expect(getEditingDocumentId({documentId: DRAFT})).toBe(DRAFT)
+    expect(getEditingDocumentId({documentId: VERSION, perspective: 'published'})).toBe(PUBLISHED)
+    expect(getEditingDocumentId({documentId: DRAFT, perspective: {releaseName: 'autumn'}})).toBe(
+      VERSION,
+    )
+  })
+
+  it('differs from getEffectiveDocumentId precisely where it has to', () => {
+    // The canonical key collapses a draft onto its published id, which is right for
+    // storing state and wrong for anything comparing exact ids.
+    expect(getEffectiveDocumentId({documentId: DRAFT, documentType: 'movie'})).toBe(PUBLISHED)
+    expect(getEditingDocumentId({documentId: DRAFT})).toBe(DRAFT)
+  })
+})