@atlaskit/collab-provider 18.1.6 → 18.2.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/collab-provider
 
+## 18.2.0
+
+### Minor Changes
+
+- [`efed9a7ddd2cd`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/efed9a7ddd2cd) -
+  Use websocket transport only for socket connections on GCP tenants
+
 ## 18.1.6
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -1,7 +1,6 @@
 {
 	"extends": "../../../../tsconfig.local-consumption.json",
 	"compilerOptions": {
-		"target": "es5",
 		"outDir": "../../../../../confluence/tsDist/@atlaskit__collab-provider",
 		"rootDir": "../",
 		"composite": true,

package/dist/cjs/helpers/utils.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.isAIProviderID = exports.getSubProduct = exports.getStepsAdfWithObfuscation = exports.getStepUGCFreeDetails = exports.getStepTypes = exports.getStepPositions = exports.getProduct = exports.getObfuscatedSteps = exports.getDocAdfWithObfuscationFromJSON = exports.getDocAdfWithObfuscation = exports.createLogger = void 0;
+exports.isGCPtenant = isGCPtenant;
 exports.logObfuscatedSteps = logObfuscatedSteps;
 exports.sleep = sleep;
 exports.toObfuscatedSteps = toObfuscatedSteps;
@@ -267,6 +268,12 @@ function _logObfuscatedSteps() {
 function toObfuscatedSteps(_x3) {
   return _toObfuscatedSteps.apply(this, arguments);
 }
+/**
+ * Copied from confluence/next/packages/graphql/src/utils/gcpDomainUtils.ts
+ * Checks if the current domain is a GCP tenant matching the pattern: .*-cdp-{cdp-id}\.jira-dev\.com
+ * @param {string | undefined} hostname optional hostname to evaluate
+ * @returns {boolean} true if the domain matches the GCP tenant pattern
+ */
 function _toObfuscatedSteps() {
   _toObfuscatedSteps = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(steps) {
     var _steps;
@@ -287,4 +294,13 @@ function _toObfuscatedSteps() {
     }, _callee2);
   }));
   return _toObfuscatedSteps.apply(this, arguments);
+}
+function isGCPtenant(hostname) {
+  if (!hostname) {
+    return false;
+  }
+
+  // eslint-disable-next-line require-unicode-regexp
+  var gcpTenantPattern = /^.*-cdp-\w+\.jira-dev\.com$/;
+  return gcpTenantPattern.test(hostname);
 }

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

