@atlaskit/editor-synced-block-provider 2.10.5 → 2.11.0

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @atlaskit/editor-synced-block-provider
 
+## 2.11.0
+
+### Minor Changes
+
+- [`1ed7afa478690`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/1ed7afa478690) -
+  Update the blocks endpoint calls to match API design
+
+### Patch Changes
+
+- [`0cc1855e9071d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0cc1855e9071d) -
+  EDITOR-1921 add analytics for sync block provider failures
+- Updated dependencies
+
+## 2.10.6
+
+### Patch Changes
+
+- [`23c24c4b7faff`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/23c24c4b7faff) -
+  EDITOR-3312 Make data handling product agnostic
+- Updated dependencies
+
 ## 2.10.5
 
 ### Patch Changes

package/dist/cjs/clients/block-service/blockService.js

@@ -39,7 +39,7 @@ var getSyncedBlockContent = exports.getSyncedBlockContent = /*#__PURE__*/functio
         case 0:
           blockAri = _ref.blockAri;
           _context.next = 3;
-          return fetch("".concat(BLOCK_SERVICE_API_URL, "/block/").concat(blockAri), {
+          return fetch("".concat(BLOCK_SERVICE_API_URL, "/block/").concat(encodeURIComponent(blockAri)), {
             method: 'GET',
             headers: COMMON_HEADERS
           });
@@ -73,7 +73,7 @@ var deleteSyncedBlock = exports.deleteSyncedBlock = /*#__PURE__*/function () {
         case 0:
           blockAri = _ref3.blockAri;
           _context2.next = 3;
-          return fetch("".concat(BLOCK_SERVICE_API_URL, "/block/").concat(blockAri), {
+          return fetch("".concat(BLOCK_SERVICE_API_URL, "/block/").concat(encodeURIComponent(blockAri)), {
             method: 'DELETE',
             headers: COMMON_HEADERS
           });
@@ -102,7 +102,7 @@ var updateSyncedBlock = exports.updateSyncedBlock = /*#__PURE__*/function () {
         case 0:
           blockAri = _ref5.blockAri, content = _ref5.content;
           _context3.next = 3;
-          return fetch("".concat(BLOCK_SERVICE_API_URL, "/block/").concat(blockAri), {
+          return fetch("".concat(BLOCK_SERVICE_API_URL, "/block/").concat(encodeURIComponent(blockAri)), {
             method: 'PUT',
             headers: COMMON_HEADERS,
             body: JSON.stringify({
@@ -134,10 +134,11 @@ var createSyncedBlock = exports.createSyncedBlock = /*#__PURE__*/function () {
         case 0:
           blockAri = _ref7.blockAri, blockInstanceId = _ref7.blockInstanceId, sourceAri = _ref7.sourceAri, product = _ref7.product, content = _ref7.content;
           _context4.next = 3;
-          return fetch("".concat(BLOCK_SERVICE_API_URL, "/block/").concat(blockAri), {
+          return fetch("".concat(BLOCK_SERVICE_API_URL, "/block"), {
             method: 'POST',
             headers: COMMON_HEADERS,
             body: JSON.stringify({
+              blockAri: blockAri,
               blockInstanceId: blockInstanceId,
               sourceAri: sourceAri,
               product: product,

package/dist/cjs/clients/confluence/sourceInfo.js

@@ -4,10 +4,12 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.fetchConfluenceSourceInfo = void 0;
+exports.fetchConfluencePageInfo = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _monitoring = require("@atlaskit/editor-common/monitoring");
+var _errorHandling = require("../../utils/errorHandling");
 var _ari = require("./ari");
 var _utils = require("./utils");
 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; }
@@ -68,8 +70,8 @@ var getConfluenceSourceInfo = /*#__PURE__*/function () {
     return _ref.apply(this, arguments);
   };
 }();
-var fetchConfluenceSourceInfo = exports.fetchConfluenceSourceInfo = /*#__PURE__*/function () {
-  var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(pageAri, localId) {
+var fetchConfluencePageInfo = exports.fetchConfluencePageInfo = /*#__PURE__*/function () {
+  var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(pageAri, localId, fireAnalyticsEvent) {
     var _response$data, _contentData$space, _getPageIdAndTypeFrom, pageType, response, contentData, title, url, _ref3, base;
     return _regenerator.default.wrap(function _callee2$(_context2) {
       while (1) switch (_context2.prev = _context2.next) {
@@ -81,15 +83,9 @@ var fetchConfluenceSourceInfo = exports.fetchConfluenceSourceInfo = /*#__PURE__*
         case 4:
           response = _context2.sent;
           contentData = (_response$data = response.data) === null || _response$data === void 0 || (_response$data = _response$data.content) === null || _response$data === void 0 || (_response$data = _response$data.nodes) === null || _response$data === void 0 ? void 0 : _response$data[0];
-          if (contentData) {
-            _context2.next = 8;
-            break;
-          }
-          throw new Error("Failed to get content data");
-        case 8:
-          title = contentData.title;
-          _ref3 = contentData.links || {}, base = _ref3.base;
-          if (base && (_contentData$space = contentData.space) !== null && _contentData$space !== void 0 && _contentData$space.key && contentData.id) {
+          title = contentData === null || contentData === void 0 ? void 0 : contentData.title;
+          _ref3 = (contentData === null || contentData === void 0 ? void 0 : contentData.links) || {}, base = _ref3.base;
+          if (base && contentData !== null && contentData !== void 0 && (_contentData$space = contentData.space) !== null && _contentData$space !== void 0 && _contentData$space.key && contentData !== null && contentData !== void 0 && contentData.id) {
             if ((0, _utils.isBlogPageType)(pageType)) {
               url = "".concat(base, "/spaces/").concat(contentData.space.key, "/blog/edit-v2/").concat(contentData.id);
             } else if (contentData.subType === 'live') {
@@ -99,21 +95,28 @@ var fetchConfluenceSourceInfo = exports.fetchConfluenceSourceInfo = /*#__PURE__*
             }
           }
           url = url && localId ? "".concat(url, "#block-").concat(localId) : url;
+          if (!title || !url) {
+            fireAnalyticsEvent === null || fireAnalyticsEvent === void 0 || fireAnalyticsEvent((0, _errorHandling.getSourceInfoErrorPayload)('Failed to get confluence page source info'));
+          }
           return _context2.abrupt("return", Promise.resolve({
             title: title,
             url: url
           }));
-        case 15:
-          _context2.prev = 15;
+        case 14:
+          _context2.prev = 14;
           _context2.t0 = _context2["catch"](0);
+          (0, _monitoring.logException)(_context2.t0, {
+            location: 'editor-synced-block-provider/sourceInfo'
+          });
+          fireAnalyticsEvent === null || fireAnalyticsEvent === void 0 || fireAnalyticsEvent((0, _errorHandling.getSourceInfoErrorPayload)(_context2.t0.message));
           return _context2.abrupt("return", Promise.resolve(undefined));
-        case 18:
+        case 19:
         case "end":
           return _context2.stop();
       }
-    }, _callee2, null, [[0, 15]]);
+    }, _callee2, null, [[0, 14]]);
   }));
-  return function fetchConfluenceSourceInfo(_x2, _x3) {
+  return function fetchConfluencePageInfo(_x2, _x3, _x4) {
     return _ref2.apply(this, arguments);
   };
 }();

package/dist/cjs/hooks/useFetchSyncBlockData.js

@@ -9,9 +9,11 @@ var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"))
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _react = require("react");
+var _monitoring = require("@atlaskit/editor-common/monitoring");
 var _types = require("../common/types");
+var _errorHandling = require("../utils/errorHandling");
 var _utils = require("../utils/utils");
-var useFetchSyncBlockData = exports.useFetchSyncBlockData = function useFetchSyncBlockData(manager, resourceId, localId) {
+var useFetchSyncBlockData = exports.useFetchSyncBlockData = function useFetchSyncBlockData(manager, resourceId, localId, fireAnalyticsEvent) {
   var _useState = (0, _react.useState)(null),
     _useState2 = (0, _slicedToArray2.default)(_useState, 2),
     syncBlockInstance = _useState2[0],
@@ -31,36 +33,43 @@ var useFetchSyncBlockData = exports.useFetchSyncBlockData = function useFetchSyn
           }
           return _context.abrupt("return");
         case 2:
+          _context.prev = 2;
           syncBlockNode = resourceId && localId ? (0, _utils.createSyncBlockNode)(localId, resourceId) : null;
           if (syncBlockNode) {
-            _context.next = 5;
+            _context.next = 6;
             break;
           }
-          return _context.abrupt("return");
-        case 5:
+          throw new Error('Failed to create sync block node from resourceid and localid');
+        case 6:
           setIsLoading(true);
-          _context.prev = 6;
+
+          // Fetch sync block data, the `subscribeToSyncBlock` will update the state once data is fetched
           _context.next = 9;
           return manager.referenceManager.fetchSyncBlocksData([syncBlockNode]);
         case 9:
-          _context.next = 14;
+          _context.next = 16;
           break;
         case 11:
           _context.prev = 11;
-          _context.t0 = _context["catch"](6);
+          _context.t0 = _context["catch"](2);
+          (0, _monitoring.logException)(_context.t0, {
+            location: 'editor-synced-block-provider/useFetchSyncBlockData'
+          });
+          fireAnalyticsEvent === null || fireAnalyticsEvent === void 0 || fireAnalyticsEvent((0, _errorHandling.fetchErrorPayload)(_context.t0.message));
+
           // Set error state if fetching fails
           setSyncBlockInstance({
             resourceId: resourceId || '',
             error: _types.SyncBlockError.Errored
           });
-        case 14:
+        case 16:
           setIsLoading(false);
-        case 15:
+        case 17:
         case "end":
           return _context.stop();
       }
-    }, _callee, null, [[6, 11]]);
-  })), [isLoading, localId, manager.referenceManager, resourceId]);
+    }, _callee, null, [[2, 11]]);
+  })), [isLoading, localId, manager.referenceManager, resourceId, fireAnalyticsEvent]);
   (0, _react.useEffect)(function () {
     var unsubscribe = manager.referenceManager.subscribeToSyncBlock(resourceId || '', localId || '', function (data) {
       setSyncBlockInstance(data);

package/dist/cjs/hooks/useHandleContentChanges.js

@@ -7,10 +7,6 @@ exports.useHandleContentChanges = void 0;
 var _react = require("react");
 var useHandleContentChanges = exports.useHandleContentChanges = function useHandleContentChanges(manager, syncBlockNode) {
   (0, _react.useEffect)(function () {
-    try {
-      manager.sourceManager.updateSyncBlockData(syncBlockNode);
-    } catch (_unused) {
-      //TODO: EDITOR-1921 - add error analytics
-    }
+    manager.sourceManager.updateSyncBlockData(syncBlockNode);
   }, [manager, syncBlockNode]);
 };

package/dist/cjs/index.js

@@ -63,10 +63,10 @@ Object.defineProperty(exports, "createSyncBlockNode", {
     return _utils.createSyncBlockNode;
   }
 });
-Object.defineProperty(exports, "fetchConfluenceSourceInfo", {
+Object.defineProperty(exports, "fetchConfluencePageInfo", {
   enumerable: true,
   get: function get() {
-    return _sourceInfo.fetchConfluenceSourceInfo;
+    return _sourceInfo.fetchConfluencePageInfo;
   }
 });
 Object.defineProperty(exports, "getConfluencePageAri", {

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

@@ -96,33 +96,22 @@ var BlockServiceADFFetchProvider = /*#__PURE__*/function () {
       }
       return fetchData;
     }()
-  }, {
-    key: "retrieveSourceInfoFetchData",
-    value: function retrieveSourceInfoFetchData(resourceId, pageARI) {
-      var sourceLocalId;
-      try {
-        sourceLocalId = (0, _ari.getLocalIdFromBlockResourceId)(resourceId);
-      } catch (error) {
-        // EDITOR-1921: log analytic here, safe to continue
-      }
-      return {
-        pageARI: pageARI,
-        sourceLocalId: sourceLocalId
-      };
-    }
   }]);
 }();
 /**
  * ADFWriteProvider implementation that writes synced block data to Block Service API
  */
 var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
-  function BlockServiceADFWriteProvider() {
+  function BlockServiceADFWriteProvider(sourceAri, product) {
     (0, _classCallCheck2.default)(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 (0, _createClass2.default)(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 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(data) {
         var resourceId;
         return _regenerator.default.wrap(function _callee2$(_context2) {
@@ -154,8 +143,8 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
               return (0, _blockService.createSyncedBlock)({
                 blockAri: resourceId,
                 blockInstanceId: data.blockInstanceId,
-                sourceAri: resourceId,
-                product: 'confluence-page',
+                sourceAri: this.sourceAri,
+                product: this.product,
                 content: JSON.stringify(data.content)
               });
             case 13:
@@ -175,7 +164,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);
@@ -231,22 +220,24 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
     }()
   }, {
     key: "generateResourceId",
-    value: function generateResourceId(sourceId, localId) {
-      return (0, _ari.blockResourceIdFromSourceAndLocalId)(sourceId, localId);
+    value: function generateResourceId(sourceAri, localId) {
+      return (0, _ari.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
   };
 };
-var useMemoizedBlockServiceAPIProviders = exports.useMemoizedBlockServiceAPIProviders = function useMemoizedBlockServiceAPIProviders() {
-  return (0, _react.useMemo)(createBlockServiceAPIProviders, []);
+var useMemoizedBlockServiceAPIProviders = exports.useMemoizedBlockServiceAPIProviders = function useMemoizedBlockServiceAPIProviders(sourceAri, product) {
+  return (0, _react.useMemo)(function () {
+    return createBlockServiceAPIProviders(sourceAri, product);
+  }, [sourceAri, product]);
 };

package/dist/cjs/providers/confluence/confluenceContentAPI.js

@@ -146,21 +146,6 @@ var ConfluenceADFFetchProvider = /*#__PURE__*/function () {
       }
       return fetchData;
     }()
-  }, {
-    key: "retrieveSourceInfoFetchData",
-    value: function retrieveSourceInfoFetchData(resourceId) {
-      var pageARI = (0, _ari.getPageARIFromContentPropertyResourceId)(resourceId);
-      var sourceLocalId;
-      try {
-        sourceLocalId = (0, _ari.getLocalIdFromConfluencePageAri)(resourceId);
-      } catch (error) {
-        // EDITOR-1921: log analytic here, safe to continue
-      }
-      return {
-        pageARI: pageARI,
-        sourceLocalId: sourceLocalId
-      };
-    }
   }]);
 }();
 /**

package/dist/cjs/providers/syncBlockProvider.js

@@ -91,7 +91,7 @@ var SyncBlockProvider = exports.SyncBlockProvider = /*#__PURE__*/function (_Sync
           return data;
         }, function () {
           return {
-            status: _types.SyncBlockError.Errored,
+            error: _types.SyncBlockError.Errored,
             resourceId: resourceId
           };
         });
@@ -209,34 +209,28 @@ var SyncBlockProvider = exports.SyncBlockProvider = /*#__PURE__*/function (_Sync
     }
 
     /**
-     * Retrieve the source info from the source id
+     * Fetch the source info from the source id
      *
-     * @param node
+     * @param params
+     * @param params.sourceAri - The source ARI
+     * @param params.sourceProduct - The source product. e.g. 'confluence-page', 'jira-work-item'
      *
      * @returns The source info
      */
   }, {
-    key: "retrieveSyncBlockSourceInfo",
-    value: function retrieveSyncBlockSourceInfo(node) {
-      // with content API, this is the concatenation of the page ARI and the block's localId.
-      // with block service, this is the ARI of the block.
-      // this can be cleaned up from the specific providers and placed here after platform_synced_blocks_block_service_provider
-      var resourceId = node.attrs.resourceId;
-      var pageARI;
-      var sourceLocalId;
-      if (resourceId && typeof resourceId === 'string') {
-        try {
-          var fetchData = this.fetchProvider.retrieveSourceInfoFetchData(resourceId, this.sourceId);
-          pageARI = fetchData.pageARI;
-          sourceLocalId = fetchData.sourceLocalId;
-        } catch (error) {
-          return Promise.reject(error);
-        }
+    key: "fetchSyncBlockSourceInfo",
+    value: function fetchSyncBlockSourceInfo(localId, sourceAri, sourceProduct, fireAnalyticsEvent) {
+      if (!sourceAri || !sourceProduct) {
+        return Promise.reject(new Error('Source ari or source product is undefined'));
+      }
+      switch (sourceProduct) {
+        case 'confluence-page':
+          return (0, _sourceInfo.fetchConfluencePageInfo)(sourceAri, localId, fireAnalyticsEvent);
+        case 'jira-work-item':
+          return Promise.reject(new Error('Jira work item source product not supported'));
+        default:
+          return Promise.reject(new Error("".concat(sourceProduct, " source product not supported")));
       }
-
-      // TODO: EDITOR-3312 - based on the source sync block product,
-      // execute fetchConfluenceSourceInfo or fetchJiraItemSourceInfo or similar...
-      return pageARI ? (0, _sourceInfo.fetchConfluenceSourceInfo)(pageARI, sourceLocalId) : Promise.resolve(undefined);
     }
   }, {
     key: "generateResourceId",
@@ -258,32 +252,28 @@ var SyncBlockProvider = exports.SyncBlockProvider = /*#__PURE__*/function (_Sync
     /**
      * Retrieve the parent info for the sync block
      *
-     * @param resourceId
-     * @param syncBlockInstance
+     * @param sourceAri - The source ARI
+     * @param sourceProduct - The source product. e.g. 'confluence-page', 'jira-work-item'
      *
      * @returns The parent info for the sync block
      */
   }, {
     key: "retrieveSyncBlockParentInfo",
-    value: function retrieveSyncBlockParentInfo(syncBlockInstance) {
-      if (!syncBlockInstance || !syncBlockInstance.data) {
+    value: function retrieveSyncBlockParentInfo(sourceAri, sourceProduct) {
+      if (!sourceAri || !sourceProduct) {
         return undefined;
       }
-      var _syncBlockInstance$da = syncBlockInstance.data,
-        sourceAri = _syncBlockInstance$da.sourceAri,
-        product = _syncBlockInstance$da.product;
-      if (!sourceAri || !product) {
-        return undefined;
+      switch (sourceProduct) {
+        case 'confluence-page':
+          return {
+            contentId: (0, _ari.getPageIdAndTypeFromConfluencePageAri)(sourceAri).id,
+            contentProduct: sourceProduct
+          };
+        case 'jira-work-item':
+          throw new Error('Jira work item source product not supported');
+        default:
+          throw new Error("".concat(sourceProduct, " source product not supported"));
       }
-
-      // TODO: EDITOR-3312 - based on the source sync block product,
-      // execute getPageIdAndTypeFromConfluencePageAri or getJiraItemIdAndTypeFromJiraItemAri or similar...
-      var _getPageIdAndTypeFrom = (0, _ari.getPageIdAndTypeFromConfluencePageAri)(sourceAri),
-        contentId = _getPageIdAndTypeFrom.id;
-      return {
-        contentId: contentId,
-        contentProduct: product
-      };
     }
   }]);
 }(_types2.SyncBlockDataProvider);