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

package/dist/types/providers/types.d.ts

@@ -25,6 +25,12 @@ export type SyncBlockInstance = {
 export type DeleteSyncBlockResult = {
     error?: string;
     resourceId: ResourceId;
+    /**
+     * HTTP status code from the backend (Block Service) when the failure originated
+     * from a `BlockError`. Surfaced so failure analytics can break down delete/update
+     * failures by status code (EDITOR-7796). Undefined for non-HTTP failures.
+     */
+    statusCode?: number;
     success: boolean;
 };
 /**
@@ -66,6 +72,12 @@ export type WriteSyncBlockResult = {
     error?: string;
     resourceId?: ResourceId;
     status?: SyncBlockStatus;
+    /**
+     * HTTP status code from the backend (Block Service) when the failure originated
+     * from a `BlockError`. Surfaced so failure analytics can break down update
+     * failures by status code (EDITOR-7796). Undefined for non-HTTP failures.
+     */
+    statusCode?: number;
 };
 export type SourceInfoFetchData = {
     pageARI: string;
@@ -73,6 +85,12 @@ export type SourceInfoFetchData = {
 };
 export type UpdateReferenceSyncBlockResult = {
     error?: string;
+    /**
+     * HTTP status code from the backend when the failure originated from a `BlockError`.
+     * Surfaced so reference-update failure analytics can break down failures by status
+     * code (EDITOR-7796). Undefined for non-HTTP failures.
+     */
+    statusCode?: number;
     success: boolean;
 };
 export type BlockNodeIdentifiers = {

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

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

package/dist/types/utils/errorHandling.d.ts

@@ -1,17 +1,56 @@
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID } from '@atlaskit/editor-common/analytics';
 import type { RendererSyncBlockEventPayload, OperationalAEP, SyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
+import { SyncBlockError } from '../common/types';
 export declare const stringifyError: (error: unknown) => string | undefined;
-export declare const getErrorPayload: <T extends ACTION_SUBJECT_ID>(actionSubjectId: T, error: string, resourceId?: string, sourceProduct?: string) => OperationalAEP<ACTION.ERROR, ACTION_SUBJECT.SYNCED_BLOCK, T, {
+/**
+ * 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.
+ */
+export type SyncBlockErrorReason = `${SyncBlockError}` | 'unknown';
+/**
+ * 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 declare const classifyErrorReason: (error?: string) => SyncBlockErrorReason;
+/**
+ * Extra, optional analytics attributes describing WHY an operational synced-block
+ * action failed. Spread conditionally so we never emit `undefined` keys (EDITOR-7796).
+ */
+export type ErrorAttributionAttributes = {
+    /** Categorical failure cause for dashboard grouping. */
+    reason?: SyncBlockErrorReason;
+    /** Backend HTTP status code when the failure came from a `BlockError`. */
+    statusCode?: number;
+};
+/**
+ * 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 declare const buildErrorAttribution: (gateEnabled: boolean, error?: string, statusCode?: number) => ErrorAttributionAttributes | undefined;
+export declare const getErrorPayload: <T extends ACTION_SUBJECT_ID>(actionSubjectId: T, error: string, resourceId?: string, sourceProduct?: string, attribution?: ErrorAttributionAttributes) => OperationalAEP<ACTION.ERROR, ACTION_SUBJECT.SYNCED_BLOCK, T, {
     error: string;
     resourceId?: string;
     sourceProduct?: string;
+    reason?: SyncBlockErrorReason;
+    statusCode?: number;
 }>;
 export declare const fetchErrorPayload: (error: string, resourceId?: string, sourceProduct?: string) => RendererSyncBlockEventPayload;
 export declare const getSourceInfoErrorPayload: (error: string, resourceId?: string, sourceProduct?: string) => RendererSyncBlockEventPayload;
-export declare const updateErrorPayload: (error: string, resourceId?: string, sourceProduct?: string) => SyncBlockEventPayload;
-export declare const updateReferenceErrorPayload: (error: string, resourceId?: string, sourceProduct?: string) => RendererSyncBlockEventPayload;
-export declare const createErrorPayload: (error: string, resourceId?: string, sourceProduct?: string) => SyncBlockEventPayload;
-export declare const deleteErrorPayload: (error: string, resourceId?: string, sourceProduct?: string) => SyncBlockEventPayload;
+export declare const updateErrorPayload: (error: string, resourceId?: string, sourceProduct?: string, attribution?: ErrorAttributionAttributes) => SyncBlockEventPayload;
+export declare const updateReferenceErrorPayload: (error: string, resourceId?: string, sourceProduct?: string, attribution?: ErrorAttributionAttributes) => RendererSyncBlockEventPayload;
+export declare const createErrorPayload: (error: string, resourceId?: string, sourceProduct?: string, attribution?: ErrorAttributionAttributes) => SyncBlockEventPayload;
+export declare const deleteErrorPayload: (error: string, resourceId?: string, sourceProduct?: string, attribution?: ErrorAttributionAttributes) => SyncBlockEventPayload;
 export declare const updateCacheErrorPayload: (error: string, resourceId?: string, sourceProduct?: string) => SyncBlockEventPayload;
 /**
  * Payload for `SYNCED_BLOCK_SOURCE_INFO_ORPHANED`. Fired when source-info

package/package.json

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