@@ -17,7 +17,8 @@ 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) { (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, path, documentAri) {
   var _URL = new URL(url),
-    pathname = _URL.pathname;
+    pathname = _URL.pathname,
+    hostname = _URL.hostname;
   var socketIOOptions = _config.SOCKET_IO_OPTIONS;
   // Polling first
   var transports = ['polling', 'websocket'];
@@ -36,6 +37,9 @@ function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, analyticsH
     if ((0, _expValEquals.expValEquals)('platform_editor_to_use_pmr_for_collab_edit_none_ic', 'isEnabled', true, false)) {
       usePMR = true;
     }
+    if ((0, _utils.isGCPtenant)(hostname) && (0, _platformFeatureFlags.fg)('collab_edit_via_websocket_only_for_gcp')) {
+      transports = ['websocket'];
+    }
   }
   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 = "18.1.5";
+var version = exports.version = "18.1.6";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/helpers/utils.js

@@ -217,4 +217,20 @@ export async function logObfuscatedSteps(oldState, newState) {
 export async function toObfuscatedSteps(steps) {
   const _steps = await Promise.resolve(steps.slice().map(s => s.toJSON()));
   return JSON.stringify(getObfuscatedSteps(_steps));
+}
+
+/**
+ * Copied from confluence/next/packages/graphql/src/utils/gcpDomainUtils.ts
+ * Checks if the current domain is a GCP tenant matching the pattern: .*-cdp-{cdp-id}\.jira-dev\.com
+ * @param {string | undefined} hostname optional hostname to evaluate
+ * @returns {boolean} true if the domain matches the GCP tenant pattern
+ */
+export function isGCPtenant(hostname) {
+  if (!hostname) {
+    return false;
+  }
+
+  // eslint-disable-next-line require-unicode-regexp
+  const gcpTenantPattern = /^.*-cdp-\w+\.jira-dev\.com$/;
+  return gcpTenantPattern.test(hostname);
 }

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

@@ -2,11 +2,12 @@ import { io } from 'socket.io-client';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { Provider } from './provider';
-import { getProduct, getSubProduct } from './helpers/utils';
+import { getProduct, getSubProduct, isGCPtenant } from './helpers/utils';
 import { SOCKET_IO_OPTIONS, SOCKET_IO_OPTIONS_WITH_HIGH_JITTER } from './config';
 export function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, analyticsHelper, path, documentAri) {
   const {
-    pathname
+    pathname,
+    hostname
   } = new URL(url);
   let socketIOOptions = SOCKET_IO_OPTIONS;
   // Polling first
@@ -26,6 +27,9 @@ export function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, ana
     if (expValEquals('platform_editor_to_use_pmr_for_collab_edit_none_ic', 'isEnabled', true, false)) {
       usePMR = true;
     }
+    if (isGCPtenant(hostname) && fg('collab_edit_via_websocket_only_for_gcp')) {
+      transports = ['websocket'];
+    }
   }
   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 = "18.1.5";
+export const version = "18.1.6";
 export const nextMajorVersion = () => {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/esm/helpers/utils.js

@@ -257,6 +257,13 @@ function _logObfuscatedSteps() {
 export function toObfuscatedSteps(_x3) {
   return _toObfuscatedSteps.apply(this, arguments);
 }
+
+/**
+ * Copied from confluence/next/packages/graphql/src/utils/gcpDomainUtils.ts
+ * Checks if the current domain is a GCP tenant matching the pattern: .*-cdp-{cdp-id}\.jira-dev\.com
+ * @param {string | undefined} hostname optional hostname to evaluate
+ * @returns {boolean} true if the domain matches the GCP tenant pattern
+ */
 function _toObfuscatedSteps() {
   _toObfuscatedSteps = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(steps) {
     var _steps;
@@ -277,4 +284,13 @@ function _toObfuscatedSteps() {
     }, _callee2);
   }));
   return _toObfuscatedSteps.apply(this, arguments);
+}
+export function isGCPtenant(hostname) {
+  if (!hostname) {
+    return false;
+  }
+
+  // eslint-disable-next-line require-unicode-regexp
+  var gcpTenantPattern = /^.*-cdp-\w+\.jira-dev\.com$/;
+  return gcpTenantPattern.test(hostname);
 }

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

@@ -5,11 +5,12 @@ import { io } from 'socket.io-client';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { Provider } from './provider';
-import { getProduct, getSubProduct } from './helpers/utils';
+import { getProduct, getSubProduct, isGCPtenant } from './helpers/utils';
 import { SOCKET_IO_OPTIONS, SOCKET_IO_OPTIONS_WITH_HIGH_JITTER } from './config';
 export function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, analyticsHelper, path, documentAri) {
   var _URL = new URL(url),
-    pathname = _URL.pathname;
+    pathname = _URL.pathname,
+    hostname = _URL.hostname;
   var socketIOOptions = SOCKET_IO_OPTIONS;
   // Polling first
   var transports = ['polling', 'websocket'];
@@ -28,6 +29,9 @@ export function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, ana
     if (expValEquals('platform_editor_to_use_pmr_for_collab_edit_none_ic', 'isEnabled', true, false)) {
       usePMR = true;
     }
+    if (isGCPtenant(hostname) && fg('collab_edit_via_websocket_only_for_gcp')) {
+      transports = ['websocket'];
+    }
   }
   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 = "18.1.5";
+export var version = "18.1.6";
 export var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

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

