@atlaskit/editor-synced-block-provider 4.3.4 → 4.3.6

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-synced-block-provider
 
+## 4.3.6
+
+### Patch Changes
+
+- [`540d72eba7200`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/540d72eba7200) -
+  Editor-5503: Add connection diagnostics to GraphQL WebSocket errors for improved debugging of
+  opaque browser error events
+
+## 4.3.5
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 4.3.4
 
 ### Patch Changes

package/dist/cjs/clients/block-service/blockSubscription.js

@@ -1,14 +1,60 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.subscribeToBlockUpdates = void 0;
+exports.subscribeToBlockUpdates = exports.getConnectionDiagnosticsSummary = exports.extractGraphQLWSErrorMessage = void 0;
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 var _graphqlWs = require("graphql-ws");
 var _coreUtils = require("@atlaskit/editor-common/core-utils");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _utils = require("../../utils/utils");
 var GRAPHQL_WS_ENDPOINT = '/gateway/api/graphql/subscriptions';
 var blockServiceClient = null;
+
+/**
+ * Tracks the last known WebSocket connection context for diagnostics.
+ * Since browser WebSocket errors are intentionally opaque ({isTrusted: true}),
+ * we capture lifecycle events to provide meaningful context when errors occur.
+ */
+var connectionDiagnostics = {
+  /** Whether the last connection attempt was a retry */
+  wasRetry: false,
+  /** Timestamp of the last successful connection */
+  lastConnectedAt: 0,
+  /** The close code from the most recent WebSocket CloseEvent, see (https://websocket.org/reference/close-codes/)*/
+  lastCloseCode: 0,
+  /** The close reason from the most recent WebSocket CloseEvent */
+  lastCloseReason: '',
+  /** Whether the last close was clean */
+  lastCloseWasClean: true,
+  /** Current connection state */
+  state: 'idle',
+  /** Number of consecutive connection failures */
+  consecutiveFailures: 0
+};
+
+/**
+ * Returns a diagnostic summary string from the last known connection state.
+ * This provides context that the opaque WebSocket error events cannot.
+ */
+var getConnectionDiagnosticsSummary = exports.getConnectionDiagnosticsSummary = function getConnectionDiagnosticsSummary() {
+  var parts = [];
+  if (connectionDiagnostics.lastCloseCode !== 0) {
+    parts.push("lastCloseCode=".concat(connectionDiagnostics.lastCloseCode));
+    parts.push("lastCloseReason=\"".concat(connectionDiagnostics.lastCloseReason || 'none', "\""));
+    parts.push("wasClean=".concat(connectionDiagnostics.lastCloseWasClean));
+  }
+  parts.push("state=".concat(connectionDiagnostics.state));
+  parts.push("wasRetry=".concat(connectionDiagnostics.wasRetry));
+  parts.push("consecutiveFailures=".concat(connectionDiagnostics.consecutiveFailures));
+  if (connectionDiagnostics.lastConnectedAt > 0) {
+    var elapsed = Date.now() - connectionDiagnostics.lastConnectedAt;
+    parts.push("timeSinceLastConnection=".concat(elapsed, "ms"));
+  }
+  return parts.join(', ');
+};
 var getBlockServiceClient = function getBlockServiceClient() {
   // Don't create client during SSR
   if ((0, _coreUtils.isSSR)()) {
@@ -20,12 +66,63 @@ var getBlockServiceClient = function getBlockServiceClient() {
     blockServiceClient = (0, _graphqlWs.createClient)({
       url: wsUrl,
       lazy: true,
-      retryAttempts: 3
+      retryAttempts: 3,
+      on: (0, _platformFeatureFlags.fg)('platform_synced_block_add_info_web_socket_error') ? {
+        connecting: function connecting(isRetry) {
+          connectionDiagnostics.wasRetry = isRetry;
+          connectionDiagnostics.state = 'connecting';
+        },
+        connected: function connected(_socket, _payload, wasRetry) {
+          connectionDiagnostics.state = 'connected';
+          connectionDiagnostics.lastConnectedAt = Date.now();
+          connectionDiagnostics.wasRetry = wasRetry;
+          connectionDiagnostics.consecutiveFailures = 0;
+        },
+        closed: function closed(event) {
+          var _closeEvent$code, _closeEvent$reason, _closeEvent$wasClean;
+          connectionDiagnostics.state = 'closed';
+          var closeEvent = event;
+          connectionDiagnostics.lastCloseCode = (_closeEvent$code = closeEvent.code) !== null && _closeEvent$code !== void 0 ? _closeEvent$code : 0;
+          connectionDiagnostics.lastCloseReason = (_closeEvent$reason = closeEvent.reason) !== null && _closeEvent$reason !== void 0 ? _closeEvent$reason : '';
+          connectionDiagnostics.lastCloseWasClean = (_closeEvent$wasClean = closeEvent.wasClean) !== null && _closeEvent$wasClean !== void 0 ? _closeEvent$wasClean : false;
+        },
+        error: function error() {
+          connectionDiagnostics.state = 'error';
+          connectionDiagnostics.consecutiveFailures += 1;
+        }
+      } : undefined
     });
   }
   return blockServiceClient;
 };
 var SUBSCRIPTION_QUERY = "\nsubscription EDITOR_SYNCED_BLOCK_ON_BLOCK_UPDATED($resourceId: ID!) {\n\tblockService_onBlockUpdated(resourceId: $resourceId) {\n\t\tblockAri\n\t\tblockInstanceId\n\t\tcontent\n\t\tcontentUpdatedAt\n\t\tcreatedAt\n\t\tcreatedBy\n\t\tdeletionReason\n\t\tproduct\n\t\tsourceAri\n\t\tstatus\n\t}\n}\n";
+/**
+ * Extracts a meaningful error message from the error: GraphQL WebSocket Error: {"isTrusted":true}
+ *
+ * @param error - The error passed to the sink's error callback
+ * @returns A descriptive error message string
+ */
+var extractGraphQLWSErrorMessage = exports.extractGraphQLWSErrorMessage = function extractGraphQLWSErrorMessage(error) {
+  var diagnostics = getConnectionDiagnosticsSummary();
+
+  // Raw Event from WebSocket.onerror — browsers don't expose error details
+  // for security reasons, so {isTrusted: true} is all we get.
+  if ((0, _typeof2.default)(error) === 'object' && error !== null && 'isTrusted' in error) {
+    return "GraphQL WebSocket connection error (browser restricted error details). Diagnostics: ".concat(diagnostics);
+  }
+  if (error instanceof Error) {
+    return error.message;
+  }
+
+  // Fallback: try to stringify whatever we got
+  try {
+    var serialized = JSON.stringify(error);
+    return "GraphQL subscription error: ".concat(serialized);
+  } catch (_unused) {
+    return 'GraphQL subscription error: unknown error';
+  }
+};
+
 /**
  * Extracts the resourceId from a block ARI.
  * Block ARI format: ari:cloud:blocks:<cloudId>:synced-block/<resourceId>
@@ -65,7 +162,7 @@ var parseSubscriptionPayload = function parseSubscriptionPayload(payload) {
       sourceAri: payload.sourceAri,
       status: payload.status
     };
-  } catch (_unused) {
+  } catch (_unused2) {
     return null;
   }
 };
@@ -111,8 +208,12 @@ var subscribeToBlockUpdates = exports.subscribeToBlockUpdates = function subscri
       };
       return error;
     }(function (error) {
-      var errorMessage = error instanceof Error ? error.message : 'GraphQL subscription error';
-      onError === null || onError === void 0 || onError(new Error(errorMessage));
+      if ((0, _platformFeatureFlags.fg)('platform_synced_block_add_info_web_socket_error')) {
+        onError === null || onError === void 0 || onError(new Error(extractGraphQLWSErrorMessage(error)));
+      } else {
+        var errorMessage = error instanceof Error ? error.message : 'GraphQL subscription error';
+        onError === null || onError === void 0 || onError(new Error(errorMessage));
+      }
     }),
     complete: function complete() {
       // Subscription completed

package/dist/cjs/index.js

@@ -87,6 +87,12 @@ Object.defineProperty(exports, "createSyncBlockNode", {
     return _utils.createSyncBlockNode;
   }
 });
+Object.defineProperty(exports, "extractGraphQLWSErrorMessage", {
+  enumerable: true,
+  get: function get() {
+    return _blockSubscription.extractGraphQLWSErrorMessage;
+  }
+});
 Object.defineProperty(exports, "extractResourceIdFromBlockAri", {
   enumerable: true,
   get: function get() {
@@ -135,6 +141,12 @@ Object.defineProperty(exports, "getConfluencePageAri", {
     return _ari2.getConfluencePageAri;
   }
 });
+Object.defineProperty(exports, "getConnectionDiagnosticsSummary", {
+  enumerable: true,
+  get: function get() {
+    return _blockSubscription.getConnectionDiagnosticsSummary;
+  }
+});
 Object.defineProperty(exports, "getContentIdAndProductFromResourceId", {
   enumerable: true,
   get: function get() {
@@ -262,6 +274,7 @@ var _useFetchSyncBlockTitle = require("./hooks/useFetchSyncBlockTitle");
 var _useHandleContentChanges = require("./hooks/useHandleContentChanges");
 var _ari = require("./clients/block-service/ari");
 var _blockService = require("./clients/block-service/blockService");
+var _blockSubscription = require("./clients/block-service/blockSubscription");
 var _ari2 = require("./clients/confluence/ari");
 var _fetchMediaToken = require("./clients/confluence/fetchMediaToken");
 var _ari3 = require("./clients/jira/ari");

package/dist/es2019/clients/block-service/blockSubscription.js

@@ -1,8 +1,52 @@
 import { createClient } from 'graphql-ws';
 import { isSSR } from '@atlaskit/editor-common/core-utils';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { convertContentUpdatedAt } from '../../utils/utils';
 const GRAPHQL_WS_ENDPOINT = '/gateway/api/graphql/subscriptions';
 let blockServiceClient = null;
+
+/**
+ * Tracks the last known WebSocket connection context for diagnostics.
+ * Since browser WebSocket errors are intentionally opaque ({isTrusted: true}),
+ * we capture lifecycle events to provide meaningful context when errors occur.
+ */
+const connectionDiagnostics = {
+  /** Whether the last connection attempt was a retry */
+  wasRetry: false,
+  /** Timestamp of the last successful connection */
+  lastConnectedAt: 0,
+  /** The close code from the most recent WebSocket CloseEvent, see (https://websocket.org/reference/close-codes/)*/
+  lastCloseCode: 0,
+  /** The close reason from the most recent WebSocket CloseEvent */
+  lastCloseReason: '',
+  /** Whether the last close was clean */
+  lastCloseWasClean: true,
+  /** Current connection state */
+  state: 'idle',
+  /** Number of consecutive connection failures */
+  consecutiveFailures: 0
+};
+
+/**
+ * Returns a diagnostic summary string from the last known connection state.
+ * This provides context that the opaque WebSocket error events cannot.
+ */
+export const getConnectionDiagnosticsSummary = () => {
+  const parts = [];
+  if (connectionDiagnostics.lastCloseCode !== 0) {
+    parts.push(`lastCloseCode=${connectionDiagnostics.lastCloseCode}`);
+    parts.push(`lastCloseReason="${connectionDiagnostics.lastCloseReason || 'none'}"`);
+    parts.push(`wasClean=${connectionDiagnostics.lastCloseWasClean}`);
+  }
+  parts.push(`state=${connectionDiagnostics.state}`);
+  parts.push(`wasRetry=${connectionDiagnostics.wasRetry}`);
+  parts.push(`consecutiveFailures=${connectionDiagnostics.consecutiveFailures}`);
+  if (connectionDiagnostics.lastConnectedAt > 0) {
+    const elapsed = Date.now() - connectionDiagnostics.lastConnectedAt;
+    parts.push(`timeSinceLastConnection=${elapsed}ms`);
+  }
+  return parts.join(', ');
+};
 const getBlockServiceClient = () => {
   // Don't create client during SSR
   if (isSSR()) {
@@ -14,7 +58,31 @@ const getBlockServiceClient = () => {
     blockServiceClient = createClient({
       url: wsUrl,
       lazy: true,
-      retryAttempts: 3
+      retryAttempts: 3,
+      on: fg('platform_synced_block_add_info_web_socket_error') ? {
+        connecting: isRetry => {
+          connectionDiagnostics.wasRetry = isRetry;
+          connectionDiagnostics.state = 'connecting';
+        },
+        connected: (_socket, _payload, wasRetry) => {
+          connectionDiagnostics.state = 'connected';
+          connectionDiagnostics.lastConnectedAt = Date.now();
+          connectionDiagnostics.wasRetry = wasRetry;
+          connectionDiagnostics.consecutiveFailures = 0;
+        },
+        closed: event => {
+          var _closeEvent$code, _closeEvent$reason, _closeEvent$wasClean;
+          connectionDiagnostics.state = 'closed';
+          const closeEvent = event;
+          connectionDiagnostics.lastCloseCode = (_closeEvent$code = closeEvent.code) !== null && _closeEvent$code !== void 0 ? _closeEvent$code : 0;
+          connectionDiagnostics.lastCloseReason = (_closeEvent$reason = closeEvent.reason) !== null && _closeEvent$reason !== void 0 ? _closeEvent$reason : '';
+          connectionDiagnostics.lastCloseWasClean = (_closeEvent$wasClean = closeEvent.wasClean) !== null && _closeEvent$wasClean !== void 0 ? _closeEvent$wasClean : false;
+        },
+        error: () => {
+          connectionDiagnostics.state = 'error';
+          connectionDiagnostics.consecutiveFailures += 1;
+        }
+      } : undefined
     });
   }
   return blockServiceClient;
@@ -35,6 +103,33 @@ subscription EDITOR_SYNCED_BLOCK_ON_BLOCK_UPDATED($resourceId: ID!) {
 	}
 }
 `;
+/**
+ * Extracts a meaningful error message from the error: GraphQL WebSocket Error: {"isTrusted":true}
+ *
+ * @param error - The error passed to the sink's error callback
+ * @returns A descriptive error message string
+ */
+export const extractGraphQLWSErrorMessage = error => {
+  const diagnostics = getConnectionDiagnosticsSummary();
+
+  // Raw Event from WebSocket.onerror — browsers don't expose error details
+  // for security reasons, so {isTrusted: true} is all we get.
+  if (typeof error === 'object' && error !== null && 'isTrusted' in error) {
+    return `GraphQL WebSocket connection error (browser restricted error details). Diagnostics: ${diagnostics}`;
+  }
+  if (error instanceof Error) {
+    return error.message;
+  }
+
+  // Fallback: try to stringify whatever we got
+  try {
+    const serialized = JSON.stringify(error);
+    return `GraphQL subscription error: ${serialized}`;
+  } catch {
+    return 'GraphQL subscription error: unknown error';
+  }
+};
+
 /**
  * Extracts the resourceId from a block ARI.
  * Block ARI format: ari:cloud:blocks:<cloudId>:synced-block/<resourceId>
@@ -112,8 +207,12 @@ export const subscribeToBlockUpdates = (blockAri, onData, onError) => {
       }
     },
     error: error => {
-      const errorMessage = error instanceof Error ? error.message : 'GraphQL subscription error';
-      onError === null || onError === void 0 ? void 0 : onError(new Error(errorMessage));
+      if (fg('platform_synced_block_add_info_web_socket_error')) {
+        onError === null || onError === void 0 ? void 0 : onError(new Error(extractGraphQLWSErrorMessage(error)));
+      } else {
+        const errorMessage = error instanceof Error ? error.message : 'GraphQL subscription error';
+        onError === null || onError === void 0 ? void 0 : onError(new Error(errorMessage));
+      }
     },
     complete: () => {
       // Subscription completed

package/dist/es2019/index.js

@@ -11,6 +11,7 @@ export { useHandleContentChanges } from './hooks/useHandleContentChanges';
 // clients
 export { generateBlockAri, generateBlockAriFromReference, getLocalIdFromBlockResourceId } from './clients/block-service/ari';
 export { BlockError, updateSyncedBlocks } from './clients/block-service/blockService';
+export { extractGraphQLWSErrorMessage, getConnectionDiagnosticsSummary } from './clients/block-service/blockSubscription';
 export { getConfluencePageAri, getPageIdAndTypeFromConfluencePageAri } from './clients/confluence/ari';
 export { fetchMediaToken } from './clients/confluence/fetchMediaToken';
 export { getJiraWorkItemAri, getJiraWorkItemIdFromAri } from './clients/jira/ari';

package/dist/esm/clients/block-service/blockSubscription.js

@@ -1,8 +1,53 @@
+import _typeof from "@babel/runtime/helpers/typeof";
 import { createClient } from 'graphql-ws';
 import { isSSR } from '@atlaskit/editor-common/core-utils';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { convertContentUpdatedAt } from '../../utils/utils';
 var GRAPHQL_WS_ENDPOINT = '/gateway/api/graphql/subscriptions';
 var blockServiceClient = null;
+
+/**
+ * Tracks the last known WebSocket connection context for diagnostics.
+ * Since browser WebSocket errors are intentionally opaque ({isTrusted: true}),
+ * we capture lifecycle events to provide meaningful context when errors occur.
+ */
+var connectionDiagnostics = {
+  /** Whether the last connection attempt was a retry */
+  wasRetry: false,
+  /** Timestamp of the last successful connection */
+  lastConnectedAt: 0,
+  /** The close code from the most recent WebSocket CloseEvent, see (https://websocket.org/reference/close-codes/)*/
+  lastCloseCode: 0,
+  /** The close reason from the most recent WebSocket CloseEvent */
+  lastCloseReason: '',
+  /** Whether the last close was clean */
+  lastCloseWasClean: true,
+  /** Current connection state */
+  state: 'idle',
+  /** Number of consecutive connection failures */
+  consecutiveFailures: 0
+};
+
+/**
+ * Returns a diagnostic summary string from the last known connection state.
+ * This provides context that the opaque WebSocket error events cannot.
+ */
+export var getConnectionDiagnosticsSummary = function getConnectionDiagnosticsSummary() {
+  var parts = [];
+  if (connectionDiagnostics.lastCloseCode !== 0) {
+    parts.push("lastCloseCode=".concat(connectionDiagnostics.lastCloseCode));
+    parts.push("lastCloseReason=\"".concat(connectionDiagnostics.lastCloseReason || 'none', "\""));
+    parts.push("wasClean=".concat(connectionDiagnostics.lastCloseWasClean));
+  }
+  parts.push("state=".concat(connectionDiagnostics.state));
+  parts.push("wasRetry=".concat(connectionDiagnostics.wasRetry));
+  parts.push("consecutiveFailures=".concat(connectionDiagnostics.consecutiveFailures));
+  if (connectionDiagnostics.lastConnectedAt > 0) {
+    var elapsed = Date.now() - connectionDiagnostics.lastConnectedAt;
+    parts.push("timeSinceLastConnection=".concat(elapsed, "ms"));
+  }
+  return parts.join(', ');
+};
 var getBlockServiceClient = function getBlockServiceClient() {
   // Don't create client during SSR
   if (isSSR()) {
@@ -14,12 +59,63 @@ var getBlockServiceClient = function getBlockServiceClient() {
     blockServiceClient = createClient({
       url: wsUrl,
       lazy: true,
-      retryAttempts: 3
+      retryAttempts: 3,
+      on: fg('platform_synced_block_add_info_web_socket_error') ? {
+        connecting: function connecting(isRetry) {
+          connectionDiagnostics.wasRetry = isRetry;
+          connectionDiagnostics.state = 'connecting';
+        },
+        connected: function connected(_socket, _payload, wasRetry) {
+          connectionDiagnostics.state = 'connected';
+          connectionDiagnostics.lastConnectedAt = Date.now();
+          connectionDiagnostics.wasRetry = wasRetry;
+          connectionDiagnostics.consecutiveFailures = 0;
+        },
+        closed: function closed(event) {
+          var _closeEvent$code, _closeEvent$reason, _closeEvent$wasClean;
+          connectionDiagnostics.state = 'closed';
+          var closeEvent = event;
+          connectionDiagnostics.lastCloseCode = (_closeEvent$code = closeEvent.code) !== null && _closeEvent$code !== void 0 ? _closeEvent$code : 0;
+          connectionDiagnostics.lastCloseReason = (_closeEvent$reason = closeEvent.reason) !== null && _closeEvent$reason !== void 0 ? _closeEvent$reason : '';
+          connectionDiagnostics.lastCloseWasClean = (_closeEvent$wasClean = closeEvent.wasClean) !== null && _closeEvent$wasClean !== void 0 ? _closeEvent$wasClean : false;
+        },
+        error: function error() {
+          connectionDiagnostics.state = 'error';
+          connectionDiagnostics.consecutiveFailures += 1;
+        }
+      } : undefined
     });
   }
   return blockServiceClient;
 };
 var SUBSCRIPTION_QUERY = "\nsubscription EDITOR_SYNCED_BLOCK_ON_BLOCK_UPDATED($resourceId: ID!) {\n\tblockService_onBlockUpdated(resourceId: $resourceId) {\n\t\tblockAri\n\t\tblockInstanceId\n\t\tcontent\n\t\tcontentUpdatedAt\n\t\tcreatedAt\n\t\tcreatedBy\n\t\tdeletionReason\n\t\tproduct\n\t\tsourceAri\n\t\tstatus\n\t}\n}\n";
+/**
+ * Extracts a meaningful error message from the error: GraphQL WebSocket Error: {"isTrusted":true}
+ *
+ * @param error - The error passed to the sink's error callback
+ * @returns A descriptive error message string
+ */
+export var extractGraphQLWSErrorMessage = function extractGraphQLWSErrorMessage(error) {
+  var diagnostics = getConnectionDiagnosticsSummary();
+
+  // Raw Event from WebSocket.onerror — browsers don't expose error details
+  // for security reasons, so {isTrusted: true} is all we get.
+  if (_typeof(error) === 'object' && error !== null && 'isTrusted' in error) {
+    return "GraphQL WebSocket connection error (browser restricted error details). Diagnostics: ".concat(diagnostics);
+  }
+  if (error instanceof Error) {
+    return error.message;
+  }
+
+  // Fallback: try to stringify whatever we got
+  try {
+    var serialized = JSON.stringify(error);
+    return "GraphQL subscription error: ".concat(serialized);
+  } catch (_unused) {
+    return 'GraphQL subscription error: unknown error';
+  }
+};
+
 /**
  * Extracts the resourceId from a block ARI.
  * Block ARI format: ari:cloud:blocks:<cloudId>:synced-block/<resourceId>
@@ -59,7 +155,7 @@ var parseSubscriptionPayload = function parseSubscriptionPayload(payload) {
       sourceAri: payload.sourceAri,
       status: payload.status
     };
-  } catch (_unused) {
+  } catch (_unused2) {
     return null;
   }
 };
@@ -105,8 +201,12 @@ export var subscribeToBlockUpdates = function subscribeToBlockUpdates(blockAri,
       };
       return error;
     }(function (error) {
-      var errorMessage = error instanceof Error ? error.message : 'GraphQL subscription error';
-      onError === null || onError === void 0 || onError(new Error(errorMessage));
+      if (fg('platform_synced_block_add_info_web_socket_error')) {
+        onError === null || onError === void 0 || onError(new Error(extractGraphQLWSErrorMessage(error)));
+      } else {
+        var errorMessage = error instanceof Error ? error.message : 'GraphQL subscription error';
+        onError === null || onError === void 0 || onError(new Error(errorMessage));
+      }
     }),
     complete: function complete() {
       // Subscription completed

package/dist/esm/index.js

@@ -11,6 +11,7 @@ export { useHandleContentChanges } from './hooks/useHandleContentChanges';
 // clients
 export { generateBlockAri, generateBlockAriFromReference, getLocalIdFromBlockResourceId } from './clients/block-service/ari';
 export { BlockError, updateSyncedBlocks } from './clients/block-service/blockService';
+export { extractGraphQLWSErrorMessage, getConnectionDiagnosticsSummary } from './clients/block-service/blockSubscription';
 export { getConfluencePageAri, getPageIdAndTypeFromConfluencePageAri } from './clients/confluence/ari';
 export { fetchMediaToken } from './clients/confluence/fetchMediaToken';
 export { getJiraWorkItemAri, getJiraWorkItemIdFromAri } from './clients/jira/ari';

package/dist/types/clients/block-service/blockSubscription.d.ts

@@ -1,5 +1,10 @@
 import type { ADFEntity } from '@atlaskit/adf-utils/types';
 import type { SyncBlockProduct } from '../../common/types';
+/**
+ * Returns a diagnostic summary string from the last known connection state.
+ * This provides context that the opaque WebSocket error events cannot.
+ */
+export declare const getConnectionDiagnosticsSummary: () => string;
 export type BlockSubscriptionPayload = {
     blockAri: string;
     blockInstanceId: string;
@@ -27,6 +32,13 @@ export type ParsedBlockSubscriptionData = {
 type SubscriptionCallback = (data: ParsedBlockSubscriptionData) => void;
 type ErrorCallback = (error: Error) => void;
 type Unsubscribe = () => void;
+/**
+ * Extracts a meaningful error message from the error: GraphQL WebSocket Error: {"isTrusted":true}
+ *
+ * @param error - The error passed to the sink's error callback
+ * @returns A descriptive error message string
+ */
+export declare const extractGraphQLWSErrorMessage: (error: unknown) => string;
 /**
  * Creates a GraphQL subscription to block updates using the shared graphql-ws client.
  *

package/dist/types/index.d.ts

@@ -7,6 +7,7 @@ export { useHandleContentChanges } from './hooks/useHandleContentChanges';
 export { generateBlockAri, generateBlockAriFromReference, getLocalIdFromBlockResourceId, } from './clients/block-service/ari';
 export type { BlockContentResponse, BatchRetrieveSyncedBlocksResponse, ErrorResponse, } from './clients/block-service/blockService';
 export { BlockError, updateSyncedBlocks } from './clients/block-service/blockService';
+export { extractGraphQLWSErrorMessage, getConnectionDiagnosticsSummary, } from './clients/block-service/blockSubscription';
 export { getConfluencePageAri, getPageIdAndTypeFromConfluencePageAri, } from './clients/confluence/ari';
 export { fetchMediaToken, type TokenData, type ConfigData, } from './clients/confluence/fetchMediaToken';
 export { getJiraWorkItemAri, getJiraWorkItemIdFromAri } from './clients/jira/ari';

package/dist/types-ts4.5/clients/block-service/blockSubscription.d.ts

@@ -1,5 +1,10 @@
 import type { ADFEntity } from '@atlaskit/adf-utils/types';
 import type { SyncBlockProduct } from '../../common/types';
+/**
+ * Returns a diagnostic summary string from the last known connection state.
+ * This provides context that the opaque WebSocket error events cannot.
+ */
+export declare const getConnectionDiagnosticsSummary: () => string;
 export type BlockSubscriptionPayload = {
     blockAri: string;
     blockInstanceId: string;
@@ -27,6 +32,13 @@ export type ParsedBlockSubscriptionData = {
 type SubscriptionCallback = (data: ParsedBlockSubscriptionData) => void;
 type ErrorCallback = (error: Error) => void;
 type Unsubscribe = () => void;
+/**
+ * Extracts a meaningful error message from the error: GraphQL WebSocket Error: {"isTrusted":true}
+ *
+ * @param error - The error passed to the sink's error callback
+ * @returns A descriptive error message string
+ */
+export declare const extractGraphQLWSErrorMessage: (error: unknown) => string;
 /**
  * Creates a GraphQL subscription to block updates using the shared graphql-ws client.
  *

package/dist/types-ts4.5/index.d.ts

@@ -7,6 +7,7 @@ export { useHandleContentChanges } from './hooks/useHandleContentChanges';
 export { generateBlockAri, generateBlockAriFromReference, getLocalIdFromBlockResourceId, } from './clients/block-service/ari';
 export type { BlockContentResponse, BatchRetrieveSyncedBlocksResponse, ErrorResponse, } from './clients/block-service/blockService';
 export { BlockError, updateSyncedBlocks } from './clients/block-service/blockService';
+export { extractGraphQLWSErrorMessage, getConnectionDiagnosticsSummary, } from './clients/block-service/blockSubscription';
 export { getConfluencePageAri, getPageIdAndTypeFromConfluencePageAri, } from './clients/confluence/ari';
 export { fetchMediaToken, type TokenData, type ConfigData, } from './clients/confluence/fetchMediaToken';
 export { getJiraWorkItemAri, getJiraWorkItemIdFromAri } from './clients/jira/ari';

package/package.json

@@ -29,7 +29,7 @@
 		"@atlaskit/editor-prosemirror": "^7.3.0",
 		"@atlaskit/node-data-provider": "^9.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^54.5.0",
+		"@atlaskit/tmp-editor-statsig": "^55.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.20.0",
 		"graphql-ws": "^5.14.2",
@@ -81,7 +81,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "4.3.4",
+	"version": "4.3.6",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -97,6 +97,9 @@
 		},
 		"platform_synced_block_patch_8": {
 			"type": "boolean"
+		},
+		"platform_synced_block_add_info_web_socket_error": {
+			"type": "boolean"
 		}
 	}
 }