@atlaskit/editor-synced-block-provider 4.0.1 → 4.1.1

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlaskit/editor-synced-block-provider
 
+## 4.1.1
+
+### Patch Changes
+
+- [`7428d9bf3aa13`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7428d9bf3aa13) -
+  Clean up platform_synced_block_patch_5 feature gate
+- Updated dependencies
+
+## 4.1.0
+
+### Minor Changes
+
+- [`beb2f030213b1`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/beb2f030213b1) -
+  EDITOR-5735 Make SSR bulk request configurable
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 4.0.1
 
 ### Patch Changes

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

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.updateSyncedBlocks = exports.updateSyncedBlock = exports.updateReferenceSyncedBlockOnDocument = exports.isBlockContentResponse = exports.getSyncedBlockContent = exports.getReferenceSyncedBlocksByBlockAri = exports.getReferenceSyncedBlocks = exports.deleteSyncedBlock = exports.createSyncedBlock = exports.batchRetrieveSyncedBlocks = exports.BlockError = void 0;
+exports.updateSyncedBlocks = exports.updateSyncedBlock = exports.updateReferenceSyncedBlockOnDocument = exports.isBlockContentResponse = exports.getSyncedBlockContent = exports.getReferenceSyncedBlocksByBlockAri = exports.getReferenceSyncedBlocks = exports.deleteSyncedBlock = exports.createSyncedBlock = exports.batchRetrieveSyncedBlocks = exports.BlockTimeoutError = exports.BlockError = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
@@ -225,6 +225,17 @@ var BlockError = exports.BlockError = /*#__PURE__*/function (_Error) {
   (0, _inherits2.default)(BlockError, _Error);
   return (0, _createClass2.default)(BlockError);
 }( /*#__PURE__*/(0, _wrapNativeSuper2.default)(Error));
