@atlaskit/editor-synced-block-provider 8.6.0 → 8.6.2

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

@@ -1,4 +1,6 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { bind } from 'bind-event-listener';
+import { getDocument } from '@atlaskit/browser-apis';
 import { logException } from '@atlaskit/editor-common/monitoring';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { buildFetchErrorAttribution, fetchErrorPayload, fetchSuccessPayload } from '../utils/errorHandling';
@@ -45,6 +47,22 @@ export class SyncBlockSubscriptionManager {
     // backoff cap (gate ON)
     _defineProperty(this, "retryAttempts", new Map());
     _defineProperty(this, "pendingRetries", new Map());
+    // Resources whose reconnection exhausted while the tab was hidden: parked here and
+    // re-armed on the next online / visibilitychange→visible instead of surfacing a
+    // terminal error. Only a re-armed attempt that also exhausts while visible fails.
+    _defineProperty(this, "deferredExhausted", new Set());
+    _defineProperty(this, "wakeDebounceTimer", null);
+    // `online` always sweeps (network is back regardless of tab visibility); a
+    // `visibilitychange` only sweeps when the tab became visible.
+    _defineProperty(this, "onOnline", () => this.scheduleWakeSweep());
+    _defineProperty(this, "onVisibilityChange", () => {
+      if (!this.isDocumentHidden()) {
+        this.scheduleWakeSweep();
+      }
+    });
+    // Cleanup fns returned by `bind` for the registered wake listeners; a non-empty
+    // array means listeners are currently registered. Emptied on teardown.
+    _defineProperty(this, "wakeListenerCleanups", []);
     this.deps = deps;
   }
 
