@atlaskit/editor-synced-block-provider 4.3.0 → 4.3.2

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/editor-synced-block-provider
 
+## 4.3.2
+
+### Patch Changes
+
+- [`eaeabd907b737`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/eaeabd907b737) -
+  Move unregistered references logic into a separate method.
+- [`38e89dd6515da`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/38e89dd6515da) -
+  Disable synced block write operations (create, update, delete, flush) when the editor is in view
+  mode, gated behind platform_synced_block_patch_8. This prevents unintended block service mutations
+  (e.g. deletion modals, data loss) when the editor is used in read-only contexts such as Version
+  History.
+
+## 4.3.1
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 4.3.0
 
 ### Minor Changes

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

@@ -13,6 +13,7 @@ var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/creat
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _isEqual = _interopRequireDefault(require("lodash/isEqual"));
 var _monitoring = require("@atlaskit/editor-common/monitoring");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _types = require("../common/types");
 var _errorHandling = require("../utils/errorHandling");
 var _experienceTracking = require("../utils/experienceTracking");
@@ -37,7 +38,7 @@ var CACHE_KEY_PREFIX = 'sync-block-data-';
 var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
   // Track the setTimeout handle for queued flush so we can cancel it on destroy
 
-  function ReferenceSyncBlockStoreManager(dataProvider) {
+  function ReferenceSyncBlockStoreManager(dataProvider, viewMode) {
     var _this = this,
       _this$dataProvider;
     (0, _classCallCheck2.default)(this, ReferenceSyncBlockStoreManager);
@@ -52,6 +53,7 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
     // Track if another flush is needed after the current one completes
     (0, _defineProperty2.default)(this, "flushNeededAfterCurrent", false);
     this.dataProvider = dataProvider;
+    this.viewMode = viewMode;
     this.syncBlockFetchDataRequests = new Map();
     this.syncBlockSourceInfoRequests = new Map();
     this.newlyAddedSyncBlocks = new Set();
@@ -702,14 +704,20 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
         return _regenerator.default.wrap(function _callee3$(_context4) {
           while (1) switch (_context4.prev = _context4.next) {
             case 0:
-              if (this.isCacheDirty) {
+              if (!(this.viewMode === 'view' && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_8'))) {
                 _context4.next = 2;
                 break;
               }
-              return _context4.abrupt("return", true);
+              return _context4.abrupt("return", false);
             case 2:
+              if (this.isCacheDirty) {
+                _context4.next = 4;
+                break;
+              }
+              return _context4.abrupt("return", true);
+            case 4:
               if (!this.isFlushInProgress) {
-                _context4.next = 7;
+                _context4.next = 9;
                 break;
               }
               // Mark that another flush is needed after the current one completes
@@ -717,22 +725,22 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
 
               // We return true here because we know the pending flush will handle the dirty cache
               return _context4.abrupt("return", true);
-            case 7:
+            case 9:
               this.isFlushInProgress = true;
-            case 8:
+            case 10:
               success = true; // a copy of the subscriptions STRUCTURE (without the callbacks)
               // To be saved as the last flushed structure if the flush is successful
               syncedBlocksToFlush = {};
-              _context4.prev = 10;
+              _context4.prev = 12;
               if (this.dataProvider) {
-                _context4.next = 13;
+                _context4.next = 15;
                 break;
               }
               throw new Error('Data provider not set');
-            case 13:
+            case 15:
               blocks = []; // First, build the complete subscription structure
               _iterator = _createForOfIteratorHelper(this._subscriptionManager.getSubscriptions().entries());
-              _context4.prev = 15;
+              _context4.prev = 17;
               _loop = /*#__PURE__*/_regenerator.default.mark(function _loop() {
                 var _step$value, resourceId, callbacks;
                 return _regenerator.default.wrap(function _loop$(_context3) {
@@ -754,34 +762,34 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
                 }, _loop);
               });
               _iterator.s();
-            case 18:
+            case 20:
               if ((_step = _iterator.n()).done) {
-                _context4.next = 22;
+                _context4.next = 24;
                 break;
               }
-              return _context4.delegateYield(_loop(), "t0", 20);
-            case 20:
-              _context4.next = 18;
-              break;
+              return _context4.delegateYield(_loop(), "t0", 22);
             case 22:
-              _context4.next = 27;
+              _context4.next = 20;
               break;
             case 24:
-              _context4.prev = 24;
-              _context4.t1 = _context4["catch"](15);
+              _context4.next = 29;
+              break;
+            case 26:
+              _context4.prev = 26;
+              _context4.t1 = _context4["catch"](17);
               _iterator.e(_context4.t1);
-            case 27:
-              _context4.prev = 27;
+            case 29:
+              _context4.prev = 29;
               _iterator.f();
-              return _context4.finish(27);
-            case 30:
+              return _context4.finish(29);
+            case 32:
               if (!(0, _isEqual.default)(syncedBlocksToFlush, this.lastFlushedSyncedBlocks)) {
-                _context4.next = 33;
+                _context4.next = 35;
                 break;
               }
               this.isCacheDirty = false; // Reset since we're considering this a successful no-op flush
               return _context4.abrupt("return", true);
-            case 33:
+            case 35:
               // 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
@@ -789,9 +797,9 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
               // exactly at a time when the updateReferenceData is being executed asynchronously.
               this.isCacheDirty = false;
               (_this$saveExperience = this.saveExperience) === null || _this$saveExperience === void 0 || _this$saveExperience.start();
-              _context4.next = 37;
+              _context4.next = 39;
               return this.dataProvider.updateReferenceData(blocks);
-            case 37:
+            case 39:
               updateResult = _context4.sent;
               if (!updateResult.success) {
                 success = false;
@@ -800,11 +808,11 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
                 });
                 (_this$fireAnalyticsEv6 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv6 === void 0 || _this$fireAnalyticsEv6.call(this, (0, _errorHandling.updateReferenceErrorPayload)(updateResult.error || 'Failed to update reference synced blocks on the document'));
               }
-              _context4.next = 47;
+              _context4.next = 49;
               break;
-            case 41:
-              _context4.prev = 41;
-              _context4.t2 = _context4["catch"](10);
+            case 43:
+              _context4.prev = 43;
+              _context4.t2 = _context4["catch"](12);
               success = false;
               (0, _monitoring.logException)(_context4.t2, {
                 location: 'editor-synced-block-provider/referenceSyncBlockStoreManager'
@@ -813,8 +821,8 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
                 reason: _context4.t2.message
               });
               (_this$fireAnalyticsEv7 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv7 === void 0 || _this$fireAnalyticsEv7.call(this, (0, _errorHandling.updateReferenceErrorPayload)(_context4.t2.message));
-            case 47:
-              _context4.prev = 47;
+            case 49:
+              _context4.prev = 49;
               if (!success) {
                 // set isCacheDirty back to true for cases where it failed to update the reference synced blocks on the BE
                 this.isCacheDirty = true;
@@ -836,14 +844,14 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
                   void _this7.flush();
                 }, 0);
               }
-              return _context4.finish(47);
-            case 52:
+              return _context4.finish(49);
+            case 54:
               return _context4.abrupt("return", success);
-            case 53:
+            case 55:
             case "end":
               return _context4.stop();
           }
-        }, _callee3, this, [[10, 41, 47, 52], [15, 24, 27, 30]]);
+        }, _callee3, this, [[12, 43, 49, 54], [17, 26, 29, 32]]);
       }));
       function flush() {
         return _flush.apply(this, arguments);

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

@@ -26,17 +26,21 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 // Handles caching, debouncing updates, and publish/subscribe for local changes.
 // Ensures consistency between local and remote state, and can be used in both editor and renderer contexts.
 var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PURE__*/function () {
-  function SourceSyncBlockStoreManager(dataProvider) {
+  function SourceSyncBlockStoreManager(dataProvider, viewMode) {
     var _this = this;
     (0, _classCallCheck2.default)(this, SourceSyncBlockStoreManager);
     (0, _defineProperty2.default)(this, "hasReceivedContentChange", false);
     (0, _defineProperty2.default)(this, "setPendingDeletion", function (Ids, value) {
+      if (_this.viewMode === 'view' && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_8')) {
+        return;
+      }
       var syncBlock = _this.syncBlockCache.get(Ids.resourceId);
       if (syncBlock) {
         syncBlock.pendingDeletion = value;
       }
     });
     this.dataProvider = dataProvider;
+    this.viewMode = viewMode;
     this.syncBlockCache = new Map();
     this.creationCompletionCallbacks = new Map();
   }
@@ -74,6 +78,9 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
     key: "updateSyncBlockData",
     value: function updateSyncBlockData(syncBlockNode) {
       try {
+        if (this.viewMode === 'view' && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_8')) {
+          return false;
+        }
         if (!this.isSourceBlock(syncBlockNode)) {
           throw new Error('Invalid sync block node type provided for updateSyncBlockData');
         }
@@ -134,6 +141,12 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
           while (1) switch (_context.prev = _context.next) {
             case 0:
               _context.prev = 0;
+              if (!(this.viewMode === 'view' && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_8'))) {
+                _context.next = 3;
+                break;
+              }
+              return _context.abrupt("return", false);
+            case 3:
               bodiedSyncBlockNodes = [];
               bodiedSyncBlockData = [];
               Array.from(this.syncBlockCache.values()).forEach(function (syncBlockData) {
@@ -163,21 +176,21 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
                 }
               });
               if (!(bodiedSyncBlockNodes.length === 0)) {
-                _context.next = 6;
+                _context.next = 8;
                 break;
               }
               return _context.abrupt("return", Promise.resolve(true));
-            case 6:
+            case 8:
               if (this.dataProvider) {
-                _context.next = 8;
+                _context.next = 10;
                 break;
               }
               throw new Error('Data provider not set');
-            case 8:
+            case 10:
               (_this$saveExperience = this.saveExperience) === null || _this$saveExperience === void 0 || _this$saveExperience.start({});
-              _context.next = 11;
+              _context.next = 13;
               return this.dataProvider.writeNodesData(bodiedSyncBlockNodes, bodiedSyncBlockData);
-            case 11:
+            case 13:
               writeResults = _context.sent;
               writeResults.forEach(function (result) {
                 // set isDirty to true for cases where it failed to save the sync block to the BE
@@ -191,7 +204,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
               if (!writeResults.every(function (result) {
                 return result.resourceId && !result.error;
               })) {
-                _context.next = 19;
+                _context.next = 21;
                 break;
               }
               (_this$saveExperience2 = this.saveExperience) === null || _this$saveExperience2 === void 0 || _this$saveExperience2.success();
@@ -202,7 +215,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
                 }
               });
               return _context.abrupt("return", true);
-            case 19:
+            case 21:
               (_this$saveExperience3 = this.saveExperience) === null || _this$saveExperience3 === void 0 || _this$saveExperience3.failure();
               writeResults.filter(function (result) {
                 return !result.resourceId || result.error;
@@ -211,28 +224,28 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
                 (_this2$fireAnalyticsE2 = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE2 === void 0 || _this2$fireAnalyticsE2.call(_this2, (0, _errorHandling.updateErrorPayload)(result.error || 'Failed to write data', result.resourceId));
               });
               return _context.abrupt("return", false);
-            case 22:
-              _context.next = 29;
-              break;
             case 24:
-              _context.prev = 24;
+              _context.next = 31;
+              break;
+            case 26:
+              _context.prev = 26;
               _context.t0 = _context["catch"](0);
               (0, _monitoring.logException)(_context.t0, {
                 location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
               });
               (_this$fireAnalyticsEv2 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv2 === void 0 || _this$fireAnalyticsEv2.call(this, (0, _errorHandling.updateErrorPayload)(_context.t0.message));
               return _context.abrupt("return", false);
-            case 29:
-              _context.prev = 29;
+            case 31:
+              _context.prev = 31;
               if ((0, _platformFeatureFlags.fg)('platform_synced_block_patch_7')) {
                 (_this$flushCompletion = this.flushCompletionCallback) === null || _this$flushCompletion === void 0 || _this$flushCompletion.call(this);
               }
-              return _context.finish(29);
-            case 32:
+              return _context.finish(31);
+            case 34:
             case "end":
               return _context.stop();
           }
-        }, _callee, this, [[0, 24, 29, 32]]);
+        }, _callee, this, [[0, 26, 31, 34]]);
       }));
       function flush() {
         return _flush.apply(this, arguments);
@@ -242,6 +255,9 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
   }, {
     key: "hasUnsavedChanges",
     value: function hasUnsavedChanges() {
+      if (this.viewMode === 'view' && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_8')) {
+        return false;
+      }
       return this.hasReceivedContentChange && Array.from(this.syncBlockCache.values()).some(function (syncBlockData) {
         return syncBlockData.isDirty;
       });
@@ -259,6 +275,9 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
   }, {
     key: "commitPendingCreation",
     value: function commitPendingCreation(success, resourceId) {
+      if (this.viewMode === 'view' && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_8')) {
+        return;
+      }
       var onCompletion = this.creationCompletionCallbacks.get(resourceId);
       if (onCompletion) {
         this.creationCompletionCallbacks.delete(resourceId);
@@ -325,6 +344,9 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
     key: "createBodiedSyncBlockNode",
     value: function createBodiedSyncBlockNode(attrs, onCompletion) {
       var _this4 = this;
+      if (this.viewMode === 'view' && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_8')) {
+        return;
+      }
       var resourceId = attrs.resourceId,
         blockInstanceId = attrs.localId;
       try {
@@ -384,21 +406,27 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
           while (1) switch (_context2.prev = _context2.next) {
             case 0:
               _context2.prev = 0;
-              if (this.dataProvider) {
+              if (!(this.viewMode === 'view' && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_8'))) {
                 _context2.next = 3;
                 break;
               }
-              throw new Error('Data provider not set');
+              return _context2.abrupt("return", false);
             case 3:
+              if (this.dataProvider) {
+                _context2.next = 5;
+                break;
+              }
+              throw new Error('Data provider not set');
+            case 5:
               syncBlockIds.forEach(function (Ids) {
                 _this5.setPendingDeletion(Ids, true);
               });
               (_this$deleteExperienc = this.deleteExperience) === null || _this$deleteExperienc === void 0 || _this$deleteExperienc.start({});
-              _context2.next = 7;
+              _context2.next = 9;
               return this.dataProvider.deleteNodesData(syncBlockIds.map(function (attrs) {
                 return attrs.resourceId;
               }), reason);
-            case 7:
+            case 9:
               results = _context2.sent;
               isDeleteSuccessful = results.every(function (result) {
                 return result.success;
@@ -432,8 +460,8 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
               }
               syncBlockIds.forEach(callback);
               return _context2.abrupt("return", isDeleteSuccessful);
-            case 15:
-              _context2.prev = 15;
+            case 17:
+              _context2.prev = 17;
               _context2.t0 = _context2["catch"](0);
               syncBlockIds.forEach(function (Ids) {
                 var _this5$fireAnalyticsE4;
@@ -445,11 +473,11 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
               });
               onDeleteCompleted(false);
               return _context2.abrupt("return", false);
-            case 21:
+            case 23:
             case "end":
               return _context2.stop();
           }
-        }, _callee2, this, [[0, 15]]);
+        }, _callee2, this, [[0, 17]]);
       }));
       function _delete(_x, _x2, _x3, _x4) {
         return _delete2.apply(this, arguments);
@@ -469,20 +497,26 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
         return _regenerator.default.wrap(function _callee3$(_context3) {
           while (1) switch (_context3.prev = _context3.next) {
             case 0:
-              if (this.deletionRetryInfo) {
+              if (!(this.viewMode === 'view' && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_8'))) {
                 _context3.next = 2;
                 break;
               }
               return _context3.abrupt("return", Promise.resolve());
             case 2:
+              if (this.deletionRetryInfo) {
+                _context3.next = 4;
+                break;
+              }
+              return _context3.abrupt("return", Promise.resolve());
+            case 4:
               _this$deletionRetryIn = this.deletionRetryInfo, syncBlockIds = _this$deletionRetryIn.syncBlockIds, onDelete = _this$deletionRetryIn.onDelete, onDeleteCompleted = _this$deletionRetryIn.onDeleteCompleted, deletionReason = _this$deletionRetryIn.deletionReason;
               if (!this.confirmationCallback) {
-                _context3.next = 6;
+                _context3.next = 8;
                 break;
               }
-              _context3.next = 6;
+              _context3.next = 8;
               return this.delete(syncBlockIds, onDelete, onDeleteCompleted, deletionReason);
-            case 6:
+            case 8:
             case "end":
               return _context3.stop();
           }
@@ -516,21 +550,27 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
         return _regenerator.default.wrap(function _callee4$(_context4) {
           while (1) switch (_context4.prev = _context4.next) {
             case 0:
+              if (!(this.viewMode === 'view' && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_8'))) {
+                _context4.next = 2;
+                break;
+              }
+              return _context4.abrupt("return", Promise.resolve());
+            case 2:
               if (!this.confirmationCallback) {
-                _context4.next = 12;
+                _context4.next = 14;
                 break;
               }
-              _context4.next = 3;
+              _context4.next = 5;
               return this.confirmationCallback(syncBlockIds, deletionReason);
-            case 3:
+            case 5:
               confirmed = _context4.sent;
               if (!confirmed) {
-                _context4.next = 11;
+                _context4.next = 13;
                 break;
               }
-              _context4.next = 7;
+              _context4.next = 9;
               return this.delete(syncBlockIds, onDelete, onDeleteCompleted, deletionReason);
-            case 7:
+            case 9:
               isDeleteSuccessful = _context4.sent;
               if (!isDeleteSuccessful) {
                 // If deletion failed, save deletion info for potential retry
@@ -544,11 +584,11 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
               } else {
                 destroyCallback();
               }
-              _context4.next = 12;
+              _context4.next = 14;
               break;
-            case 11:
+            case 13:
               destroyCallback();
-            case 12:
+            case 14:
             case "end":
               return _context4.stop();
           }