@atlaskit/editor-synced-block-provider 2.15.5 → 2.16.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @atlaskit/editor-synced-block-provider
 
+## 2.16.0
+
+### Minor Changes
+
+- [`1e626a0fb59a7`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/1e626a0fb59a7) -
+  Can pass in get NCS step version function
+
+## 2.15.6
+
+### Patch Changes
+
+- [`d40079fdeef5d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d40079fdeef5d) -
+  EDITOR-4044 Fix a race condition in source sync block dirty tracking logic
+- [`267f0abf6b4cf`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/267f0abf6b4cf) -
+  EDITOR-4044 Fix a race condition in reference sync block dirty tracking logic
+- Updated dependencies
+
 ## 2.15.5
 
 ### Patch Changes

package/dist/cjs/clients/block-service/blockService.js

@@ -177,27 +177,31 @@ var deleteSyncedBlock = exports.deleteSyncedBlock = /*#__PURE__*/function () {
 }();
 var updateSyncedBlock = exports.updateSyncedBlock = /*#__PURE__*/function () {
   var _ref7 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(_ref6) {
-    var blockAri, content, response;
+    var blockAri, content, stepVersion, requestBody, response;
     return _regenerator.default.wrap(function _callee4$(_context4) {
       while (1) switch (_context4.prev = _context4.next) {
         case 0:
-          blockAri = _ref6.blockAri, content = _ref6.content;
-          _context4.next = 3;
+          blockAri = _ref6.blockAri, content = _ref6.content, stepVersion = _ref6.stepVersion;
+          requestBody = {
+            content: content
+          };
+          if (stepVersion !== undefined) {
+            requestBody.stepVersion = stepVersion;
+          }
+          _context4.next = 5;
           return (0, _retry.fetchWithRetry)("".concat(BLOCK_SERVICE_API_URL, "/block/").concat(encodeURIComponent(blockAri)), {
             method: 'PUT',
             headers: COMMON_HEADERS,
-            body: JSON.stringify({
-              content: content
-            })
+            body: JSON.stringify(requestBody)
           });
-        case 3:
+        case 5:
           response = _context4.sent;
           if (response.ok) {
-            _context4.next = 6;
+            _context4.next = 8;
             break;
           }
           throw new BlockError(response.status);
-        case 6:
+        case 8:
         case "end":
           return _context4.stop();
       }
@@ -209,36 +213,40 @@ var updateSyncedBlock = exports.updateSyncedBlock = /*#__PURE__*/function () {
 }();
 var createSyncedBlock = exports.createSyncedBlock = /*#__PURE__*/function () {
   var _ref9 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(_ref8) {
-    var blockAri, blockInstanceId, sourceAri, product, content, response;
+    var blockAri, blockInstanceId, sourceAri, product, content, stepVersion, requestBody, response;
     return _regenerator.default.wrap(function _callee5$(_context5) {
       while (1) switch (_context5.prev = _context5.next) {
         case 0:
-          blockAri = _ref8.blockAri, blockInstanceId = _ref8.blockInstanceId, sourceAri = _ref8.sourceAri, product = _ref8.product, content = _ref8.content;
-          _context5.next = 3;
+          blockAri = _ref8.blockAri, blockInstanceId = _ref8.blockInstanceId, sourceAri = _ref8.sourceAri, product = _ref8.product, content = _ref8.content, stepVersion = _ref8.stepVersion;
+          requestBody = {
+            blockAri: blockAri,
+            blockInstanceId: blockInstanceId,
+            sourceAri: sourceAri,
+            product: product,
+            content: content
+          };
+          if (stepVersion !== undefined) {
+            requestBody.stepVersion = stepVersion;
+          }
+          _context5.next = 5;
           return (0, _retry.fetchWithRetry)("".concat(BLOCK_SERVICE_API_URL, "/block"), {
             method: 'POST',
             headers: COMMON_HEADERS,
-            body: JSON.stringify({
-              blockAri: blockAri,
-              blockInstanceId: blockInstanceId,
-              sourceAri: sourceAri,
-              product: product,
-              content: content
-            })
+            body: JSON.stringify(requestBody)
           });
-        case 3:
+        case 5:
           response = _context5.sent;
           if (response.ok) {
-            _context5.next = 6;
+            _context5.next = 8;
             break;
           }
           throw new BlockError(response.status);
-        case 6:
-          _context5.next = 8;
-          return response.json();
         case 8:
+          _context5.next = 10;
+          return response.json();
+        case 10:
           return _context5.abrupt("return", _context5.sent);
-        case 9:
+        case 11:
         case "end":
           return _context5.stop();
       }

package/dist/cjs/providers/block-service/blockServiceAPI.js

@@ -196,11 +196,12 @@ var BlockServiceADFFetchProvider = /*#__PURE__*/function () {
  * ADFWriteProvider implementation that writes synced block data to Block Service API
  */
 var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
-  function BlockServiceADFWriteProvider(sourceAri, product, sourceDocumentId) {
+  function BlockServiceADFWriteProvider(sourceAri, product, sourceDocumentId, getVersion) {
     (0, _classCallCheck2.default)(this, BlockServiceADFWriteProvider);
     this.sourceAri = sourceAri;
     this.product = product;
     this.sourceDocumentId = sourceDocumentId;
+    this.getVersion = getVersion;
   }
 
   // it will first try to update and if it can't (404) then it will try to create
@@ -208,43 +209,45 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
     key: "writeData",
     value: function () {
       var _writeData = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(data) {
-        var resourceId, blockAri;
+        var resourceId, blockAri, stepVersion;
         return _regenerator.default.wrap(function _callee3$(_context3) {
           while (1) switch (_context3.prev = _context3.next) {
             case 0:
               resourceId = data.resourceId;
               blockAri = (0, _ari.generateBlockAri)(this.sourceAri, resourceId, this.product);
-              _context3.prev = 2;
-              _context3.next = 5;
+              stepVersion = this.getVersion ? this.getVersion() : undefined;
+              _context3.prev = 3;
+              _context3.next = 6;
               return (0, _blockService.updateSyncedBlock)({
                 blockAri: blockAri,
-                content: JSON.stringify(data.content)
+                content: JSON.stringify(data.content),
+                stepVersion: stepVersion
               });
-            case 5:
+            case 6:
               return _context3.abrupt("return", {
                 resourceId: resourceId
               });
-            case 8:
-              _context3.prev = 8;
-              _context3.t0 = _context3["catch"](2);
+            case 9:
+              _context3.prev = 9;
+              _context3.t0 = _context3["catch"](3);
               if (!(_context3.t0 instanceof _blockService.BlockError)) {
-                _context3.next = 12;
+                _context3.next = 13;
                 break;
               }
               return _context3.abrupt("return", {
                 error: mapBlockError(_context3.t0),
                 resourceId: resourceId
               });
-            case 12:
+            case 13:
               return _context3.abrupt("return", {
                 error: (0, _errorHandling.stringifyError)(_context3.t0),
                 resourceId: resourceId
               });
-            case 13:
+            case 14:
             case "end":
               return _context3.stop();
           }
-        }, _callee3, this, [[2, 8]]);
+        }, _callee3, this, [[3, 9]]);
       }));
       function writeData(_x3) {
         return _writeData.apply(this, arguments);
@@ -255,46 +258,48 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
     key: "createData",
     value: function () {
       var _createData = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(data) {
-        var resourceId, blockAri;
+        var resourceId, blockAri, stepVersion;
         return _regenerator.default.wrap(function _callee4$(_context4) {
           while (1) switch (_context4.prev = _context4.next) {
             case 0:
               resourceId = data.resourceId;
               blockAri = (0, _ari.generateBlockAri)(this.sourceAri, resourceId, this.product);
-              _context4.prev = 2;
-              _context4.next = 5;
+              stepVersion = this.getVersion ? this.getVersion() : undefined;
+              _context4.prev = 3;
+              _context4.next = 6;
               return (0, _blockService.createSyncedBlock)({
                 blockAri: blockAri,
                 blockInstanceId: data.blockInstanceId,
                 sourceAri: this.sourceAri,
                 product: this.product,
-                content: JSON.stringify(data.content)
+                content: JSON.stringify(data.content),
+                stepVersion: stepVersion
               });
-            case 5:
+            case 6:
               return _context4.abrupt("return", {
                 resourceId: resourceId
               });
-            case 8:
-              _context4.prev = 8;
-              _context4.t0 = _context4["catch"](2);
+            case 9:
+              _context4.prev = 9;
+              _context4.t0 = _context4["catch"](3);
               if (!(_context4.t0 instanceof _blockService.BlockError)) {
-                _context4.next = 12;
+                _context4.next = 13;
                 break;
               }
               return _context4.abrupt("return", {
                 error: mapBlockError(_context4.t0),
                 resourceId: resourceId
               });
-            case 12:
+            case 13:
               return _context4.abrupt("return", {
                 error: (0, _errorHandling.stringifyError)(_context4.t0),
                 resourceId: resourceId
               });
-            case 13:
+            case 14:
             case "end":
               return _context4.stop();
           }
-        }, _callee4, this, [[2, 8]]);
+        }, _callee4, this, [[3, 9]]);
       }));
       function createData(_x4) {
         return _createData.apply(this, arguments);
@@ -425,16 +430,16 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
 /**
  * Factory function to create both providers with shared configuration
  */
-var createBlockServiceAPIProviders = function createBlockServiceAPIProviders(sourceAri, product, sourceDocumentId) {
+var createBlockServiceAPIProviders = function createBlockServiceAPIProviders(sourceAri, product, sourceDocumentId, getVersion) {
   var fetchProvider = new BlockServiceADFFetchProvider(sourceAri);
-  var writeProvider = new BlockServiceADFWriteProvider(sourceAri, product, sourceDocumentId);
+  var writeProvider = new BlockServiceADFWriteProvider(sourceAri, product, sourceDocumentId, getVersion);
   return {
     fetchProvider: fetchProvider,
     writeProvider: writeProvider
   };
 };
-var useMemoizedBlockServiceAPIProviders = exports.useMemoizedBlockServiceAPIProviders = function useMemoizedBlockServiceAPIProviders(sourceAri, product, sourceDocumentId) {
+var useMemoizedBlockServiceAPIProviders = exports.useMemoizedBlockServiceAPIProviders = function useMemoizedBlockServiceAPIProviders(sourceAri, product, sourceDocumentId, getVersion) {
   return (0, _react.useMemo)(function () {
-    return createBlockServiceAPIProviders(sourceAri, product, sourceDocumentId);
-  }, [sourceAri, product, sourceDocumentId]);
+    return createBlockServiceAPIProviders(sourceAri, product, sourceDocumentId, getVersion);
+  }, [sourceAri, product, sourceDocumentId, getVersion]);
 };

package/dist/cjs/store-manager/referenceSyncBlockStoreManager.js

@@ -574,42 +574,50 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
                 });
               });
               if (!(blocks.length === 0)) {
-                _context4.next = 10;
+                _context4.next = 11;
                 break;
               }
+              this.isCacheDirty = false;
               return _context4.abrupt("return", true);
-            case 10:
-              _context4.next = 12;
+            case 11:
+              // reset isCacheDirty early to prevent race condition
+              // There is a race condition where if a user makes changes (create/delete) to a reference sync block
+              // on a live page and the reference sync block is being saved while the user
+              // is still making changes, the new changes might not be saved if they all happen
+              // exactly at a time when the updateReferenceData is being executed asynchronously.
+              this.isCacheDirty = false;
+              _context4.next = 14;
               return this.dataProvider.updateReferenceData(blocks);
-            case 12:
+            case 14:
               updateResult = _context4.sent;
               if (!updateResult.success) {
                 success = false;
                 (_this$fireAnalyticsEv9 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv9 === void 0 || _this$fireAnalyticsEv9.call(this, (0, _errorHandling.updateReferenceErrorPayload)(updateResult.error || 'Failed to update reference synced blocks on the document'));
               }
-              _context4.next = 21;
+              _context4.next = 23;
               break;
-            case 16:
-              _context4.prev = 16;
+            case 18:
+              _context4.prev = 18;
               _context4.t0 = _context4["catch"](3);
               success = false;
               (0, _monitoring.logException)(_context4.t0, {
                 location: 'editor-synced-block-provider/referenceSyncBlockStoreManager'
               });
               (_this$fireAnalyticsEv0 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv0 === void 0 || _this$fireAnalyticsEv0.call(this, (0, _errorHandling.updateReferenceErrorPayload)(_context4.t0.message));
-            case 21:
-              _context4.prev = 21;
-              if (success) {
-                this.isCacheDirty = false;
+            case 23:
+              _context4.prev = 23;
+              if (!success) {
+                // set isCacheDirty back to true for cases where it failed to update the reference synced blocks on the BE
+                this.isCacheDirty = true;
               }
-              return _context4.finish(21);
-            case 24:
+              return _context4.finish(23);
+            case 26:
               return _context4.abrupt("return", success);
-            case 25:
+            case 27:
             case "end":
               return _context4.stop();
           }
-        }, _callee3, this, [[3, 16, 21, 24]]);
+        }, _callee3, this, [[3, 18, 23, 26]]);
       }));
       function flush() {
         return _flush.apply(this, arguments);

package/dist/cjs/store-manager/sourceSyncBlockStoreManager.js

@@ -109,6 +109,13 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
                     }
                   });
                   bodiedSyncBlockData.push(syncBlockData);
+
+                  // reset isDirty early to prevent race condition
+                  // There is a race condition where if a user makes changes to a source sync block
+                  // on a live page and the source sync block is being saved while the user
+                  // is still making changes, the new changes might not be saved if they all happen
+                  // exactly at a time when the writeNodesData is being executed asynchronously.
+                  syncBlockData.isDirty = false;
                 }
               });
               if (!(bodiedSyncBlockNodes.length === 0)) {
@@ -122,11 +129,11 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
             case 10:
               writeResults = _context.sent;
               writeResults.forEach(function (result) {
-                // set isDirty to false on write success and unrecoverable errors like not found
-                if (result.resourceId && (result.error === _types.SyncBlockError.NotFound || !result.error)) {
+                // set isDirty to true for cases where it failed to save the sync block to the BE
+                if (result.resourceId && result.error && result.error !== _types.SyncBlockError.NotFound) {
                   var cachedData = _this2.syncBlockCache.get(result.resourceId);
                   if (cachedData) {
-                    cachedData.isDirty = false;
+                    cachedData.isDirty = true;
                   }
                 }
               });

package/dist/es2019/clients/block-service/blockService.js

@@ -92,14 +92,19 @@ export const deleteSyncedBlock = async ({
 };
 export const updateSyncedBlock = async ({
   blockAri,
-  content
+  content,
+  stepVersion
 }) => {
+  const requestBody = {
+    content
+  };
+  if (stepVersion !== undefined) {
+    requestBody.stepVersion = stepVersion;
+  }
   const response = await fetchWithRetry(`${BLOCK_SERVICE_API_URL}/block/${encodeURIComponent(blockAri)}`, {
     method: 'PUT',
     headers: COMMON_HEADERS,
-    body: JSON.stringify({
-      content
-    })
+    body: JSON.stringify(requestBody)
   });
   if (!response.ok) {
     throw new BlockError(response.status);
@@ -110,18 +115,23 @@ export const createSyncedBlock = async ({
   blockInstanceId,
   sourceAri,
   product,
-  content
+  content,
+  stepVersion
 }) => {
+  const requestBody = {
+    blockAri,
+    blockInstanceId,
+    sourceAri,
+    product,
+    content
+  };
+  if (stepVersion !== undefined) {
+    requestBody.stepVersion = stepVersion;
+  }
   const response = await fetchWithRetry(`${BLOCK_SERVICE_API_URL}/block`, {
     method: 'POST',
     headers: COMMON_HEADERS,
-    body: JSON.stringify({
-      blockAri,
-      blockInstanceId,
-      sourceAri,
-      product,
-      content
-    })
+    body: JSON.stringify(requestBody)
   });
   if (!response.ok) {
     throw new BlockError(response.status);

package/dist/es2019/providers/block-service/blockServiceAPI.js

@@ -134,10 +134,11 @@ class BlockServiceADFFetchProvider {
  * ADFWriteProvider implementation that writes synced block data to Block Service API
  */
 class BlockServiceADFWriteProvider {
-  constructor(sourceAri, product, sourceDocumentId) {
+  constructor(sourceAri, product, sourceDocumentId, getVersion) {
     this.sourceAri = sourceAri;
     this.product = product;
     this.sourceDocumentId = sourceDocumentId;
+    this.getVersion = getVersion;
   }
 
   // it will first try to update and if it can't (404) then it will try to create
@@ -146,11 +147,13 @@ class BlockServiceADFWriteProvider {
       resourceId
     } = data;
     const blockAri = generateBlockAri(this.sourceAri, resourceId, this.product);
+    const stepVersion = this.getVersion ? this.getVersion() : undefined;
     try {
       // Try update existing block's content
       await updateSyncedBlock({
         blockAri,
-        content: JSON.stringify(data.content)
+        content: JSON.stringify(data.content),
+        stepVersion
       });
       return {
         resourceId
@@ -173,13 +176,15 @@ class BlockServiceADFWriteProvider {
       resourceId
     } = data;
     const blockAri = generateBlockAri(this.sourceAri, resourceId, this.product);
+    const stepVersion = this.getVersion ? this.getVersion() : undefined;
     try {
       await createSyncedBlock({
         blockAri,
         blockInstanceId: data.blockInstanceId,
         sourceAri: this.sourceAri,
         product: this.product,
-        content: JSON.stringify(data.content)
+        content: JSON.stringify(data.content),
+        stepVersion
       });
       return {
         resourceId
@@ -272,14 +277,14 @@ class BlockServiceADFWriteProvider {
 /**
  * Factory function to create both providers with shared configuration
  */
-const createBlockServiceAPIProviders = (sourceAri, product, sourceDocumentId) => {
+const createBlockServiceAPIProviders = (sourceAri, product, sourceDocumentId, getVersion) => {
   const fetchProvider = new BlockServiceADFFetchProvider(sourceAri);
-  const writeProvider = new BlockServiceADFWriteProvider(sourceAri, product, sourceDocumentId);
+  const writeProvider = new BlockServiceADFWriteProvider(sourceAri, product, sourceDocumentId, getVersion);
   return {
     fetchProvider,
     writeProvider
   };
 };
-export const useMemoizedBlockServiceAPIProviders = (sourceAri, product, sourceDocumentId) => {
-  return useMemo(() => createBlockServiceAPIProviders(sourceAri, product, sourceDocumentId), [sourceAri, product, sourceDocumentId]);
+export const useMemoizedBlockServiceAPIProviders = (sourceAri, product, sourceDocumentId, getVersion) => {
+  return useMemo(() => createBlockServiceAPIProviders(sourceAri, product, sourceDocumentId, getVersion), [sourceAri, product, sourceDocumentId, getVersion]);
 };

package/dist/es2019/store-manager/referenceSyncBlockStoreManager.js

@@ -441,8 +441,16 @@ export class ReferenceSyncBlockStoreManager {
         });
       });
       if (blocks.length === 0) {
+        this.isCacheDirty = false;
         return true;
       }
+
+      // reset isCacheDirty early to prevent race condition
+      // There is a race condition where if a user makes changes (create/delete) to a reference sync block
+      // on a live page and the reference sync block is being saved while the user
+      // is still making changes, the new changes might not be saved if they all happen
+      // exactly at a time when the updateReferenceData is being executed asynchronously.
+      this.isCacheDirty = false;
       const updateResult = await this.dataProvider.updateReferenceData(blocks);
       if (!updateResult.success) {
         var _this$fireAnalyticsEv10;
@@ -457,8 +465,9 @@ export class ReferenceSyncBlockStoreManager {
       });
       (_this$fireAnalyticsEv11 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv11 === void 0 ? void 0 : _this$fireAnalyticsEv11.call(this, updateReferenceErrorPayload(error.message));
     } finally {
-      if (success) {
-        this.isCacheDirty = false;
+      if (!success) {
+        // set isCacheDirty back to true for cases where it failed to update the reference synced blocks on the BE
+        this.isCacheDirty = true;
       }
     }
     return success;

package/dist/es2019/store-manager/sourceSyncBlockStoreManager.js

@@ -82,6 +82,13 @@ export class SourceSyncBlockStoreManager {
             }
           });
           bodiedSyncBlockData.push(syncBlockData);
+
+          // reset isDirty early to prevent race condition
+          // There is a race condition where if a user makes changes to a source sync block
+          // on a live page and the source sync block is being saved while the user
+          // is still making changes, the new changes might not be saved if they all happen
+          // exactly at a time when the writeNodesData is being executed asynchronously.
+          syncBlockData.isDirty = false;
         }
       });
       if (bodiedSyncBlockNodes.length === 0) {
@@ -89,11 +96,11 @@ export class SourceSyncBlockStoreManager {
       }
       const writeResults = await this.dataProvider.writeNodesData(bodiedSyncBlockNodes, bodiedSyncBlockData);
       writeResults.forEach(result => {
-        // set isDirty to false on write success and unrecoverable errors like not found
-        if (result.resourceId && (result.error === SyncBlockError.NotFound || !result.error)) {
+        // set isDirty to true for cases where it failed to save the sync block to the BE
+        if (result.resourceId && result.error && result.error !== SyncBlockError.NotFound) {
           const cachedData = this.syncBlockCache.get(result.resourceId);
           if (cachedData) {
-            cachedData.isDirty = false;
+            cachedData.isDirty = true;
           }
         }
       });

package/dist/esm/clients/block-service/blockService.js

@@ -170,27 +170,31 @@ export var deleteSyncedBlock = /*#__PURE__*/function () {
 }();
 export var updateSyncedBlock = /*#__PURE__*/function () {
   var _ref7 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4(_ref6) {
-    var blockAri, content, response;
+    var blockAri, content, stepVersion, requestBody, response;
     return _regeneratorRuntime.wrap(function _callee4$(_context4) {
       while (1) switch (_context4.prev = _context4.next) {
         case 0:
-          blockAri = _ref6.blockAri, content = _ref6.content;
-          _context4.next = 3;
+          blockAri = _ref6.blockAri, content = _ref6.content, stepVersion = _ref6.stepVersion;
+          requestBody = {
+            content: content
+          };
+          if (stepVersion !== undefined) {
+            requestBody.stepVersion = stepVersion;
+          }
+          _context4.next = 5;
           return fetchWithRetry("".concat(BLOCK_SERVICE_API_URL, "/block/").concat(encodeURIComponent(blockAri)), {
             method: 'PUT',
             headers: COMMON_HEADERS,
-            body: JSON.stringify({
-              content: content
-            })
+            body: JSON.stringify(requestBody)
           });
-        case 3:
+        case 5:
           response = _context4.sent;
           if (response.ok) {
-            _context4.next = 6;
+            _context4.next = 8;
             break;
           }
           throw new BlockError(response.status);
-        case 6:
+        case 8:
         case "end":
           return _context4.stop();
       }
@@ -202,36 +206,40 @@ export var updateSyncedBlock = /*#__PURE__*/function () {
 }();
 export var createSyncedBlock = /*#__PURE__*/function () {
   var _ref9 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee5(_ref8) {
-    var blockAri, blockInstanceId, sourceAri, product, content, response;
+    var blockAri, blockInstanceId, sourceAri, product, content, stepVersion, requestBody, response;
     return _regeneratorRuntime.wrap(function _callee5$(_context5) {
       while (1) switch (_context5.prev = _context5.next) {
         case 0:
-          blockAri = _ref8.blockAri, blockInstanceId = _ref8.blockInstanceId, sourceAri = _ref8.sourceAri, product = _ref8.product, content = _ref8.content;
-          _context5.next = 3;
+          blockAri = _ref8.blockAri, blockInstanceId = _ref8.blockInstanceId, sourceAri = _ref8.sourceAri, product = _ref8.product, content = _ref8.content, stepVersion = _ref8.stepVersion;
+          requestBody = {
+            blockAri: blockAri,
+            blockInstanceId: blockInstanceId,
+            sourceAri: sourceAri,
+            product: product,
+            content: content
+          };
+          if (stepVersion !== undefined) {
+            requestBody.stepVersion = stepVersion;
+          }
+          _context5.next = 5;
           return fetchWithRetry("".concat(BLOCK_SERVICE_API_URL, "/block"), {
             method: 'POST',
             headers: COMMON_HEADERS,
-            body: JSON.stringify({
-              blockAri: blockAri,
-              blockInstanceId: blockInstanceId,
-              sourceAri: sourceAri,
-              product: product,
-              content: content
-            })
+            body: JSON.stringify(requestBody)
           });
-        case 3:
+        case 5:
           response = _context5.sent;
           if (response.ok) {
-            _context5.next = 6;
+            _context5.next = 8;
             break;
           }
           throw new BlockError(response.status);
-        case 6:
-          _context5.next = 8;
-          return response.json();
         case 8:
+          _context5.next = 10;
+          return response.json();
+        case 10:
           return _context5.abrupt("return", _context5.sent);
-        case 9:
+        case 11:
         case "end":
           return _context5.stop();
       }

package/dist/esm/providers/block-service/blockServiceAPI.js

@@ -188,11 +188,12 @@ var BlockServiceADFFetchProvider = /*#__PURE__*/function () {
  * ADFWriteProvider implementation that writes synced block data to Block Service API
  */
 var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
-  function BlockServiceADFWriteProvider(sourceAri, product, sourceDocumentId) {
+  function BlockServiceADFWriteProvider(sourceAri, product, sourceDocumentId, getVersion) {
     _classCallCheck(this, BlockServiceADFWriteProvider);
     this.sourceAri = sourceAri;
     this.product = product;
     this.sourceDocumentId = sourceDocumentId;
+    this.getVersion = getVersion;
   }
 
   // it will first try to update and if it can't (404) then it will try to create
@@ -200,43 +201,45 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
     key: "writeData",
     value: function () {
       var _writeData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(data) {
-        var resourceId, blockAri;
+        var resourceId, blockAri, stepVersion;
         return _regeneratorRuntime.wrap(function _callee3$(_context3) {
           while (1) switch (_context3.prev = _context3.next) {
             case 0:
               resourceId = data.resourceId;
               blockAri = generateBlockAri(this.sourceAri, resourceId, this.product);
-              _context3.prev = 2;
-              _context3.next = 5;
+              stepVersion = this.getVersion ? this.getVersion() : undefined;
+              _context3.prev = 3;
+              _context3.next = 6;
               return updateSyncedBlock({
                 blockAri: blockAri,
-                content: JSON.stringify(data.content)
+                content: JSON.stringify(data.content),
+                stepVersion: stepVersion
               });
-            case 5:
+            case 6:
               return _context3.abrupt("return", {
                 resourceId: resourceId
               });
-            case 8:
-              _context3.prev = 8;
-              _context3.t0 = _context3["catch"](2);
+            case 9:
+              _context3.prev = 9;
+              _context3.t0 = _context3["catch"](3);
               if (!(_context3.t0 instanceof BlockError)) {
-                _context3.next = 12;
+                _context3.next = 13;
                 break;
               }
               return _context3.abrupt("return", {
                 error: mapBlockError(_context3.t0),
                 resourceId: resourceId
               });
-            case 12:
+            case 13:
               return _context3.abrupt("return", {
                 error: stringifyError(_context3.t0),
                 resourceId: resourceId
               });
-            case 13:
+            case 14:
             case "end":
               return _context3.stop();
           }
-        }, _callee3, this, [[2, 8]]);
+        }, _callee3, this, [[3, 9]]);
       }));
       function writeData(_x3) {
         return _writeData.apply(this, arguments);
@@ -247,46 +250,48 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
     key: "createData",
     value: function () {
       var _createData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4(data) {
-        var resourceId, blockAri;
+        var resourceId, blockAri, stepVersion;
         return _regeneratorRuntime.wrap(function _callee4$(_context4) {
           while (1) switch (_context4.prev = _context4.next) {
             case 0:
               resourceId = data.resourceId;
               blockAri = generateBlockAri(this.sourceAri, resourceId, this.product);
-              _context4.prev = 2;
-              _context4.next = 5;
+              stepVersion = this.getVersion ? this.getVersion() : undefined;
+              _context4.prev = 3;
+              _context4.next = 6;
               return createSyncedBlock({
                 blockAri: blockAri,
                 blockInstanceId: data.blockInstanceId,
                 sourceAri: this.sourceAri,
                 product: this.product,
-                content: JSON.stringify(data.content)
+                content: JSON.stringify(data.content),
+                stepVersion: stepVersion
               });
-            case 5:
+            case 6:
               return _context4.abrupt("return", {
                 resourceId: resourceId
               });
-            case 8:
-              _context4.prev = 8;
-              _context4.t0 = _context4["catch"](2);
+            case 9:
+              _context4.prev = 9;
+              _context4.t0 = _context4["catch"](3);
               if (!(_context4.t0 instanceof BlockError)) {
-                _context4.next = 12;
+                _context4.next = 13;
                 break;
               }
               return _context4.abrupt("return", {
                 error: mapBlockError(_context4.t0),
                 resourceId: resourceId
               });
-            case 12:
+            case 13:
               return _context4.abrupt("return", {
                 error: stringifyError(_context4.t0),
                 resourceId: resourceId
               });
-            case 13:
+            case 14:
             case "end":
               return _context4.stop();
           }
-        }, _callee4, this, [[2, 8]]);
+        }, _callee4, this, [[3, 9]]);
       }));
       function createData(_x4) {
         return _createData.apply(this, arguments);
@@ -417,16 +422,16 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
 /**
  * Factory function to create both providers with shared configuration
  */
-var createBlockServiceAPIProviders = function createBlockServiceAPIProviders(sourceAri, product, sourceDocumentId) {
+var createBlockServiceAPIProviders = function createBlockServiceAPIProviders(sourceAri, product, sourceDocumentId, getVersion) {
   var fetchProvider = new BlockServiceADFFetchProvider(sourceAri);
-  var writeProvider = new BlockServiceADFWriteProvider(sourceAri, product, sourceDocumentId);
+  var writeProvider = new BlockServiceADFWriteProvider(sourceAri, product, sourceDocumentId, getVersion);
   return {
     fetchProvider: fetchProvider,
     writeProvider: writeProvider
   };
 };
-export var useMemoizedBlockServiceAPIProviders = function useMemoizedBlockServiceAPIProviders(sourceAri, product, sourceDocumentId) {
+export var useMemoizedBlockServiceAPIProviders = function useMemoizedBlockServiceAPIProviders(sourceAri, product, sourceDocumentId, getVersion) {
   return useMemo(function () {
-    return createBlockServiceAPIProviders(sourceAri, product, sourceDocumentId);
-  }, [sourceAri, product, sourceDocumentId]);
+    return createBlockServiceAPIProviders(sourceAri, product, sourceDocumentId, getVersion);
+  }, [sourceAri, product, sourceDocumentId, getVersion]);
 };

package/dist/esm/store-manager/referenceSyncBlockStoreManager.js

@@ -568,42 +568,50 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
                 });
               });
               if (!(blocks.length === 0)) {
-                _context4.next = 10;
+                _context4.next = 11;
                 break;
               }
+              this.isCacheDirty = false;
               return _context4.abrupt("return", true);
-            case 10:
-              _context4.next = 12;
+            case 11:
+              // reset isCacheDirty early to prevent race condition
+              // There is a race condition where if a user makes changes (create/delete) to a reference sync block
+              // on a live page and the reference sync block is being saved while the user
+              // is still making changes, the new changes might not be saved if they all happen
+              // exactly at a time when the updateReferenceData is being executed asynchronously.
+              this.isCacheDirty = false;
+              _context4.next = 14;
               return this.dataProvider.updateReferenceData(blocks);
-            case 12:
+            case 14:
               updateResult = _context4.sent;
               if (!updateResult.success) {
                 success = false;
                 (_this$fireAnalyticsEv9 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv9 === void 0 || _this$fireAnalyticsEv9.call(this, updateReferenceErrorPayload(updateResult.error || 'Failed to update reference synced blocks on the document'));
               }
-              _context4.next = 21;
+              _context4.next = 23;
               break;
-            case 16:
-              _context4.prev = 16;
+            case 18:
+              _context4.prev = 18;
               _context4.t0 = _context4["catch"](3);
               success = false;
               logException(_context4.t0, {
                 location: 'editor-synced-block-provider/referenceSyncBlockStoreManager'
               });
               (_this$fireAnalyticsEv0 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv0 === void 0 || _this$fireAnalyticsEv0.call(this, updateReferenceErrorPayload(_context4.t0.message));
-            case 21:
-              _context4.prev = 21;
-              if (success) {
-                this.isCacheDirty = false;
+            case 23:
+              _context4.prev = 23;
+              if (!success) {
+                // set isCacheDirty back to true for cases where it failed to update the reference synced blocks on the BE
+                this.isCacheDirty = true;
               }
-              return _context4.finish(21);
-            case 24:
+              return _context4.finish(23);
+            case 26:
               return _context4.abrupt("return", success);
-            case 25:
+            case 27:
             case "end":
               return _context4.stop();
           }
-        }, _callee3, this, [[3, 16, 21, 24]]);
+        }, _callee3, this, [[3, 18, 23, 26]]);
       }));
       function flush() {
         return _flush.apply(this, arguments);

package/dist/esm/store-manager/sourceSyncBlockStoreManager.js

@@ -103,6 +103,13 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
                     }
                   });
                   bodiedSyncBlockData.push(syncBlockData);
+
+                  // reset isDirty early to prevent race condition
+                  // There is a race condition where if a user makes changes to a source sync block
+                  // on a live page and the source sync block is being saved while the user
+                  // is still making changes, the new changes might not be saved if they all happen
+                  // exactly at a time when the writeNodesData is being executed asynchronously.
+                  syncBlockData.isDirty = false;
                 }
               });
               if (!(bodiedSyncBlockNodes.length === 0)) {
@@ -116,11 +123,11 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
             case 10:
               writeResults = _context.sent;
               writeResults.forEach(function (result) {
-                // set isDirty to false on write success and unrecoverable errors like not found
-                if (result.resourceId && (result.error === SyncBlockError.NotFound || !result.error)) {
+                // set isDirty to true for cases where it failed to save the sync block to the BE
+                if (result.resourceId && result.error && result.error !== SyncBlockError.NotFound) {
                   var cachedData = _this2.syncBlockCache.get(result.resourceId);
                   if (cachedData) {
-                    cachedData.isDirty = false;
+                    cachedData.isDirty = true;
                   }
                 }
               });

package/dist/types/clients/block-service/blockService.d.ts

@@ -72,6 +72,7 @@ export type DeleteSyncedBlockRequest = {
 export type UpdateSyncedBlockRequest = {
     blockAri: string;
     content: string;
+    stepVersion?: number;
 };
 export type CreateSyncedBlockRequest = {
     blockAri: string;
@@ -79,6 +80,7 @@ export type CreateSyncedBlockRequest = {
     content: string;
     product: SyncBlockProduct;
     sourceAri: string;
+    stepVersion?: number;
 };
 type ReferenceSyncedBlockIDs = {
     blockAri: string;
@@ -95,7 +97,7 @@ export declare class BlockError extends Error {
 }
 export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
 export declare const deleteSyncedBlock: ({ blockAri }: DeleteSyncedBlockRequest) => Promise<void>;
-export declare const updateSyncedBlock: ({ blockAri, content, }: UpdateSyncedBlockRequest) => Promise<void>;
-export declare const createSyncedBlock: ({ blockAri, blockInstanceId, sourceAri, product, content, }: CreateSyncedBlockRequest) => Promise<BlockContentResponse>;
+export declare const updateSyncedBlock: ({ blockAri, content, stepVersion, }: UpdateSyncedBlockRequest) => Promise<void>;
+export declare const createSyncedBlock: ({ blockAri, blockInstanceId, sourceAri, product, content, stepVersion, }: CreateSyncedBlockRequest) => Promise<BlockContentResponse>;
 export declare const updateReferenceSyncedBlockOnDocument: ({ documentAri, blocks, noContent, }: UpdateReferenceSyncedBlockOnDocumentRequest) => Promise<ReferenceSyncedBlockResponse | void>;
 export {};

package/dist/types/providers/block-service/blockServiceAPI.d.ts

@@ -15,8 +15,9 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
 declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
     private sourceAri;
     private sourceDocumentId;
+    private getVersion?;
     product: SyncBlockProduct;
-    constructor(sourceAri: string, product: SyncBlockProduct, sourceDocumentId: string);
+    constructor(sourceAri: string, product: SyncBlockProduct, sourceDocumentId: string, getVersion?: () => number | undefined);
     writeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
     createData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
     deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
@@ -24,7 +25,7 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
     generateResourceId(): ResourceId;
     updateReferenceData(blocks: SyncBlockAttrs[], noContent?: boolean): Promise<UpdateReferenceSyncBlockResult>;
 }
-export declare const useMemoizedBlockServiceAPIProviders: (sourceAri: string, product: SyncBlockProduct, sourceDocumentId: string) => {
+export declare const useMemoizedBlockServiceAPIProviders: (sourceAri: string, product: SyncBlockProduct, sourceDocumentId: string, getVersion?: () => number | undefined) => {
     fetchProvider: BlockServiceADFFetchProvider;
     writeProvider: BlockServiceADFWriteProvider;
 };

package/dist/types-ts4.5/clients/block-service/blockService.d.ts

@@ -72,6 +72,7 @@ export type DeleteSyncedBlockRequest = {
 export type UpdateSyncedBlockRequest = {
     blockAri: string;
     content: string;
+    stepVersion?: number;
 };
 export type CreateSyncedBlockRequest = {
     blockAri: string;
@@ -79,6 +80,7 @@ export type CreateSyncedBlockRequest = {
     content: string;
     product: SyncBlockProduct;
     sourceAri: string;
+    stepVersion?: number;
 };
 type ReferenceSyncedBlockIDs = {
     blockAri: string;
@@ -95,7 +97,7 @@ export declare class BlockError extends Error {
 }
 export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
 export declare const deleteSyncedBlock: ({ blockAri }: DeleteSyncedBlockRequest) => Promise<void>;
-export declare const updateSyncedBlock: ({ blockAri, content, }: UpdateSyncedBlockRequest) => Promise<void>;
-export declare const createSyncedBlock: ({ blockAri, blockInstanceId, sourceAri, product, content, }: CreateSyncedBlockRequest) => Promise<BlockContentResponse>;
+export declare const updateSyncedBlock: ({ blockAri, content, stepVersion, }: UpdateSyncedBlockRequest) => Promise<void>;
+export declare const createSyncedBlock: ({ blockAri, blockInstanceId, sourceAri, product, content, stepVersion, }: CreateSyncedBlockRequest) => Promise<BlockContentResponse>;
 export declare const updateReferenceSyncedBlockOnDocument: ({ documentAri, blocks, noContent, }: UpdateReferenceSyncedBlockOnDocumentRequest) => Promise<ReferenceSyncedBlockResponse | void>;
 export {};

package/dist/types-ts4.5/providers/block-service/blockServiceAPI.d.ts

@@ -15,8 +15,9 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
 declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
     private sourceAri;
     private sourceDocumentId;
+    private getVersion?;
     product: SyncBlockProduct;
-    constructor(sourceAri: string, product: SyncBlockProduct, sourceDocumentId: string);
+    constructor(sourceAri: string, product: SyncBlockProduct, sourceDocumentId: string, getVersion?: () => number | undefined);
     writeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
     createData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
     deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
@@ -24,7 +25,7 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
     generateResourceId(): ResourceId;
     updateReferenceData(blocks: SyncBlockAttrs[], noContent?: boolean): Promise<UpdateReferenceSyncBlockResult>;
 }
-export declare const useMemoizedBlockServiceAPIProviders: (sourceAri: string, product: SyncBlockProduct, sourceDocumentId: string) => {
+export declare const useMemoizedBlockServiceAPIProviders: (sourceAri: string, product: SyncBlockProduct, sourceDocumentId: string, getVersion?: () => number | undefined) => {
     fetchProvider: BlockServiceADFFetchProvider;
     writeProvider: BlockServiceADFWriteProvider;
 };

package/package.json

@@ -33,7 +33,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.46.0",
+		"@atlaskit/editor-common": "^110.49.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -76,7 +76,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "2.15.5",
+	"version": "2.16.0",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",