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

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/es2019/utils/errorHandling.js

@@ -1,4 +1,5 @@
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE, ACTION_SUBJECT_ID } from '@atlaskit/editor-common/analytics';
+import { SyncBlockError } from '../common/types';
 export const stringifyError = error => {
   try {
     return JSON.stringify(error);
@@ -7,13 +8,63 @@ export const stringifyError = error => {
   }
 };
 
+/**
+ * The set of categorical failure reasons emitted on synced-block operational error
+ * events (EDITOR-7796). These let the analytics dashboard break delete/update/create
+ * failures down by cause (Block Service / HG / Relay) instead of relying on the
+ * free-text `error` blob. Mirrors the {@link SyncBlockError} enum values, plus an
+ * `unknown` fallback for unclassifiable errors.
+ */
+
+const SYNC_BLOCK_ERROR_REASONS = new Set(Object.values(SyncBlockError));
+
+/**
+ * Maps a result `error` field (which may be a {@link SyncBlockError} enum value such as
+ * `'not_found'`, or an arbitrary stringified blob) to a stable categorical
+ * {@link SyncBlockErrorReason} for analytics grouping. Anything that is not a known
+ * `SyncBlockError` value collapses to `'unknown'` so the dashboard never has to group on
+ * free-text error blobs.
+ */
+export const classifyErrorReason = error => {
+  if (error && SYNC_BLOCK_ERROR_REASONS.has(error)) {
+    return error;
+  }
+  return 'unknown';
+};
+
+/**
+ * Extra, optional analytics attributes describing WHY an operational synced-block
+ * action failed. Spread conditionally so we never emit `undefined` keys (EDITOR-7796).
+ */
+
+/**
+ * Builds the {@link ErrorAttributionAttributes} for a failed synced-block operation from
+ * the raw result `error` field and optional backend `statusCode`. Returns `undefined`
+ * when the `platform_editor_blocks_patch_3` gate is OFF, so the new `reason`/`statusCode`
+ * attributes are only emitted once the gate is rolled out (EDITOR-7796).
+ *
+ * `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 buildErrorAttribution = (gateEnabled, error, statusCode) => {
+  if (!gateEnabled) {
+    return undefined;
+  }
+  return {
+    reason: classifyErrorReason(error),
+    ...(statusCode !== undefined && {
+      statusCode
+    })
+  };
+};
+
 // `sourceProduct` is threaded through every helper so analytics
 // events can be attributed to the source product (`confluence-page` vs `jira-work-item`).
 // All helpers accept it as an optional trailing argument; the spread-only-when-truthy
 // pattern below ensures we never emit `sourceProduct: undefined` (which would dirty the
 // event schema with empty keys).
 
-export const getErrorPayload = (actionSubjectId, error, resourceId, sourceProduct) => ({
+export const getErrorPayload = (actionSubjectId, error, resourceId, sourceProduct, attribution) => ({
   action: ACTION.ERROR,
   actionSubject: ACTION_SUBJECT.SYNCED_BLOCK,
   actionSubjectId,
@@ -25,15 +76,21 @@ export const getErrorPayload = (actionSubjectId, error, resourceId, sourceProduc
     }),
     ...(sourceProduct && {
       sourceProduct
+    }),
+    ...((attribution === null || attribution === void 0 ? void 0 : attribution.reason) && {
+      reason: attribution.reason
+    }),
+    ...((attribution === null || attribution === void 0 ? void 0 : attribution.statusCode) !== undefined && {
+      statusCode: attribution.statusCode
     })
   }
 });
 export const fetchErrorPayload = (error, resourceId, sourceProduct) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_FETCH, error, resourceId, sourceProduct);
 export const getSourceInfoErrorPayload = (error, resourceId, sourceProduct) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_GET_SOURCE_INFO, error, resourceId, sourceProduct);
-export const updateErrorPayload = (error, resourceId, sourceProduct) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE, error, resourceId, sourceProduct);
-export const updateReferenceErrorPayload = (error, resourceId, sourceProduct) => getErrorPayload(ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_UPDATE, error, resourceId, sourceProduct);
-export const createErrorPayload = (error, resourceId, sourceProduct) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE, error, resourceId, sourceProduct);
-export const deleteErrorPayload = (error, resourceId, sourceProduct) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_DELETE, error, resourceId, sourceProduct);
+export const updateErrorPayload = (error, resourceId, sourceProduct, attribution) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE, error, resourceId, sourceProduct, attribution);
+export const updateReferenceErrorPayload = (error, resourceId, sourceProduct, attribution) => getErrorPayload(ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_UPDATE, error, resourceId, sourceProduct, attribution);
+export const createErrorPayload = (error, resourceId, sourceProduct, attribution) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE, error, resourceId, sourceProduct, attribution);
+export const deleteErrorPayload = (error, resourceId, sourceProduct, attribution) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_DELETE, error, resourceId, sourceProduct, attribution);
 export const updateCacheErrorPayload = (error, resourceId, sourceProduct) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE_CACHE, error, resourceId, sourceProduct);
 /**
  * Payload for `SYNCED_BLOCK_SOURCE_INFO_ORPHANED`. Fired when source-info

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

@@ -567,7 +567,8 @@ export var writeDataBatch = /*#__PURE__*/function () {
           return _context4.abrupt("return", data.map(function (block) {
             return {
               error: mapBlockError(_t6),
-              resourceId: block.resourceId
+              resourceId: block.resourceId,
+              statusCode: _t6.status
             };
           }));
         case 11:
@@ -913,7 +914,8 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
               }
               return _context8.abrupt("return", {
                 error: mapBlockError(_t0),
-                resourceId: resourceId
+                resourceId: resourceId,
+                statusCode: _t0.status
               });
             case 8:
               return _context8.abrupt("return", {
@@ -993,7 +995,8 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
               }
               return _context9.abrupt("return", {
                 error: mapBlockError(_t10),
-                resourceId: resourceId
+                resourceId: resourceId,
+                statusCode: _t10.status
               });
             case 8:
               return _context9.abrupt("return", {
@@ -1077,7 +1080,8 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
               return _context0.abrupt("return", {
                 resourceId: resourceId,
                 success: false,
-                error: mapBlockError(_t11)
+                error: mapBlockError(_t11),
+                statusCode: _t11.status
               });
             case 7:
               return _context0.abrupt("return", {
@@ -1152,7 +1156,8 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
               return _context1.abrupt("return", {
                 resourceId: resourceId,
                 success: false,
-                error: mapBlockError(_t13)
+                error: mapBlockError(_t13),
+                statusCode: _t13.status
               });
             case 9:
               return _context1.abrupt("return", {
@@ -1182,7 +1187,8 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
               return _context1.abrupt("return", {
                 resourceId: resourceId,
                 success: false,
-                error: mapBlockError(_t14)
+                error: mapBlockError(_t14),
+                statusCode: _t14.status
               });
             case 13:
               return _context1.abrupt("return", {
@@ -1267,7 +1273,8 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
               }
               return _context10.abrupt("return", {
                 success: false,
-                error: mapBlockError(_t15)
+                error: mapBlockError(_t15),
+                statusCode: _t15.status
               });
             case 4:
               return _context10.abrupt("return", {
@@ -1434,7 +1441,8 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
               return _context12.abrupt("return", data.map(function (block) {
                 return {
                   error: mapBlockError(_t18),
-                  resourceId: block.resourceId
+                  resourceId: block.resourceId,
+                  statusCode: _t18.status
                 };
               }));
             case 15:

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

@@ -13,7 +13,7 @@ import isEqual from 'lodash/isEqual';
 import { logException } from '@atlaskit/editor-common/monitoring';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { SyncBlockError } from '../common/types';
-import { cacheDeletionForcedPayload, fetchErrorPayload, fetchSuccessPayload, getSourceInfoErrorPayload, sourceInfoOrphanedPayload, updateReferenceErrorPayload } from '../utils/errorHandling';
+import { buildErrorAttribution, cacheDeletionForcedPayload, fetchErrorPayload, fetchSuccessPayload, getSourceInfoErrorPayload, sourceInfoOrphanedPayload, updateReferenceErrorPayload } from '../utils/errorHandling';
 import { getFetchExperience, getFetchSourceInfoExperience, getSaveReferenceExperience } from '../utils/experienceTracking';
 import { resolveSyncBlockInstance } from '../utils/resolveSyncBlockInstance';
 import { createSyncBlockNode, getSourceProductFromResourceIdSafe, normalizeSyncBlockJSONContent } from '../utils/utils';
@@ -1077,7 +1077,7 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
                 (_this$saveExperience2 = this.saveExperience) === null || _this$saveExperience2 === void 0 || _this$saveExperience2.failure({
                   reason: updateResult.error || 'Failed to update reference synced blocks on the document'
                 });
-                (_this$fireAnalyticsEv8 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv8 === void 0 || _this$fireAnalyticsEv8.call(this, updateReferenceErrorPayload(updateResult.error || 'Failed to update reference synced blocks on the document'));
+                (_this$fireAnalyticsEv8 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv8 === void 0 || _this$fireAnalyticsEv8.call(this, updateReferenceErrorPayload(updateResult.error || 'Failed to update reference synced blocks on the document', undefined, undefined, buildErrorAttribution(fg('platform_editor_blocks_patch_3'), updateResult.error, updateResult.statusCode)));
               }
               _context4.next = 17;
               break;
@@ -1092,7 +1092,9 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
                 reason: _t3.message
               });
               // No `resourceId` available in this catch — sourceProduct is intentionally omitted.
-              (_this$fireAnalyticsEv9 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv9 === void 0 || _this$fireAnalyticsEv9.call(this, updateReferenceErrorPayload(_t3.message));
+              // No structured SyncBlockError/status here, so the attribution `reason` falls back
+              // to `unknown` when the gate is on.
+              (_this$fireAnalyticsEv9 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv9 === void 0 || _this$fireAnalyticsEv9.call(this, updateReferenceErrorPayload(_t3.message, undefined, undefined, buildErrorAttribution(fg('platform_editor_blocks_patch_3'))));
             case 17:
               _context4.prev = 17;
               if (!success) {

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

@@ -10,8 +10,9 @@ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length)
 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; }
 import { logException } from '@atlaskit/editor-common/monitoring';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { SyncBlockError } from '../common/types';
-import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload, getSourceInfoErrorPayload, updateSuccessPayload, createSuccessPayload, deleteSuccessPayload, fetchReferencesErrorPayload } from '../utils/errorHandling';
+import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload, getSourceInfoErrorPayload, updateSuccessPayload, createSuccessPayload, deleteSuccessPayload, fetchReferencesErrorPayload, buildErrorAttribution } from '../utils/errorHandling';
 import { getCreateSourceExperience, getDeleteSourceExperience, getSaveSourceExperience, getFetchSourceInfoExperience } from '../utils/experienceTracking';
 import { convertSyncBlockPMNodeToSyncBlockData, getSourceProductFromResourceIdSafe } from '../utils/utils';
 /** Maximum time (ms) flush() will wait for in-flight block creations before proceeding. */
@@ -158,7 +159,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
     value: (function () {
       var _flush = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
         var _this2 = this;
-        var _this$saveExperience, timedOut, timeoutId, timeout, _iterator, _step, resourceId, bodiedSyncBlockNodes, bodiedSyncBlockData, writeResults, _this$saveExperience2, _this$saveExperience3, _this$fireAnalyticsEv2, _this$flushCompletion, _t;
+        var _this$saveExperience, timedOut, timeoutId, timeout, _iterator, _step, resourceId, bodiedSyncBlockNodes, bodiedSyncBlockData, writeResults, _this$saveExperience2, _this$saveExperience3, attributionEnabled, _this$fireAnalyticsEv2, _this$flushCompletion, _t;
         return _regeneratorRuntime.wrap(function (_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
@@ -277,11 +278,12 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
               return _context.abrupt("return", true);
             case 7:
               (_this$saveExperience3 = this.saveExperience) === null || _this$saveExperience3 === void 0 || _this$saveExperience3.failure();
+              attributionEnabled = fg('platform_editor_blocks_patch_3');
               writeResults.filter(function (result) {
                 return !result.resourceId || result.error;
               }).forEach(function (result) {
                 var _this2$fireAnalyticsE2;
-                (_this2$fireAnalyticsE2 = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE2 === void 0 || _this2$fireAnalyticsE2.call(_this2, updateErrorPayload(result.error || 'Failed to write data', result.resourceId, getSourceProductFromResourceIdSafe(result.resourceId)));
+                (_this2$fireAnalyticsE2 = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE2 === void 0 || _this2$fireAnalyticsE2.call(_this2, updateErrorPayload(result.error || 'Failed to write data', result.resourceId, getSourceProductFromResourceIdSafe(result.resourceId), buildErrorAttribution(attributionEnabled, result.error, result.statusCode)));
               });
               return _context.abrupt("return", false);
             case 8:
@@ -293,8 +295,9 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
               logException(_t, {
                 location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
               });
-              // Top-level flush failure is not tied to a single resourceId.
-              (_this$fireAnalyticsEv2 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv2 === void 0 || _this$fireAnalyticsEv2.call(this, updateErrorPayload(_t.message));
+              // Top-level flush failure is not tied to a single resourceId. There is no structured
+              // SyncBlockError/status here, so the attribution `reason` falls back to `unknown`.
+              (_this$fireAnalyticsEv2 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv2 === void 0 || _this$fireAnalyticsEv2.call(this, updateErrorPayload(_t.message, undefined, undefined, buildErrorAttribution(fg('platform_editor_blocks_patch_3'))));
               return _context.abrupt("return", false);
             case 10:
               _context.prev = 10;
@@ -469,7 +472,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
             (_this4$createExperien2 = _this4.createExperience) === null || _this4$createExperien2 === void 0 || _this4$createExperien2.failure({
               reason: result.error || 'Failed to create bodied sync block'
             });
-            (_this4$fireAnalyticsE = _this4.fireAnalyticsEvent) === null || _this4$fireAnalyticsE === void 0 || _this4$fireAnalyticsE.call(_this4, createErrorPayload(result.error || 'Failed to create bodied sync block', resourceId, getSourceProductFromResourceIdSafe(resourceId)));
+            (_this4$fireAnalyticsE = _this4.fireAnalyticsEvent) === null || _this4$fireAnalyticsE === void 0 || _this4$fireAnalyticsE.call(_this4, createErrorPayload(result.error || 'Failed to create bodied sync block', resourceId, getSourceProductFromResourceIdSafe(resourceId), buildErrorAttribution(fg('platform_editor_blocks_patch_3'), result.error, result.statusCode)));
           }
         }).catch(function (error) {
           var _this4$createExperien3, _this4$fireAnalyticsE2;
@@ -501,7 +504,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
     value: function () {
       var _delete2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(syncBlockIds, onDelete, onDeleteCompleted, reason) {
         var _this5 = this;
-        var _this$deleteExperienc, results, callback, isDeleteSuccessful, _this$deleteExperienc2, _this$deleteExperienc3, _t2;
+        var _this$deleteExperienc, results, callback, isDeleteSuccessful, _this$deleteExperienc2, _this$deleteExperienc3, attributionEnabled, attribution, _t2;
         return _regeneratorRuntime.wrap(function (_context2) {
           while (1) switch (_context2.prev = _context2.next) {
             case 0:
@@ -548,13 +551,14 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
                   _this5.setPendingDeletion(Ids, false);
                 };
                 (_this$deleteExperienc3 = this.deleteExperience) === null || _this$deleteExperienc3 === void 0 || _this$deleteExperienc3.failure();
+                attributionEnabled = fg('platform_editor_blocks_patch_3');
                 results.forEach(function (result) {
                   if (result.success) {
                     var _this5$fireAnalyticsE2;
                     (_this5$fireAnalyticsE2 = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE2 === void 0 || _this5$fireAnalyticsE2.call(_this5, deleteSuccessPayload(result.resourceId, getSourceProductFromResourceIdSafe(result.resourceId)));
                   } else {
                     var _this5$fireAnalyticsE3;
-                    (_this5$fireAnalyticsE3 = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE3 === void 0 || _this5$fireAnalyticsE3.call(_this5, deleteErrorPayload(result.error || 'Failed to delete synced block', result.resourceId, getSourceProductFromResourceIdSafe(result.resourceId)));
+                    (_this5$fireAnalyticsE3 = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE3 === void 0 || _this5$fireAnalyticsE3.call(_this5, deleteErrorPayload(result.error || 'Failed to delete synced block', result.resourceId, getSourceProductFromResourceIdSafe(result.resourceId), buildErrorAttribution(attributionEnabled, result.error, result.statusCode)));
                   }
                 });
               }
@@ -563,10 +567,13 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
             case 4:
               _context2.prev = 4;
               _t2 = _context2["catch"](0);
+              // Thrown (non-result) failure — no structured SyncBlockError/status is available,
+              // so the attribution `reason` falls back to `unknown` when the gate is on.
+              attribution = buildErrorAttribution(fg('platform_editor_blocks_patch_3'));
               syncBlockIds.forEach(function (Ids) {
                 var _this5$fireAnalyticsE4;
                 _this5.setPendingDeletion(Ids, false);
-                (_this5$fireAnalyticsE4 = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE4 === void 0 || _this5$fireAnalyticsE4.call(_this5, deleteErrorPayload(_t2.message, Ids.resourceId, getSourceProductFromResourceIdSafe(Ids.resourceId)));
+                (_this5$fireAnalyticsE4 = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE4 === void 0 || _this5$fireAnalyticsE4.call(_this5, deleteErrorPayload(_t2.message, Ids.resourceId, getSourceProductFromResourceIdSafe(Ids.resourceId), attribution));
               });
               logException(_t2, {
                 location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'

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/esm/utils/errorHandling.js

@@ -2,6 +2,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 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; }
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE, ACTION_SUBJECT_ID } from '@atlaskit/editor-common/analytics';
+import { SyncBlockError } from '../common/types';
 export var stringifyError = function stringifyError(error) {
   try {
     return JSON.stringify(error);
@@ -10,24 +11,77 @@ export var stringifyError = function stringifyError(error) {
   }
 };
 
+/**
+ * The set of categorical failure reasons emitted on synced-block operational error
+ * events (EDITOR-7796). These let the analytics dashboard break delete/update/create
+ * failures down by cause (Block Service / HG / Relay) instead of relying on the
+ * free-text `error` blob. Mirrors the {@link SyncBlockError} enum values, plus an
+ * `unknown` fallback for unclassifiable errors.
+ */
+
+var SYNC_BLOCK_ERROR_REASONS = new Set(Object.values(SyncBlockError));
+
+/**
+ * Maps a result `error` field (which may be a {@link SyncBlockError} enum value such as
+ * `'not_found'`, or an arbitrary stringified blob) to a stable categorical
+ * {@link SyncBlockErrorReason} for analytics grouping. Anything that is not a known
+ * `SyncBlockError` value collapses to `'unknown'` so the dashboard never has to group on
+ * free-text error blobs.
+ */
+export var classifyErrorReason = function classifyErrorReason(error) {
+  if (error && SYNC_BLOCK_ERROR_REASONS.has(error)) {
+    return error;
+  }
+  return 'unknown';
+};
+
+/**
+ * Extra, optional analytics attributes describing WHY an operational synced-block
+ * action failed. Spread conditionally so we never emit `undefined` keys (EDITOR-7796).
+ */
+
+/**
+ * Builds the {@link ErrorAttributionAttributes} for a failed synced-block operation from
+ * the raw result `error` field and optional backend `statusCode`. Returns `undefined`
+ * when the `platform_editor_blocks_patch_3` gate is OFF, so the new `reason`/`statusCode`
+ * attributes are only emitted once the gate is rolled out (EDITOR-7796).
+ *
+ * `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 var buildErrorAttribution = function buildErrorAttribution(gateEnabled, error, statusCode) {
+  if (!gateEnabled) {
+    return undefined;
+  }
+  return _objectSpread({
+    reason: classifyErrorReason(error)
+  }, statusCode !== undefined && {
+    statusCode: statusCode
+  });
+};
+
 // `sourceProduct` is threaded through every helper so analytics
 // events can be attributed to the source product (`confluence-page` vs `jira-work-item`).
 // All helpers accept it as an optional trailing argument; the spread-only-when-truthy
 // pattern below ensures we never emit `sourceProduct: undefined` (which would dirty the
 // event schema with empty keys).
 
-export var getErrorPayload = function getErrorPayload(actionSubjectId, error, resourceId, sourceProduct) {
+export var getErrorPayload = function getErrorPayload(actionSubjectId, error, resourceId, sourceProduct, attribution) {
   return {
     action: ACTION.ERROR,
     actionSubject: ACTION_SUBJECT.SYNCED_BLOCK,
     actionSubjectId: actionSubjectId,
     eventType: EVENT_TYPE.OPERATIONAL,
-    attributes: _objectSpread(_objectSpread({
+    attributes: _objectSpread(_objectSpread(_objectSpread(_objectSpread({
       error: error
     }, resourceId && {
       resourceId: resourceId
     }), sourceProduct && {
       sourceProduct: sourceProduct
+    }), (attribution === null || attribution === void 0 ? void 0 : attribution.reason) && {
+      reason: attribution.reason
+    }), (attribution === null || attribution === void 0 ? void 0 : attribution.statusCode) !== undefined && {
+      statusCode: attribution.statusCode
     })
   };
 };
@@ -37,17 +91,17 @@ export var fetchErrorPayload = function fetchErrorPayload(error, resourceId, sou
 export var getSourceInfoErrorPayload = function getSourceInfoErrorPayload(error, resourceId, sourceProduct) {
   return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_GET_SOURCE_INFO, error, resourceId, sourceProduct);
 };
-export var updateErrorPayload = function updateErrorPayload(error, resourceId, sourceProduct) {
-  return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE, error, resourceId, sourceProduct);
+export var updateErrorPayload = function updateErrorPayload(error, resourceId, sourceProduct, attribution) {
+  return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE, error, resourceId, sourceProduct, attribution);
 };
-export var updateReferenceErrorPayload = function updateReferenceErrorPayload(error, resourceId, sourceProduct) {
-  return getErrorPayload(ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_UPDATE, error, resourceId, sourceProduct);
+export var updateReferenceErrorPayload = function updateReferenceErrorPayload(error, resourceId, sourceProduct, attribution) {
+  return getErrorPayload(ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_UPDATE, error, resourceId, sourceProduct, attribution);
 };
-export var createErrorPayload = function createErrorPayload(error, resourceId, sourceProduct) {
-  return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE, error, resourceId, sourceProduct);
+export var createErrorPayload = function createErrorPayload(error, resourceId, sourceProduct, attribution) {
+  return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE, error, resourceId, sourceProduct, attribution);
 };
-export var deleteErrorPayload = function deleteErrorPayload(error, resourceId, sourceProduct) {
-  return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_DELETE, error, resourceId, sourceProduct);
+export var deleteErrorPayload = function deleteErrorPayload(error, resourceId, sourceProduct, attribution) {
+  return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_DELETE, error, resourceId, sourceProduct, attribution);
 };
 export var updateCacheErrorPayload = function updateCacheErrorPayload(error, resourceId, sourceProduct) {
   return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE_CACHE, error, resourceId, sourceProduct);