@atlaskit/collab-provider 25.1.6 → 25.2.1

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @atlaskit/collab-provider
 
+## 25.2.1
+
+### Patch Changes
+
+- [`f330bc1939dac`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f330bc1939dac) -
+  Extend websocket-only transport to collab editing, behind the
+  platform-editor-collab-edit-websocket-only feature gate (excludes long-polling-only tenants).
+  Previously websocket-only applied to presence only.
+- Updated dependencies
+
+## 25.2.0
+
+### Minor Changes
+
+- [`23f2823b17126`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/23f2823b17126) -
+  Add a `DOCUMENT_BLOCKED` provider error and map the NCS `ARI_BLACKLISTED` (423) error to it.
+  Previously `ARI_BLACKLISTED` had no mapping and was silently dropped by the provider, so products
+  could not react to a blocked (blacklisted) document. The new mapping is gated behind
+  `platform_editor_blocked_document_ux`; when the gate is off the error is still dropped, preserving
+  existing behaviour.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 25.1.6
 
 ### Patch Changes

package/dist/cjs/errors/error-code-mapper.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.errorCodeMapper = void 0;
+var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _ncsErrors = require("./ncs-errors");
 var _internalErrors = require("./internal-errors");
 var _collab = require("@atlaskit/editor-common/collab");
@@ -58,6 +59,19 @@ var errorCodeMapper = exports.errorCodeMapper = function errorCodeMapper(error)
         message: 'The document is currently not available, please try again later',
         recoverable: true
       };
