@atlaskit/editor-synced-block-provider 3.31.0 → 3.31.2

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/editor-synced-block-provider
 
+## 3.31.2
+
+### Patch Changes
+
+- [`432dbdcd07917`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/432dbdcd07917) -
+  EDITOR-5500 add hasUnsavedBodiedSyncBlocks state to synced block plugin to allow confluence to
+  check whether changes have been saved yet before leaving the page
+
+## 3.31.1
+
+### Patch Changes
+
+- [`6424f86f6390a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/6424f86f6390a) -
+  Improve Synced Blocks robustness
+- Updated dependencies
+
 ## 3.31.0
 
 ### Minor Changes

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

@@ -22,7 +22,10 @@ var _experienceTracking = require("../utils/experienceTracking");
 var _resolveSyncBlockInstance = require("../utils/resolveSyncBlockInstance");
 var _resourceId = require("../utils/resourceId");
 var _utils = require("../utils/utils");
+var _syncBlockBatchFetcher = require("./syncBlockBatchFetcher");
 var _syncBlockInMemorySessionCache = require("./syncBlockInMemorySessionCache");
+var _syncBlockProviderFactoryManager = require("./syncBlockProviderFactoryManager");
+var _syncBlockSubscriptionManager = require("./syncBlockSubscriptionManager");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
@@ -85,6 +88,50 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
     this.graphqlSubscriptions = new Map();
     this.subscriptionChangeListeners = new Set();
     this.newlyAddedSyncBlocks = new Set();
+    if ((0, _platformFeatureFlags.fg)('platform_synced_block_patch_5')) {
+      this._subscriptionManager = new _syncBlockSubscriptionManager.SyncBlockSubscriptionManager({
+        getDataProvider: function getDataProvider() {
+          return _this.dataProvider;
+        },
+        getSubscriptions: function getSubscriptions() {
+          return _this.subscriptions;
+        },
+        getFromCache: function getFromCache(rid) {
+          return _this.getFromCache(rid);
+        },
+        updateCache: function updateCache(inst) {
+          return _this.updateCache(inst);
+        },
+        fetchSyncBlockSourceInfo: function fetchSyncBlockSourceInfo(rid) {
+          return _this.fetchSyncBlockSourceInfo(rid);
+        },
+        getFireAnalyticsEvent: function getFireAnalyticsEvent() {
+          return _this.fireAnalyticsEvent;
+        }
+      });
+      this._providerFactoryManager = new _syncBlockProviderFactoryManager.SyncBlockProviderFactoryManager({
+        getDataProvider: function getDataProvider() {
+          return _this.dataProvider;
+        },
+        getFromCache: function getFromCache(rid) {
+          return _this.getFromCache(rid);
+        },
+        getFireAnalyticsEvent: function getFireAnalyticsEvent() {
+          return _this.fireAnalyticsEvent;
+        }
+      });
+      this._batchFetcher = new _syncBlockBatchFetcher.SyncBlockBatchFetcher({
+        getSubscriptions: function getSubscriptions() {
+          return _this.subscriptions;
+        },
+        fetchSyncBlocksData: function fetchSyncBlocksData(nodes) {
+          return _this.fetchSyncBlocksData(nodes);
+        },
+        getFireAnalyticsEvent: function getFireAnalyticsEvent() {
+          return _this.fireAnalyticsEvent;
+        }
+      });
+    }
 
     // The provider might have SSR data cache already set, so we need to update the cache in session memory storage
     this.setSSRDataInSessionCache((_this$dataProvider = this.dataProvider) === null || _this$dataProvider === void 0 ? void 0 : _this$dataProvider.getNodeDataCacheKeys());
@@ -99,6 +146,10 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
   return (0, _createClass2.default)(ReferenceSyncBlockStoreManager, [{
     key: "setRealTimeSubscriptionsEnabled",
     value: function setRealTimeSubscriptionsEnabled(enabled) {
+      if (this._subscriptionManager && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_5')) {
+        this._subscriptionManager.setRealTimeSubscriptionsEnabled(enabled);
+        return;
+      }
       if (this.useRealTimeSubscriptions === enabled) {
         return;
       }
@@ -118,6 +169,9 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
   }, {
     key: "isRealTimeSubscriptionsEnabled",
     value: function isRealTimeSubscriptionsEnabled() {
+      if (this._subscriptionManager && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_5')) {
+        return this._subscriptionManager.isRealTimeSubscriptionsEnabled();
+      }
       return this.useRealTimeSubscriptions;
     }
 
@@ -128,6 +182,9 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
   }, {
     key: "getSubscribedResourceIds",
     value: function getSubscribedResourceIds() {
+      if (this._subscriptionManager && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_5')) {
+        return this._subscriptionManager.getSubscribedResourceIds();
+      }
       return Array.from(this.subscriptions.keys());
     }
 
@@ -140,6 +197,9 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
     key: "onSubscriptionsChanged",
     value: function onSubscriptionsChanged(listener) {
       var _this2 = this;
+      if (this._subscriptionManager && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_5')) {
+        return this._subscriptionManager.onSubscriptionsChanged(listener);
+      }
       this.subscriptionChangeListeners.add(listener);
       return function () {
         _this2.subscriptionChangeListeners.delete(listener);
@@ -153,6 +213,10 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
     key: "notifySubscriptionChangeListeners",
     value: function notifySubscriptionChangeListeners() {
       var _this3 = this;
+      if (this._subscriptionManager && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_5')) {
+        this._subscriptionManager.notifySubscriptionChangeListeners();
+        return;
+      }
       this.subscriptionChangeListeners.forEach(function (listener) {
         try {
           listener();
@@ -174,6 +238,10 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
   }, {
     key: "handleSubscriptionUpdate",
     value: function handleSubscriptionUpdate(syncBlockInstance) {
+      if (this._subscriptionManager && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_5')) {
+        this._subscriptionManager.handleSubscriptionUpdate(syncBlockInstance);
+        return;
+      }
       if (!syncBlockInstance.resourceId) {
         return;
       }
@@ -361,6 +429,11 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
     value: function setupGraphQLSubscription(resourceId) {
       var _this$dataProvider3,
         _this4 = this;
+      if (this._subscriptionManager && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_5')) {
+        this._subscriptionManager.setupSubscription(resourceId);
+        return;
+      }
+
       // Don't set up duplicate subscriptions
       if (this.graphqlSubscriptions.has(resourceId)) {
         return;
@@ -422,6 +495,10 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
   }, {
     key: "cleanupGraphQLSubscription",
     value: function cleanupGraphQLSubscription(resourceId) {
+      if (this._subscriptionManager && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_5')) {
+        this._subscriptionManager.cleanupSubscription(resourceId);
+        return;
+      }
       var unsubscribe = this.graphqlSubscriptions.get(resourceId);
       if (unsubscribe) {
         unsubscribe();
@@ -435,6 +512,10 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
   }, {
     key: "setupGraphQLSubscriptionsForAllBlocks",
     value: function setupGraphQLSubscriptionsForAllBlocks() {
+      if (this._subscriptionManager && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_5')) {
+        this._subscriptionManager.setupSubscriptionsForAllBlocks();
+        return;
+      }
       var _iterator2 = _createForOfIteratorHelper(this.subscriptions.keys()),
         _step2;
       try {
@@ -455,6 +536,10 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
   }, {
     key: "cleanupAllGraphQLSubscriptions",
     value: function cleanupAllGraphQLSubscriptions() {
+      if (this._subscriptionManager && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_5')) {
+        this._subscriptionManager.cleanupAll();
+        return;
+      }
       var _iterator3 = _createForOfIteratorHelper(this.graphqlSubscriptions.values()),
         _step3;
       try {
@@ -783,14 +868,13 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
             hasUnexpectedError = true;
           }
           return;
-        } else {
-          var callbacks = _this9.subscriptions.get(syncBlockInstance.resourceId);
-          var localIds = callbacks ? Object.keys(callbacks) : [];
-          localIds.forEach(function (localId) {
-            var _this9$fireAnalyticsE4, _syncBlockInstance$da2;
-            (_this9$fireAnalyticsE4 = _this9.fireAnalyticsEvent) === null || _this9$fireAnalyticsE4 === void 0 || _this9$fireAnalyticsE4.call(_this9, (0, _errorHandling.fetchSuccessPayload)(syncBlockInstance.resourceId, localId, (_syncBlockInstance$da2 = syncBlockInstance.data) === null || _syncBlockInstance$da2 === void 0 ? void 0 : _syncBlockInstance$da2.product));
-          });
         }
+        var callbacks = _this9.subscriptions.get(syncBlockInstance.resourceId);
+        var localIds = callbacks ? Object.keys(callbacks) : [];
+        localIds.forEach(function (localId) {
+          var _this9$fireAnalyticsE4, _syncBlockInstance$da2;
+          (_this9$fireAnalyticsE4 = _this9.fireAnalyticsEvent) === null || _this9$fireAnalyticsE4 === void 0 || _this9$fireAnalyticsE4.call(_this9, (0, _errorHandling.fetchSuccessPayload)(syncBlockInstance.resourceId, localId, (_syncBlockInstance$da2 = syncBlockInstance.data) === null || _syncBlockInstance$da2 === void 0 ? void 0 : _syncBlockInstance$da2.product));
+        });
         _this9.fetchSyncBlockSourceInfo(resolvedSyncBlockInstance.resourceId);
       });
       return {
@@ -856,11 +940,19 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
     value: function deleteFromCache(resourceId) {
       var _this$dataProvider6;
       (_this$dataProvider6 = this.dataProvider) === null || _this$dataProvider6 === void 0 || _this$dataProvider6.removeFromCache([resourceId]);
-      this.providerFactories.delete(resourceId);
+      if (this._providerFactoryManager && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_5')) {
+        this._providerFactoryManager.deleteFactory(resourceId);
+      } else {
+        this.providerFactories.delete(resourceId);
+      }
     }
   }, {
     key: "debouncedBatchedFetchSyncBlocks",
     value: function debouncedBatchedFetchSyncBlocks(resourceId) {
+      if (this._batchFetcher && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_5')) {
+        this._batchFetcher.queueFetch(resourceId);
+        return;
+      }
       // Only add to pending requests if there are active subscriptions for this resource
       if (this.subscriptions.has(resourceId) && Object.keys(this.subscriptions.get(resourceId) || {}).length > 0) {
         this.pendingFetchRequests.add(resourceId);
@@ -916,7 +1008,8 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
       }
 
       // Set up GraphQL subscription if real-time subscriptions are enabled
-      if (this.useRealTimeSubscriptions) {
+      var useRealTime = this._subscriptionManager && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_5') ? this._subscriptionManager.shouldUseRealTime() : this.useRealTimeSubscriptions;
+      if (useRealTime) {
         this.setupGraphQLSubscription(resourceId);
       }
       return function () {
@@ -1031,6 +1124,9 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
   }, {
     key: "getProviderFactory",
     value: function getProviderFactory(resourceId) {
+      if (this._providerFactoryManager && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_5')) {
+        return this._providerFactoryManager.getProviderFactory(resourceId);
+      }
       if (!this.dataProvider) {
         var _this$fireAnalyticsEv8;
         var error = new Error('Data provider not set');
@@ -1078,6 +1174,9 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
   }, {
     key: "getSSRProviders",
     value: function getSSRProviders(resourceId) {
+      if (this._providerFactoryManager && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_5')) {
+        return this._providerFactoryManager.getSSRProviders(resourceId);
+      }
       if (!this.dataProvider) {
         return null;
       }
@@ -1340,6 +1439,12 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
         clearTimeout(this.queuedFlushTimeout);
         this.queuedFlushTimeout = undefined;
       }
+      if ((0, _platformFeatureFlags.fg)('platform_synced_block_patch_5')) {
+        var _this$_subscriptionMa, _this$_providerFactor, _this$_batchFetcher;
+        (_this$_subscriptionMa = this._subscriptionManager) === null || _this$_subscriptionMa === void 0 || _this$_subscriptionMa.destroy();
+        (_this$_providerFactor = this._providerFactoryManager) === null || _this$_providerFactor === void 0 || _this$_providerFactor.destroy();
+        (_this$_batchFetcher = this._batchFetcher) === null || _this$_batchFetcher === void 0 || _this$_batchFetcher.destroy();
+      }
 
       // Clean up all GraphQL subscriptions first
       this.cleanupAllGraphQLSubscriptions();
@@ -1368,6 +1473,9 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
         reason: 'editorDestroyed'
       });
       this.fireAnalyticsEvent = undefined;
+      if ((0, _platformFeatureFlags.fg)('platform_synced_block_patch_5')) {
+        _syncBlockInMemorySessionCache.syncBlockInMemorySessionCache.clear();
+      }
     }
   }]);
 }();

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

@@ -10,7 +10,9 @@ var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 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");
@@ -26,6 +28,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
   function SourceSyncBlockStoreManager(dataProvider) {
     var _this = this;
     (0, _classCallCheck2.default)(this, SourceSyncBlockStoreManager);
+    (0, _defineProperty2.default)(this, "hasReceivedContentChange", false);
     (0, _defineProperty2.default)(this, "setPendingDeletion", function (Ids, value) {
       var syncBlock = _this.syncBlockCache.get(Ids.resourceId);
       if (syncBlock) {
@@ -69,6 +72,12 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
           throw new Error('Local ID or resource ID is not set');
         }
         var syncBlockData = (0, _utils.convertSyncBlockPMNodeToSyncBlockData)(syncBlockNode);
+        if ((0, _platformFeatureFlags.fg)('platform_synced_block_patch_5')) {
+          var cachedBlock = this.syncBlockCache.get(resourceId);
+          if (cachedBlock && !(0, _isEqual.default)(syncBlockData.content, cachedBlock.content)) {
+            this.hasReceivedContentChange = true;
+          }
+        }
         this.syncBlockCache.set(resourceId, _objectSpread(_objectSpread({}, syncBlockData), {}, {
           isDirty: true
         }));
@@ -197,6 +206,13 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
       }
       return flush;
     }())
+  }, {
+    key: "hasUnsavedChanges",
+    value: function hasUnsavedChanges() {
+      return this.hasReceivedContentChange && Array.from(this.syncBlockCache.values()).some(function (syncBlockData) {
+        return syncBlockData.isDirty;
+      });
+    }
   }, {
     key: "isPendingCreation",
     value: function isPendingCreation(resourceId) {

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

@@ -0,0 +1,76 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SyncBlockBatchFetcher = void 0;
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _rafSchd = _interopRequireDefault(require("raf-schd"));
+var _monitoring = require("@atlaskit/editor-common/monitoring");
+var _errorHandling = require("../utils/errorHandling");
+var _utils = require("../utils/utils");
+/**
+ * Handles debounced batch-fetching of sync block data via `raf-schd`.
+ * Accumulates resource IDs and flushes them in a single fetch per
+ * animation frame.
+ */
+var SyncBlockBatchFetcher = exports.SyncBlockBatchFetcher = /*#__PURE__*/function () {
+  function SyncBlockBatchFetcher(deps) {
+    var _this = this;
+    (0, _classCallCheck2.default)(this, SyncBlockBatchFetcher);
+    (0, _defineProperty2.default)(this, "pendingFetchRequests", new Set());
+    this.deps = deps;
+    this.scheduledBatchFetch = (0, _rafSchd.default)(function () {
+      if (_this.pendingFetchRequests.size === 0) {
+        return;
+      }
+      var resourceIds = Array.from(_this.pendingFetchRequests);
+      var syncBlockNodes = resourceIds.map(function (resId) {
+        var subscriptions = _this.deps.getSubscriptions().get(resId) || {};
+        var firstLocalId = Object.keys(subscriptions)[0] || '';
+        return (0, _utils.createSyncBlockNode)(firstLocalId, resId);
+      });
+      _this.pendingFetchRequests.clear();
+      _this.deps.fetchSyncBlocksData(syncBlockNodes).catch(function (error) {
+        (0, _monitoring.logException)(error, {
+          location: 'editor-synced-block-provider/syncBlockBatchFetcher/batchedFetchSyncBlocks'
+        });
+        resourceIds.forEach(function (resId) {
+          var _this$deps$getFireAna;
+          (_this$deps$getFireAna = _this.deps.getFireAnalyticsEvent()) === null || _this$deps$getFireAna === void 0 || _this$deps$getFireAna((0, _errorHandling.fetchErrorPayload)(error.message, resId));
+        });
+      });
+    });
+  }
+  return (0, _createClass2.default)(SyncBlockBatchFetcher, [{
+    key: "queueFetch",
+    value: function queueFetch(resourceId) {
+      var subscriptions = this.deps.getSubscriptions();
+      if (subscriptions.has(resourceId) && Object.keys(subscriptions.get(resourceId) || {}).length > 0) {
+        this.pendingFetchRequests.add(resourceId);
+        this.scheduledBatchFetch();
+      } else {
+        this.pendingFetchRequests.delete(resourceId);
+      }
+    }
+  }, {
+    key: "cancel",
+    value: function cancel() {
+      this.scheduledBatchFetch.cancel();
+    }
+  }, {
+    key: "clearPending",
+    value: function clearPending() {
+      this.pendingFetchRequests.clear();
+    }
+  }, {
+    key: "destroy",
+    value: function destroy() {
+      this.cancel();
+      this.clearPending();
+    }
+  }]);
+}();

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

@@ -22,6 +22,13 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
  * (least-recently-used) entries are evicted first.
  */
 var SyncBlockInMemorySessionCache = exports.SyncBlockInMemorySessionCache = /*#__PURE__*/function () {
+  /**
+   * Maximum total size of all cached values, measured in **UTF-16 code
+   * units** (i.e. `String.prototype.length`), not bytes.  For ASCII-only
+   * content the two are equivalent; for content with characters outside
+   * the BMP each surrogate pair counts as 2.
+   */
+
   function SyncBlockInMemorySessionCache() {
     var maxSize = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 5 * 1024 * 1024;
     (0, _classCallCheck2.default)(this, SyncBlockInMemorySessionCache);
@@ -29,6 +36,14 @@ var SyncBlockInMemorySessionCache = exports.SyncBlockInMemorySessionCache = /*#_
     (0, _defineProperty2.default)(this, "currentSize", 0);
     this.maxSize = maxSize;
   }
+
+  /**
+   * Retrieves a cached value by key.
+   *
+   * **Side-effect:** promotes the entry to the most-recently-used
+   * position by re-inserting it at the end of the underlying Map's
+   * iteration order.
+   */
   return (0, _createClass2.default)(SyncBlockInMemorySessionCache, [{
     key: "getItem",
     value: function getItem(key) {
@@ -70,6 +85,17 @@ var SyncBlockInMemorySessionCache = exports.SyncBlockInMemorySessionCache = /*#_
         this.store.delete(key);
       }
     }
+
+    /**
+     * Removes all entries from the cache and resets the tracked size to zero.
+     * Useful for cleaning up the singleton on SPA navigation boundaries.
+     */
+  }, {
+    key: "clear",
+    value: function clear() {
+      this.store.clear();
+      this.currentSize = 0;
+    }
   }]);
 }();
 var syncBlockInMemorySessionCache = exports.syncBlockInMemorySessionCache = new SyncBlockInMemorySessionCache();

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

@@ -0,0 +1,175 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SyncBlockProviderFactoryManager = void 0;
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _monitoring = require("@atlaskit/editor-common/monitoring");
+var _providerFactory = require("@atlaskit/editor-common/provider-factory");
+var _errorHandling = require("../utils/errorHandling");
+var _resourceId = require("../utils/resourceId");
+/**
+ * Manages creation and caching of ProviderFactory instances used to
+ * render synced block content (media, emoji, smart links, etc.).
+ */
+var SyncBlockProviderFactoryManager = exports.SyncBlockProviderFactoryManager = /*#__PURE__*/function () {
+  function SyncBlockProviderFactoryManager(deps) {
+    (0, _classCallCheck2.default)(this, SyncBlockProviderFactoryManager);
+    (0, _defineProperty2.default)(this, "providerFactories", new Map());
+    this.deps = deps;
+  }
+  return (0, _createClass2.default)(SyncBlockProviderFactoryManager, [{
+    key: "getProviderFactory",
+    value: function getProviderFactory(resourceId) {
+      var dataProvider = this.deps.getDataProvider();
+      if (!dataProvider) {
+        var _this$deps$getFireAna;
+        var error = new Error('Data provider not set');
+        (0, _monitoring.logException)(error, {
+          location: 'editor-synced-block-provider/syncBlockProviderFactoryManager'
+        });
+        (_this$deps$getFireAna = this.deps.getFireAnalyticsEvent()) === null || _this$deps$getFireAna === void 0 || _this$deps$getFireAna((0, _errorHandling.fetchErrorPayload)(error.message));
+        return undefined;
+      }
+      var _dataProvider$getSync = dataProvider.getSyncedBlockRendererProviderOptions(),
+        parentDataProviders = _dataProvider$getSync.parentDataProviders,
+        providerCreator = _dataProvider$getSync.providerCreator;
+      var providerFactory = this.providerFactories.get(resourceId);
+      if (!providerFactory) {
+        providerFactory = _providerFactory.ProviderFactory.create({
+          mentionProvider: parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.mentionProvider,
+          profilecardProvider: parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.profilecardProvider,
+          taskDecisionProvider: parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.taskDecisionProvider
+        });
+        this.providerFactories.set(resourceId, providerFactory);
+      } else {
+        if (parentDataProviders !== null && parentDataProviders !== void 0 && parentDataProviders.mentionProvider) {
+          providerFactory.setProvider('mentionProvider', parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.mentionProvider);
+        }
+        if (parentDataProviders !== null && parentDataProviders !== void 0 && parentDataProviders.profilecardProvider) {
+          providerFactory.setProvider('profilecardProvider', parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.profilecardProvider);
+        }
+        if (parentDataProviders !== null && parentDataProviders !== void 0 && parentDataProviders.taskDecisionProvider) {
+          providerFactory.setProvider('taskDecisionProvider', parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.taskDecisionProvider);
+        }
+      }
+      if (providerCreator) {
+        try {
+          this.retrieveDynamicProviders(resourceId, providerFactory, providerCreator);
+        } catch (error) {
+          var _this$deps$getFireAna2;
+          (0, _monitoring.logException)(error, {
+            location: 'editor-synced-block-provider/syncBlockProviderFactoryManager'
+          });
+          (_this$deps$getFireAna2 = this.deps.getFireAnalyticsEvent()) === null || _this$deps$getFireAna2 === void 0 || _this$deps$getFireAna2((0, _errorHandling.fetchErrorPayload)(error.message, resourceId));
+        }
+      }
+      return providerFactory;
+    }
+  }, {
+    key: "getSSRProviders",
+    value: function getSSRProviders(resourceId) {
+      var dataProvider = this.deps.getDataProvider();
+      if (!dataProvider) {
+        return null;
+      }
+      var _dataProvider$getSync2 = dataProvider.getSyncedBlockRendererProviderOptions(),
+        providerCreator = _dataProvider$getSync2.providerCreator;
+      if (!(providerCreator !== null && providerCreator !== void 0 && providerCreator.createSSRMediaProvider)) {
+        return null;
+      }
+      var parsedResourceId = (0, _resourceId.parseResourceId)(resourceId);
+      if (!parsedResourceId) {
+        return null;
+      }
+      var contentId = parsedResourceId.contentId,
+        contentProduct = parsedResourceId.product;
+      try {
+        var mediaProvider = providerCreator.createSSRMediaProvider({
+          contentId: contentId,
+          contentProduct: contentProduct
+        });
+        if (mediaProvider) {
+          return {
+            media: mediaProvider
+          };
+        }
+      } catch (error) {
+        (0, _monitoring.logException)(error, {
+          location: 'editor-synced-block-provider/syncBlockProviderFactoryManager'
+        });
+      }
+      return null;
+    }
+  }, {
+    key: "deleteFactory",
+    value: function deleteFactory(resourceId) {
+      this.providerFactories.delete(resourceId);
+    }
+  }, {
+    key: "destroy",
+    value: function destroy() {
+      this.providerFactories.forEach(function (pf) {
+        return pf.destroy();
+      });
+      this.providerFactories.clear();
+    }
+  }, {
+    key: "retrieveDynamicProviders",
+    value: function retrieveDynamicProviders(resourceId, providerFactory, providerCreator) {
+      var dataProvider = this.deps.getDataProvider();
+      if (!dataProvider) {
+        throw new Error('Data provider not set');
+      }
+      var hasMediaProvider = providerFactory.hasProvider('mediaProvider');
+      var hasEmojiProvider = providerFactory.hasProvider('emojiProvider');
+      var hasCardProvider = providerFactory.hasProvider('cardProvider');
+      if (hasMediaProvider && hasEmojiProvider && hasCardProvider) {
+        return;
+      }
+      var syncBlock = this.deps.getFromCache(resourceId);
+      if (!(syncBlock !== null && syncBlock !== void 0 && syncBlock.data)) {
+        return;
+      }
+      if (!syncBlock.data.sourceAri || !syncBlock.data.product) {
+        var _this$deps$getFireAna3;
+        (_this$deps$getFireAna3 = this.deps.getFireAnalyticsEvent()) === null || _this$deps$getFireAna3 === void 0 || _this$deps$getFireAna3((0, _errorHandling.fetchErrorPayload)('Sync block source ari or product not found'));
+        return;
+      }
+      var parentInfo = dataProvider.retrieveSyncBlockParentInfo(syncBlock.data.sourceAri, syncBlock.data.product);
+      if (!parentInfo) {
+        throw new Error('Unable to retrieve sync block parent info');
+      }
+      var contentId = parentInfo.contentId,
+        contentProduct = parentInfo.contentProduct;
+      if (!hasMediaProvider && providerCreator.createMediaProvider && contentId && contentProduct) {
+        var mediaProvider = providerCreator.createMediaProvider({
+          contentProduct: contentProduct,
+          contentId: contentId
+        });
+        if (mediaProvider) {
+          providerFactory.setProvider('mediaProvider', mediaProvider);
+        }
+      }
+      if (!hasEmojiProvider && providerCreator.createEmojiProvider && contentId && contentProduct) {
+        var emojiProvider = providerCreator.createEmojiProvider({
+          contentProduct: contentProduct,
+          contentId: contentId
+        });
+        if (emojiProvider) {
+          providerFactory.setProvider('emojiProvider', emojiProvider);
+        }
+      }
+      if (!hasCardProvider && providerCreator.createSmartLinkProvider) {
+        var smartLinkProvider = providerCreator.createSmartLinkProvider();
+        if (smartLinkProvider) {
+          providerFactory.setProvider('cardProvider', smartLinkProvider);
+        }
+      }
+    }
+  }]);
+}();