+var BlockTimeoutError = exports.BlockTimeoutError = /*#__PURE__*/function (_Error2) {
+  function BlockTimeoutError() {
+    var _this2;
+    (0, _classCallCheck2.default)(this, BlockTimeoutError);
+    _this2 = _callSuper(this, BlockTimeoutError, ['Block request timed out']);
+    _this2.name = 'BlockTimeoutError';
+    return _this2;
+  }
+  (0, _inherits2.default)(BlockTimeoutError, _Error2);
+  return (0, _createClass2.default)(BlockTimeoutError);
+}( /*#__PURE__*/(0, _wrapNativeSuper2.default)(Error));
 var getSyncedBlockContent = exports.getSyncedBlockContent = /*#__PURE__*/function () {
   var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(_ref2) {
     var _result$data;
@@ -293,12 +304,12 @@ var getSyncedBlockContent = exports.getSyncedBlockContent = /*#__PURE__*/functio
  */
 var batchRetrieveSyncedBlocks = exports.batchRetrieveSyncedBlocks = /*#__PURE__*/function () {
   var _ref5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(_ref4) {
-    var _result$data2;
-    var blockIdentifiers, blockAris, bodyData, url, response, result, graphqlResponse;
+    var _config$timeoutMs, _result$data2;
+    var blockIdentifiers, config, blockAris, bodyData, url, fetchPromise, timeoutMs, response, result, graphqlResponse;
     return _regenerator.default.wrap(function _callee3$(_context3) {
       while (1) switch (_context3.prev = _context3.next) {
         case 0:
-          blockIdentifiers = _ref4.blockIdentifiers;
+          blockIdentifiers = _ref4.blockIdentifiers, config = _ref4.config;
           blockAris = blockIdentifiers.map(function (blockIdentifier) {
             return blockIdentifier.blockAri;
           });
@@ -306,45 +317,52 @@ var batchRetrieveSyncedBlocks = exports.batchRetrieveSyncedBlocks = /*#__PURE__*
             query: buildBatchRetrieveBlocksQuery(blockAris),
             operationName: BATCH_RETRIEVE_BLOCKS_OPERATION_NAME
           };
-          url = "".concat(GRAPHQL_ENDPOINT, "?operation=editorSyncedBlockBatchRetrieveBlocks");
-          _context3.next = 6;
-          return (0, _retry.fetchWithRetry)(url, {
+          url = "".concat(GRAPHQL_ENDPOINT, "?operation=editorSyncedBlockBatchRetrieveBlocks"); // undefined or 0 or negative means no timeout,
+          // We don't enforce a minimum timeout for simplicity
+          fetchPromise = (0, _retry.fetchWithRetry)(url, {
             method: 'POST',
             headers: COMMON_HEADERS,
             body: JSON.stringify(bodyData)
           });
-        case 6:
+          timeoutMs = (_config$timeoutMs = config === null || config === void 0 ? void 0 : config.timeoutMs) !== null && _config$timeoutMs !== void 0 ? _config$timeoutMs : 0;
+          _context3.next = 8;
+          return timeoutMs > 0 ? Promise.race([fetchPromise, new Promise(function (_, reject) {
+            return setTimeout(function () {
+              return reject(new BlockTimeoutError());
+            }, timeoutMs);
+          })]) : fetchPromise;
+        case 8:
           response = _context3.sent;
           if (response.ok) {
-            _context3.next = 9;
+            _context3.next = 11;
             break;
           }
           throw new BlockError(response.status);
-        case 9:
-          _context3.next = 11;
-          return response.json();
         case 11:
+          _context3.next = 13;
+          return response.json();
+        case 13:
           result = _context3.sent;
           if (!(result.errors && result.errors.length > 0)) {
-            _context3.next = 14;
+            _context3.next = 16;
             break;
           }
           throw new Error(result.errors.map(function (e) {
             return e.message;
           }).join(', '));
-        case 14:
+        case 16:
           if ((_result$data2 = result.data) !== null && _result$data2 !== void 0 && _result$data2.blockService_batchRetrieveBlocks) {
-            _context3.next = 16;
+            _context3.next = 18;
             break;
           }
           throw new Error('No data returned from GraphQL query');
-        case 16:
+        case 18:
           graphqlResponse = result.data.blockService_batchRetrieveBlocks;
           return _context3.abrupt("return", {
             success: graphqlResponse.success,
             error: graphqlResponse.error
           });
-        case 18:
+        case 20:
         case "end":
           return _context3.stop();
       }

package/dist/cjs/common/types.js

@@ -17,5 +17,7 @@ var SyncBlockError = exports.SyncBlockError = /*#__PURE__*/function (SyncBlockEr
   // content is not a valid JSON
   SyncBlockError["Offline"] = "offline";
   SyncBlockError["Unpublished"] = "unpublished";
+  // request was aborted, typically due to client timeout
+  SyncBlockError["Aborted"] = "aborted";
   return SyncBlockError;
 }({});

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

@@ -12,6 +12,7 @@ var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/creat
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _react = require("react");
+var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _ari = require("../../clients/block-service/ari");
 var _blockService = require("../../clients/block-service/blockService");
 var _blockSubscription = require("../../clients/block-service/blockSubscription");
@@ -392,6 +393,20 @@ var _batchFetchData = exports.batchFetchData = /*#__PURE__*/function () {
         case 61:
           _context2.prev = 61;
           _context2.t2 = _context2["catch"](5);
+          if (!(_context2.t2 instanceof _blockService.BlockTimeoutError && (0, _expValEquals.expValEquals)('platform_editor_sync_block_ssr_config', 'isEnabled', true))) {
+            _context2.next = 65;
+            break;
+          }
+          return _context2.abrupt("return", blockNodeIdentifiers.map(function (blockNodeIdentifier) {
+            return {
+              error: {
+                type: _types.SyncBlockError.Aborted,
+                reason: _context2.t2.message
+              },
+              resourceId: blockNodeIdentifier.resourceId
+            };
+          }));
+        case 65:
           return _context2.abrupt("return", blockNodeIdentifiers.map(function (blockNodeIdentifier) {
             return {
               error: {
@@ -401,7 +416,7 @@ var _batchFetchData = exports.batchFetchData = /*#__PURE__*/function () {
               resourceId: blockNodeIdentifier.resourceId
             };
           }));
-        case 64:
+        case 66:
         case "end":
           return _context2.stop();
       }