@atlaskit/editor-synced-block-provider 2.10.6 → 2.11.1

package/dist/esm/hooks/useHandleContentChanges.js

@@ -1,10 +1,6 @@
 import { useEffect } from 'react';
 export var useHandleContentChanges = function useHandleContentChanges(manager, syncBlockNode) {
   useEffect(function () {
-    try {
-      manager.sourceManager.updateSyncBlockData(syncBlockNode);
-    } catch (_unused) {
-      //TODO: EDITOR-1921 - add error analytics
-    }
+    manager.sourceManager.updateSyncBlockData(syncBlockNode);
   }, [manager, syncBlockNode]);
 };

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

@@ -95,13 +95,16 @@ var BlockServiceADFFetchProvider = /*#__PURE__*/function () {
  * ADFWriteProvider implementation that writes synced block data to Block Service API
  */
 var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
-  function BlockServiceADFWriteProvider() {
+  function BlockServiceADFWriteProvider(sourceAri, product) {
     _classCallCheck(this, BlockServiceADFWriteProvider);
+    this.sourceAri = sourceAri;
+    this.product = product;
   }
+
+  // it will first try to update and if it can't (404) then it will try to create
   return _createClass(BlockServiceADFWriteProvider, [{
     key: "writeData",
-    value: // it will first try to update and if it can't (404) then it will try to create
-    function () {
+    value: function () {
       var _writeData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(data) {
         var resourceId;
         return _regeneratorRuntime.wrap(function _callee2$(_context2) {
@@ -133,8 +136,8 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
               return createSyncedBlock({
                 blockAri: resourceId,
                 blockInstanceId: data.blockInstanceId,
-                sourceAri: resourceId,
-                product: 'confluence-page',
+                sourceAri: this.sourceAri,
+                product: this.product,
                 content: JSON.stringify(data.content)
               });
             case 13:
@@ -154,7 +157,7 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
             case "end":
               return _context2.stop();
           }
-        }, _callee2, null, [[1, 7]]);
+        }, _callee2, this, [[1, 7]]);
       }));
       function writeData(_x2) {
         return _writeData.apply(this, arguments);
@@ -210,22 +213,24 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
     }()
   }, {
     key: "generateResourceId",
-    value: function generateResourceId(sourceId, localId) {
-      return blockResourceIdFromSourceAndLocalId(sourceId, localId);
+    value: function generateResourceId(sourceAri, localId) {
+      return blockResourceIdFromSourceAndLocalId(sourceAri, localId);
     }
   }]);
 }();
 /**
  * Factory function to create both providers with shared configuration
  */
-var createBlockServiceAPIProviders = function createBlockServiceAPIProviders() {
+var createBlockServiceAPIProviders = function createBlockServiceAPIProviders(sourceAri, product) {
   var fetchProvider = new BlockServiceADFFetchProvider();
-  var writeProvider = new BlockServiceADFWriteProvider();
+  var writeProvider = new BlockServiceADFWriteProvider(sourceAri, product);
   return {
     fetchProvider: fetchProvider,
     writeProvider: writeProvider
   };
 };
-export var useMemoizedBlockServiceAPIProviders = function useMemoizedBlockServiceAPIProviders() {
-  return useMemo(createBlockServiceAPIProviders, []);
+export var useMemoizedBlockServiceAPIProviders = function useMemoizedBlockServiceAPIProviders(sourceAri, product) {
+  return useMemo(function () {
+    return createBlockServiceAPIProviders(sourceAri, product);
+  }, [sourceAri, product]);
 };

package/dist/esm/providers/syncBlockProvider.js

@@ -84,7 +84,7 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
           return data;
         }, function () {
           return {
-            status: SyncBlockError.Errored,
+            error: SyncBlockError.Errored,
             resourceId: resourceId
           };
         });
@@ -212,13 +212,13 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
      */
   }, {
     key: "fetchSyncBlockSourceInfo",
-    value: function fetchSyncBlockSourceInfo(localId, sourceAri, sourceProduct) {
+    value: function fetchSyncBlockSourceInfo(localId, sourceAri, sourceProduct, fireAnalyticsEvent) {
       if (!sourceAri || !sourceProduct) {
-        return Promise.resolve(undefined);
+        return Promise.reject(new Error('Source ari or source product is undefined'));
       }
       switch (sourceProduct) {
         case 'confluence-page':
-          return fetchConfluencePageInfo(sourceAri, localId);
+          return fetchConfluencePageInfo(sourceAri, localId, fireAnalyticsEvent);
         case 'jira-work-item':
           return Promise.reject(new Error('Jira work item source product not supported'));
         default:

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

@@ -9,8 +9,10 @@ import _regeneratorRuntime from "@babel/runtime/regenerator";
 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; } } }; }
 function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
 function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+import { logException } from '@atlaskit/editor-common/monitoring';
 import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 import { SyncBlockError } from '../common/types';
