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

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @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
+
+- [`a4e834c2647ac`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/a4e834c2647ac) -
+  Add failure reason and HTTP status code attributes to synced block delete, update and create
+  operational error analytics, so failures can be broken down by cause.
+
 ## 8.1.8
 
 ### Patch Changes

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

@@ -574,7 +574,8 @@ var writeDataBatch = exports.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:
@@ -922,7 +923,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", {
@@ -1002,7 +1004,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", {
@@ -1086,7 +1089,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", {
@@ -1161,7 +1165,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", {
@@ -1191,7 +1196,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", {
@@ -1276,7 +1282,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", {
@@ -1443,7 +1450,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/cjs/store-manager/referenceSyncBlockStoreManager.js

@@ -1084,7 +1084,7 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
                 (_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, (0, _errorHandling.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, (0, _errorHandling.updateReferenceErrorPayload)(updateResult.error || 'Failed to update reference synced blocks on the document', undefined, undefined, (0, _errorHandling.buildErrorAttribution)((0, _platformFeatureFlags.fg)('platform_editor_blocks_patch_3'), updateResult.error, updateResult.statusCode)));
               }
               _context4.next = 17;
               break;
@@ -1099,7 +1099,9 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
                 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, (0, _errorHandling.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, (0, _errorHandling.updateReferenceErrorPayload)(_t3.message, undefined, undefined, (0, _errorHandling.buildErrorAttribution)((0, _platformFeatureFlags.fg)('platform_editor_blocks_patch_3'))));
             case 17:
               _context4.prev = 17;
               if (!success) {

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

@@ -12,6 +12,7 @@ var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/cl
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _monitoring = require("@atlaskit/editor-common/monitoring");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _types = require("../common/types");
 var _errorHandling = require("../utils/errorHandling");
 var _experienceTracking = require("../utils/experienceTracking");
@@ -165,7 +166,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
     value: (function () {
       var _flush = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.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 _regenerator.default.wrap(function (_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
@@ -284,11 +285,12 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
               return _context.abrupt("return", true);
             case 7:
               (_this$saveExperience3 = this.saveExperience) === null || _this$saveExperience3 === void 0 || _this$saveExperience3.failure();
+              attributionEnabled = (0, _platformFeatureFlags.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, (0, _errorHandling.updateErrorPayload)(result.error || 'Failed to write data', result.resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(result.resourceId)));
+                (_this2$fireAnalyticsE2 = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE2 === void 0 || _this2$fireAnalyticsE2.call(_this2, (0, _errorHandling.updateErrorPayload)(result.error || 'Failed to write data', result.resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(result.resourceId), (0, _errorHandling.buildErrorAttribution)(attributionEnabled, result.error, result.statusCode)));
               });
               return _context.abrupt("return", false);
             case 8:
@@ -300,8 +302,9 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
               (0, _monitoring.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, (0, _errorHandling.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, (0, _errorHandling.updateErrorPayload)(_t.message, undefined, undefined, (0, _errorHandling.buildErrorAttribution)((0, _platformFeatureFlags.fg)('platform_editor_blocks_patch_3'))));
               return _context.abrupt("return", false);
             case 10:
               _context.prev = 10;
@@ -476,7 +479,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
             (_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, (0, _errorHandling.createErrorPayload)(result.error || 'Failed to create bodied sync block', resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId)));
+            (_this4$fireAnalyticsE = _this4.fireAnalyticsEvent) === null || _this4$fireAnalyticsE === void 0 || _this4$fireAnalyticsE.call(_this4, (0, _errorHandling.createErrorPayload)(result.error || 'Failed to create bodied sync block', resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId), (0, _errorHandling.buildErrorAttribution)((0, _platformFeatureFlags.fg)('platform_editor_blocks_patch_3'), result.error, result.statusCode)));
           }
         }).catch(function (error) {
           var _this4$createExperien3, _this4$fireAnalyticsE2;
@@ -508,7 +511,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
     value: function () {
       var _delete2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.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 _regenerator.default.wrap(function (_context2) {
           while (1) switch (_context2.prev = _context2.next) {
             case 0:
@@ -555,13 +558,14 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
                   _this5.setPendingDeletion(Ids, false);
                 };
                 (_this$deleteExperienc3 = this.deleteExperience) === null || _this$deleteExperienc3 === void 0 || _this$deleteExperienc3.failure();
+                attributionEnabled = (0, _platformFeatureFlags.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, (0, _errorHandling.deleteSuccessPayload)(result.resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(result.resourceId)));
                   } else {
                     var _this5$fireAnalyticsE3;
-                    (_this5$fireAnalyticsE3 = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE3 === void 0 || _this5$fireAnalyticsE3.call(_this5, (0, _errorHandling.deleteErrorPayload)(result.error || 'Failed to delete synced block', result.resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(result.resourceId)));
+                    (_this5$fireAnalyticsE3 = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE3 === void 0 || _this5$fireAnalyticsE3.call(_this5, (0, _errorHandling.deleteErrorPayload)(result.error || 'Failed to delete synced block', result.resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(result.resourceId), (0, _errorHandling.buildErrorAttribution)(attributionEnabled, result.error, result.statusCode)));
                   }
                 });
               }
@@ -570,10 +574,13 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
             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 = (0, _errorHandling.buildErrorAttribution)((0, _platformFeatureFlags.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, (0, _errorHandling.deleteErrorPayload)(_t2.message, Ids.resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(Ids.resourceId)));
+                (_this5$fireAnalyticsE4 = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE4 === void 0 || _this5$fireAnalyticsE4.call(_this5, (0, _errorHandling.deleteErrorPayload)(_t2.message, Ids.resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(Ids.resourceId), attribution));
               });
               (0, _monitoring.logException)(_t2, {
                 location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'

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

@@ -4,9 +4,10 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.updateSuccessPayload = exports.updateReferenceErrorPayload = exports.updateErrorPayload = exports.updateCacheErrorPayload = exports.stringifyError = exports.sourceInfoOrphanedPayload = exports.getSourceInfoErrorPayload = exports.getErrorPayload = exports.fetchSuccessPayload = exports.fetchReferencesErrorPayload = exports.fetchErrorPayload = exports.deleteSuccessPayload = exports.deleteErrorPayload = exports.createSuccessPayloadNew = exports.createSuccessPayload = exports.createErrorPayload = exports.cacheDeletionForcedPayload = void 0;
+exports.updateSuccessPayload = exports.updateReferenceErrorPayload = exports.updateErrorPayload = exports.updateCacheErrorPayload = exports.stringifyError = exports.sourceInfoOrphanedPayload = exports.getSourceInfoErrorPayload = exports.getErrorPayload = exports.fetchSuccessPayload = exports.fetchReferencesErrorPayload = exports.fetchErrorPayload = exports.deleteSuccessPayload = exports.deleteErrorPayload = exports.createSuccessPayloadNew = exports.createSuccessPayload = exports.createErrorPayload = exports.classifyErrorReason = exports.cacheDeletionForcedPayload = exports.buildErrorAttribution = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _analytics = require("@atlaskit/editor-common/analytics");
+var _types = require("../common/types");
 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; }
 var stringifyError = exports.stringifyError = function stringifyError(error) {
@@ -17,24 +18,77 @@ var stringifyError = exports.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(_types.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.
+ */
+var classifyErrorReason = exports.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.
+ */
+var buildErrorAttribution = exports.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).
 
-var getErrorPayload = exports.getErrorPayload = function getErrorPayload(actionSubjectId, error, resourceId, sourceProduct) {
+var getErrorPayload = exports.getErrorPayload = function getErrorPayload(actionSubjectId, error, resourceId, sourceProduct, attribution) {
   return {
     action: _analytics.ACTION.ERROR,
     actionSubject: _analytics.ACTION_SUBJECT.SYNCED_BLOCK,
     actionSubjectId: actionSubjectId,
     eventType: _analytics.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
     })
   };
 };
@@ -44,17 +98,17 @@ var fetchErrorPayload = exports.fetchErrorPayload = function fetchErrorPayload(e
 var getSourceInfoErrorPayload = exports.getSourceInfoErrorPayload = function getSourceInfoErrorPayload(error, resourceId, sourceProduct) {
   return getErrorPayload(_analytics.ACTION_SUBJECT_ID.SYNCED_BLOCK_GET_SOURCE_INFO, error, resourceId, sourceProduct);
 };
-var updateErrorPayload = exports.updateErrorPayload = function updateErrorPayload(error, resourceId, sourceProduct) {
-  return getErrorPayload(_analytics.ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE, error, resourceId, sourceProduct);
+var updateErrorPayload = exports.updateErrorPayload = function updateErrorPayload(error, resourceId, sourceProduct, attribution) {
+  return getErrorPayload(_analytics.ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE, error, resourceId, sourceProduct, attribution);
 };
-var updateReferenceErrorPayload = exports.updateReferenceErrorPayload = function updateReferenceErrorPayload(error, resourceId, sourceProduct) {
-  return getErrorPayload(_analytics.ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_UPDATE, error, resourceId, sourceProduct);
+var updateReferenceErrorPayload = exports.updateReferenceErrorPayload = function updateReferenceErrorPayload(error, resourceId, sourceProduct, attribution) {
+  return getErrorPayload(_analytics.ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_UPDATE, error, resourceId, sourceProduct, attribution);
 };
-var createErrorPayload = exports.createErrorPayload = function createErrorPayload(error, resourceId, sourceProduct) {
-  return getErrorPayload(_analytics.ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE, error, resourceId, sourceProduct);
+var createErrorPayload = exports.createErrorPayload = function createErrorPayload(error, resourceId, sourceProduct, attribution) {
+  return getErrorPayload(_analytics.ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE, error, resourceId, sourceProduct, attribution);
 };
-var deleteErrorPayload = exports.deleteErrorPayload = function deleteErrorPayload(error, resourceId, sourceProduct) {
-  return getErrorPayload(_analytics.ACTION_SUBJECT_ID.SYNCED_BLOCK_DELETE, error, resourceId, sourceProduct);
+var deleteErrorPayload = exports.deleteErrorPayload = function deleteErrorPayload(error, resourceId, sourceProduct, attribution) {
+  return getErrorPayload(_analytics.ACTION_SUBJECT_ID.SYNCED_BLOCK_DELETE, error, resourceId, sourceProduct, attribution);
 };
 var updateCacheErrorPayload = exports.updateCacheErrorPayload = function updateCacheErrorPayload(error, resourceId, sourceProduct) {
   return getErrorPayload(_analytics.ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE_CACHE, error, resourceId, sourceProduct);

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

@@ -387,7 +387,8 @@ export const writeDataBatch = async (cloudId, parentAri, parentId, product, data
     if (error instanceof BlockError) {
       return data.map(block => ({
         error: mapBlockError(error),
-        resourceId: block.resourceId
+        resourceId: block.resourceId,
+        statusCode: error.status
       }));
     }
     return data.map(block => ({
@@ -632,7 +633,8 @@ class BlockServiceADFWriteProvider {
       if (error instanceof BlockError) {
         return {
           error: mapBlockError(error),
-          resourceId
+          resourceId,
+          statusCode: error.status
         };
       }
       return {
@@ -675,7 +677,8 @@ class BlockServiceADFWriteProvider {
       if (error instanceof BlockError) {
         return {
           error: mapBlockError(error),
-          resourceId
+          resourceId,
+          statusCode: error.status
         };
       }
       return {
@@ -731,7 +734,8 @@ class BlockServiceADFWriteProvider {
         return {
           resourceId,
           success: false,
-          error: mapBlockError(error)
+          error: mapBlockError(error),
+          statusCode: error.status
         };
       }
       return {
@@ -772,7 +776,8 @@ class BlockServiceADFWriteProvider {
           return {
             resourceId,
             success: false,
-            error: mapBlockError(createError)
+            error: mapBlockError(createError),
+            statusCode: createError.status
           };
         } else {
           return {
@@ -796,7 +801,8 @@ class BlockServiceADFWriteProvider {
         return {
           resourceId,
           success: false,
-          error: mapBlockError(error)
+          error: mapBlockError(error),
+          statusCode: error.status
         };
       }
       return {
@@ -848,7 +854,8 @@ class BlockServiceADFWriteProvider {
       if (error instanceof BlockError) {
         return {
           success: false,
-          error: mapBlockError(error)
+          error: mapBlockError(error),
+          statusCode: error.status
         };
       }
       return {
@@ -923,7 +930,8 @@ class BlockServiceADFWriteProvider {
       if (error instanceof BlockError) {
         return data.map(block => ({
           error: mapBlockError(error),
-          resourceId: block.resourceId
+          resourceId: block.resourceId,
+          statusCode: error.status
         }));
       }
       return data.map(block => ({

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

@@ -3,7 +3,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';
@@ -874,7 +874,7 @@ export class ReferenceSyncBlockStoreManager {
         (_this$saveExperience2 = this.saveExperience) === null || _this$saveExperience2 === void 0 ? void 0 : _this$saveExperience2.failure({
           reason: updateResult.error || 'Failed to update reference synced blocks on the document'
         });
-        (_this$fireAnalyticsEv12 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv12 === void 0 ? void 0 : _this$fireAnalyticsEv12.call(this, updateReferenceErrorPayload(updateResult.error || 'Failed to update reference synced blocks on the document'));
+        (_this$fireAnalyticsEv12 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv12 === void 0 ? void 0 : _this$fireAnalyticsEv12.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)));
       }
     } catch (error) {
       var _this$saveExperience3, _this$fireAnalyticsEv13;
@@ -886,7 +886,9 @@ export class ReferenceSyncBlockStoreManager {
         reason: error.message
       });
       // No `resourceId` available in this catch — sourceProduct is intentionally omitted.
-      (_this$fireAnalyticsEv13 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv13 === void 0 ? void 0 : _this$fireAnalyticsEv13.call(this, updateReferenceErrorPayload(error.message));
+      // No structured SyncBlockError/status here, so the attribution `reason` falls back
+      // to `unknown` when the gate is on.
+      (_this$fireAnalyticsEv13 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv13 === void 0 ? void 0 : _this$fireAnalyticsEv13.call(this, updateReferenceErrorPayload(error.message, undefined, undefined, buildErrorAttribution(fg('platform_editor_blocks_patch_3'))));
     } finally {
       if (!success) {
         // set isCacheDirty back to true for cases where it failed to update the reference synced blocks on the BE

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

@@ -1,7 +1,8 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 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. */
@@ -236,9 +237,10 @@ export class SourceSyncBlockStoreManager {
       } else {
         var _this$saveExperience3;
         (_this$saveExperience3 = this.saveExperience) === null || _this$saveExperience3 === void 0 ? void 0 : _this$saveExperience3.failure();
+        const attributionEnabled = fg('platform_editor_blocks_patch_3');
         writeResults.filter(result => !result.resourceId || result.error).forEach(result => {
           var _this$fireAnalyticsEv3;
-          (_this$fireAnalyticsEv3 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv3 === void 0 ? void 0 : _this$fireAnalyticsEv3.call(this, updateErrorPayload(result.error || 'Failed to write data', result.resourceId, getSourceProductFromResourceIdSafe(result.resourceId)));
+          (_this$fireAnalyticsEv3 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv3 === void 0 ? void 0 : _this$fireAnalyticsEv3.call(this, updateErrorPayload(result.error || 'Failed to write data', result.resourceId, getSourceProductFromResourceIdSafe(result.resourceId), buildErrorAttribution(attributionEnabled, result.error, result.statusCode)));
         });
         return false;
       }
@@ -247,8 +249,9 @@ export class SourceSyncBlockStoreManager {
       logException(error, {
         location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
       });
-      // Top-level flush failure is not tied to a single resourceId.
-      (_this$fireAnalyticsEv4 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv4 === void 0 ? void 0 : _this$fireAnalyticsEv4.call(this, updateErrorPayload(error.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$fireAnalyticsEv4 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv4 === void 0 ? void 0 : _this$fireAnalyticsEv4.call(this, updateErrorPayload(error.message, undefined, undefined, buildErrorAttribution(fg('platform_editor_blocks_patch_3'))));
       return false;
     } finally {
       var _this$flushCompletion;
@@ -396,7 +399,7 @@ export class SourceSyncBlockStoreManager {
           (_this$createExperienc3 = this.createExperience) === null || _this$createExperienc3 === void 0 ? void 0 : _this$createExperienc3.failure({
             reason: result.error || 'Failed to create bodied sync block'
           });
-          (_this$fireAnalyticsEv8 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv8 === void 0 ? void 0 : _this$fireAnalyticsEv8.call(this, createErrorPayload(result.error || 'Failed to create bodied sync block', resourceId, getSourceProductFromResourceIdSafe(resourceId)));
+          (_this$fireAnalyticsEv8 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv8 === void 0 ? void 0 : _this$fireAnalyticsEv8.call(this, createErrorPayload(result.error || 'Failed to create bodied sync block', resourceId, getSourceProductFromResourceIdSafe(resourceId), buildErrorAttribution(fg('platform_editor_blocks_patch_3'), result.error, result.statusCode)));
         }
       }).catch(error => {
         var _this$createExperienc4, _this$fireAnalyticsEv9;
@@ -456,23 +459,27 @@ export class SourceSyncBlockStoreManager {
           this.setPendingDeletion(Ids, false);
         };
         (_this$deleteExperienc3 = this.deleteExperience) === null || _this$deleteExperienc3 === void 0 ? void 0 : _this$deleteExperienc3.failure();
+        const attributionEnabled = fg('platform_editor_blocks_patch_3');
         results.forEach(result => {
           if (result.success) {
             var _this$fireAnalyticsEv10;
             (_this$fireAnalyticsEv10 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv10 === void 0 ? void 0 : _this$fireAnalyticsEv10.call(this, deleteSuccessPayload(result.resourceId, getSourceProductFromResourceIdSafe(result.resourceId)));
           } else {
             var _this$fireAnalyticsEv11;
-            (_this$fireAnalyticsEv11 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv11 === void 0 ? void 0 : _this$fireAnalyticsEv11.call(this, deleteErrorPayload(result.error || 'Failed to delete synced block', result.resourceId, getSourceProductFromResourceIdSafe(result.resourceId)));
+            (_this$fireAnalyticsEv11 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv11 === void 0 ? void 0 : _this$fireAnalyticsEv11.call(this, deleteErrorPayload(result.error || 'Failed to delete synced block', result.resourceId, getSourceProductFromResourceIdSafe(result.resourceId), buildErrorAttribution(attributionEnabled, result.error, result.statusCode)));
           }
         });
       }
       syncBlockIds.forEach(callback);
       return isDeleteSuccessful;
     } catch (error) {
+      // Thrown (non-result) failure — no structured SyncBlockError/status is available,
+      // so the attribution `reason` falls back to `unknown` when the gate is on.
+      const attribution = buildErrorAttribution(fg('platform_editor_blocks_patch_3'));
       syncBlockIds.forEach(Ids => {
         var _this$fireAnalyticsEv12;
         this.setPendingDeletion(Ids, false);
-        (_this$fireAnalyticsEv12 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv12 === void 0 ? void 0 : _this$fireAnalyticsEv12.call(this, deleteErrorPayload(error.message, Ids.resourceId, getSourceProductFromResourceIdSafe(Ids.resourceId)));
+        (_this$fireAnalyticsEv12 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv12 === void 0 ? void 0 : _this$fireAnalyticsEv12.call(this, deleteErrorPayload(error.message, Ids.resourceId, getSourceProductFromResourceIdSafe(Ids.resourceId), attribution));
       });
       logException(error, {
         location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'