@@ -18,34 +18,22 @@ export type UGCFreeStepDetails = {
 };
 export declare const getStepUGCFreeDetails: (step: ProseMirrorStep) => UGCFreeStepDetails;
 export declare const getStepTypes: (stepJson: StepJson) => {
-    type: string;
     contentTypes: string | null;
+    type: string;
 };
 export declare const getStepsAdfWithObfuscation: (stepJson: StepJson) => ADFEntity[] | null;
 export declare const getDocAdfWithObfuscation: (doc: ProseMirrorNode) => ADFEntity | null;
 export declare const getDocAdfWithObfuscationFromJSON: (docJson: JSONDocNode) => ADFEntity | null;
 export declare const getStepPositions: (stepJson: StepJson) => {
-    pos?: number | undefined;
-    insert?: number | undefined;
+    from?: number | undefined;
     gapFrom?: number | undefined;
     gapTo?: number | undefined;
-    from?: number | undefined;
+    insert?: number | undefined;
+    pos?: number | undefined;
     to?: number | undefined;
 };
 export declare const getObfuscatedSteps: (steps: StepJson[], endIndex?: number | undefined) => {
-    stepType: {
-        type: string;
-        contentTypes: string | null;
-    };
     stepContent: ADFEntity[] | null;
-    stepPositions: {
-        pos?: number | undefined;
-        insert?: number | undefined;
-        gapFrom?: number | undefined;
-        gapTo?: number | undefined;
-        from?: number | undefined;
-        to?: number | undefined;
-    };
     stepMetadata: {
         createdOffline?: boolean;
         prevStepId?: string;
@@ -57,9 +45,28 @@ export declare const getObfuscatedSteps: (steps: StepJson[], endIndex?: number |
         traceId?: string;
         unconfirmedStepAfterRecovery?: boolean;
     } | undefined;
+    stepPositions: {
+        from?: number | undefined;
+        gapFrom?: number | undefined;
+        gapTo?: number | undefined;
+        insert?: number | undefined;
+        pos?: number | undefined;
+        to?: number | undefined;
+    };
+    stepType: {
+        contentTypes: string | null;
+        type: string;
+    };
 }[];
 export declare function logObfuscatedSteps(oldState: EditorState | null, newState: EditorState): Promise<CustomError | {
-    stepsFromOldState: string;
     stepsFromNewState: string;
+    stepsFromOldState: string;
 }>;
 export declare function toObfuscatedSteps(steps: readonly ProseMirrorStep[]): Promise<string>;
+/**
+ * Copied from confluence/next/packages/graphql/src/utils/gcpDomainUtils.ts
+ * Checks if the current domain is a GCP tenant matching the pattern: .*-cdp-{cdp-id}\.jira-dev\.com
+ * @param {string | undefined} hostname optional hostname to evaluate
+ * @returns {boolean} true if the domain matches the GCP tenant pattern
+ */
+export declare function isGCPtenant(hostname?: string): boolean;

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

@@ -18,34 +18,22 @@ export type UGCFreeStepDetails = {
 };
 export declare const getStepUGCFreeDetails: (step: ProseMirrorStep) => UGCFreeStepDetails;
 export declare const getStepTypes: (stepJson: StepJson) => {
-    type: string;
     contentTypes: string | null;
+    type: string;
 };
 export declare const getStepsAdfWithObfuscation: (stepJson: StepJson) => ADFEntity[] | null;
 export declare const getDocAdfWithObfuscation: (doc: ProseMirrorNode) => ADFEntity | null;
 export declare const getDocAdfWithObfuscationFromJSON: (docJson: JSONDocNode) => ADFEntity | null;
 export declare const getStepPositions: (stepJson: StepJson) => {
-    pos?: number | undefined;
-    insert?: number | undefined;
+    from?: number | undefined;
     gapFrom?: number | undefined;
     gapTo?: number | undefined;
-    from?: number | undefined;
+    insert?: number | undefined;
+    pos?: number | undefined;
     to?: number | undefined;
 };
 export declare const getObfuscatedSteps: (steps: StepJson[], endIndex?: number | undefined) => {
-    stepType: {
-        type: string;
-        contentTypes: string | null;
-    };
     stepContent: ADFEntity[] | null;
-    stepPositions: {
-        pos?: number | undefined;
-        insert?: number | undefined;
-        gapFrom?: number | undefined;
-        gapTo?: number | undefined;
-        from?: number | undefined;
-        to?: number | undefined;
-    };
     stepMetadata: {
         createdOffline?: boolean;
         prevStepId?: string;
@@ -57,9 +45,28 @@ export declare const getObfuscatedSteps: (steps: StepJson[], endIndex?: number |
         traceId?: string;
         unconfirmedStepAfterRecovery?: boolean;
     } | undefined;
+    stepPositions: {
+        from?: number | undefined;
+        gapFrom?: number | undefined;
+        gapTo?: number | undefined;
+        insert?: number | undefined;
+        pos?: number | undefined;
+        to?: number | undefined;
+    };
+    stepType: {
+        contentTypes: string | null;
+        type: string;
+    };
 }[];
 export declare function logObfuscatedSteps(oldState: EditorState | null, newState: EditorState): Promise<CustomError | {
-    stepsFromOldState: string;
     stepsFromNewState: string;
+    stepsFromOldState: string;
 }>;
 export declare function toObfuscatedSteps(steps: readonly ProseMirrorStep[]): Promise<string>;
+/**
+ * Copied from confluence/next/packages/graphql/src/utils/gcpDomainUtils.ts
+ * Checks if the current domain is a GCP tenant matching the pattern: .*-cdp-{cdp-id}\.jira-dev\.com
+ * @param {string | undefined} hostname optional hostname to evaluate
+ * @returns {boolean} true if the domain matches the GCP tenant pattern
+ */
+export declare function isGCPtenant(hostname?: string): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "18.1.6",
+	"version": "18.2.0",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -37,7 +37,7 @@
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/prosemirror-collab": "^0.22.0",
 		"@atlaskit/react-ufo": "^5.19.0",
-		"@atlaskit/tmp-editor-statsig": "^77.0.0",
+		"@atlaskit/tmp-editor-statsig": "^77.1.0",
 		"@atlaskit/ufo": "^0.4.0",
 		"@atlaskit/util-service-support": "^6.3.0",
 		"@babel/runtime": "^7.0.0",
@@ -70,9 +70,12 @@
 	"platform-feature-flags": {
 		"platform-editor-presence-websocket-only": {
 			"type": "boolean"
+		},
+		"collab_edit_via_websocket_only_for_gcp": {
+			"type": "boolean"
 		}
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^114.20.0"
+		"@atlaskit/editor-common": "^114.21.0"
 	}
 }

package/afm-jira/tsconfig.json

@@ -1,72 +0,0 @@
-{
-	"extends": "../../../../tsconfig.local-consumption.json",
-	"compilerOptions": {
-		"target": "es5",
-		"outDir": "../../../../../jira/tsDist/@atlaskit__collab-provider/app",
-		"rootDir": "../",
-		"composite": true,
-		"noCheck": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*",
-		"../src/**/examples/*",
-		"../src/**/examples/**/*",
-		"../src/**/*.stories.*",
-		"../src/**/stories/*",
-		"../src/**/stories/**/*"
-	],
-	"references": [
-		{
-			"path": "../../adf-utils/afm-jira/tsconfig.json"
-		},
-		{
-			"path": "../../../analytics/analytics-gas-types/afm-jira/tsconfig.json"
-		},
-		{
-			"path": "../../../analytics/analytics-listeners/afm-jira/tsconfig.json"
-		},
-		{
-			"path": "../../../elements/anonymous-assets/afm-jira/tsconfig.json"
-		},
-		{
-			"path": "../../../uip/atlassian-context/afm-jira/tsconfig.json"
-		},
-		{
-			"path": "../../editor-json-transformer/afm-jira/tsconfig.json"
-		},
-		{
-			"path": "../../editor-prosemirror/afm-jira/tsconfig.json"
-		},
-		{
-			"path": "../../../measurement/feature-gate-js-client/afm-jira/tsconfig.json"
-		},
-		{
-			"path": "../../../platform/feature-flags/afm-jira/tsconfig.json"
-		},
-		{
-			"path": "../../prosemirror-collab/afm-jira/tsconfig.json"
-		},
-		{
-			"path": "../../../react-ufo/atlaskit/afm-jira/tsconfig.json"
-		},
-		{
-			"path": "../../tmp-editor-statsig/afm-jira/tsconfig.json"
-		},
-		{
-			"path": "../../../data/ufo-external/afm-jira/tsconfig.json"
-		},
-		{
-			"path": "../../../elements/util-service-support/afm-jira/tsconfig.json"
-		},
-		{
-			"path": "../../editor-common/afm-jira/tsconfig.json"
-		}
-	]
-}