+    case _ncsErrors.NCS_ERROR_CODE.ARI_BLACKLISTED:
+      // The document ARI has been blocked (e.g. via the documentari kill switch). This is not
+      // recoverable, so emit a distinct error the product can use to disable editing and tell
+      // the user the document is blocked, rather than swallowing it as an unmapped error.
+      if ((0, _fg.fg)('platform_editor_blocked_document_ux')) {
+        return {
+          code: _collab.PROVIDER_ERROR_CODE.DOCUMENT_BLOCKED,
+          message: 'The document is blocked and cannot be edited',
+          recoverable: false,
+          status: 423
+        };
+      }
+      return;
     case _ncsErrors.NCS_ERROR_CODE.DYNAMO_ERROR:
       return {
         code: _collab.PROVIDER_ERROR_CODE.FAIL_TO_SAVE,

package/dist/cjs/errors/ncs-errors.js

@@ -17,6 +17,7 @@ var NCS_ERROR_CODE = exports.NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_C
   NCS_ERROR_CODE["NAMESPACE_NOT_FOUND"] = "NAMESPACE_NOT_FOUND";
   NCS_ERROR_CODE["TENANT_INSTANCE_MAINTENANCE"] = "TENANT_INSTANCE_MAINTENANCE";
   NCS_ERROR_CODE["LOCKED_DOCUMENT"] = "LOCKED_DOCUMENT";
+  NCS_ERROR_CODE["ARI_BLACKLISTED"] = "ARI_BLACKLISTED";
   NCS_ERROR_CODE["EMPTY_BROADCAST"] = "EMPTY_BROADCAST";
   NCS_ERROR_CODE["DYNAMO_ERROR"] = "DYNAMO_ERROR";
   NCS_ERROR_CODE["INVALID_ACTIVATION_ID"] = "INVALID_ACTIVATION_ID";
@@ -36,6 +37,12 @@ var NCS_ERROR_CODE = exports.NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_C
  * This might be because invalid ADF has been written to a document, as it was not validated correctly.
  */
 // - Less common back-end errors
+/**
+ * The document ARI has been blacklisted (blocked) by NCS, e.g. via the documentari kill switch
+ * https://switcheroo.atlassian.com/ui/gates/1a5f36bd-0eb6-4634-ba32-ae325174edb8/key/documentari_kill_switch
+ * NCS rejects the connection with a 423 status. Unlike a temporary namespace lock, this is not
+ * expected to clear on its own.
+ */
 /**
  * The client is trying to send too many messages or messages that are too large. This not expected to be a standard
  * operating condition and should only ever indicate a frontend bug.

package/dist/cjs/socket-io-provider.js

@@ -19,20 +19,47 @@ function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, analyticsH
     pathname = _URL.pathname,
     hostname = _URL.hostname;
   var socketIOOptions = _config.SOCKET_IO_OPTIONS;
-  // Polling first
+  // Default: polling first, with WebSocket upgrade fallback
   var transports = ['polling', 'websocket'];
-  if (isPresenceOnly) {
-    // Presence-specific configuration
-    if ((0, _fg.fg)('platform-editor-presence-websocket-only')) {
-      // https://socket.io/docs/v4/client-options/#transports
-      // WebSocket first, if fails, try polling
-      transports = ['websocket'];
-    }
-    socketIOOptions = _config.SOCKET_IO_OPTIONS_WITH_HIGH_JITTER;
-  } else {
-    if ((0, _utils.isGCPtenant)(hostname) && (0, _fg.fg)('collab_edit_via_websocket_only_for_gcp')) {
-      transports = ['websocket'];
+
+  // Determine transport strategy based on connection type and tenant.
+  // https://socket.io/docs/v4/client-options/#transports
+
+  var getConnectionCase = function getConnectionCase() {
+    if (isPresenceOnly) {
+      // Presence connections: all tenants (commercial, GCP, IC, etc.)
+      return 'presence';
+    } else if ((0, _utils.isGCPtenant)(hostname)) {
+      // Collab editing: GCP tenant
+      return 'gcp-collab';
+    } else {
+      // Collab editing: commercial and all other tenants
+      return 'collab-edit';
     }
+  };
+  switch (getConnectionCase()) {
+    case 'presence':
+      // Presence for all tenants (commercial, GCP, IC, …): WebSocket only when flag is enabled
+      socketIOOptions = _config.SOCKET_IO_OPTIONS_WITH_HIGH_JITTER;
+      if ((0, _fg.fg)('platform-editor-presence-websocket-only')) {
+        transports = ['websocket'];
+      }
+      break;
+    case 'gcp-collab':
+      // GCP: use WebSocket for all collab editing as well
+      if ((0, _fg.fg)('collab_edit_via_websocket_only_for_gcp')) {
+        transports = ['websocket'];
+      }
+      break;
+    case 'collab-edit':
+      // Collab edit (commercial and all other tenants): WebSocket only when flag is enabled, otherwise polling fallback
+      if ((0, _fg.fg)('platform-editor-collab-edit-websocket-only')) {
+        transports = ['websocket'];
+      }
+      break;
+    default:
+      // Default: polling first, with WebSocket upgrade fallback
+      break;
   }
   var extraHeaders = {
     'x-product': (0, _utils.getProduct)(productInfo),

package/dist/cjs/version-wrapper.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = exports.name = "@atlaskit/collab-provider";
-var version = exports.version = "25.1.5";
+var version = exports.version = "25.2.0";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/errors/error-code-mapper.js

@@ -1,3 +1,4 @@
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { NCS_ERROR_CODE } from './ncs-errors';
 import { INTERNAL_ERROR_CODE } from './internal-errors';
 import { PROVIDER_ERROR_CODE } from '@atlaskit/editor-common/collab';
@@ -53,6 +54,19 @@ export const errorCodeMapper = error => {
         message: 'The document is currently not available, please try again later',
         recoverable: true
       };
+    case NCS_ERROR_CODE.ARI_BLACKLISTED:
+      // The document ARI has been blocked (e.g. via the documentari kill switch). This is not
+      // recoverable, so emit a distinct error the product can use to disable editing and tell
+      // the user the document is blocked, rather than swallowing it as an unmapped error.
+      if (fg('platform_editor_blocked_document_ux')) {
+        return {
+          code: PROVIDER_ERROR_CODE.DOCUMENT_BLOCKED,
+          message: 'The document is blocked and cannot be edited',
+          recoverable: false,
+          status: 423
+        };
+      }
+      return;
     case NCS_ERROR_CODE.DYNAMO_ERROR:
       return {
         code: PROVIDER_ERROR_CODE.FAIL_TO_SAVE,

package/dist/es2019/errors/ncs-errors.js

@@ -11,6 +11,7 @@ export let NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
   NCS_ERROR_CODE["NAMESPACE_NOT_FOUND"] = "NAMESPACE_NOT_FOUND";
   NCS_ERROR_CODE["TENANT_INSTANCE_MAINTENANCE"] = "TENANT_INSTANCE_MAINTENANCE";
   NCS_ERROR_CODE["LOCKED_DOCUMENT"] = "LOCKED_DOCUMENT";
+  NCS_ERROR_CODE["ARI_BLACKLISTED"] = "ARI_BLACKLISTED";
   NCS_ERROR_CODE["EMPTY_BROADCAST"] = "EMPTY_BROADCAST";
   NCS_ERROR_CODE["DYNAMO_ERROR"] = "DYNAMO_ERROR";
   NCS_ERROR_CODE["INVALID_ACTIVATION_ID"] = "INVALID_ACTIVATION_ID";
@@ -39,6 +40,13 @@ export let NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
 
 // - Less common back-end errors
 
+/**
+ * The document ARI has been blacklisted (blocked) by NCS, e.g. via the documentari kill switch
+ * https://switcheroo.atlassian.com/ui/gates/1a5f36bd-0eb6-4634-ba32-ae325174edb8/key/documentari_kill_switch
+ * NCS rejects the connection with a 423 status. Unlike a temporary namespace lock, this is not
+ * expected to clear on its own.
+ */
+
 /**
  * The client is trying to send too many messages or messages that are too large. This not expected to be a standard
  * operating condition and should only ever indicate a frontend bug.

package/dist/es2019/socket-io-provider.js

@@ -9,20 +9,47 @@ export function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, ana
     hostname
   } = new URL(url);
   let socketIOOptions = SOCKET_IO_OPTIONS;
-  // Polling first
+  // Default: polling first, with WebSocket upgrade fallback
   let transports = ['polling', 'websocket'];
-  if (isPresenceOnly) {
-    // Presence-specific configuration
-    if (fg('platform-editor-presence-websocket-only')) {
-      // https://socket.io/docs/v4/client-options/#transports
-      // WebSocket first, if fails, try polling
-      transports = ['websocket'];
-    }
-    socketIOOptions = SOCKET_IO_OPTIONS_WITH_HIGH_JITTER;
-  } else {
-    if (isGCPtenant(hostname) && fg('collab_edit_via_websocket_only_for_gcp')) {
-      transports = ['websocket'];
+
+  // Determine transport strategy based on connection type and tenant.
+  // https://socket.io/docs/v4/client-options/#transports
+
+  const getConnectionCase = () => {
+    if (isPresenceOnly) {
+      // Presence connections: all tenants (commercial, GCP, IC, etc.)
+      return 'presence';
+    } else if (isGCPtenant(hostname)) {
+      // Collab editing: GCP tenant
+      return 'gcp-collab';
+    } else {
+      // Collab editing: commercial and all other tenants
+      return 'collab-edit';
     }
+  };
+  switch (getConnectionCase()) {
+    case 'presence':
+      // Presence for all tenants (commercial, GCP, IC, …): WebSocket only when flag is enabled
+      socketIOOptions = SOCKET_IO_OPTIONS_WITH_HIGH_JITTER;
+      if (fg('platform-editor-presence-websocket-only')) {
+        transports = ['websocket'];
+      }
+      break;
+    case 'gcp-collab':
+      // GCP: use WebSocket for all collab editing as well
+      if (fg('collab_edit_via_websocket_only_for_gcp')) {
+        transports = ['websocket'];
+      }
+      break;
+    case 'collab-edit':
+      // Collab edit (commercial and all other tenants): WebSocket only when flag is enabled, otherwise polling fallback
+      if (fg('platform-editor-collab-edit-websocket-only')) {
+        transports = ['websocket'];
+      }
+      break;
+    default:
+      // Default: polling first, with WebSocket upgrade fallback
+      break;
   }
   const extraHeaders = {
     'x-product': getProduct(productInfo),

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/collab-provider";
-export const version = "25.1.5";
+export const version = "25.2.0";
 export const nextMajorVersion = () => {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/esm/errors/error-code-mapper.js

@@ -1,3 +1,4 @@
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { NCS_ERROR_CODE } from './ncs-errors';
 import { INTERNAL_ERROR_CODE } from './internal-errors';
 import { PROVIDER_ERROR_CODE } from '@atlaskit/editor-common/collab';
@@ -53,6 +54,19 @@ export var errorCodeMapper = function errorCodeMapper(error) {
         message: 'The document is currently not available, please try again later',
         recoverable: true
       };
+    case NCS_ERROR_CODE.ARI_BLACKLISTED:
+      // The document ARI has been blocked (e.g. via the documentari kill switch). This is not
+      // recoverable, so emit a distinct error the product can use to disable editing and tell
+      // the user the document is blocked, rather than swallowing it as an unmapped error.
+      if (fg('platform_editor_blocked_document_ux')) {
+        return {
+          code: PROVIDER_ERROR_CODE.DOCUMENT_BLOCKED,
+          message: 'The document is blocked and cannot be edited',
+          recoverable: false,
+          status: 423
+        };
+      }
+      return;
     case NCS_ERROR_CODE.DYNAMO_ERROR:
       return {
         code: PROVIDER_ERROR_CODE.FAIL_TO_SAVE,

package/dist/esm/errors/ncs-errors.js

@@ -11,6 +11,7 @@ export var NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
   NCS_ERROR_CODE["NAMESPACE_NOT_FOUND"] = "NAMESPACE_NOT_FOUND";
   NCS_ERROR_CODE["TENANT_INSTANCE_MAINTENANCE"] = "TENANT_INSTANCE_MAINTENANCE";
   NCS_ERROR_CODE["LOCKED_DOCUMENT"] = "LOCKED_DOCUMENT";
+  NCS_ERROR_CODE["ARI_BLACKLISTED"] = "ARI_BLACKLISTED";
   NCS_ERROR_CODE["EMPTY_BROADCAST"] = "EMPTY_BROADCAST";
   NCS_ERROR_CODE["DYNAMO_ERROR"] = "DYNAMO_ERROR";
   NCS_ERROR_CODE["INVALID_ACTIVATION_ID"] = "INVALID_ACTIVATION_ID";
@@ -39,6 +40,13 @@ export var NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
 
 // - Less common back-end errors
 
+/**
+ * The document ARI has been blacklisted (blocked) by NCS, e.g. via the documentari kill switch
+ * https://switcheroo.atlassian.com/ui/gates/1a5f36bd-0eb6-4634-ba32-ae325174edb8/key/documentari_kill_switch
+ * NCS rejects the connection with a 423 status. Unlike a temporary namespace lock, this is not
+ * expected to clear on its own.
+ */
+
 /**
  * The client is trying to send too many messages or messages that are too large. This not expected to be a standard
  * operating condition and should only ever indicate a frontend bug.

package/dist/esm/socket-io-provider.js

@@ -11,20 +11,47 @@ export function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, ana
     pathname = _URL.pathname,
     hostname = _URL.hostname;
   var socketIOOptions = SOCKET_IO_OPTIONS;
-  // Polling first
+  // Default: polling first, with WebSocket upgrade fallback
   var transports = ['polling', 'websocket'];
-  if (isPresenceOnly) {
-    // Presence-specific configuration
-    if (fg('platform-editor-presence-websocket-only')) {
-      // https://socket.io/docs/v4/client-options/#transports
-      // WebSocket first, if fails, try polling
-      transports = ['websocket'];
-    }
-    socketIOOptions = SOCKET_IO_OPTIONS_WITH_HIGH_JITTER;
-  } else {
-    if (isGCPtenant(hostname) && fg('collab_edit_via_websocket_only_for_gcp')) {
-      transports = ['websocket'];
+
+  // Determine transport strategy based on connection type and tenant.
+  // https://socket.io/docs/v4/client-options/#transports
+
+  var getConnectionCase = function getConnectionCase() {
+    if (isPresenceOnly) {
+      // Presence connections: all tenants (commercial, GCP, IC, etc.)
+      return 'presence';
+    } else if (isGCPtenant(hostname)) {
+      // Collab editing: GCP tenant
+      return 'gcp-collab';
+    } else {
+      // Collab editing: commercial and all other tenants
+      return 'collab-edit';
     }
+  };
+  switch (getConnectionCase()) {
+    case 'presence':
+      // Presence for all tenants (commercial, GCP, IC, …): WebSocket only when flag is enabled
+      socketIOOptions = SOCKET_IO_OPTIONS_WITH_HIGH_JITTER;
+      if (fg('platform-editor-presence-websocket-only')) {
+        transports = ['websocket'];
+      }
+      break;
+    case 'gcp-collab':
+      // GCP: use WebSocket for all collab editing as well
+      if (fg('collab_edit_via_websocket_only_for_gcp')) {
+        transports = ['websocket'];
+      }
+      break;
+    case 'collab-edit':
+      // Collab edit (commercial and all other tenants): WebSocket only when flag is enabled, otherwise polling fallback
+      if (fg('platform-editor-collab-edit-websocket-only')) {
+        transports = ['websocket'];
+      }
+      break;
+    default:
+      // Default: polling first, with WebSocket upgrade fallback
+      break;
   }
   var extraHeaders = {
     'x-product': getProduct(productInfo),

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/collab-provider";
-export var version = "25.1.5";
+export var version = "25.2.0";
 export var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/types/errors/ncs-errors.d.ts

@@ -10,6 +10,7 @@ export declare enum NCS_ERROR_CODE {
     NAMESPACE_NOT_FOUND = "NAMESPACE_NOT_FOUND",
     TENANT_INSTANCE_MAINTENANCE = "TENANT_INSTANCE_MAINTENANCE",
     LOCKED_DOCUMENT = "LOCKED_DOCUMENT",
+    ARI_BLACKLISTED = "ARI_BLACKLISTED",
     EMPTY_BROADCAST = "EMPTY_BROADCAST",
     DYNAMO_ERROR = "DYNAMO_ERROR",
     INVALID_ACTIVATION_ID = "INVALID_ACTIVATION_ID",
@@ -123,6 +124,20 @@ type NamespaceLockedError = {
     };
     message: string;
 };
+/**
+ * The document ARI has been blacklisted (blocked) by NCS, e.g. via the documentari kill switch
+ * https://switcheroo.atlassian.com/ui/gates/1a5f36bd-0eb6-4634-ba32-ae325174edb8/key/documentari_kill_switch
+ * NCS rejects the connection with a 423 status. Unlike a temporary namespace lock, this is not
+ * expected to clear on its own.
+ */
+type DocumentBlacklistedError = {
+    data: {
+        code: NCS_ERROR_CODE.ARI_BLACKLISTED;
+        meta?: string;
+        status: number;
+    };
+    message: string;
+};
 type EmptyBroadcastError = {
     data: {
         code: NCS_ERROR_CODE.EMPTY_BROADCAST;
@@ -180,5 +195,5 @@ export type RateLimitError = {
     };
     message: string;
 };
-export type NCSErrors = HeadVersionUpdateFailedError | VersionAlreadyPresentInDynamoError | InsufficientEditingPermissionError | ForbiddenUserTokenError | NCSDocumentNotFoundError | FailedToLoadInitDataError | ErrorMappingError | InvalidNamespaceDefinedError | SocketNamespaceNotFoundError | TenantInstanceMaintenanceError | NamespaceLockedError | EmptyBroadcastError | DynamoError | InvalidActivationIdError | InvalidDocumentAriError | InvalidCloudIdError | RateLimitError | ProsemirrorSchemaValidationError;
+export type NCSErrors = HeadVersionUpdateFailedError | VersionAlreadyPresentInDynamoError | InsufficientEditingPermissionError | ForbiddenUserTokenError | NCSDocumentNotFoundError | FailedToLoadInitDataError | ErrorMappingError | InvalidNamespaceDefinedError | SocketNamespaceNotFoundError | TenantInstanceMaintenanceError | NamespaceLockedError | DocumentBlacklistedError | EmptyBroadcastError | DynamoError | InvalidActivationIdError | InvalidDocumentAriError | InvalidCloudIdError | RateLimitError | ProsemirrorSchemaValidationError;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "25.1.6",
+	"version": "25.2.1",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -18,7 +18,7 @@
 		"team": "Editor: Collaboration"
 	},
 	"dependencies": {
-		"@atlaskit/adf-utils": "^20.8.0",
+		"@atlaskit/adf-utils": "^20.9.0",
 		"@atlaskit/analytics-gas-types": "^6.2.0",
 		"@atlaskit/analytics-listeners": "^11.3.0",
 		"@atlaskit/anonymous-assets": "^2.8.0",
@@ -39,10 +39,10 @@
 		"lodash": "^4.17.21",
 		"prosemirror-changeset": "^2.3.1",
 		"socket.io-client": "^4.7.5",
-		"uuid": "^3.1.0"
+		"uuid": "^11.1.1"
 	},
 	"devDependencies": {
-		"@atlaskit/adf-schema": "^57.2.0",
+		"@atlaskit/adf-schema": "^57.3.0",
 		"@atlaskit/editor-test-helpers": "workspace:^",
 		"@atlassian/a11y-jest-testing": "^0.17.0",
 		"@atlassian/experiment-test-utils": "^0.2.0",
@@ -61,9 +61,15 @@
 		},
 		"collab_edit_via_websocket_only_for_gcp": {
 			"type": "boolean"
+		},
+		"platform_editor_blocked_document_ux": {
+			"type": "boolean"
+		},
+		"platform-editor-collab-edit-websocket-only": {
+			"type": "boolean"
 		}
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^120.12.0"
+		"@atlaskit/editor-common": "^120.15.0"
 	}
 }