@atlaskit/editor-synced-block-provider 4.1.6 → 4.2.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlaskit/editor-synced-block-provider
 
+## 4.2.0
+
+### Minor Changes
+
+- [`a9d6a5531d4ba`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/a9d6a5531d4ba) -
+  [ux] Ensures hasUnsavedBodiedSyncBlockChanges state is updated when page is being published.
+
+### Patch Changes
+
+- Updated dependencies
+
+## 4.1.7
+
+### Patch Changes
+
+- [`612d18a57aabd`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/612d18a57aabd) -
+  404s on updating a source synced block should be ignored
+- Updated dependencies
+
 ## 4.1.6
 
 ### Patch Changes

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 _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _ari = require("../../clients/block-service/ari");
 var _blockService = require("../../clients/block-service/blockService");
@@ -49,6 +50,8 @@ var mapErrorResponseCode = function mapErrorResponseCode(errorCode) {
   switch (errorCode) {
     case 'FORBIDDEN':
       return _types.SyncBlockError.Forbidden;
+    case 'RESOURCE_NOT_FOUND':
+      return (0, _platformFeatureFlags.fg)('block_service_source_repair') ? _types.SyncBlockError.NotFound : _types.SyncBlockError.Errored;
     case 'NOT_FOUND':
       return _types.SyncBlockError.NotFound;
     case 'INVALID_REQUEST':
@@ -832,8 +835,6 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
     this.product = product;
     this.getVersion = getVersion;
   }
-
-  // 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: function () {
@@ -1241,10 +1242,19 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
                       block = _step7.value;
                       error = errorResourceIds.get(block.resourceId);
                       if (error) {
-                        results.push({
-                          error: error,
-                          resourceId: block.resourceId
-                        });
+                        if ((0, _platformFeatureFlags.fg)('block_service_source_repair')) {
+                          if (error !== _types.SyncBlockError.NotFound) {
+                            results.push({
+                              error: error,
+                              resourceId: block.resourceId
+                            });
+                          }
+                        } else {
+                          results.push({
+                            error: error,
+                            resourceId: block.resourceId
+                          });
+                        }
                       } else if (!results.some(function (r) {
                         return r.resourceId === block.resourceId;
                       })) {

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

@@ -12,6 +12,7 @@ var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/creat
 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 _experiments = require("@atlaskit/tmp-editor-statsig/experiments");
 var _types = require("../common/types");
 var _errorHandling = require("../utils/errorHandling");
@@ -39,7 +40,18 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
     this.syncBlockCache = new Map();
     this.creationCompletionCallbacks = new Map();
   }
+
+  /**
+   * Register a callback to be invoked after flush() completes.
+   * Used by the pm-plugin to dispatch a transaction so that
+   * hasUnsavedBodiedSyncBlockChanges is recalculated in plugin state.
+   */
   return (0, _createClass2.default)(SourceSyncBlockStoreManager, [{
+    key: "registerFlushCompletionCallback",
+    value: function registerFlushCompletionCallback(callback) {
+      this.flushCompletionCallback = callback;
+    }
+  }, {
     key: "setFireAnalyticsEvent",
     value: function setFireAnalyticsEvent(fireAnalyticsEvent) {
       this.fireAnalyticsEvent = fireAnalyticsEvent;
@@ -100,7 +112,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
     value: (function () {
       var _flush = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
         var _this2 = this;
-        var _this$saveExperience, bodiedSyncBlockNodes, bodiedSyncBlockData, writeResults, _this$saveExperience2, _this$saveExperience3, _this$fireAnalyticsEv2;
+        var _this$saveExperience, bodiedSyncBlockNodes, bodiedSyncBlockData, writeResults, _this$saveExperience2, _this$saveExperience3, _this$fireAnalyticsEv2, _this$flushCompletion;
         return _regenerator.default.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
@@ -194,10 +206,16 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
               (_this$fireAnalyticsEv2 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv2 === void 0 || _this$fireAnalyticsEv2.call(this, (0, _errorHandling.updateErrorPayload)(_context.t0.message));
               return _context.abrupt("return", false);
             case 29:
+              _context.prev = 29;
+              if ((0, _platformFeatureFlags.fg)('platform_synced_block_patch_7')) {
+                (_this$flushCompletion = this.flushCompletionCallback) === null || _this$flushCompletion === void 0 || _this$flushCompletion.call(this);
+              }
+              return _context.finish(29);
+            case 32:
             case "end":
               return _context.stop();
           }
-        }, _callee, this, [[0, 24]]);
+        }, _callee, this, [[0, 24, 29, 32]]);
       }));
       function flush() {
         return _flush.apply(this, arguments);
@@ -581,6 +599,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
       this.syncBlockCache.clear();
       this.confirmationCallback = undefined;
       this.creationCompletionCallbacks.clear();
+      this.flushCompletionCallback = undefined;
       this.dataProvider = undefined;
       (_this$saveExperience4 = this.saveExperience) === null || _this$saveExperience4 === void 0 || _this$saveExperience4.abort({
         reason: 'editorDestroyed'

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

@@ -1,5 +1,6 @@
 /* eslint-disable require-unicode-regexp  */
 import { useMemo } from 'react';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { generateBlockAri, generateBlockAriFromReference } from '../../clients/block-service/ari';
 import { batchRetrieveSyncedBlocks, BlockError, BlockTimeoutError, createSyncedBlock, deleteSyncedBlock, getReferenceSyncedBlocks, getReferenceSyncedBlocksByBlockAri, getSyncedBlockContent, updateReferenceSyncedBlockOnDocument, updateSyncedBlock, updateSyncedBlocks } from '../../clients/block-service/blockService';
@@ -32,6 +33,8 @@ const mapErrorResponseCode = errorCode => {
   switch (errorCode) {
     case 'FORBIDDEN':
       return SyncBlockError.Forbidden;
+    case 'RESOURCE_NOT_FOUND':
+      return fg('block_service_source_repair') ? SyncBlockError.NotFound : SyncBlockError.Errored;
     case 'NOT_FOUND':
       return SyncBlockError.NotFound;
     case 'INVALID_REQUEST':
@@ -573,8 +576,6 @@ class BlockServiceADFWriteProvider {
     this.product = product;
     this.getVersion = getVersion;
   }
-
-  // it will first try to update and if it can't (404) then it will try to create
   async writeData(data) {
     if (!this.parentAri || !this.parentId) {
       return {
@@ -802,10 +803,19 @@ class BlockServiceADFWriteProvider {
         for (const block of data) {
           const error = errorResourceIds.get(block.resourceId);
           if (error) {
-            results.push({
-              error,
-              resourceId: block.resourceId
-            });
+            if (fg('block_service_source_repair')) {
+              if (error !== SyncBlockError.NotFound) {
+                results.push({
+                  error,
+                  resourceId: block.resourceId
+                });
+              }
+            } else {
+              results.push({
+                error,
+                resourceId: block.resourceId
+              });
+            }
           } else if (!results.some(r => r.resourceId === block.resourceId)) {
             // If not in success or error lists, mark as errored
             results.push({

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

@@ -1,6 +1,7 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import isEqual from 'lodash/isEqual';
 import { logException } from '@atlaskit/editor-common/monitoring';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { SyncBlockError } from '../common/types';
 import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload, getSourceInfoErrorPayload, updateSuccessPayload, createSuccessPayload, deleteSuccessPayload, fetchReferencesErrorPayload } from '../utils/errorHandling';
@@ -24,6 +25,15 @@ export class SourceSyncBlockStoreManager {
     this.syncBlockCache = new Map();
     this.creationCompletionCallbacks = new Map();
   }
+
+  /**
+   * Register a callback to be invoked after flush() completes.
+   * Used by the pm-plugin to dispatch a transaction so that
+   * hasUnsavedBodiedSyncBlockChanges is recalculated in plugin state.
+   */
+  registerFlushCompletionCallback(callback) {
+    this.flushCompletionCallback = callback;
+  }
   setFireAnalyticsEvent(fireAnalyticsEvent) {
     this.fireAnalyticsEvent = fireAnalyticsEvent;
     this.createExperience = getCreateSourceExperience(fireAnalyticsEvent);
@@ -151,6 +161,11 @@ export class SourceSyncBlockStoreManager {
       });
       (_this$fireAnalyticsEv4 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv4 === void 0 ? void 0 : _this$fireAnalyticsEv4.call(this, updateErrorPayload(error.message));
       return false;
+    } finally {
+      if (fg('platform_synced_block_patch_7')) {
+        var _this$flushCompletion;
+        (_this$flushCompletion = this.flushCompletionCallback) === null || _this$flushCompletion === void 0 ? void 0 : _this$flushCompletion.call(this);
+      }
     }
   }
   hasUnsavedChanges() {
@@ -430,6 +445,7 @@ export class SourceSyncBlockStoreManager {
     this.syncBlockCache.clear();
     this.confirmationCallback = undefined;
     this.creationCompletionCallbacks.clear();
+    this.flushCompletionCallback = undefined;
     this.dataProvider = undefined;
     (_this$saveExperience4 = this.saveExperience) === null || _this$saveExperience4 === void 0 ? void 0 : _this$saveExperience4.abort({
       reason: 'editorDestroyed'

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

@@ -11,6 +11,7 @@ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length)
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 /* eslint-disable require-unicode-regexp  */
 import { useMemo } from 'react';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { generateBlockAri as _generateBlockAri, generateBlockAriFromReference } from '../../clients/block-service/ari';
 import { batchRetrieveSyncedBlocks, BlockError, BlockTimeoutError, createSyncedBlock, deleteSyncedBlock, getReferenceSyncedBlocks, getReferenceSyncedBlocksByBlockAri, getSyncedBlockContent, updateReferenceSyncedBlockOnDocument, updateSyncedBlock, updateSyncedBlocks } from '../../clients/block-service/blockService';
@@ -43,6 +44,8 @@ var mapErrorResponseCode = function mapErrorResponseCode(errorCode) {
   switch (errorCode) {
     case 'FORBIDDEN':
       return SyncBlockError.Forbidden;
+    case 'RESOURCE_NOT_FOUND':
+      return fg('block_service_source_repair') ? SyncBlockError.NotFound : SyncBlockError.Errored;
     case 'NOT_FOUND':
       return SyncBlockError.NotFound;
     case 'INVALID_REQUEST':
@@ -827,8 +830,6 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
     this.product = product;
     this.getVersion = getVersion;
   }
-
-  // it will first try to update and if it can't (404) then it will try to create
   return _createClass(BlockServiceADFWriteProvider, [{
     key: "writeData",
     value: function () {
@@ -1236,10 +1237,19 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
                       block = _step7.value;
                       error = errorResourceIds.get(block.resourceId);
                       if (error) {
-                        results.push({
-                          error: error,
-                          resourceId: block.resourceId
-                        });
+                        if (fg('block_service_source_repair')) {
+                          if (error !== SyncBlockError.NotFound) {
+                            results.push({
+                              error: error,
+                              resourceId: block.resourceId
+                            });
+                          }
+                        } else {
+                          results.push({
+                            error: error,
+                            resourceId: block.resourceId
+                          });
+                        }
                       } else if (!results.some(function (r) {
                         return r.resourceId === block.resourceId;
                       })) {

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

@@ -7,6 +7,7 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 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) { _defineProperty(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; }
 import isEqual from 'lodash/isEqual';
 import { logException } from '@atlaskit/editor-common/monitoring';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { SyncBlockError } from '../common/types';
 import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload, getSourceInfoErrorPayload, updateSuccessPayload, createSuccessPayload, deleteSuccessPayload, fetchReferencesErrorPayload } from '../utils/errorHandling';
@@ -32,7 +33,18 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
     this.syncBlockCache = new Map();
     this.creationCompletionCallbacks = new Map();
   }
+
+  /**
+   * Register a callback to be invoked after flush() completes.
+   * Used by the pm-plugin to dispatch a transaction so that
+   * hasUnsavedBodiedSyncBlockChanges is recalculated in plugin state.
+   */
   return _createClass(SourceSyncBlockStoreManager, [{
+    key: "registerFlushCompletionCallback",
+    value: function registerFlushCompletionCallback(callback) {
+      this.flushCompletionCallback = callback;
+    }
+  }, {
     key: "setFireAnalyticsEvent",
     value: function setFireAnalyticsEvent(fireAnalyticsEvent) {
       this.fireAnalyticsEvent = fireAnalyticsEvent;
@@ -93,7 +105,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
     value: (function () {
       var _flush = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
         var _this2 = this;
-        var _this$saveExperience, bodiedSyncBlockNodes, bodiedSyncBlockData, writeResults, _this$saveExperience2, _this$saveExperience3, _this$fireAnalyticsEv2;
+        var _this$saveExperience, bodiedSyncBlockNodes, bodiedSyncBlockData, writeResults, _this$saveExperience2, _this$saveExperience3, _this$fireAnalyticsEv2, _this$flushCompletion;
         return _regeneratorRuntime.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
@@ -187,10 +199,16 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
               (_this$fireAnalyticsEv2 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv2 === void 0 || _this$fireAnalyticsEv2.call(this, updateErrorPayload(_context.t0.message));
               return _context.abrupt("return", false);
             case 29:
+              _context.prev = 29;
+              if (fg('platform_synced_block_patch_7')) {
+                (_this$flushCompletion = this.flushCompletionCallback) === null || _this$flushCompletion === void 0 || _this$flushCompletion.call(this);
+              }
+              return _context.finish(29);
+            case 32:
             case "end":
               return _context.stop();
           }
-        }, _callee, this, [[0, 24]]);
+        }, _callee, this, [[0, 24, 29, 32]]);
       }));
       function flush() {
         return _flush.apply(this, arguments);
@@ -574,6 +592,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
       this.syncBlockCache.clear();
       this.confirmationCallback = undefined;
       this.creationCompletionCallbacks.clear();
+      this.flushCompletionCallback = undefined;
       this.dataProvider = undefined;
       (_this$saveExperience4 = this.saveExperience) === null || _this$saveExperience4 === void 0 || _this$saveExperience4.abort({
         reason: 'editorDestroyed'

package/dist/types/store-manager/sourceSyncBlockStoreManager.d.ts

@@ -14,11 +14,18 @@ export declare class SourceSyncBlockStoreManager {
     private confirmationCallback?;
     private deletionRetryInfo?;
     private creationCompletionCallbacks;
+    private flushCompletionCallback?;
     private createExperience;
     private saveExperience;
     private deleteExperience;
     private fetchSourceInfoExperience;
     constructor(dataProvider?: SyncBlockDataProviderInterface);
+    /**
+     * Register a callback to be invoked after flush() completes.
+     * Used by the pm-plugin to dispatch a transaction so that
+     * hasUnsavedBodiedSyncBlockChanges is recalculated in plugin state.
+     */
+    registerFlushCompletionCallback(callback: () => void): void;
     setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void): void;
     isSourceBlock(node: PMNode): boolean;
     /**

package/dist/types-ts4.5/store-manager/sourceSyncBlockStoreManager.d.ts

@@ -14,11 +14,18 @@ export declare class SourceSyncBlockStoreManager {
     private confirmationCallback?;
     private deletionRetryInfo?;
     private creationCompletionCallbacks;
+    private flushCompletionCallback?;
     private createExperience;
     private saveExperience;
     private deleteExperience;
     private fetchSourceInfoExperience;
     constructor(dataProvider?: SyncBlockDataProviderInterface);
+    /**
+     * Register a callback to be invoked after flush() completes.
+     * Used by the pm-plugin to dispatch a transaction so that
+     * hasUnsavedBodiedSyncBlockChanges is recalculated in plugin state.
+     */
+    registerFlushCompletionCallback(callback: () => void): void;
     setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void): void;
     isSourceBlock(node: PMNode): boolean;
     /**

package/package.json

@@ -29,7 +29,7 @@
 		"@atlaskit/editor-prosemirror": "^7.3.0",
 		"@atlaskit/node-data-provider": "^9.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^45.0.0",
+		"@atlaskit/tmp-editor-statsig": "^45.1.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.20.0",
 		"graphql-ws": "^5.14.2",
@@ -38,7 +38,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^112.8.0",
+		"@atlaskit/editor-common": "^112.9.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -81,12 +81,19 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "4.1.6",
+	"version": "4.2.0",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
 	},
-	"platform-feature-flags": {}
+	"platform-feature-flags": {
+		"block_service_source_repair": {
+			"type": "boolean"
+		},
+		"platform_synced_block_patch_7": {
+			"type": "boolean"
+		}
+	}
 }