@atlaskit/editor-synced-block-provider 8.1.9 → 8.1.10

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/editor-synced-block-provider
 
+## 8.1.10
+
+### Patch Changes
+
+- [`b4cfc35a62476`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/b4cfc35a62476) -
+  Improve the reliability of synced-block real-time updates. Transient WebSocket drops now recover
+  silently via a more resilient reconnection strategy (more retry attempts, capped exponential
+  backoff with jitter) instead of being reported as failures. A failure is only surfaced once
+  reconnection is genuinely exhausted. Behind a feature gate.
+- Updated dependencies
+
 ## 8.1.9
 
 ### Patch Changes

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

@@ -37,6 +37,7 @@ var SyncBlockSubscriptionManager = exports.SyncBlockSubscriptionManager = /*#__P
     // causing the cache to be deleted prematurely. We delay deletion to allow
     // the new component to subscribe and cancel the pending deletion.
     (0, _defineProperty2.default)(this, "pendingCacheDeletions", new Map());
+    // backoff cap (gate ON)
     (0, _defineProperty2.default)(this, "retryAttempts", new Map());
     (0, _defineProperty2.default)(this, "pendingRetries", new Map());
     this.deps = deps;
@@ -47,6 +48,30 @@ var SyncBlockSubscriptionManager = exports.SyncBlockSubscriptionManager = /*#__P
    * that need to read the current subscription state.
    */
   return (0, _createClass2.default)(SyncBlockSubscriptionManager, [{
+    key: "getMaxRetryAttempts",
+    value:
+    // EDITOR-7861: higher ceiling lets transient WS-gateway drops self-heal
+    // before a terminal failure is surfaced.
+    function getMaxRetryAttempts() {
+      return (0, _platformFeatureFlags.fg)('platform_editor_blocks_patch_3') ? SyncBlockSubscriptionManager.MAX_RETRY_ATTEMPTS_HARDENED : SyncBlockSubscriptionManager.MAX_RETRY_ATTEMPTS;
+    }
+
+    // Backoff delay for the given attempt.
+    // Gate OFF: pure exponential (1s, 2s, 4s, 8s, 16s).
+    // Gate ON (EDITOR-7861): exponential capped at MAX_RETRY_DELAY_MS with equal
+    // jitter (capped/2 + random*capped/2) — de-synchronises simultaneous
+    // reconnects while guaranteeing a non-zero delay (full jitter could hit 0).
+  }, {
+    key: "getReconnectionDelay",
+    value: function getReconnectionDelay(attempts) {
+      var exponential = SyncBlockSubscriptionManager.INITIAL_RETRY_DELAY_MS * Math.pow(SyncBlockSubscriptionManager.RETRY_BACKOFF_MULTIPLIER, attempts);
+      if (!(0, _platformFeatureFlags.fg)('platform_editor_blocks_patch_3')) {
+        return exponential;
+      }
+      var half = Math.min(exponential, SyncBlockSubscriptionManager.MAX_RETRY_DELAY_MS) / 2;
+      return Math.round(half + Math.random() * half);
+    }
+  }, {
     key: "getSubscriptions",
     value: function getSubscriptions() {
       return this.subscriptions;
@@ -273,11 +298,17 @@ var SyncBlockSubscriptionManager = exports.SyncBlockSubscriptionManager = /*#__P
       var unsubscribe = dataProvider.subscribeToBlockUpdates(resourceId, function (syncBlockInstance) {
         _this5.handleGraphQLUpdate(syncBlockInstance);
       }, function (error) {
-        var _this5$deps$getFireAn;
         (0, _monitoring.logException)(error, {
           location: 'editor-synced-block-provider/syncBlockSubscriptionManager/graphql-subscription'
         });
-        (_this5$deps$getFireAn = _this5.deps.getFireAnalyticsEvent()) === null || _this5$deps$getFireAn === void 0 || _this5$deps$getFireAn((0, _errorHandling.fetchErrorPayload)(error.message, resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId)));
+        // EDITOR-7861: a single socket drop is usually transient and
+        // recovers on reconnect, so under the gate we don't fire a
+        // user-facing error here — it's only surfaced on exhaustion (see
+        // scheduleReconnection). Gate OFF keeps the legacy fire-on-drop.
+        if (!(0, _platformFeatureFlags.fg)('platform_editor_blocks_patch_3')) {
+          var _this5$deps$getFireAn;
+          (_this5$deps$getFireAn = _this5.deps.getFireAnalyticsEvent()) === null || _this5$deps$getFireAn === void 0 || _this5$deps$getFireAn((0, _errorHandling.fetchErrorPayload)(error.message, resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId)));
+        }
         _this5.handleSubscriptionTerminated(resourceId);
       }, function () {
         _this5.handleSubscriptionTerminated(resourceId);
@@ -308,19 +339,19 @@ var SyncBlockSubscriptionManager = exports.SyncBlockSubscriptionManager = /*#__P
       }
     }
 
-    /**
-     * Schedules a reconnection attempt with exponential backoff.
-     * Delay = INITIAL_RETRY_DELAY_MS * (RETRY_BACKOFF_MULTIPLIER ^ attempts)
-     * e.g. 1s, 2s, 4s, 8s, 16s
-     */
+    // Schedules a reconnection with backoff (see getMaxRetryAttempts /
+    // getReconnectionDelay for the gated behaviour).
   }, {
     key: "scheduleReconnection",
     value: function scheduleReconnection(resourceId) {
       var _this$retryAttempts$g,
         _this6 = this;
       var attempts = (_this$retryAttempts$g = this.retryAttempts.get(resourceId)) !== null && _this$retryAttempts$g !== void 0 ? _this$retryAttempts$g : 0;
-      if (attempts >= SyncBlockSubscriptionManager.MAX_RETRY_ATTEMPTS) {
+      var maxAttempts = this.getMaxRetryAttempts();
+      if (attempts >= maxAttempts) {
         var _this$deps$getFireAna;
+        // Exhausted all attempts — the only place a WS drop surfaces as a
+        // fetch error under the gate (EDITOR-7861).
         var errorMessage = "Subscription reconnection failed after ".concat(attempts, " attempts");
         (0, _monitoring.logException)(new Error(errorMessage), {
           location: 'editor-synced-block-provider/syncBlockSubscriptionManager/max-retries-exhausted'
@@ -328,7 +359,7 @@ var SyncBlockSubscriptionManager = exports.SyncBlockSubscriptionManager = /*#__P
         (_this$deps$getFireAna = this.deps.getFireAnalyticsEvent()) === null || _this$deps$getFireAna === void 0 || _this$deps$getFireAna((0, _errorHandling.fetchErrorPayload)(errorMessage, resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId)));
         return;
       }
-      var delay = SyncBlockSubscriptionManager.INITIAL_RETRY_DELAY_MS * Math.pow(SyncBlockSubscriptionManager.RETRY_BACKOFF_MULTIPLIER, attempts);
+      var delay = this.getReconnectionDelay(attempts);
       var timer = setTimeout(function () {
         _this6.pendingRetries.delete(resourceId);
 
@@ -486,7 +517,11 @@ var SyncBlockSubscriptionManager = exports.SyncBlockSubscriptionManager = /*#__P
     }
   }]);
 }();
-// Reconnection with exponential backoff
+// Reconnection with exponential backoff.
 (0, _defineProperty2.default)(SyncBlockSubscriptionManager, "INITIAL_RETRY_DELAY_MS", 1000);
 (0, _defineProperty2.default)(SyncBlockSubscriptionManager, "RETRY_BACKOFF_MULTIPLIER", 2);
-(0, _defineProperty2.default)(SyncBlockSubscriptionManager, "MAX_RETRY_ATTEMPTS", 5);
+(0, _defineProperty2.default)(SyncBlockSubscriptionManager, "MAX_RETRY_ATTEMPTS", 5);
+// legacy (gate OFF)
+(0, _defineProperty2.default)(SyncBlockSubscriptionManager, "MAX_RETRY_ATTEMPTS_HARDENED", 8);
+// gate ON (EDITOR-7861)
+(0, _defineProperty2.default)(SyncBlockSubscriptionManager, "MAX_RETRY_DELAY_MS", 30000);

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

@@ -12,6 +12,25 @@ import { getSourceProductFromResourceIdSafe } from '../utils/utils';
  */
 
 export class SyncBlockSubscriptionManager {
+  // EDITOR-7861: higher ceiling lets transient WS-gateway drops self-heal
+  // before a terminal failure is surfaced.
+  getMaxRetryAttempts() {
+    return fg('platform_editor_blocks_patch_3') ? SyncBlockSubscriptionManager.MAX_RETRY_ATTEMPTS_HARDENED : SyncBlockSubscriptionManager.MAX_RETRY_ATTEMPTS;
+  }
+
+  // Backoff delay for the given attempt.
+  // Gate OFF: pure exponential (1s, 2s, 4s, 8s, 16s).
+  // Gate ON (EDITOR-7861): exponential capped at MAX_RETRY_DELAY_MS with equal
+  // jitter (capped/2 + random*capped/2) — de-synchronises simultaneous
+  // reconnects while guaranteeing a non-zero delay (full jitter could hit 0).
+  getReconnectionDelay(attempts) {
+    const exponential = SyncBlockSubscriptionManager.INITIAL_RETRY_DELAY_MS * Math.pow(SyncBlockSubscriptionManager.RETRY_BACKOFF_MULTIPLIER, attempts);
+    if (!fg('platform_editor_blocks_patch_3')) {
+      return exponential;
+    }
+    const half = Math.min(exponential, SyncBlockSubscriptionManager.MAX_RETRY_DELAY_MS) / 2;
+    return Math.round(half + Math.random() * half);
+  }
   constructor(deps) {
     _defineProperty(this, "subscriptions", new Map());
     _defineProperty(this, "titleSubscriptions", new Map());
@@ -23,6 +42,7 @@ export class SyncBlockSubscriptionManager {
     // causing the cache to be deleted prematurely. We delay deletion to allow
     // the new component to subscribe and cancel the pending deletion.
     _defineProperty(this, "pendingCacheDeletions", new Map());
+    // backoff cap (gate ON)
     _defineProperty(this, "retryAttempts", new Map());
     _defineProperty(this, "pendingRetries", new Map());
     this.deps = deps;
@@ -237,11 +257,17 @@ export class SyncBlockSubscriptionManager {
     const unsubscribe = dataProvider.subscribeToBlockUpdates(resourceId, syncBlockInstance => {
       this.handleGraphQLUpdate(syncBlockInstance);
     }, error => {
-      var _this$deps$getFireAna2;
       logException(error, {
         location: 'editor-synced-block-provider/syncBlockSubscriptionManager/graphql-subscription'
       });
-      (_this$deps$getFireAna2 = this.deps.getFireAnalyticsEvent()) === null || _this$deps$getFireAna2 === void 0 ? void 0 : _this$deps$getFireAna2(fetchErrorPayload(error.message, resourceId, getSourceProductFromResourceIdSafe(resourceId)));
+      // EDITOR-7861: a single socket drop is usually transient and
+      // recovers on reconnect, so under the gate we don't fire a
+      // user-facing error here — it's only surfaced on exhaustion (see
+      // scheduleReconnection). Gate OFF keeps the legacy fire-on-drop.
+      if (!fg('platform_editor_blocks_patch_3')) {
+        var _this$deps$getFireAna2;
+        (_this$deps$getFireAna2 = this.deps.getFireAnalyticsEvent()) === null || _this$deps$getFireAna2 === void 0 ? void 0 : _this$deps$getFireAna2(fetchErrorPayload(error.message, resourceId, getSourceProductFromResourceIdSafe(resourceId)));
+      }
       this.handleSubscriptionTerminated(resourceId);
     }, () => {
       this.handleSubscriptionTerminated(resourceId);
@@ -270,16 +296,16 @@ export class SyncBlockSubscriptionManager {
     }
   }
 
-  /**
-   * Schedules a reconnection attempt with exponential backoff.
-   * Delay = INITIAL_RETRY_DELAY_MS * (RETRY_BACKOFF_MULTIPLIER ^ attempts)
-   * e.g. 1s, 2s, 4s, 8s, 16s
-   */
+  // Schedules a reconnection with backoff (see getMaxRetryAttempts /
+  // getReconnectionDelay for the gated behaviour).
   scheduleReconnection(resourceId) {
     var _this$retryAttempts$g;
     const attempts = (_this$retryAttempts$g = this.retryAttempts.get(resourceId)) !== null && _this$retryAttempts$g !== void 0 ? _this$retryAttempts$g : 0;
-    if (attempts >= SyncBlockSubscriptionManager.MAX_RETRY_ATTEMPTS) {
+    const maxAttempts = this.getMaxRetryAttempts();
+    if (attempts >= maxAttempts) {
       var _this$deps$getFireAna3;
+      // Exhausted all attempts — the only place a WS drop surfaces as a
+      // fetch error under the gate (EDITOR-7861).
       const errorMessage = `Subscription reconnection failed after ${attempts} attempts`;
       logException(new Error(errorMessage), {
         location: 'editor-synced-block-provider/syncBlockSubscriptionManager/max-retries-exhausted'
@@ -287,7 +313,7 @@ export class SyncBlockSubscriptionManager {
       (_this$deps$getFireAna3 = this.deps.getFireAnalyticsEvent()) === null || _this$deps$getFireAna3 === void 0 ? void 0 : _this$deps$getFireAna3(fetchErrorPayload(errorMessage, resourceId, getSourceProductFromResourceIdSafe(resourceId)));
       return;
     }
-    const delay = SyncBlockSubscriptionManager.INITIAL_RETRY_DELAY_MS * Math.pow(SyncBlockSubscriptionManager.RETRY_BACKOFF_MULTIPLIER, attempts);
+    const delay = this.getReconnectionDelay(attempts);
     const timer = setTimeout(() => {
       this.pendingRetries.delete(resourceId);
 
@@ -389,7 +415,11 @@ export class SyncBlockSubscriptionManager {
     }
   }
 }
-// Reconnection with exponential backoff
+// Reconnection with exponential backoff.
 _defineProperty(SyncBlockSubscriptionManager, "INITIAL_RETRY_DELAY_MS", 1000);
 _defineProperty(SyncBlockSubscriptionManager, "RETRY_BACKOFF_MULTIPLIER", 2);
-_defineProperty(SyncBlockSubscriptionManager, "MAX_RETRY_ATTEMPTS", 5);
+_defineProperty(SyncBlockSubscriptionManager, "MAX_RETRY_ATTEMPTS", 5);
+// legacy (gate OFF)
+_defineProperty(SyncBlockSubscriptionManager, "MAX_RETRY_ATTEMPTS_HARDENED", 8);
+// gate ON (EDITOR-7861)
+_defineProperty(SyncBlockSubscriptionManager, "MAX_RETRY_DELAY_MS", 30000);

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

@@ -31,6 +31,7 @@ export var SyncBlockSubscriptionManager = /*#__PURE__*/function () {
     // causing the cache to be deleted prematurely. We delay deletion to allow
     // the new component to subscribe and cancel the pending deletion.
     _defineProperty(this, "pendingCacheDeletions", new Map());
+    // backoff cap (gate ON)
     _defineProperty(this, "retryAttempts", new Map());
     _defineProperty(this, "pendingRetries", new Map());
     this.deps = deps;
@@ -41,6 +42,30 @@ export var SyncBlockSubscriptionManager = /*#__PURE__*/function () {
    * that need to read the current subscription state.
    */
   return _createClass(SyncBlockSubscriptionManager, [{
+    key: "getMaxRetryAttempts",
+    value:
+    // EDITOR-7861: higher ceiling lets transient WS-gateway drops self-heal
+    // before a terminal failure is surfaced.
+    function getMaxRetryAttempts() {
+      return fg('platform_editor_blocks_patch_3') ? SyncBlockSubscriptionManager.MAX_RETRY_ATTEMPTS_HARDENED : SyncBlockSubscriptionManager.MAX_RETRY_ATTEMPTS;
+    }
+
+    // Backoff delay for the given attempt.
+    // Gate OFF: pure exponential (1s, 2s, 4s, 8s, 16s).
+    // Gate ON (EDITOR-7861): exponential capped at MAX_RETRY_DELAY_MS with equal
+    // jitter (capped/2 + random*capped/2) — de-synchronises simultaneous
+    // reconnects while guaranteeing a non-zero delay (full jitter could hit 0).
+  }, {
+    key: "getReconnectionDelay",
+    value: function getReconnectionDelay(attempts) {
+      var exponential = SyncBlockSubscriptionManager.INITIAL_RETRY_DELAY_MS * Math.pow(SyncBlockSubscriptionManager.RETRY_BACKOFF_MULTIPLIER, attempts);
+      if (!fg('platform_editor_blocks_patch_3')) {
+        return exponential;
+      }
+      var half = Math.min(exponential, SyncBlockSubscriptionManager.MAX_RETRY_DELAY_MS) / 2;
+      return Math.round(half + Math.random() * half);
+    }
+  }, {
     key: "getSubscriptions",
     value: function getSubscriptions() {
       return this.subscriptions;
@@ -267,11 +292,17 @@ export var SyncBlockSubscriptionManager = /*#__PURE__*/function () {
       var unsubscribe = dataProvider.subscribeToBlockUpdates(resourceId, function (syncBlockInstance) {
         _this5.handleGraphQLUpdate(syncBlockInstance);
       }, function (error) {
-        var _this5$deps$getFireAn;
         logException(error, {
           location: 'editor-synced-block-provider/syncBlockSubscriptionManager/graphql-subscription'
         });
-        (_this5$deps$getFireAn = _this5.deps.getFireAnalyticsEvent()) === null || _this5$deps$getFireAn === void 0 || _this5$deps$getFireAn(fetchErrorPayload(error.message, resourceId, getSourceProductFromResourceIdSafe(resourceId)));
+        // EDITOR-7861: a single socket drop is usually transient and
+        // recovers on reconnect, so under the gate we don't fire a
+        // user-facing error here — it's only surfaced on exhaustion (see
+        // scheduleReconnection). Gate OFF keeps the legacy fire-on-drop.
+        if (!fg('platform_editor_blocks_patch_3')) {
+          var _this5$deps$getFireAn;
+          (_this5$deps$getFireAn = _this5.deps.getFireAnalyticsEvent()) === null || _this5$deps$getFireAn === void 0 || _this5$deps$getFireAn(fetchErrorPayload(error.message, resourceId, getSourceProductFromResourceIdSafe(resourceId)));
+        }
         _this5.handleSubscriptionTerminated(resourceId);
       }, function () {
         _this5.handleSubscriptionTerminated(resourceId);
@@ -302,19 +333,19 @@ export var SyncBlockSubscriptionManager = /*#__PURE__*/function () {
       }
     }
 
-    /**
-     * Schedules a reconnection attempt with exponential backoff.
-     * Delay = INITIAL_RETRY_DELAY_MS * (RETRY_BACKOFF_MULTIPLIER ^ attempts)
-     * e.g. 1s, 2s, 4s, 8s, 16s
-     */
+    // Schedules a reconnection with backoff (see getMaxRetryAttempts /
+    // getReconnectionDelay for the gated behaviour).
   }, {
     key: "scheduleReconnection",
     value: function scheduleReconnection(resourceId) {
       var _this$retryAttempts$g,
         _this6 = this;
       var attempts = (_this$retryAttempts$g = this.retryAttempts.get(resourceId)) !== null && _this$retryAttempts$g !== void 0 ? _this$retryAttempts$g : 0;
-      if (attempts >= SyncBlockSubscriptionManager.MAX_RETRY_ATTEMPTS) {
+      var maxAttempts = this.getMaxRetryAttempts();
+      if (attempts >= maxAttempts) {
         var _this$deps$getFireAna;
+        // Exhausted all attempts — the only place a WS drop surfaces as a
+        // fetch error under the gate (EDITOR-7861).
         var errorMessage = "Subscription reconnection failed after ".concat(attempts, " attempts");
         logException(new Error(errorMessage), {
           location: 'editor-synced-block-provider/syncBlockSubscriptionManager/max-retries-exhausted'
@@ -322,7 +353,7 @@ export var SyncBlockSubscriptionManager = /*#__PURE__*/function () {
         (_this$deps$getFireAna = this.deps.getFireAnalyticsEvent()) === null || _this$deps$getFireAna === void 0 || _this$deps$getFireAna(fetchErrorPayload(errorMessage, resourceId, getSourceProductFromResourceIdSafe(resourceId)));
         return;
       }
-      var delay = SyncBlockSubscriptionManager.INITIAL_RETRY_DELAY_MS * Math.pow(SyncBlockSubscriptionManager.RETRY_BACKOFF_MULTIPLIER, attempts);
+      var delay = this.getReconnectionDelay(attempts);
       var timer = setTimeout(function () {
         _this6.pendingRetries.delete(resourceId);
 
@@ -480,7 +511,11 @@ export var SyncBlockSubscriptionManager = /*#__PURE__*/function () {
     }
   }]);
 }();
-// Reconnection with exponential backoff
+// Reconnection with exponential backoff.
 _defineProperty(SyncBlockSubscriptionManager, "INITIAL_RETRY_DELAY_MS", 1000);
 _defineProperty(SyncBlockSubscriptionManager, "RETRY_BACKOFF_MULTIPLIER", 2);
-_defineProperty(SyncBlockSubscriptionManager, "MAX_RETRY_ATTEMPTS", 5);
+_defineProperty(SyncBlockSubscriptionManager, "MAX_RETRY_ATTEMPTS", 5);
+// legacy (gate OFF)
+_defineProperty(SyncBlockSubscriptionManager, "MAX_RETRY_ATTEMPTS_HARDENED", 8);
+// gate ON (EDITOR-7861)
+_defineProperty(SyncBlockSubscriptionManager, "MAX_RETRY_DELAY_MS", 30000);

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

@@ -33,8 +33,12 @@ export declare class SyncBlockSubscriptionManager {
     private static readonly INITIAL_RETRY_DELAY_MS;
     private static readonly RETRY_BACKOFF_MULTIPLIER;
     private static readonly MAX_RETRY_ATTEMPTS;
+    private static readonly MAX_RETRY_ATTEMPTS_HARDENED;
+    private static readonly MAX_RETRY_DELAY_MS;
     private retryAttempts;
     private pendingRetries;
+    private getMaxRetryAttempts;
+    private getReconnectionDelay;
     constructor(deps: SyncBlockSubscriptionManagerDeps);
     /**
      * Returns the subscriptions map. Used by external consumers (e.g. batch fetcher, flush)
@@ -62,11 +66,6 @@ export declare class SyncBlockSubscriptionManager {
      * stale entry and scheduling a reconnection with exponential backoff.
      */
     private handleSubscriptionTerminated;
-    /**
-     * Schedules a reconnection attempt with exponential backoff.
-     * Delay = INITIAL_RETRY_DELAY_MS * (RETRY_BACKOFF_MULTIPLIER ^ attempts)
-     * e.g. 1s, 2s, 4s, 8s, 16s
-     */
     private scheduleReconnection;
     /**
      * Resets the retry counter for a resource. Called when a successful

package/package.json

@@ -30,7 +30,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^116.13.0",
+		"@atlaskit/editor-common": "^116.14.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -74,7 +74,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "8.1.9",
+	"version": "8.1.10",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",