@@ -306,14 +324,26 @@ export class SyncBlockSubscriptionManager {
     const attempts = (_this$retryAttempts$g = this.retryAttempts.get(resourceId)) !== null && _this$retryAttempts$g !== void 0 ? _this$retryAttempts$g : 0;
     const maxAttempts = this.getMaxRetryAttempts();
     if (attempts >= maxAttempts) {
-      var _this$deps$getFireAna3;
+      var _this$deps$getFireAna4;
       // 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`;
+
+      // Tab hidden at exhaustion: don't surface a terminal failure (user isn't
+      // looking, and most exhaustions self-recover once foregrounded). Park + re-arm
+      // on wake, emitting a benign `deferred` signal so suppression stays auditable.
+      const shouldDefer = fg('platform_editor_blocks_patch_3') && this.isDocumentHidden();
+      if (shouldDefer) {
+        var _this$deps$getFireAna3;
+        this.deferredExhausted.add(resourceId);
+        this.registerWakeListeners();
+        (_this$deps$getFireAna3 = this.deps.getFireAnalyticsEvent()) === null || _this$deps$getFireAna3 === void 0 ? void 0 : _this$deps$getFireAna3(fetchErrorPayload(errorMessage, resourceId, getSourceProductFromResourceIdSafe(resourceId), buildFetchErrorAttribution(true, errorMessage, undefined, /* deferred */true)));
+        return;
+      }
       logException(new Error(errorMessage), {
         location: 'editor-synced-block-provider/syncBlockSubscriptionManager/max-retries-exhausted'
       });
-      (_this$deps$getFireAna3 = this.deps.getFireAnalyticsEvent()) === null || _this$deps$getFireAna3 === void 0 ? void 0 : _this$deps$getFireAna3(fetchErrorPayload(errorMessage, resourceId, getSourceProductFromResourceIdSafe(resourceId), buildFetchErrorAttribution(fg('platform_editor_blocks_patch_3'), errorMessage)));
+      (_this$deps$getFireAna4 = this.deps.getFireAnalyticsEvent()) === null || _this$deps$getFireAna4 === void 0 ? void 0 : _this$deps$getFireAna4(fetchErrorPayload(errorMessage, resourceId, getSourceProductFromResourceIdSafe(resourceId), buildFetchErrorAttribution(fg('platform_editor_blocks_patch_3'), errorMessage)));
       return;
     }
     const delay = this.getReconnectionDelay(attempts);
@@ -344,6 +374,85 @@ export class SyncBlockSubscriptionManager {
   resetRetryCount(resourceId) {
     this.retryAttempts.delete(resourceId);
   }
+
+  /**
+   * Whether the tab is currently hidden. SSR/non-browser is treated as "not hidden" so
+   * we never defer where wake events can't fire (realtime never subscribes there anyway).
+   */
+  isDocumentHidden() {
+    var _getDocument;
+    return ((_getDocument = getDocument()) === null || _getDocument === void 0 ? void 0 : _getDocument.hidden) === true;
+  }
+
+  /**
+   * Lazily register shared `online` / `visibilitychange` listeners on first deferral.
+   * Torn down by `unregisterWakeListeners` (via `handleWake`). No-op in SSR / non-browser.
+   */
+  registerWakeListeners() {
+    if (this.wakeListenerCleanups.length > 0 || typeof window === 'undefined') {
+      return;
+    }
+    this.wakeListenerCleanups.push(bind(window, {
+      type: 'online',
+      listener: this.onOnline
+    }));
+    const doc = getDocument();
+    if (doc) {
+      this.wakeListenerCleanups.push(bind(doc, {
+        type: 'visibilitychange',
+        listener: this.onVisibilityChange
+      }));
+    }
+  }
+  unregisterWakeListeners() {
+    if (this.wakeDebounceTimer !== null) {
+      clearTimeout(this.wakeDebounceTimer);
+      this.wakeDebounceTimer = null;
+    }
+    for (const cleanup of this.wakeListenerCleanups) {
+      cleanup();
+    }
+    this.wakeListenerCleanups = [];
+  }
+
+  /**
+   * Coalesce a burst of wake events into one debounced re-arm sweep. Callers decide
+   * eligibility: `onOnline` always sweeps; `onVisibilityChange` only sweeps when visible.
+   */
+  scheduleWakeSweep() {
+    if (this.wakeDebounceTimer !== null) {
+      return;
+    }
+    this.wakeDebounceTimer = setTimeout(() => {
+      this.wakeDebounceTimer = null;
+      this.handleWake();
+    }, SyncBlockSubscriptionManager.WAKE_DEBOUNCE_MS);
+  }
+
+  /**
+   * Re-arm every deferred resource: full reset (attempts→0) + immediate reconnect now
+   * the tab is visible / online. Healthy subscriptions are untouched. A re-armed cycle
+   * that later exhausts while visible fires the terminal error normally.
+   */
+  handleWake() {
+    if (this.deferredExhausted.size === 0) {
+      this.unregisterWakeListeners();
+      return;
+    }
+    const toRearm = Array.from(this.deferredExhausted);
+    this.deferredExhausted.clear();
+    for (const resourceId of toRearm) {
+      // Only re-arm resources that still have active subscribers and realtime on.
+      if (!this.subscriptions.has(resourceId) || !this.shouldUseRealTime()) {
+        continue;
+      }
+      this.resetRetryCount(resourceId);
+      this.cancelPendingRetry(resourceId);
+      this.setupSubscription(resourceId);
+    }
+    // No deferred resources remain until another hidden exhaustion re-adds one.
+    this.unregisterWakeListeners();
+  }
   cancelPendingRetry(resourceId) {
     const timer = this.pendingRetries.get(resourceId);
     if (timer) {
@@ -357,6 +466,9 @@ export class SyncBlockSubscriptionManager {
     }
     this.pendingRetries.clear();
     this.retryAttempts.clear();
+    // Nothing left to re-arm: drop parked exhaustions and tear down wake listeners.
+    this.deferredExhausted.clear();
+    this.unregisterWakeListeners();
   }
   cleanupSubscription(resourceId) {
     const unsubscribe = this.graphqlSubscriptions.get(resourceId);
@@ -366,6 +478,11 @@ export class SyncBlockSubscriptionManager {
     }
     this.cancelPendingRetry(resourceId);
     this.retryAttempts.delete(resourceId);
+    // No subscribers left, so this resource can't be re-armed.
+    this.deferredExhausted.delete(resourceId);
+    if (this.deferredExhausted.size === 0) {
+      this.unregisterWakeListeners();
+    }
   }
   setupSubscriptionsForAllBlocks() {
     for (const resourceId of this.subscriptions.keys()) {
@@ -404,21 +521,28 @@ export class SyncBlockSubscriptionManager {
     this.deps.updateCache(resolved);
     if (!syncBlockInstance.error) {
       this.resetRetryCount(syncBlockInstance.resourceId);
+      // A healthy update means a parked exhaustion recovered on its own before any
+      // wake sweep — drop it and tear down listeners if nothing else is parked.
+      if (this.deferredExhausted.delete(syncBlockInstance.resourceId)) {
+        if (this.deferredExhausted.size === 0) {
+          this.unregisterWakeListeners();
+        }
+      }
       const callbacks = this.subscriptions.get(syncBlockInstance.resourceId);
       const localIds = callbacks ? Object.keys(callbacks) : [];
       localIds.forEach(localId => {
-        var _this$deps$getFireAna4, _syncBlockInstance$da, _syncBlockInstance$da2;
-        (_this$deps$getFireAna4 = this.deps.getFireAnalyticsEvent()) === null || _this$deps$getFireAna4 === void 0 ? void 0 : _this$deps$getFireAna4(fetchSuccessPayload(syncBlockInstance.resourceId, localId, (_syncBlockInstance$da = (_syncBlockInstance$da2 = syncBlockInstance.data) === null || _syncBlockInstance$da2 === void 0 ? void 0 : _syncBlockInstance$da2.product) !== null && _syncBlockInstance$da !== void 0 ? _syncBlockInstance$da : getSourceProductFromResourceIdSafe(syncBlockInstance.resourceId)));
+        var _this$deps$getFireAna5, _syncBlockInstance$da, _syncBlockInstance$da2;
+        (_this$deps$getFireAna5 = this.deps.getFireAnalyticsEvent()) === null || _this$deps$getFireAna5 === void 0 ? void 0 : _this$deps$getFireAna5(fetchSuccessPayload(syncBlockInstance.resourceId, localId, (_syncBlockInstance$da = (_syncBlockInstance$da2 = syncBlockInstance.data) === null || _syncBlockInstance$da2 === void 0 ? void 0 : _syncBlockInstance$da2.product) !== null && _syncBlockInstance$da !== void 0 ? _syncBlockInstance$da : getSourceProductFromResourceIdSafe(syncBlockInstance.resourceId)));
       });
       this.deps.fetchSyncBlockSourceInfo(resolved.resourceId);
     } else {
-      var _syncBlockInstance$er, _syncBlockInstance$er2, _this$deps$getFireAna5, _syncBlockInstance$da3, _syncBlockInstance$da4, _syncBlockInstance$er3, _syncBlockInstance$er4, _syncBlockInstance$er5;
+      var _syncBlockInstance$er, _syncBlockInstance$er2, _this$deps$getFireAna6, _syncBlockInstance$da3, _syncBlockInstance$da4, _syncBlockInstance$er3, _syncBlockInstance$er4, _syncBlockInstance$er5;
       const errorMessage = ((_syncBlockInstance$er = syncBlockInstance.error) === null || _syncBlockInstance$er === void 0 ? void 0 : _syncBlockInstance$er.reason) || ((_syncBlockInstance$er2 = syncBlockInstance.error) === null || _syncBlockInstance$er2 === void 0 ? void 0 : _syncBlockInstance$er2.type);
 
       // Prefer the structured `type` (a `SyncBlockError` enum value) for classification
       // and fall back to the free-text `reason` so source-state/permission strings are
       // still bucketed (EDITOR-7862). The emitted free-text `error` attribute is unchanged.
-      (_this$deps$getFireAna5 = this.deps.getFireAnalyticsEvent()) === null || _this$deps$getFireAna5 === void 0 ? void 0 : _this$deps$getFireAna5(fetchErrorPayload(errorMessage, syncBlockInstance.resourceId, (_syncBlockInstance$da3 = (_syncBlockInstance$da4 = syncBlockInstance.data) === null || _syncBlockInstance$da4 === void 0 ? void 0 : _syncBlockInstance$da4.product) !== null && _syncBlockInstance$da3 !== void 0 ? _syncBlockInstance$da3 : getSourceProductFromResourceIdSafe(syncBlockInstance.resourceId), buildFetchErrorAttribution(fg('platform_editor_blocks_patch_3'), ((_syncBlockInstance$er3 = syncBlockInstance.error) === null || _syncBlockInstance$er3 === void 0 ? void 0 : _syncBlockInstance$er3.type) || ((_syncBlockInstance$er4 = syncBlockInstance.error) === null || _syncBlockInstance$er4 === void 0 ? void 0 : _syncBlockInstance$er4.reason), (_syncBlockInstance$er5 = syncBlockInstance.error) === null || _syncBlockInstance$er5 === void 0 ? void 0 : _syncBlockInstance$er5.statusCode)));
+      (_this$deps$getFireAna6 = this.deps.getFireAnalyticsEvent()) === null || _this$deps$getFireAna6 === void 0 ? void 0 : _this$deps$getFireAna6(fetchErrorPayload(errorMessage, syncBlockInstance.resourceId, (_syncBlockInstance$da3 = (_syncBlockInstance$da4 = syncBlockInstance.data) === null || _syncBlockInstance$da4 === void 0 ? void 0 : _syncBlockInstance$da4.product) !== null && _syncBlockInstance$da3 !== void 0 ? _syncBlockInstance$da3 : getSourceProductFromResourceIdSafe(syncBlockInstance.resourceId), buildFetchErrorAttribution(fg('platform_editor_blocks_patch_3'), ((_syncBlockInstance$er3 = syncBlockInstance.error) === null || _syncBlockInstance$er3 === void 0 ? void 0 : _syncBlockInstance$er3.type) || ((_syncBlockInstance$er4 = syncBlockInstance.error) === null || _syncBlockInstance$er4 === void 0 ? void 0 : _syncBlockInstance$er4.reason), (_syncBlockInstance$er5 = syncBlockInstance.error) === null || _syncBlockInstance$er5 === void 0 ? void 0 : _syncBlockInstance$er5.statusCode)));
     }
   }
 }
@@ -429,4 +553,6 @@ _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);
+_defineProperty(SyncBlockSubscriptionManager, "MAX_RETRY_DELAY_MS", 30000);
+// Coalesce wake-event bursts into one re-arm sweep to avoid a reconnection storm.
+_defineProperty(SyncBlockSubscriptionManager, "WAKE_DEBOUNCE_MS", 1000);

package/dist/es2019/utils/errorHandling.js

@@ -188,16 +188,20 @@ export const classifyFetchErrorReason = error => {
  * `gateEnabled` is injected by the caller (the store managers evaluate `fg(...)`) so this
  * helper stays pure and trivially unit-testable for both gate states.
  */
-export const buildFetchErrorAttribution = (gateEnabled, error, statusCode) => {
+export const buildFetchErrorAttribution = (gateEnabled, error, statusCode, deferred) => {
   if (!gateEnabled) {
     return undefined;
   }
   const reason = classifyFetchErrorReason(error);
   return {
     reason,
-    benign: FETCH_BENIGN_REASONS.has(reason),
+    // A deferred (tab-hidden) exhaustion is benign regardless of reason bucket.
+    benign: deferred === true || FETCH_BENIGN_REASONS.has(reason),
     ...(statusCode !== undefined && {
       statusCode
+    }),
+    ...(deferred === true && {
+      deferred: true
     })
   };
 };
@@ -246,6 +250,11 @@ export function getErrorPayload(actionSubjectId, error, resourceId, sourceProduc
       // `attribution.benign` is accessible.
       ...(attribution && 'benign' in attribution && {
         benign: attribution.benign
+      }),
+      // `deferred` is only present on fetch/subscribe attribution, and only when a
+      // tab-hidden exhaustion was deferred rather than surfaced. Boolean, never UGC.
+      ...(attribution && 'deferred' in attribution && attribution.deferred === true && {
+        deferred: true
       })
     }
   };

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

@@ -1013,7 +1013,7 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
                 _context4.next = 1;
                 break;
               }
-              return _context4.abrupt("return", fg('platform_editor_blocks_patch_2'));
+              return _context4.abrupt("return", true);
             case 1:
               if (this.isCacheDirty) {
                 _context4.next = 2;