@atlaskit/collab-provider 14.1.2 → 14.2.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/collab-provider
 
+## 14.2.0
+
+### Minor Changes
+
+- [`081b4e257529b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/081b4e257529b) -
+  Support sharded routing for collab presence socket connections
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 14.1.2
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -5,7 +5,8 @@
 		"target": "es5",
 		"outDir": "../../../../../confluence/tsDist/@atlaskit__collab-provider",
 		"rootDir": "../",
-		"composite": true
+		"composite": true,
+		"noCheck": true
 	},
 	"include": [
 		"../src/**/*.ts",
@@ -35,6 +36,9 @@
 		{
 			"path": "../../../elements/anonymous-assets/afm-cc/tsconfig.json"
 		},
+		{
+			"path": "../../../uip/atlassian-context/afm-cc/tsconfig.json"
+		},
 		{
 			"path": "../../editor-json-transformer/afm-cc/tsconfig.json"
 		},

package/afm-jira/tsconfig.json

@@ -5,7 +5,8 @@
 		"target": "es5",
 		"outDir": "../../../../../jira/tsDist/@atlaskit__collab-provider/app",
 		"rootDir": "../",
-		"composite": true
+		"composite": true,
+		"noCheck": true
 	},
 	"include": [
 		"../src/**/*.ts",
@@ -35,6 +36,9 @@
 		{
 			"path": "../../../elements/anonymous-assets/afm-jira/tsconfig.json"
 		},
+		{
+			"path": "../../../uip/atlassian-context/afm-jira/tsconfig.json"
+		},
 		{
 			"path": "../../editor-json-transformer/afm-jira/tsconfig.json"
 		},

package/dist/cjs/channel.js

@@ -546,10 +546,10 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
       }
       var _this$config = this.config,
         documentAri = _this$config.documentAri,
-        url = _this$config.url;
-      var _this$config2 = this.config,
-        createSocket = _this$config2.createSocket,
-        permissionTokenRefresh = _this$config2.permissionTokenRefresh;
+        url = _this$config.url,
+        path = _this$config.path,
+        createSocket = _this$config.createSocket,
+        permissionTokenRefresh = _this$config.permissionTokenRefresh;
       var auth;
       if (permissionTokenRefresh) {
         auth = /*#__PURE__*/function () {
@@ -635,7 +635,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
           };
         }();
       }
-      this.socket = createSocket("".concat(url, "/session/").concat(documentAri), auth, this.config.productInfo, this.config.isPresenceOnly, this.analyticsHelper);
+      this.socket = createSocket("".concat(url, "/session/").concat(documentAri), auth, this.config.productInfo, this.config.isPresenceOnly, this.analyticsHelper, path);
 
       // Due to https://github.com/socketio/socket.io-client/issues/1473,
       // reconnect no longer fired on the socket.
@@ -733,7 +733,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
       // Ensure the error emit to the provider has the same structure, so we can handle them unified.
       this.socket.on('connect_error', this.onConnectError);
       this.socket.on('permission:invalidateToken', this.handlePermissionInvalidateToken);
-      this.socket.onAnyOutgoing(function (_event) {
+      this.socket.onAnyOutgoing(function (_) {
         for (var _len = arguments.length, args = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
           args[_key - 1] = arguments[_key];
         }

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

@@ -9,17 +9,21 @@ exports.createSocketIOSocket = createSocketIOSocket;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _socket = require("socket.io-client");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _atlassianContext = require("@atlaskit/atlassian-context");
+var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _provider = require("./provider");
 var _utils = require("./helpers/utils");
 var _config = require("./config");
 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; }
-function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, analyticsHelper) {
+function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, analyticsHelper, path) {
   var _URL = new URL(url),
     pathname = _URL.pathname;
   var socketIOOptions = _config.SOCKET_IO_OPTIONS;
   // Polling first
   var transports = ['polling', 'websocket'];
+  var usePMR = false;
+
   // Limit this change to Presence only
   if (isPresenceOnly) {
     if ((0, _platformFeatureFlags.fg)('platform-editor-presence-websocket-only')) {
@@ -28,6 +32,9 @@ function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, analyticsH
       transports = ['websocket'];
     }
     socketIOOptions = _config.SOCKET_IO_OPTIONS_WITH_HIGH_JITTER;
+    if ((0, _atlassianContext.isIsolatedCloud)() && (0, _expValEquals.expValEquals)('platform_editor_use_pmr_for_collab_presence_in_ic', 'isEnabled', true, false) || !(0, _atlassianContext.isIsolatedCloud)() && (0, _expValEquals.expValEquals)('platform_editor_use_pmr_for_collab_presence_non_ic', 'isEnabled', true, false)) {
+      usePMR = true;
+    }
   }
   var client = (0, _socket.io)(url, {
     reconnectionDelayMax: socketIOOptions.RECONNECTION_DELAY_MAX,
@@ -36,7 +43,7 @@ function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, analyticsH
     closeOnBeforeunload: false,
     withCredentials: true,
     transports: transports,
-    path: "/".concat(pathname.split('/')[1], "/socket.io"),
+    path: usePMR && path ? "".concat(path, "/socket.io") : "/".concat(pathname.split('/')[1], "/socket.io"),
     auth: auth,
     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 = "0.0.0-development";
+var version = exports.version = "14.1.2";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/channel.js

@@ -389,9 +389,8 @@ export class Channel extends Emitter {
     }
     const {
       documentAri,
-      url
-    } = this.config;
-    const {
+      url,
+      path,
       createSocket,
       permissionTokenRefresh
     } = this.config;
@@ -447,7 +446,7 @@ export class Channel extends Emitter {
         cb(authData);
       };
     }
-    this.socket = createSocket(`${url}/session/${documentAri}`, auth, this.config.productInfo, this.config.isPresenceOnly, this.analyticsHelper);
+    this.socket = createSocket(`${url}/session/${documentAri}`, auth, this.config.productInfo, this.config.isPresenceOnly, this.analyticsHelper, path);
 
     // Due to https://github.com/socketio/socket.io-client/issues/1473,
     // reconnect no longer fired on the socket.
@@ -536,7 +535,7 @@ export class Channel extends Emitter {
     // Ensure the error emit to the provider has the same structure, so we can handle them unified.
     this.socket.on('connect_error', this.onConnectError);
     this.socket.on('permission:invalidateToken', this.handlePermissionInvalidateToken);
-    this.socket.onAnyOutgoing((_event, ...args) => this.onAnyOutgoingHandler(Date.now(), args));
+    this.socket.onAnyOutgoing((_, ...args) => this.onAnyOutgoingHandler(Date.now(), args));
 
     // To trigger reconnection when browser comes back online
     if (!this.network) {

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

@@ -1,15 +1,19 @@
 import { io } from 'socket.io-client';
 import { fg } from '@atlaskit/platform-feature-flags';
+import { isIsolatedCloud } from '@atlaskit/atlassian-context';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { Provider } from './provider';
 import { getProduct, getSubProduct } from './helpers/utils';
 import { SOCKET_IO_OPTIONS, SOCKET_IO_OPTIONS_WITH_HIGH_JITTER } from './config';
-export function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, analyticsHelper) {
+export function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, analyticsHelper, path) {
   const {
     pathname
   } = new URL(url);
   let socketIOOptions = SOCKET_IO_OPTIONS;
   // Polling first
   let transports = ['polling', 'websocket'];
+  let usePMR = false;
+
   // Limit this change to Presence only
   if (isPresenceOnly) {
     if (fg('platform-editor-presence-websocket-only')) {
@@ -18,6 +22,9 @@ export function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, ana
       transports = ['websocket'];
     }
     socketIOOptions = SOCKET_IO_OPTIONS_WITH_HIGH_JITTER;
+    if (isIsolatedCloud() && expValEquals('platform_editor_use_pmr_for_collab_presence_in_ic', 'isEnabled', true, false) || !isIsolatedCloud() && expValEquals('platform_editor_use_pmr_for_collab_presence_non_ic', 'isEnabled', true, false)) {
+      usePMR = true;
+    }
   }
   const client = io(url, {
     reconnectionDelayMax: socketIOOptions.RECONNECTION_DELAY_MAX,
@@ -26,7 +33,7 @@ export function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, ana
     closeOnBeforeunload: false,
     withCredentials: true,
     transports,
-    path: `/${pathname.split('/')[1]}/socket.io`,
+    path: usePMR && path ? `${path}/socket.io` : `/${pathname.split('/')[1]}/socket.io`,
     auth,
     extraHeaders: {
       'x-product': getProduct(productInfo),

package/dist/es2019/version-wrapper.js

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

package/dist/esm/channel.js

@@ -539,10 +539,10 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
       }
       var _this$config = this.config,
         documentAri = _this$config.documentAri,
-        url = _this$config.url;
-      var _this$config2 = this.config,
-        createSocket = _this$config2.createSocket,
-        permissionTokenRefresh = _this$config2.permissionTokenRefresh;
+        url = _this$config.url,
+        path = _this$config.path,
+        createSocket = _this$config.createSocket,
+        permissionTokenRefresh = _this$config.permissionTokenRefresh;
       var auth;
       if (permissionTokenRefresh) {
         auth = /*#__PURE__*/function () {
@@ -628,7 +628,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
           };
         }();
       }
-      this.socket = createSocket("".concat(url, "/session/").concat(documentAri), auth, this.config.productInfo, this.config.isPresenceOnly, this.analyticsHelper);
+      this.socket = createSocket("".concat(url, "/session/").concat(documentAri), auth, this.config.productInfo, this.config.isPresenceOnly, this.analyticsHelper, path);
 
       // Due to https://github.com/socketio/socket.io-client/issues/1473,
       // reconnect no longer fired on the socket.
@@ -726,7 +726,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
       // Ensure the error emit to the provider has the same structure, so we can handle them unified.
       this.socket.on('connect_error', this.onConnectError);
       this.socket.on('permission:invalidateToken', this.handlePermissionInvalidateToken);
-      this.socket.onAnyOutgoing(function (_event) {
+      this.socket.onAnyOutgoing(function (_) {
         for (var _len = arguments.length, args = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
           args[_key - 1] = arguments[_key];
         }

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

@@ -3,15 +3,19 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import { io } from 'socket.io-client';
 import { fg } from '@atlaskit/platform-feature-flags';
+import { isIsolatedCloud } from '@atlaskit/atlassian-context';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { Provider } from './provider';
 import { getProduct, getSubProduct } from './helpers/utils';
 import { SOCKET_IO_OPTIONS, SOCKET_IO_OPTIONS_WITH_HIGH_JITTER } from './config';
-export function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, analyticsHelper) {
+export function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, analyticsHelper, path) {
   var _URL = new URL(url),
     pathname = _URL.pathname;
   var socketIOOptions = SOCKET_IO_OPTIONS;
   // Polling first
   var transports = ['polling', 'websocket'];
+  var usePMR = false;
+
   // Limit this change to Presence only
   if (isPresenceOnly) {
     if (fg('platform-editor-presence-websocket-only')) {
@@ -20,6 +24,9 @@ export function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, ana
       transports = ['websocket'];
     }
     socketIOOptions = SOCKET_IO_OPTIONS_WITH_HIGH_JITTER;
+    if (isIsolatedCloud() && expValEquals('platform_editor_use_pmr_for_collab_presence_in_ic', 'isEnabled', true, false) || !isIsolatedCloud() && expValEquals('platform_editor_use_pmr_for_collab_presence_non_ic', 'isEnabled', true, false)) {
+      usePMR = true;
+    }
   }
   var client = io(url, {
     reconnectionDelayMax: socketIOOptions.RECONNECTION_DELAY_MAX,
@@ -28,7 +35,7 @@ export function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, ana
     closeOnBeforeunload: false,
     withCredentials: true,
     transports: transports,
-    path: "/".concat(pathname.split('/')[1], "/socket.io"),
+    path: usePMR && path ? "".concat(path, "/socket.io") : "/".concat(pathname.split('/')[1], "/socket.io"),
     auth: auth,
     extraHeaders: {
       'x-product': getProduct(productInfo),

package/dist/esm/version-wrapper.js

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

package/dist/types/socket-io-provider.d.ts

@@ -1,6 +1,6 @@
 import type { Socket } from 'socket.io-client';
 import { Provider } from './provider';
-import type AnalyticsHelper from './analytics/analytics-helper';
 import type { Config, ProductInformation, InitAndAuthData, AuthCallback } from './types';
-export declare function createSocketIOSocket(url: string, auth?: AuthCallback | InitAndAuthData, productInfo?: ProductInformation, isPresenceOnly?: boolean, analyticsHelper?: AnalyticsHelper): Socket;
+import type AnalyticsHelper from './analytics/analytics-helper';
+export declare function createSocketIOSocket(url: string, auth?: AuthCallback | InitAndAuthData, productInfo?: ProductInformation, isPresenceOnly?: boolean, analyticsHelper?: AnalyticsHelper, path?: string): Socket;
 export declare function createSocketIOCollabProvider(config: Omit<Config, 'createSocket'>): Provider;

package/dist/types/types.d.ts

@@ -39,7 +39,7 @@ export interface Config {
      */
     analyticsClient?: AnalyticsWebClient;
     batchProps?: BatchProps;
-    createSocket: (path: string, auth?: AuthCallback | InitAndAuthData, productInfo?: ProductInformation, isPresenceOnly?: boolean, analyticsHelper?: AnalyticsHelper) => SocketIOSocket;
+    createSocket: (url: string, auth?: AuthCallback | InitAndAuthData, productInfo?: ProductInformation, isPresenceOnly?: boolean, analyticsHelper?: AnalyticsHelper, path?: string) => SocketIOSocket;
     documentAri: string;
     /**
      * Enable checking if a document update from collab-provider is being dropped by the editor,
@@ -62,6 +62,11 @@ export interface Config {
     isPresenceOnly?: boolean;
     lifecycle?: Lifecycle;
     need404?: boolean;
+    /**
+     * Used for sharded routing, product passes route to collab provider
+     * e.g. /ncs-presence/{cloudId}/{activationId}/confluence
+     */
+    path?: string;
     /**
      * If provided, permissionTokenRefresh is called whenever a new JWT token is required.
      */

package/dist/types-ts4.5/socket-io-provider.d.ts

@@ -1,6 +1,6 @@
 import type { Socket } from 'socket.io-client';
 import { Provider } from './provider';
-import type AnalyticsHelper from './analytics/analytics-helper';
 import type { Config, ProductInformation, InitAndAuthData, AuthCallback } from './types';
-export declare function createSocketIOSocket(url: string, auth?: AuthCallback | InitAndAuthData, productInfo?: ProductInformation, isPresenceOnly?: boolean, analyticsHelper?: AnalyticsHelper): Socket;
+import type AnalyticsHelper from './analytics/analytics-helper';
+export declare function createSocketIOSocket(url: string, auth?: AuthCallback | InitAndAuthData, productInfo?: ProductInformation, isPresenceOnly?: boolean, analyticsHelper?: AnalyticsHelper, path?: string): Socket;
 export declare function createSocketIOCollabProvider(config: Omit<Config, 'createSocket'>): Provider;

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

@@ -39,7 +39,7 @@ export interface Config {
      */
     analyticsClient?: AnalyticsWebClient;
     batchProps?: BatchProps;
-    createSocket: (path: string, auth?: AuthCallback | InitAndAuthData, productInfo?: ProductInformation, isPresenceOnly?: boolean, analyticsHelper?: AnalyticsHelper) => SocketIOSocket;
+    createSocket: (url: string, auth?: AuthCallback | InitAndAuthData, productInfo?: ProductInformation, isPresenceOnly?: boolean, analyticsHelper?: AnalyticsHelper, path?: string) => SocketIOSocket;
     documentAri: string;
     /**
      * Enable checking if a document update from collab-provider is being dropped by the editor,
@@ -62,6 +62,11 @@ export interface Config {
     isPresenceOnly?: boolean;
     lifecycle?: Lifecycle;
     need404?: boolean;
+    /**
+     * Used for sharded routing, product passes route to collab provider
+     * e.g. /ncs-presence/{cloudId}/{activationId}/confluence
+     */
+    path?: string;
     /**
      * If provided, permissionTokenRefresh is called whenever a new JWT token is required.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "14.1.2",
+	"version": "14.2.0",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -30,13 +30,14 @@
 		"@atlaskit/analytics-gas-types": "^5.1.0",
 		"@atlaskit/analytics-listeners": "^9.1.0",
 		"@atlaskit/anonymous-assets": "^0.0.14",
+		"@atlaskit/atlassian-context": "^0.6.0",
 		"@atlaskit/editor-json-transformer": "^8.31.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/feature-gate-js-client": "^5.5.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/prosemirror-collab": "^0.22.0",
 		"@atlaskit/react-ufo": "^4.15.0",
-		"@atlaskit/tmp-editor-statsig": "^15.0.0",
+		"@atlaskit/tmp-editor-statsig": "^15.5.0",
 		"@atlaskit/ufo": "^0.4.0",
 		"@atlaskit/util-service-support": "^6.3.0",
 		"@babel/runtime": "^7.0.0",
@@ -74,6 +75,6 @@
 		}
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.40.0"
+		"@atlaskit/editor-common": "^110.41.0"
 	}
 }