fix(sanity): remove ifDraftRevisionId optimistic lock usage when pu…

…blishing documents Co-authored-by: Bjørge Næss <bjoerge@gmail.com>
sanity-io · Jun 18, 2024 · 3064705 · 3064705
1 parent 17d0bbf
commit 3064705
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 8 deletions.
diff --git a/.../store/_legacy/document/document-pair/serverOperations/__snapshots__/publish.test.ts.snap b/.../store/_legacy/document/document-pair/serverOperations/__snapshots__/publish.test.ts.snap
@@ -9,7 +9,6 @@ Object {
         "actions": Object {
           "actionType": "sanity.action.document.publish",
           "draftId": "drafts.my-id",
-          "ifDraftRevisionId": "exampleRev",
           "ifPublishedRevisionId": "exampleRev",
           "publishedId": "my-id",
         },
@@ -37,7 +36,6 @@ Object {
         "actions": Object {
           "actionType": "sanity.action.document.publish",
           "draftId": "drafts.my-id",
-          "ifDraftRevisionId": "exampleRev",
           "ifPublishedRevisionId": undefined,
           "publishedId": "my-id",
         },
@@ -65,7 +63,6 @@ Object {
         "actions": Object {
           "actionType": "sanity.action.document.publish",
           "draftId": "drafts.my-id",
-          "ifDraftRevisionId": "exampleRev",
           "ifPublishedRevisionId": undefined,
           "publishedId": "my-id",
         },

diff --git a/packages/sanity/src/core/store/_legacy/document/document-pair/serverOperations/publish.ts b/packages/sanity/src/core/store/_legacy/document/document-pair/serverOperations/publish.ts
@@ -24,11 +24,11 @@ export const publish: OperationImpl<[], DisabledReason> = {
         actionType: 'sanity.action.document.publish',
         draftId: idPair.draftId,
         publishedId: idPair.publishedId,
-        // The editor must be able to see the latest state of both the draft document they are
-        // publishing, and the published document they are choosing to replace. Optimistic
-        // locking using `ifDraftRevisionId` and `ifPublishedRevisionId` ensures the client and
-        // server are synchronised.
-        ifDraftRevisionId: snapshots.draft._rev,
+        // Optimistic locking using `ifPublishedRevisionId` ensures that concurrent publish action
+        // invocations do not override each other.
+        //
+        // Note: for custom publish actions, `snapshots.draft._rev` may be stale, which means the
+        // `ifDraftRevisionId` optimistic lock cannot currently be used.
         ifPublishedRevisionId: snapshots.published?._rev,
       },
       {