[client] Allow specifying ID of transactions

sanity-io · Mar 3, 2018 · 4e73a08 · 4e73a08
1 parent e4801da
commit 4e73a08
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 7 deletions.
diff --git a/packages/@sanity/client/src/data/dataMethods.js b/packages/@sanity/client/src/data/dataMethods.js
@@ -91,7 +91,11 @@ module.exports = {
       : mutations
     const muts = Array.isArray(mut) ? mut : [mut]
 
-    return this.dataRequest('mutate', {mutations: muts}, options)
+    return this.dataRequest(
+      'mutate',
+      {mutations: muts, transactionId: options && options.transactionId},
+      options
+    )
   },
 
   transaction(operations) {

diff --git a/packages/@sanity/client/src/data/transaction.js b/packages/@sanity/client/src/data/transaction.js
@@ -4,17 +4,15 @@ const Patch = require('./patch')
 
 const defaultMutateOptions = {returnDocuments: false}
 
-function Transaction(operations = [], client) {
+function Transaction(operations = [], client, transactionId) {
+  this.trxId = transactionId
   this.operations = operations
   this.client = client
 }
 
 assign(Transaction.prototype, {
   clone() {
-    return new Transaction(
-      this.operations.slice(0),
-      this.client
-    )
+    return new Transaction(this.operations.slice(0), this.client, this.trxId)
   },
 
   create(doc) {
@@ -63,6 +61,15 @@ assign(Transaction.prototype, {
     return this._add({patch: assign({id: documentId}, patchOps)})
   },
 
+  transactionId(id) {
+    if (!id) {
+      return this.trxId
+    }
+
+    this.trxId = id
+    return this
+  },
+
   serialize() {
     return this.operations.slice()
   },
@@ -79,7 +86,10 @@ assign(Transaction.prototype, {
       )
     }
 
-    return this.client.mutate(this.serialize(), assign({}, defaultMutateOptions, options || {}))
+    return this.client.mutate(
+      this.serialize(),
+      assign({transactionId: this.trxId}, defaultMutateOptions, options || {})
+    )
   },
 
   reset() {

diff --git a/packages/@sanity/client/test/client.test.js b/packages/@sanity/client/test/client.test.js
@@ -1076,6 +1076,26 @@ test('transaction commit() throws if called without a client', t => {
   t.end()
 })
 
+test('transaction can be given an explicit transaction ID', t => {
+  const transactionId = 'moop'
+  const mutations = [{create: {bar: true}}, {delete: {id: 'barfoo'}}]
+  nock(projectHost())
+    .post('/v1/data/mutate/foo?returnIds=true&visibility=sync', {mutations, transactionId})
+    .reply(200, {transactionId})
+
+  getClient().transaction()
+    .create({bar: true})
+    .delete('barfoo')
+    .transactionId(transactionId)
+    .commit()
+    .then(res => {
+      t.equal(res.transactionId, transactionId, 'applies given transaction')
+    })
+    .catch(t.ifError)
+    .then(t.end)
+})
+
+
 /*****************
  * LISTENERS     *
  *****************/