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

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

@@ -14,17 +14,17 @@ import { SourceSyncBlockStoreManager } from './sourceSyncBlockStoreManager';
 // 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.
 export class SyncBlockStoreManager {
-  constructor(dataProvider) {
+  constructor(dataProvider, viewMode) {
     // 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(dataProvider);
-    this.referenceSyncBlockStoreManager = new ReferenceSyncBlockStoreManager(dataProvider);
+    this.sourceSyncBlockStoreManager = new SourceSyncBlockStoreManager(dataProvider, viewMode);
+    this.referenceSyncBlockStoreManager = new ReferenceSyncBlockStoreManager(dataProvider, viewMode);
     this.dataProvider = dataProvider;
     this.referenceSyncBlockStoreManager.setRealTimeSubscriptionsEnabled(true);
   }
   async fetchReferencesSourceInfo(resourceId, blockInstanceId, isSourceSyncBlock) {
     try {
-      var _this$fetchReferences, _response$references, _this$fetchReferences9, _response$references2;
+      var _this$fetchReferences, _response$references, _this$fetchReferences5, _response$references2;
       if (!this.dataProvider) {
         throw new Error('Data provider not set');
       }
@@ -41,94 +41,15 @@ export class SyncBlockStoreManager {
       }
       if (!response.references || ((_response$references = response.references) === null || _response$references === void 0 ? void 0 : _response$references.length) === 0) {
         if (fg('platform_synced_block_patch_8')) {
-          // No reference found
-          if (isSourceSyncBlock) {
-            var _this$fetchReferences4;
-            // 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.
-            const referenceResourceId = this.referenceSyncBlockStoreManager.generateResourceIdForReference(resourceId);
-            const hasUnregisteredReferenceOnPage = this.referenceSyncBlockStoreManager.getSubscribedResourceIds().includes(referenceResourceId);
-            if (hasUnregisteredReferenceOnPage) {
-              var _this$fetchReferences3;
-              // This is current page data. It is the same for data for source and reference
-              const sourceSyncBlockData = await this.sourceSyncBlockStoreManager.getSyncBlockSourceInfo(blockInstanceId);
-              const references = [];
-              if (sourceSyncBlockData) {
-                references.push({
-                  ...sourceSyncBlockData,
-                  onSameDocument: Boolean(sourceSyncBlockData === null || sourceSyncBlockData === void 0 ? void 0 : sourceSyncBlockData.onSameDocument),
-                  hasAccess: true,
-                  isSource: true
-                });
-              }
-              const unregisteredReferenceData = await this.referenceSyncBlockStoreManager.fetchSyncBlockSourceInfo(referenceResourceId);
-              if (unregisteredReferenceData) {
-                references.push({
-                  ...unregisteredReferenceData,
-                  onSameDocument: true,
-                  hasAccess: true,
-                  isSource: false
-                });
-              }
-              (_this$fetchReferences3 = this.fetchReferencesExperience) === null || _this$fetchReferences3 === void 0 ? void 0 : _this$fetchReferences3.success();
-              return {
-                references
-              };
-            }
-
-            // 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 ? void 0 : _this$fetchReferences4.success();
-            return {
-              references: []
-            };
-          }
-          if (!isSourceSyncBlock) {
-            var _this$fetchReferences6;
-            // 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.
-            const references = [];
-            const sourceSyncBlockData = await this.referenceSyncBlockStoreManager.fetchSyncBlockSourceInfo(resourceId);
-            if (sourceSyncBlockData) {
-              references.push({
-                ...sourceSyncBlockData,
-                onSameDocument: Boolean(sourceSyncBlockData === null || sourceSyncBlockData === void 0 ? void 0 : sourceSyncBlockData.onSameDocument),
-                hasAccess: true,
-                isSource: true
-              });
-            }
-            const currentPageData = await this.referenceSyncBlockStoreManager.fetchSyncBlockSourceInfoByLocalId(blockInstanceId);
-            if (currentPageData) {
-              references.push({
-                ...currentPageData,
-                onSameDocument: true,
-                hasAccess: true,
-                isSource: false
-              });
-            }
-            if (references.length === 0) {
-              var _this$fetchReferences5;
-              (_this$fetchReferences5 = this.fetchReferencesExperience) === null || _this$fetchReferences5 === void 0 ? void 0 : _this$fetchReferences5.failure({
-                reason: 'No references found for reference synced block'
-              });
-              return {
-                error: SyncBlockError.Errored
-              };
-            }
-            (_this$fetchReferences6 = this.fetchReferencesExperience) === null || _this$fetchReferences6 === void 0 ? void 0 : _this$fetchReferences6.success();
-            return {
-              references
-            };
-          }
+          return this.getUnregisteredReferences(resourceId, blockInstanceId, isSourceSyncBlock);
         } else {
           // No reference found
           if (isSourceSyncBlock) {
-            var _this$fetchReferences7;
-            (_this$fetchReferences7 = this.fetchReferencesExperience) === null || _this$fetchReferences7 === void 0 ? void 0 : _this$fetchReferences7.success();
+            var _this$fetchReferences3;
+            (_this$fetchReferences3 = this.fetchReferencesExperience) === null || _this$fetchReferences3 === void 0 ? void 0 : _this$fetchReferences3.success();
           } else {
-            var _this$fetchReferences8;
-            (_this$fetchReferences8 = this.fetchReferencesExperience) === null || _this$fetchReferences8 === void 0 ? void 0 : _this$fetchReferences8.failure({
+            var _this$fetchReferences4;
+            (_this$fetchReferences4 = this.fetchReferencesExperience) === null || _this$fetchReferences4 === void 0 ? void 0 : _this$fetchReferences4.failure({
               reason: 'No references found for reference synced block'
             });
           }
@@ -139,7 +60,7 @@ export class SyncBlockStoreManager {
           };
         }
       }
-      (_this$fetchReferences9 = this.fetchReferencesExperience) === null || _this$fetchReferences9 === void 0 ? void 0 : _this$fetchReferences9.success();
+      (_this$fetchReferences5 = this.fetchReferencesExperience) === null || _this$fetchReferences5 === void 0 ? void 0 : _this$fetchReferences5.success();
       const sourceInfoPromises = ((_response$references2 = response.references) !== null && _response$references2 !== void 0 ? _response$references2 : []).map(async reference => {
         var _this$fetchSourceInfo, _this$dataProvider, _this$fetchSourceInfo3;
         (_this$fetchSourceInfo = this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo === void 0 ? void 0 : _this$fetchSourceInfo.start();
@@ -198,16 +119,95 @@ export class SyncBlockStoreManager {
     return this.sourceSyncBlockStoreManager;
   }
   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 ? void 0 : _this$fetchReferences0.abort({
+    (_this$fetchReferences6 = this.fetchReferencesExperience) === null || _this$fetchReferences6 === void 0 ? void 0 : _this$fetchReferences6.abort({
       reason: 'editorDestroyed'
     });
     (_this$fetchSourceInfo4 = this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo4 === void 0 ? void 0 : _this$fetchSourceInfo4.abort({
       reason: 'editorDestroyed'
     });
   }
+  async getUnregisteredReferences(resourceId, blockInstanceId, isSourceSyncBlock) {
+    var _this$fetchReferences0;
+    // No reference found
+    if (isSourceSyncBlock) {
+      var _this$fetchReferences8;
+      // 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.
+      const referenceResourceId = this.referenceSyncBlockStoreManager.generateResourceIdForReference(resourceId);
+      const hasUnregisteredReferenceOnPage = this.referenceSyncBlockStoreManager.getSubscribedResourceIds().includes(referenceResourceId);
+      if (hasUnregisteredReferenceOnPage) {
+        var _this$fetchReferences7;
+        // This is current page data. It is the same for data for source and reference
+        const sourceSyncBlockData = await this.sourceSyncBlockStoreManager.getSyncBlockSourceInfo(blockInstanceId);
+        const references = [];
+        if (sourceSyncBlockData) {
+          const sourceSyncBlockReference = {
+            ...sourceSyncBlockData,
+            onSameDocument: true,
+            hasAccess: true,
+            isSource: true
+          };
+          const referenceSyncBlockReference = {
+            ...sourceSyncBlockData,
+            onSameDocument: true,
+            hasAccess: true,
+            isSource: false
+          };
+          references.push(sourceSyncBlockReference, referenceSyncBlockReference);
+        }
+        (_this$fetchReferences7 = this.fetchReferencesExperience) === null || _this$fetchReferences7 === void 0 ? void 0 : _this$fetchReferences7.success();
+        return {
+          references
+        };
+      }
+
+      // 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 ? void 0 : _this$fetchReferences8.success();
+      return {
+        references: []
+      };
+    }
+
+    // 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.
+    const references = [];
+    const sourceSyncBlockData = await this.referenceSyncBlockStoreManager.fetchSyncBlockSourceInfo(resourceId);
+    if (sourceSyncBlockData) {
+      references.push({
+        ...sourceSyncBlockData,
+        onSameDocument: Boolean(sourceSyncBlockData === null || sourceSyncBlockData === void 0 ? void 0 : sourceSyncBlockData.onSameDocument),
+        hasAccess: true,
+        isSource: true
+      });
+    }
+    const currentPageData = await this.referenceSyncBlockStoreManager.fetchSyncBlockSourceInfoByLocalId(blockInstanceId);
+    if (currentPageData) {
+      references.push({
+        ...currentPageData,
+        onSameDocument: true,
+        hasAccess: true,
+        isSource: false
+      });
+    }
+    if (references.length === 0) {
+      var _this$fetchReferences9;
+      (_this$fetchReferences9 = this.fetchReferencesExperience) === null || _this$fetchReferences9 === void 0 ? void 0 : _this$fetchReferences9.failure({
+        reason: 'No references found for reference synced block'
+      });
+      return {
+        error: SyncBlockError.Errored
+      };
+    }
+    (_this$fetchReferences0 = this.fetchReferencesExperience) === null || _this$fetchReferences0 === void 0 ? void 0 : _this$fetchReferences0.success();
+    return {
+      references
+    };
+  }
 }
 const createSyncBlockStoreManager = dataProvider => {
   return new SyncBlockStoreManager(dataProvider);

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

@@ -11,6 +11,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 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';
@@ -30,7 +31,7 @@ var CACHE_KEY_PREFIX = 'sync-block-data-';
 export var 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;
     _classCallCheck(this, ReferenceSyncBlockStoreManager);
@@ -45,6 +46,7 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
     // 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();
@@ -695,14 +697,20 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
         return _regeneratorRuntime.wrap(function _callee3$(_context4) {
           while (1) switch (_context4.prev = _context4.next) {
             case 0:
-              if (this.isCacheDirty) {
+              if (!(this.viewMode === 'view' && 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
@@ -710,22 +718,22 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
 
               // 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__*/_regeneratorRuntime.mark(function _loop() {
                 var _step$value, resourceId, callbacks;
                 return _regeneratorRuntime.wrap(function _loop$(_context3) {
@@ -747,34 +755,34 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
                 }, _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 (!isEqual(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
@@ -782,9 +790,9 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
               // 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;
@@ -793,11 +801,11 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
                 });
                 (_this$fireAnalyticsEv6 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv6 === void 0 || _this$fireAnalyticsEv6.call(this, 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;
               logException(_context4.t2, {
                 location: 'editor-synced-block-provider/referenceSyncBlockStoreManager'
@@ -806,8 +814,8 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
                 reason: _context4.t2.message
               });
               (_this$fireAnalyticsEv7 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv7 === void 0 || _this$fireAnalyticsEv7.call(this, 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;
@@ -829,14 +837,14 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
                   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);