@atlaskit/editor-synced-block-provider 20.0.1 → 20.0.3

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/editor-synced-block-provider
 
+## 20.0.3
+
+### Patch Changes
+
+- Updated dependencies
+
+## 20.0.2
+
+### Patch Changes
+
+- [`c239b60db852a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/c239b60db852a) -
+  Flush removed references that disappear before the first save under
+  platform_editor_blocks_patch_11
+- Updated dependencies
+
 ## 20.0.1
 
 ### Patch Changes

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

@@ -57,6 +57,7 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
     (0, _defineProperty2.default)(this, "isCacheDirty", true);
     // Keep track of the last flushed subscriptions to optimize cache flushing on document save
     (0, _defineProperty2.default)(this, "lastFlushedSyncedBlocks", {});
+    (0, _defineProperty2.default)(this, "subscribedSinceLastFlush", false);
     // Track if a flush operation is currently in progress
     (0, _defineProperty2.default)(this, "isFlushInProgress", false);
     // Track if another flush is needed after the current one completes
@@ -978,6 +979,9 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
     value: function subscribeToSyncBlock(resourceId, localId, callback) {
       var _this$sourceManager2,
         _this9 = this;
+      if ((0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_blocks_patch_11')) {
+        this.subscribedSinceLastFlush = true;
+      }
       var isSamePageSyncEnabled = (0, _isExperimentEnabled.isExperimentEnabled)('editor-synced-block-same-page-sync');
       var sameDocumentParts = isSamePageSyncEnabled ? this.getSameDocumentReferenceParts(resourceId) : undefined;
       var localReference = isSamePageSyncEnabled ? this.getLocalReference(resourceId) : undefined;
@@ -1094,7 +1098,7 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
     value: (function () {
       var _flush = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
         var _this0 = this;
-        var success, syncedBlocksToFlush, _this$saveExperience, blocks, _iterator, _step, _loop, updateResult, _this$saveExperience2, _this$fireAnalyticsEv8, _this$saveExperience3, _this$fireAnalyticsEv9, _this$saveExperience4, _t2, _t3;
+        var subscribedSinceLastFlushToFlush, success, syncedBlocksToFlush, _this$saveExperience, blocks, _iterator, _step, _loop, updateResult, _this$saveExperience2, _this$fireAnalyticsEv8, _this$saveExperience3, _this$fireAnalyticsEv9, _this$saveExperience4, _t2, _t3;
         return _regenerator.default.wrap(function (_context4) {
           while (1) switch (_context4.prev = _context4.next) {
             case 0:
@@ -1122,6 +1126,8 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
             case 3:
               this.isFlushInProgress = true;
             case 4:
+              subscribedSinceLastFlushToFlush = (0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_blocks_patch_11') && this.subscribedSinceLastFlush;
+              this.subscribedSinceLastFlush = false;
               success = true; // a copy of the subscriptions STRUCTURE (without the callbacks)
               // To be saved as the last flushed structure if the flush is successful
               syncedBlocksToFlush = {};
@@ -1177,7 +1183,7 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
               _iterator.f();
               return _context4.finish(12);
             case 13:
-              if (!(0, _isEqual.default)(syncedBlocksToFlush, this.lastFlushedSyncedBlocks)) {
+              if (!(!subscribedSinceLastFlushToFlush && (0, _isEqual.default)(syncedBlocksToFlush, this.lastFlushedSyncedBlocks))) {
                 _context4.next = 14;
                 break;
               }
@@ -1223,6 +1229,7 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
               if (!success) {
                 // set isCacheDirty back to true for cases where it failed to update the reference synced blocks on the BE
                 this.isCacheDirty = true;
+                this.subscribedSinceLastFlush || (this.subscribedSinceLastFlush = subscribedSinceLastFlushToFlush);
               } else {
                 this.lastFlushedSyncedBlocks = syncedBlocksToFlush;
                 (_this$saveExperience4 = this.saveExperience) === null || _this$saveExperience4 === void 0 || _this$saveExperience4.success();

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

@@ -37,6 +37,7 @@ export class ReferenceSyncBlockStoreManager {
     _defineProperty(this, "isCacheDirty", true);
     // Keep track of the last flushed subscriptions to optimize cache flushing on document save
     _defineProperty(this, "lastFlushedSyncedBlocks", {});
+    _defineProperty(this, "subscribedSinceLastFlush", false);
     // Track if a flush operation is currently in progress
     _defineProperty(this, "isFlushInProgress", false);
     // Track if another flush is needed after the current one completes
@@ -819,6 +820,9 @@ export class ReferenceSyncBlockStoreManager {
   }
   subscribeToSyncBlock(resourceId, localId, callback) {
     var _this$sourceManager2;
+    if (isExperimentEnabled('platform_editor_blocks_patch_11')) {
+      this.subscribedSinceLastFlush = true;
+    }
     const isSamePageSyncEnabled = isExperimentEnabled('editor-synced-block-same-page-sync');
     const sameDocumentParts = isSamePageSyncEnabled ? this.getSameDocumentReferenceParts(resourceId) : undefined;
     let localReference = isSamePageSyncEnabled ? this.getLocalReference(resourceId) : undefined;
@@ -938,6 +942,8 @@ export class ReferenceSyncBlockStoreManager {
     } else {
       this.isFlushInProgress = true;
     }
+    const subscribedSinceLastFlushToFlush = isExperimentEnabled('platform_editor_blocks_patch_11') && this.subscribedSinceLastFlush;
+    this.subscribedSinceLastFlush = false;
     let success = true;
     // a copy of the subscriptions STRUCTURE (without the callbacks)
     // To be saved as the last flushed structure if the flush is successful
@@ -963,9 +969,8 @@ export class ReferenceSyncBlockStoreManager {
 
       // Then, compare with the last flushed structure to detect changes
       // We check against the last flushed structure to prevent unnecessary flushes
-      // Note that we will always flush at least once when editor starts
-      // This is useful for eventual consistency between the editor and the BE.
-      if (isEqual(syncedBlocksToFlush, this.lastFlushedSyncedBlocks)) {
+      // A reference can subscribe and disappear before the first flush, leaving both structures empty.
+      if (!subscribedSinceLastFlushToFlush && isEqual(syncedBlocksToFlush, this.lastFlushedSyncedBlocks)) {
         this.isCacheDirty = false; // Reset since we're considering this a successful no-op flush
         return true;
       }
@@ -1002,6 +1007,7 @@ export class ReferenceSyncBlockStoreManager {
       if (!success) {
         // set isCacheDirty back to true for cases where it failed to update the reference synced blocks on the BE
         this.isCacheDirty = true;
+        this.subscribedSinceLastFlush ||= subscribedSinceLastFlushToFlush;
       } else {
         var _this$saveExperience4;
         this.lastFlushedSyncedBlocks = syncedBlocksToFlush;

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

@@ -50,6 +50,7 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
     _defineProperty(this, "isCacheDirty", true);
     // Keep track of the last flushed subscriptions to optimize cache flushing on document save
     _defineProperty(this, "lastFlushedSyncedBlocks", {});
+    _defineProperty(this, "subscribedSinceLastFlush", false);
     // Track if a flush operation is currently in progress
     _defineProperty(this, "isFlushInProgress", false);
     // Track if another flush is needed after the current one completes
@@ -971,6 +972,9 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
     value: function subscribeToSyncBlock(resourceId, localId, callback) {
       var _this$sourceManager2,
         _this9 = this;
+      if (isExperimentEnabled('platform_editor_blocks_patch_11')) {
+        this.subscribedSinceLastFlush = true;
+      }
       var isSamePageSyncEnabled = isExperimentEnabled('editor-synced-block-same-page-sync');
       var sameDocumentParts = isSamePageSyncEnabled ? this.getSameDocumentReferenceParts(resourceId) : undefined;
       var localReference = isSamePageSyncEnabled ? this.getLocalReference(resourceId) : undefined;
@@ -1087,7 +1091,7 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
     value: (function () {
       var _flush = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3() {
         var _this0 = this;
-        var success, syncedBlocksToFlush, _this$saveExperience, blocks, _iterator, _step, _loop, updateResult, _this$saveExperience2, _this$fireAnalyticsEv8, _this$saveExperience3, _this$fireAnalyticsEv9, _this$saveExperience4, _t2, _t3;
+        var subscribedSinceLastFlushToFlush, success, syncedBlocksToFlush, _this$saveExperience, blocks, _iterator, _step, _loop, updateResult, _this$saveExperience2, _this$fireAnalyticsEv8, _this$saveExperience3, _this$fireAnalyticsEv9, _this$saveExperience4, _t2, _t3;
         return _regeneratorRuntime.wrap(function (_context4) {
           while (1) switch (_context4.prev = _context4.next) {
             case 0:
@@ -1115,6 +1119,8 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
             case 3:
               this.isFlushInProgress = true;
             case 4:
+              subscribedSinceLastFlushToFlush = isExperimentEnabled('platform_editor_blocks_patch_11') && this.subscribedSinceLastFlush;
+              this.subscribedSinceLastFlush = false;
               success = true; // a copy of the subscriptions STRUCTURE (without the callbacks)
               // To be saved as the last flushed structure if the flush is successful
               syncedBlocksToFlush = {};
@@ -1170,7 +1176,7 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
               _iterator.f();
               return _context4.finish(12);
             case 13:
-              if (!isEqual(syncedBlocksToFlush, this.lastFlushedSyncedBlocks)) {
+              if (!(!subscribedSinceLastFlushToFlush && isEqual(syncedBlocksToFlush, this.lastFlushedSyncedBlocks))) {
                 _context4.next = 14;
                 break;
               }
@@ -1216,6 +1222,7 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
               if (!success) {
                 // set isCacheDirty back to true for cases where it failed to update the reference synced blocks on the BE
                 this.isCacheDirty = true;
+                this.subscribedSinceLastFlush || (this.subscribedSinceLastFlush = subscribedSinceLastFlushToFlush);
               } else {
                 this.lastFlushedSyncedBlocks = syncedBlocksToFlush;
                 (_this$saveExperience4 = this.saveExperience) === null || _this$saveExperience4 === void 0 || _this$saveExperience4.success();

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

@@ -16,6 +16,7 @@ export declare class ReferenceSyncBlockStoreManager {
     private syncBlockSourceInfoRequests;
     private newlyAddedSyncBlocks;
     private lastFlushedSyncedBlocks;
+    private subscribedSinceLastFlush;
     private onUnpublishedSyncBlockDetected?;
     private isFlushInProgress;
     private flushNeededAfterCurrent;

package/package.json

@@ -23,7 +23,7 @@
 		"@atlaskit/node-data-provider": "^25.0.0",
 		"@atlaskit/platform-feature-experiments": "^0.3.0",
 		"@atlaskit/platform-feature-flags": "^2.2.0",
-		"@atlaskit/tmp-editor-statsig": "^221.0.0",
+		"@atlaskit/tmp-editor-statsig": "^223.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^1.0.2",
 		"bind-event-listener": "^3.0.0",
@@ -33,7 +33,7 @@
 		"uuid": "^11.1.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^128.1.0",
+		"@atlaskit/editor-common": "^128.3.0",
 		"react": "^18.2.0 || ^19.2.0"
 	},
 	"devDependencies": {
@@ -42,7 +42,7 @@
 		"react-dom": "^19.2.0"
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "20.0.1",
+	"version": "20.0.3",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",