@atlaskit/editor-synced-block-provider 2.15.1 → 2.15.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-synced-block-provider
 
+## 2.15.2
+
+### Patch Changes
+
+- [`70face9ce7f1b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/70face9ce7f1b) -
+  EDITOR-3778 optimise flush to only send to BE when sync block data changes
+- Updated dependencies
+
 ## 2.15.1
 
 ### Patch Changes

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

@@ -12,9 +12,11 @@ var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/creat
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _uuid = _interopRequireDefault(require("uuid"));
 var _monitoring = require("@atlaskit/editor-common/monitoring");
+var _types = require("../common/types");
 var _errorHandling = require("../utils/errorHandling");
 var _utils = require("../utils/utils");
-// eslint-disable-next-line @atlaskit/platform/prefer-crypto-random-uuid -- Use crypto.randomUUID instead
+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; } // eslint-disable-next-line @atlaskit/platform/prefer-crypto-random-uuid -- Use crypto.randomUUID instead
 // A store manager responsible for the lifecycle and state management of source sync blocks in an editor instance.
 // Designed to manage local in-memory state and synchronize with an external data provider.
 // Supports create, flush, and delete operations for source sync blocks.
@@ -58,7 +60,9 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
           throw new Error('Local ID or resource ID is not set');
         }
         var syncBlockData = (0, _utils.convertSyncBlockPMNodeToSyncBlockData)(syncBlockNode);
-        this.syncBlockCache.set(resourceId, syncBlockData);
+        this.syncBlockCache.set(resourceId, _objectSpread(_objectSpread({}, syncBlockData), {}, {
+          isDirty: true
+        }));
         return true;
       } catch (error) {
         var _this$fireAnalyticsEv;
@@ -95,7 +99,8 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
               bodiedSyncBlockData = [];
               Array.from(this.syncBlockCache.values()).forEach(function (syncBlockData) {
                 // Don't flush nodes that are waiting to be deleted to avoid nodes being re-created
-                if (!syncBlockData.pendingDeletion) {
+                // Don't flush nodes that haven't been updated since we last flushed
+                if (!syncBlockData.pendingDeletion && syncBlockData.isDirty) {
                   bodiedSyncBlockNodes.push({
                     type: 'bodiedSyncBlock',
                     attrs: {
@@ -116,37 +121,46 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
               return this.dataProvider.writeNodesData(bodiedSyncBlockNodes, bodiedSyncBlockData);
             case 10:
               writeResults = _context.sent;
+              writeResults.forEach(function (result) {
+                // set isDirty to false on write success and unrecoverable errors like not found
+                if (result.resourceId && (result.error === _types.SyncBlockError.NotFound || !result.error)) {
+                  var cachedData = _this2.syncBlockCache.get(result.resourceId);
+                  if (cachedData) {
+                    cachedData.isDirty = false;
+                  }
+                }
+              });
               if (!writeResults.every(function (result) {
-                return result.resourceId !== undefined;
+                return result.resourceId && !result.error;
               })) {
-                _context.next = 15;
+                _context.next = 16;
                 break;
               }
               return _context.abrupt("return", true);
-            case 15:
+            case 16:
               writeResults.filter(function (result) {
-                return result.resourceId === undefined;
+                return !result.resourceId || result.error;
               }).forEach(function (result) {
                 var _this2$fireAnalyticsE;
                 (_this2$fireAnalyticsE = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE === void 0 || _this2$fireAnalyticsE.call(_this2, (0, _errorHandling.updateErrorPayload)(result.error || 'Failed to write data'));
               });
               return _context.abrupt("return", false);
-            case 17:
-              _context.next = 24;
+            case 18:
+              _context.next = 25;
               break;
-            case 19:
-              _context.prev = 19;
+            case 20:
+              _context.prev = 20;
               _context.t0 = _context["catch"](0);
               (0, _monitoring.logException)(_context.t0, {
                 location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
               });
               (_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 24:
+            case 25:
             case "end":
               return _context.stop();
           }
-        }, _callee, this, [[0, 19]]);
+        }, _callee, this, [[0, 20]]);
       }));
       function flush() {
         return _flush.apply(this, arguments);

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

@@ -2,6 +2,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 // eslint-disable-next-line @atlaskit/platform/prefer-crypto-random-uuid -- Use crypto.randomUUID instead
 import uuid from 'uuid';
 import { logException } from '@atlaskit/editor-common/monitoring';
+import { SyncBlockError } from '../common/types';
 import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload } from '../utils/errorHandling';
 import { convertSyncBlockPMNodeToSyncBlockData } from '../utils/utils';
 // A store manager responsible for the lifecycle and state management of source sync blocks in an editor instance.
@@ -42,7 +43,10 @@ export class SourceSyncBlockStoreManager {
         throw new Error('Local ID or resource ID is not set');
       }
       const syncBlockData = convertSyncBlockPMNodeToSyncBlockData(syncBlockNode);
-      this.syncBlockCache.set(resourceId, syncBlockData);
+      this.syncBlockCache.set(resourceId, {
+        ...syncBlockData,
+        isDirty: true
+      });
       return true;
     } catch (error) {
       var _this$fireAnalyticsEv;
@@ -68,7 +72,8 @@ export class SourceSyncBlockStoreManager {
       const bodiedSyncBlockData = [];
       Array.from(this.syncBlockCache.values()).forEach(syncBlockData => {
         // Don't flush nodes that are waiting to be deleted to avoid nodes being re-created
-        if (!syncBlockData.pendingDeletion) {
+        // Don't flush nodes that haven't been updated since we last flushed
+        if (!syncBlockData.pendingDeletion && syncBlockData.isDirty) {
           bodiedSyncBlockNodes.push({
             type: 'bodiedSyncBlock',
             attrs: {
@@ -83,10 +88,19 @@ export class SourceSyncBlockStoreManager {
         return Promise.resolve(true);
       }
       const writeResults = await this.dataProvider.writeNodesData(bodiedSyncBlockNodes, bodiedSyncBlockData);
-      if (writeResults.every(result => result.resourceId !== undefined)) {
+      writeResults.forEach(result => {
+        // set isDirty to false on write success and unrecoverable errors like not found
+        if (result.resourceId && (result.error === SyncBlockError.NotFound || !result.error)) {
+          const cachedData = this.syncBlockCache.get(result.resourceId);
+          if (cachedData) {
+            cachedData.isDirty = false;
+          }
+        }
+      });
+      if (writeResults.every(result => result.resourceId && !result.error)) {
         return true;
       } else {
-        writeResults.filter(result => result.resourceId === undefined).forEach(result => {
+        writeResults.filter(result => !result.resourceId || result.error).forEach(result => {
           var _this$fireAnalyticsEv2;
           (_this$fireAnalyticsEv2 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv2 === void 0 ? void 0 : _this$fireAnalyticsEv2.call(this, updateErrorPayload(result.error || 'Failed to write data'));
         });

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

@@ -3,9 +3,12 @@ import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
+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) { _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; }
 // eslint-disable-next-line @atlaskit/platform/prefer-crypto-random-uuid -- Use crypto.randomUUID instead
 import uuid from 'uuid';
 import { logException } from '@atlaskit/editor-common/monitoring';
+import { SyncBlockError } from '../common/types';
 import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload } from '../utils/errorHandling';
 import { convertSyncBlockPMNodeToSyncBlockData } from '../utils/utils';
 // A store manager responsible for the lifecycle and state management of source sync blocks in an editor instance.
@@ -51,7 +54,9 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
           throw new Error('Local ID or resource ID is not set');
         }
         var syncBlockData = convertSyncBlockPMNodeToSyncBlockData(syncBlockNode);
-        this.syncBlockCache.set(resourceId, syncBlockData);
+        this.syncBlockCache.set(resourceId, _objectSpread(_objectSpread({}, syncBlockData), {}, {
+          isDirty: true
+        }));
         return true;
       } catch (error) {
         var _this$fireAnalyticsEv;
@@ -88,7 +93,8 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
               bodiedSyncBlockData = [];
               Array.from(this.syncBlockCache.values()).forEach(function (syncBlockData) {
                 // Don't flush nodes that are waiting to be deleted to avoid nodes being re-created
-                if (!syncBlockData.pendingDeletion) {
+                // Don't flush nodes that haven't been updated since we last flushed
+                if (!syncBlockData.pendingDeletion && syncBlockData.isDirty) {
                   bodiedSyncBlockNodes.push({
                     type: 'bodiedSyncBlock',
                     attrs: {
@@ -109,37 +115,46 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
               return this.dataProvider.writeNodesData(bodiedSyncBlockNodes, bodiedSyncBlockData);
             case 10:
               writeResults = _context.sent;
+              writeResults.forEach(function (result) {
+                // set isDirty to false on write success and unrecoverable errors like not found
+                if (result.resourceId && (result.error === SyncBlockError.NotFound || !result.error)) {
+                  var cachedData = _this2.syncBlockCache.get(result.resourceId);
+                  if (cachedData) {
+                    cachedData.isDirty = false;
+                  }
+                }
+              });
               if (!writeResults.every(function (result) {
-                return result.resourceId !== undefined;
+                return result.resourceId && !result.error;
               })) {
-                _context.next = 15;
+                _context.next = 16;
                 break;
               }
               return _context.abrupt("return", true);
-            case 15:
+            case 16:
               writeResults.filter(function (result) {
-                return result.resourceId === undefined;
+                return !result.resourceId || result.error;
               }).forEach(function (result) {
                 var _this2$fireAnalyticsE;
                 (_this2$fireAnalyticsE = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE === void 0 || _this2$fireAnalyticsE.call(_this2, updateErrorPayload(result.error || 'Failed to write data'));
               });
               return _context.abrupt("return", false);
-            case 17:
-              _context.next = 24;
+            case 18:
+              _context.next = 25;
               break;
-            case 19:
-              _context.prev = 19;
+            case 20:
+              _context.prev = 20;
               _context.t0 = _context["catch"](0);
               logException(_context.t0, {
                 location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
               });
               (_this$fireAnalyticsEv2 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv2 === void 0 || _this$fireAnalyticsEv2.call(this, updateErrorPayload(_context.t0.message));
               return _context.abrupt("return", false);
-            case 24:
+            case 25:
             case "end":
               return _context.stop();
           }
-        }, _callee, this, [[0, 19]]);
+        }, _callee, this, [[0, 20]]);
       }));
       function flush() {
         return _flush.apply(this, arguments);

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

@@ -1,6 +1,6 @@
 import { type SyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { ResourceId, SyncBlockAttrs } from '../common/types';
+import { type ResourceId, type SyncBlockAttrs } from '../common/types';
 import type { SyncBlockDataProvider } from '../providers/types';
 export type ConfirmationCallback = (syncBlockCount: number) => Promise<boolean>;
 type OnDelete = () => void;

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

@@ -1,6 +1,6 @@
 import { type SyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { ResourceId, SyncBlockAttrs } from '../common/types';
+import { type ResourceId, type SyncBlockAttrs } from '../common/types';
 import type { SyncBlockDataProvider } from '../providers/types';
 export type ConfirmationCallback = (syncBlockCount: number) => Promise<boolean>;
 type OnDelete = () => void;

package/package.json

@@ -77,7 +77,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "2.15.1",
+	"version": "2.15.2",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",