+import { fetchErrorPayload, getSourceInfoErrorPayload } from '../utils/errorHandling';
 import { resolveSyncBlockInstance } from '../utils/resolveSyncBlockInstance';
 import { createSyncBlockNode } from '../utils/utils';
 
@@ -20,7 +22,7 @@ import { createSyncBlockNode } from '../utils/utils';
 // Handles fetching source URL and title for sync blocks.
 // Can be used in both editor and renderer contexts.
 export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
-  function ReferenceSyncBlockStoreManager(dataProvider) {
+  function ReferenceSyncBlockStoreManager(dataProvider, fireAnalyticsEvent) {
     _classCallCheck(this, ReferenceSyncBlockStoreManager);
     _defineProperty(this, "isRefreshingSubscriptions", false);
     this.syncBlockCache = new Map();
@@ -29,17 +31,23 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
     this.dataProvider = dataProvider;
     this.syncBlockURLRequests = new Map();
     this.providerFactories = new Map();
+    this.fireAnalyticsEvent = fireAnalyticsEvent;
   }
-
-  /**
-   * Refreshes the subscriptions for all sync blocks.
-   * @returns {Promise<void>}
-   */
   return _createClass(ReferenceSyncBlockStoreManager, [{
+    key: "updateFireAnalyticsEvent",
+    value: function updateFireAnalyticsEvent(fireAnalyticsEvent) {
+      this.fireAnalyticsEvent = fireAnalyticsEvent;
+    }
+
+    /**
+     * Refreshes the subscriptions for all sync blocks.
+     * @returns {Promise<void>}
+     */
+  }, {
     key: "refreshSubscriptions",
     value: (function () {
       var _refreshSubscriptions = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
-        var syncBlocks, _iterator, _step, _loop;
+        var syncBlocks, _iterator, _step, _loop, _this$fireAnalyticsEv;
         return _regeneratorRuntime.wrap(function _callee$(_context2) {
           while (1) switch (_context2.prev = _context2.next) {
             case 0:
@@ -94,20 +102,24 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
               _context2.next = 23;
               return this.fetchSyncBlocksData(syncBlocks);
             case 23:
-              _context2.next = 27;
+              _context2.next = 29;
               break;
             case 25:
               _context2.prev = 25;
               _context2.t2 = _context2["catch"](20);
-            case 27:
-              _context2.prev = 27;
+              logException(_context2.t2, {
+                location: 'editor-synced-block-provider/referenceSyncBlockStoreManager'
+              });
+              (_this$fireAnalyticsEv = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv === void 0 || _this$fireAnalyticsEv.call(this, fetchErrorPayload(_context2.t2.message));
+            case 29:
+              _context2.prev = 29;
               this.isRefreshingSubscriptions = false;
-              return _context2.finish(27);
-            case 30:
+              return _context2.finish(29);
+            case 32:
             case "end":
               return _context2.stop();
           }
-        }, _callee, this, [[5, 14, 17, 20], [20, 25, 27, 30]]);
+        }, _callee, this, [[5, 14, 17, 20], [20, 25, 29, 32]]);
       }));
       function refreshSubscriptions() {
         return _refreshSubscriptions.apply(this, arguments);
@@ -117,43 +129,53 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
   }, {
     key: "fetchSyncBlockSourceInfo",
     value: function fetchSyncBlockSourceInfo(resourceId) {
-      var _existingSyncBlock$da,
-        _existingSyncBlock$da2,
-        _this = this;
-      if (!resourceId || !this.dataProvider) {
-        return;
-      }
-      if (this.syncBlockURLRequests.get(resourceId)) {
-        return;
-      }
-      this.syncBlockURLRequests.set(resourceId, true);
-      var existingSyncBlock = this.getFromCache(resourceId);
-      if (!existingSyncBlock) {
-        return;
-      }
+      var _this = this;
+      try {
+        var _existingSyncBlock$da, _existingSyncBlock$da2;
+        if (!resourceId || !this.dataProvider) {
+          throw new Error('Data provider or resourceId not set');
+        }
+        if (this.syncBlockURLRequests.get(resourceId)) {
+          return;
+        }
+        this.syncBlockURLRequests.set(resourceId, true);
+        var existingSyncBlock = this.getFromCache(resourceId);
+        if (!existingSyncBlock) {
+          throw new Error('No existing sync block to fetch source info for');
+        }
 
-      // skip if source URL and title are already present
-      if ((_existingSyncBlock$da = existingSyncBlock.data) !== null && _existingSyncBlock$da !== void 0 && _existingSyncBlock$da.sourceURL && (_existingSyncBlock$da2 = existingSyncBlock.data) !== null && _existingSyncBlock$da2 !== void 0 && _existingSyncBlock$da2.sourceTitle) {
-        return;
-      }
-      var _ref = existingSyncBlock.data || {},
-        sourceAri = _ref.sourceAri,
-        product = _ref.product,
-        blockInstanceId = _ref.blockInstanceId;
-      if (!sourceAri || !product || !blockInstanceId) {
-        return;
-      }
-      this.dataProvider.fetchSyncBlockSourceInfo(blockInstanceId, sourceAri, product).then(function (sourceInfo) {
-        if (!sourceInfo) {
+        // skip if source URL and title are already present
+        if ((_existingSyncBlock$da = existingSyncBlock.data) !== null && _existingSyncBlock$da !== void 0 && _existingSyncBlock$da.sourceURL && (_existingSyncBlock$da2 = existingSyncBlock.data) !== null && _existingSyncBlock$da2 !== void 0 && _existingSyncBlock$da2.sourceTitle) {
           return;
         }
-        _this.updateCacheWithSourceInfo(resourceId, sourceInfo);
-        if (sourceInfo.title) {
-          _this.updateSourceTitleSubscriptions(resourceId, sourceInfo.title);
+        var _ref = existingSyncBlock.data || {},
+          sourceAri = _ref.sourceAri,
+          product = _ref.product,
+          blockInstanceId = _ref.blockInstanceId;
+        if (!sourceAri || !product || !blockInstanceId) {
+          throw new Error('SourceAri, product or blockInstanceId missing');
         }
-      }).finally(function () {
-        _this.syncBlockURLRequests.delete(resourceId);
-      });
+        this.dataProvider.fetchSyncBlockSourceInfo(blockInstanceId, sourceAri, product, this.fireAnalyticsEvent).then(function (sourceInfo) {
+          if (!sourceInfo) {
+            return;
+          }
+          _this.updateCacheWithSourceInfo(resourceId, sourceInfo);
+          if (sourceInfo.title) {
+            _this.updateSourceTitleSubscriptions(resourceId, sourceInfo.title);
+          }
+        }).catch(function (error) {
+          var _this$fireAnalyticsEv2;
+          (_this$fireAnalyticsEv2 = _this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv2 === void 0 || _this$fireAnalyticsEv2.call(_this, getSourceInfoErrorPayload(error.message));
+        }).finally(function () {
+          _this.syncBlockURLRequests.delete(resourceId);
+        });
+      } catch (error) {
+        var _this$fireAnalyticsEv3;
+        logException(error, {
+          location: 'editor-synced-block-provider/referenceSyncBlockStoreManager'
+        });
+        (_this$fireAnalyticsEv3 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv3 === void 0 || _this$fireAnalyticsEv3.call(this, getSourceInfoErrorPayload(error.message));
+      }
     }
 
     /**
@@ -196,18 +218,16 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
               return this.dataProvider.fetchNodesData(nodesToFetch);
             case 8:
               data = _context3.sent;
-              if (data) {
-                _context3.next = 11;
-                break;
-              }
-              throw new Error('Failed to fetch sync block node data');
-            case 11:
               resolvedData = [];
               data.forEach(function (syncBlockInstance) {
                 if (!syncBlockInstance.resourceId) {
+                  var _this2$fireAnalyticsE;
+                  (_this2$fireAnalyticsE = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE === void 0 || _this2$fireAnalyticsE.call(_this2, fetchErrorPayload(syncBlockInstance.error || 'Returned sync block instance does not have resource id'));
                   return;
                 }
                 if (syncBlockInstance.error) {
+                  var _this2$fireAnalyticsE2;
+                  (_this2$fireAnalyticsE2 = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE2 === void 0 || _this2$fireAnalyticsE2.call(_this2, fetchErrorPayload(syncBlockInstance.error));
                   _this2.updateCache(syncBlockInstance);
                   resolvedData.push(syncBlockInstance);
                   return;
@@ -219,7 +239,7 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
                 _this2.fetchSyncBlockSourceInfo(resolvedSyncBlockInstance.resourceId);
               });
               return _context3.abrupt("return", [].concat(resolvedData, blocksWithNotFoundError));
-            case 14:
+            case 12:
             case "end":
               return _context3.stop();
           }
@@ -291,7 +311,13 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
       if (cachedData) {
         callback(cachedData);
       } else {
-        this.fetchSyncBlocksData([createSyncBlockNode(localId, resourceId)]).catch(function () {});
+        this.fetchSyncBlocksData([createSyncBlockNode(localId, resourceId)]).catch(function (error) {
+          var _this3$fireAnalyticsE;
+          logException(error, {
+            location: 'editor-synced-block-provider/referenceSyncBlockStoreManager'
+          });
+          (_this3$fireAnalyticsE = _this3.fireAnalyticsEvent) === null || _this3$fireAnalyticsE === void 0 || _this3$fireAnalyticsE.call(_this3, fetchErrorPayload(error.message));
+        });
       }
       return function () {
         var resourceSubscriptions = _this3.subscriptions.get(resourceId);
@@ -344,17 +370,26 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
   }, {
     key: "subscribe",
     value: function subscribe(node, callback) {
-      // check node is a sync block, as we only support sync block subscriptions
-      if (node.type.name !== 'syncBlock') {
-        return function () {};
-      }
-      var _node$attrs2 = node.attrs,
-        resourceId = _node$attrs2.resourceId,
-        localId = _node$attrs2.localId;
-      if (!localId || !resourceId) {
+      try {
+        // check node is a sync block, as we only support sync block subscriptions
+        if (node.type.name !== 'syncBlock') {
+          throw new Error('Only sync block node subscriptions are supported');
+        }
+        var _node$attrs2 = node.attrs,
+          resourceId = _node$attrs2.resourceId,
+          localId = _node$attrs2.localId;
+        if (!localId || !resourceId) {
+          throw new Error('Missing local id or resource id');
+        }
+        return this.subscribeToSyncBlock(resourceId, localId, callback);
+      } catch (error) {
+        var _this$fireAnalyticsEv4;
+        logException(error, {
+          location: 'editor-synced-block-provider/referenceSyncBlockStoreManager'
+        });
+        (_this$fireAnalyticsEv4 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv4 === void 0 || _this$fireAnalyticsEv4.call(this, fetchErrorPayload(error.message));
         return function () {};
       }
-      return this.subscribeToSyncBlock(resourceId, localId, callback);
     }
 
     /**
@@ -376,6 +411,12 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
     key: "getProviderFactory",
     value: function getProviderFactory(resourceId) {
       if (!this.dataProvider) {
+        var _this$fireAnalyticsEv5;
+        var error = new Error('Data provider not set');
+        logException(error, {
+          location: 'editor-synced-block-provider/referenceSyncBlockStoreManager'
+        });
+        (_this$fireAnalyticsEv5 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv5 === void 0 || _this$fireAnalyticsEv5.call(this, fetchErrorPayload(error.message));
         return undefined;
       }
       var _this$dataProvider$ge = this.dataProvider.getSyncedBlockRendererProviderOptions(),
@@ -391,7 +432,15 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
         this.providerFactories.set(resourceId, providerFactory);
       }
       if (providerCreator) {
-        this.retrieveDynamicProviders(resourceId, providerFactory, providerCreator);
+        try {
+          this.retrieveDynamicProviders(resourceId, providerFactory, providerCreator);
+        } catch (error) {
+          var _this$fireAnalyticsEv6;
+          logException(error, {
+            location: 'editor-synced-block-provider/referenceSyncBlockStoreManager'
+          });
+          (_this$fireAnalyticsEv6 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv6 === void 0 || _this$fireAnalyticsEv6.call(this, fetchErrorPayload(error.message));
+        }
       }
       return providerFactory;
     }
@@ -400,7 +449,7 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
     value: function retrieveDynamicProviders(resourceId, providerFactory, providerCreator) {
       var _syncBlock$data2, _syncBlock$data3, _syncBlock$data4, _syncBlock$data5;
       if (!this.dataProvider) {
-        return;
+        throw new Error('Data provider not set');
       }
       var hasMediaProvider = providerFactory.hasProvider('mediaProvider');
       var hasEmojiProvider = providerFactory.hasProvider('emojiProvider');
@@ -409,11 +458,13 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
       }
       var syncBlock = this.getFromCache(resourceId);
       if (!syncBlock || !((_syncBlock$data2 = syncBlock.data) !== null && _syncBlock$data2 !== void 0 && _syncBlock$data2.sourceAri) || !((_syncBlock$data3 = syncBlock.data) !== null && _syncBlock$data3 !== void 0 && _syncBlock$data3.product)) {
+        var _this$fireAnalyticsEv7;
+        (_this$fireAnalyticsEv7 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv7 === void 0 || _this$fireAnalyticsEv7.call(this, fetchErrorPayload('Sync block or source ari or product not found'));
         return;
       }
       var parentInfo = this.dataProvider.retrieveSyncBlockParentInfo((_syncBlock$data4 = syncBlock.data) === null || _syncBlock$data4 === void 0 ? void 0 : _syncBlock$data4.sourceAri, (_syncBlock$data5 = syncBlock.data) === null || _syncBlock$data5 === void 0 ? void 0 : _syncBlock$data5.product);
       if (!parentInfo) {
-        return;
+        throw new Error('Unable to retrive sync block parent info');
       }
       var contentId = parentInfo.contentId,
         contentProduct = parentInfo.contentProduct;
@@ -454,6 +505,7 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
         providerFactory.destroy();
       });
       this.providerFactories.clear();
+      this.fireAnalyticsEvent = undefined;
     }
   }]);
 }();