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

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

@@ -27,12 +27,12 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 // SourceSyncBlockStoreManager is responsible for the lifecycle and state management of source sync blocks in an editor instance.
 // Can be used in both editor and renderer contexts.
 var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/function () {
-  function SyncBlockStoreManager(dataProvider) {
+  function SyncBlockStoreManager(dataProvider, viewMode) {
     (0, _classCallCheck2.default)(this, SyncBlockStoreManager);
     // In future, if reference manager needs to reach to source manager and read its current in memory cache
     // we can pass the source manager as a parameter to the reference manager constructor
-    this.sourceSyncBlockStoreManager = new _sourceSyncBlockStoreManager.SourceSyncBlockStoreManager(dataProvider);
-    this.referenceSyncBlockStoreManager = new _referenceSyncBlockStoreManager.ReferenceSyncBlockStoreManager(dataProvider);
+    this.sourceSyncBlockStoreManager = new _sourceSyncBlockStoreManager.SourceSyncBlockStoreManager(dataProvider, viewMode);
+    this.referenceSyncBlockStoreManager = new _referenceSyncBlockStoreManager.ReferenceSyncBlockStoreManager(dataProvider, viewMode);
     this.dataProvider = dataProvider;
     this.referenceSyncBlockStoreManager.setRealTimeSubscriptionsEnabled(true);
   }
@@ -41,7 +41,7 @@ var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/functio
     value: function () {
       var _fetchReferencesSourceInfo = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(resourceId, blockInstanceId, isSourceSyncBlock) {
         var _this = this;
-        var _this$fetchReferences, _response$references, _this$fetchReferences9, _response$references2, response, _this$fetchReferences2, _this$fetchReferences4, referenceResourceId, hasUnregisteredReferenceOnPage, _this$fetchReferences3, _sourceSyncBlockData, references, unregisteredReferenceData, _this$fetchReferences6, _references, _sourceSyncBlockData2, currentPageData, _this$fetchReferences5, _this$fetchReferences7, _this$fetchReferences8, sourceInfoPromises, sourceInfos, sourceSyncBlockData, _this$fireAnalyticsEv;
+        var _this$fetchReferences, _response$references, _this$fetchReferences5, _response$references2, response, _this$fetchReferences2, _this$fetchReferences3, _this$fetchReferences4, sourceInfoPromises, sourceInfos, sourceSyncBlockData, _this$fireAnalyticsEv;
         return _regenerator.default.wrap(function _callee2$(_context2) {
           while (1) switch (_context2.prev = _context2.next) {
             case 0:
@@ -69,114 +69,20 @@ var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/functio
               });
             case 10:
               if (!(!response.references || ((_response$references = response.references) === null || _response$references === void 0 ? void 0 : _response$references.length) === 0)) {
-                _context2.next = 48;
+                _context2.next = 17;
                 break;
               }
               if (!(0, _platformFeatureFlags.fg)('platform_synced_block_patch_8')) {
-                _context2.next = 46;
+                _context2.next = 15;
                 break;
               }
-              if (!isSourceSyncBlock) {
-                _context2.next = 29;
-                break;
-              }
-              // Verify that a reference sync block for this specific source actually
-              // exists on the current page by checking if the reference manager has
-              // an active subscription for the derived reference resourceId.
-              referenceResourceId = this.referenceSyncBlockStoreManager.generateResourceIdForReference(resourceId);
-              hasUnregisteredReferenceOnPage = this.referenceSyncBlockStoreManager.getSubscribedResourceIds().includes(referenceResourceId);
-              if (!hasUnregisteredReferenceOnPage) {
-                _context2.next = 27;
-                break;
-              }
-              _context2.next = 18;
-              return this.sourceSyncBlockStoreManager.getSyncBlockSourceInfo(blockInstanceId);
-            case 18:
-              _sourceSyncBlockData = _context2.sent;
-              references = [];
-              if (_sourceSyncBlockData) {
-                references.push(_objectSpread(_objectSpread({}, _sourceSyncBlockData), {}, {
-                  onSameDocument: Boolean(_sourceSyncBlockData === null || _sourceSyncBlockData === void 0 ? void 0 : _sourceSyncBlockData.onSameDocument),
-                  hasAccess: true,
-                  isSource: true
-                }));
-              }
-              _context2.next = 23;
-              return this.referenceSyncBlockStoreManager.fetchSyncBlockSourceInfo(referenceResourceId);
-            case 23:
-              unregisteredReferenceData = _context2.sent;
-              if (unregisteredReferenceData) {
-                references.push(_objectSpread(_objectSpread({}, unregisteredReferenceData), {}, {
-                  onSameDocument: true,
-                  hasAccess: true,
-                  isSource: false
-                }));
-              }
-              (_this$fetchReferences3 = this.fetchReferencesExperience) === null || _this$fetchReferences3 === void 0 || _this$fetchReferences3.success();
-              return _context2.abrupt("return", {
-                references: references
-              });
-            case 27:
-              // No remote or local reference exists — show info text with link to doco on how to use Synced Blocks
-              (_this$fetchReferences4 = this.fetchReferencesExperience) === null || _this$fetchReferences4 === void 0 || _this$fetchReferences4.success();
-              return _context2.abrupt("return", {
-                references: []
-              });
-            case 29:
-              if (isSourceSyncBlock) {
-                _context2.next = 44;
-                break;
-              }
-              // Though no references registered yet for this reference sync block,
-              // still show the source and the current page itself since they are known
-              // but not saved yet.
-              _references = [];
-              _context2.next = 33;
-              return this.referenceSyncBlockStoreManager.fetchSyncBlockSourceInfo(resourceId);
-            case 33:
-              _sourceSyncBlockData2 = _context2.sent;
-              if (_sourceSyncBlockData2) {
-                _references.push(_objectSpread(_objectSpread({}, _sourceSyncBlockData2), {}, {
-                  onSameDocument: Boolean(_sourceSyncBlockData2 === null || _sourceSyncBlockData2 === void 0 ? void 0 : _sourceSyncBlockData2.onSameDocument),
-                  hasAccess: true,
-                  isSource: true
-                }));
-              }
-              _context2.next = 37;
-              return this.referenceSyncBlockStoreManager.fetchSyncBlockSourceInfoByLocalId(blockInstanceId);
-            case 37:
-              currentPageData = _context2.sent;
-              if (currentPageData) {
-                _references.push(_objectSpread(_objectSpread({}, currentPageData), {}, {
-                  onSameDocument: true,
-                  hasAccess: true,
-                  isSource: false
-                }));
-              }
-              if (!(_references.length === 0)) {
-                _context2.next = 42;
-                break;
-              }
-              (_this$fetchReferences5 = this.fetchReferencesExperience) === null || _this$fetchReferences5 === void 0 || _this$fetchReferences5.failure({
-                reason: 'No references found for reference synced block'
-              });
-              return _context2.abrupt("return", {
-                error: _types.SyncBlockError.Errored
-              });
-            case 42:
-              (_this$fetchReferences6 = this.fetchReferencesExperience) === null || _this$fetchReferences6 === void 0 || _this$fetchReferences6.success();
-              return _context2.abrupt("return", {
-                references: _references
-              });
-            case 44:
-              _context2.next = 48;
-              break;
-            case 46:
+              return _context2.abrupt("return", this.getUnregisteredReferences(resourceId, blockInstanceId, isSourceSyncBlock));
+            case 15:
               // No reference found
               if (isSourceSyncBlock) {
-                (_this$fetchReferences7 = this.fetchReferencesExperience) === null || _this$fetchReferences7 === void 0 || _this$fetchReferences7.success();
+                (_this$fetchReferences3 = this.fetchReferencesExperience) === null || _this$fetchReferences3 === void 0 || _this$fetchReferences3.success();
               } else {
-                (_this$fetchReferences8 = this.fetchReferencesExperience) === null || _this$fetchReferences8 === void 0 || _this$fetchReferences8.failure({
+                (_this$fetchReferences4 = this.fetchReferencesExperience) === null || _this$fetchReferences4 === void 0 || _this$fetchReferences4.failure({
                   reason: 'No references found for reference synced block'
                 });
               }
@@ -185,8 +91,8 @@ var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/functio
               } : {
                 error: _types.SyncBlockError.Errored
               });
-            case 48:
-              (_this$fetchReferences9 = this.fetchReferencesExperience) === null || _this$fetchReferences9 === void 0 || _this$fetchReferences9.success();
+            case 17:
+              (_this$fetchReferences5 = this.fetchReferencesExperience) === null || _this$fetchReferences5 === void 0 || _this$fetchReferences5.success();
               sourceInfoPromises = ((_response$references2 = response.references) !== null && _response$references2 !== void 0 ? _response$references2 : []).map( /*#__PURE__*/function () {
                 var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(reference) {
                   var _this$fetchSourceInfo, _this$dataProvider, _this$fetchSourceInfo3;
@@ -224,13 +130,13 @@ var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/functio
                   return _ref.apply(this, arguments);
                 };
               }());
-              _context2.next = 52;
+              _context2.next = 21;
               return Promise.all(sourceInfoPromises);
-            case 52:
+            case 21:
               sourceInfos = _context2.sent;
-              _context2.next = 55;
+              _context2.next = 24;
               return isSourceSyncBlock ? this.sourceSyncBlockStoreManager.getSyncBlockSourceInfo(blockInstanceId) : this.referenceSyncBlockStoreManager.fetchSyncBlockSourceInfo(resourceId);
-            case 55:
+            case 24:
               sourceSyncBlockData = _context2.sent;
               if (sourceSyncBlockData) {
                 sourceInfos.push(_objectSpread(_objectSpread({}, sourceSyncBlockData), {}, {
@@ -243,8 +149,8 @@ var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/functio
               return _context2.abrupt("return", {
                 references: sourceInfos
               });
-            case 60:
-              _context2.prev = 60;
+            case 29:
+              _context2.prev = 29;
               _context2.t0 = _context2["catch"](0);
               (0, _monitoring.logException)(_context2.t0, {
                 location: 'editor-synced-block-provider/syncBlockStoreManager'
@@ -253,11 +159,11 @@ var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/functio
               return _context2.abrupt("return", {
                 error: _types.SyncBlockError.Errored
               });
-            case 65:
+            case 34:
             case "end":
               return _context2.stop();
           }
-        }, _callee2, this, [[0, 60]]);
+        }, _callee2, this, [[0, 29]]);
       }));
       function fetchReferencesSourceInfo(_x, _x2, _x3) {
         return _fetchReferencesSourceInfo.apply(this, arguments);
@@ -286,16 +192,119 @@ var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/functio
   }, {
     key: "destroy",
     value: function destroy() {
-      var _this$fetchReferences0, _this$fetchSourceInfo4;
+      var _this$fetchReferences6, _this$fetchSourceInfo4;
       this.referenceSyncBlockStoreManager.destroy();
       this.sourceSyncBlockStoreManager.destroy();
-      (_this$fetchReferences0 = this.fetchReferencesExperience) === null || _this$fetchReferences0 === void 0 || _this$fetchReferences0.abort({
+      (_this$fetchReferences6 = this.fetchReferencesExperience) === null || _this$fetchReferences6 === void 0 || _this$fetchReferences6.abort({
         reason: 'editorDestroyed'
       });
       (_this$fetchSourceInfo4 = this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo4 === void 0 || _this$fetchSourceInfo4.abort({
         reason: 'editorDestroyed'
       });
     }
+  }, {
+    key: "getUnregisteredReferences",
+    value: function () {
+      var _getUnregisteredReferences = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(resourceId, blockInstanceId, isSourceSyncBlock) {
+        var _this$fetchReferences0;
+        var _this$fetchReferences8, referenceResourceId, hasUnregisteredReferenceOnPage, _this$fetchReferences7, _sourceSyncBlockData, _references, sourceSyncBlockReference, referenceSyncBlockReference, references, sourceSyncBlockData, currentPageData, _this$fetchReferences9;
+        return _regenerator.default.wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
+            case 0:
+              if (!isSourceSyncBlock) {
+                _context3.next = 13;
+                break;
+              }
+              // Verify that a reference sync block for this specific source actually
+              // exists on the current page by checking if the reference manager has
+              // an active subscription for the derived reference resourceId.
+              referenceResourceId = this.referenceSyncBlockStoreManager.generateResourceIdForReference(resourceId);
+              hasUnregisteredReferenceOnPage = this.referenceSyncBlockStoreManager.getSubscribedResourceIds().includes(referenceResourceId);
+              if (!hasUnregisteredReferenceOnPage) {
+                _context3.next = 11;
+                break;
+              }
+              _context3.next = 6;
+              return this.sourceSyncBlockStoreManager.getSyncBlockSourceInfo(blockInstanceId);
+            case 6:
+              _sourceSyncBlockData = _context3.sent;
+              _references = [];
+              if (_sourceSyncBlockData) {
+                sourceSyncBlockReference = _objectSpread(_objectSpread({}, _sourceSyncBlockData), {}, {
+                  onSameDocument: true,
+                  hasAccess: true,
+                  isSource: true
+                });
+                referenceSyncBlockReference = _objectSpread(_objectSpread({}, _sourceSyncBlockData), {}, {
+                  onSameDocument: true,
+                  hasAccess: true,
+                  isSource: false
+                });
+                _references.push(sourceSyncBlockReference, referenceSyncBlockReference);
+              }
+              (_this$fetchReferences7 = this.fetchReferencesExperience) === null || _this$fetchReferences7 === void 0 || _this$fetchReferences7.success();
+              return _context3.abrupt("return", {
+                references: _references
+              });
+            case 11:
+              // No remote or local reference exists — show info text with link to doco on how to use Synced Blocks
+              (_this$fetchReferences8 = this.fetchReferencesExperience) === null || _this$fetchReferences8 === void 0 || _this$fetchReferences8.success();
+              return _context3.abrupt("return", {
+                references: []
+              });
+            case 13:
+              // Though no references registered yet for this reference sync block,
+              // still show the source and the current page itself since they are known
+              // but not saved yet.
+              references = [];
+              _context3.next = 16;
+              return this.referenceSyncBlockStoreManager.fetchSyncBlockSourceInfo(resourceId);
+            case 16:
+              sourceSyncBlockData = _context3.sent;
+              if (sourceSyncBlockData) {
+                references.push(_objectSpread(_objectSpread({}, sourceSyncBlockData), {}, {
+                  onSameDocument: Boolean(sourceSyncBlockData === null || sourceSyncBlockData === void 0 ? void 0 : sourceSyncBlockData.onSameDocument),
+                  hasAccess: true,
+                  isSource: true
+                }));
+              }
+              _context3.next = 20;
+              return this.referenceSyncBlockStoreManager.fetchSyncBlockSourceInfoByLocalId(blockInstanceId);
+            case 20:
+              currentPageData = _context3.sent;
+              if (currentPageData) {
+                references.push(_objectSpread(_objectSpread({}, currentPageData), {}, {
+                  onSameDocument: true,
+                  hasAccess: true,
+                  isSource: false
+                }));
+              }
+              if (!(references.length === 0)) {
+                _context3.next = 25;
+                break;
+              }
+              (_this$fetchReferences9 = this.fetchReferencesExperience) === null || _this$fetchReferences9 === void 0 || _this$fetchReferences9.failure({
+                reason: 'No references found for reference synced block'
+              });
+              return _context3.abrupt("return", {
+                error: _types.SyncBlockError.Errored
+              });
+            case 25:
+              (_this$fetchReferences0 = this.fetchReferencesExperience) === null || _this$fetchReferences0 === void 0 || _this$fetchReferences0.success();
+              return _context3.abrupt("return", {
+                references: references
+              });
+            case 27:
+            case "end":
+              return _context3.stop();
+          }
+        }, _callee3, this);
+      }));
+      function getUnregisteredReferences(_x5, _x6, _x7) {
+        return _getUnregisteredReferences.apply(this, arguments);
+      }
+      return getUnregisteredReferences;
+    }()
   }]);
 }();
 var createSyncBlockStoreManager = function createSyncBlockStoreManager(dataProvider) {

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

@@ -1,6 +1,7 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import isEqual from 'lodash/isEqual';
 import { logException } from '@atlaskit/editor-common/monitoring';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { SyncBlockError } from '../common/types';
 import { fetchErrorPayload, fetchSuccessPayload, getSourceInfoErrorPayload, updateReferenceErrorPayload } from '../utils/errorHandling';
 import { getFetchExperience, getFetchSourceInfoExperience, getSaveReferenceExperience } from '../utils/experienceTracking';
@@ -20,7 +21,7 @@ const CACHE_KEY_PREFIX = 'sync-block-data-';
 export class ReferenceSyncBlockStoreManager {
   // Track the setTimeout handle for queued flush so we can cancel it on destroy
 
-  constructor(dataProvider) {
+  constructor(dataProvider, viewMode) {
     var _this$dataProvider;
     // Keeps track of addition and deletion of reference synced blocks on the document
     // This starts as true to always flush the cache when document is saved for the first time
@@ -33,6 +34,7 @@ export class ReferenceSyncBlockStoreManager {
     // Track if another flush is needed after the current one completes
     _defineProperty(this, "flushNeededAfterCurrent", false);
     this.dataProvider = dataProvider;
+    this.viewMode = viewMode;
     this.syncBlockFetchDataRequests = new Map();
     this.syncBlockSourceInfoRequests = new Map();
     this.newlyAddedSyncBlocks = new Set();
@@ -549,6 +551,9 @@ export class ReferenceSyncBlockStoreManager {
    * @returns true if the reference synced blocks are updated successfully, false otherwise
    */
   async flush() {
+    if (this.viewMode === 'view' && fg('platform_synced_block_patch_8')) {
+      return false;
+    }
     if (!this.isCacheDirty) {
       // we use the isCacheDirty flag as a quick check.
       return true;

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

@@ -13,15 +13,19 @@ import { convertSyncBlockPMNodeToSyncBlockData } from '../utils/utils';
 // 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.
 export class SourceSyncBlockStoreManager {
-  constructor(dataProvider) {
+  constructor(dataProvider, viewMode) {
     _defineProperty(this, "hasReceivedContentChange", false);
     _defineProperty(this, "setPendingDeletion", (Ids, value) => {
+      if (this.viewMode === 'view' && fg('platform_synced_block_patch_8')) {
+        return;
+      }
       const 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();
   }
@@ -51,6 +55,9 @@ export class SourceSyncBlockStoreManager {
    */
   updateSyncBlockData(syncBlockNode) {
     try {
+      if (this.viewMode === 'view' && fg('platform_synced_block_patch_8')) {
+        return false;
+      }
       if (!this.isSourceBlock(syncBlockNode)) {
         throw new Error('Invalid sync block node type provided for updateSyncBlockData');
       }
@@ -107,6 +114,9 @@ export class SourceSyncBlockStoreManager {
   async flush() {
     try {
       var _this$saveExperience;
+      if (this.viewMode === 'view' && fg('platform_synced_block_patch_8')) {
+        return false;
+      }
       const bodiedSyncBlockNodes = [];
       const bodiedSyncBlockData = [];
       Array.from(this.syncBlockCache.values()).forEach(syncBlockData => {
@@ -187,6 +197,9 @@ export class SourceSyncBlockStoreManager {
     }
   }
   hasUnsavedChanges() {
+    if (this.viewMode === 'view' && fg('platform_synced_block_patch_8')) {
+      return false;
+    }
     return this.hasReceivedContentChange && Array.from(this.syncBlockCache.values()).some(syncBlockData => syncBlockData.isDirty);
   }
   isPendingCreation(resourceId) {
@@ -198,6 +211,9 @@ export class SourceSyncBlockStoreManager {
    * @param success
    */
   commitPendingCreation(success, resourceId) {
+    if (this.viewMode === 'view' && fg('platform_synced_block_patch_8')) {
+      return;
+    }
     const onCompletion = this.creationCompletionCallbacks.get(resourceId);
     if (onCompletion) {
       this.creationCompletionCallbacks.delete(resourceId);
@@ -255,6 +271,9 @@ export class SourceSyncBlockStoreManager {
    * @param attrs attributes Ids of the node
    */
   createBodiedSyncBlockNode(attrs, onCompletion) {
+    if (this.viewMode === 'view' && fg('platform_synced_block_patch_8')) {
+      return;
+    }
     const {
       resourceId,
       localId: blockInstanceId
@@ -309,6 +328,9 @@ export class SourceSyncBlockStoreManager {
   async delete(syncBlockIds, onDelete, onDeleteCompleted, reason) {
     try {
       var _this$deleteExperienc;
+      if (this.viewMode === 'view' && fg('platform_synced_block_patch_8')) {
+        return false;
+      }
       if (!this.dataProvider) {
         throw new Error('Data provider not set');
       }
@@ -365,6 +387,9 @@ export class SourceSyncBlockStoreManager {
     return !!this.deletionRetryInfo;
   }
   async retryDeletion() {
+    if (this.viewMode === 'view' && fg('platform_synced_block_patch_8')) {
+      return Promise.resolve();
+    }
     if (!this.deletionRetryInfo) {
       return Promise.resolve();
     }
@@ -392,6 +417,9 @@ export class SourceSyncBlockStoreManager {
    * @param destroyCallback - The callback to clear any reference stored for deletion (regardless if deletion is completed or abort)
    */
   async deleteSyncBlocksWithConfirmation(syncBlockIds, deletionReason, onDelete, onDeleteCompleted, destroyCallback) {
+    if (this.viewMode === 'view' && fg('platform_synced_block_patch_8')) {
+      return Promise.resolve();
+    }
     if (this.confirmationCallback) {
       const confirmed = await this.confirmationCallback(syncBlockIds, deletionReason);
       if (confirmed) {