@atlaskit/collab-provider 9.23.1 → 9.24.1

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/collab-provider
 
+## 9.24.1
+
+### Patch Changes
+
+- [#74416](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/74416) [`444dfaa08f4a`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/444dfaa08f4a) - ESS-4450: Trial websocket first then polling in Collab Provider
+
+## 9.24.0
+
+### Minor Changes
+
+- [#73554](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/73554) [`c03a65a711ea`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/c03a65a711ea) - Emit permission event on collab provider when permissions are set/changed
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 9.23.1
 
 ### Patch Changes

package/dist/cjs/feature-flags/index.js

@@ -10,7 +10,8 @@ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/sli
 var defaultNCSFeatureFlags = {
   testFF: false,
   blockViewOnly: false,
-  reconcileOnRecovery: false
+  reconcileOnRecovery: false,
+  connectWebsocketFirst: false
 };
 
 /**
@@ -20,7 +21,8 @@ var productKeys = {
   confluence: {
     testFF: 'confluence.frontend.collab.provider.testFF',
     blockViewOnly: 'confluence.frontend.ncs.block-view-only',
-    reconcileOnRecovery: 'confluence.frontend.ncs.reconcile-on-recovery'
+    reconcileOnRecovery: 'confluence.frontend.ncs.reconcile-on-recovery',
+    connectWebsocketFirst: 'confluence.frontend.ncs.connect-websocket-first'
   }
 };
 var filterFeatureFlagNames = function filterFeatureFlagNames(flags) {

package/dist/cjs/provider/index.js

@@ -146,6 +146,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
         });
       }).on('restore', _this.documentService.onRestore).on('permission', function (permit) {
         _this.permit = Object.assign(_this.permit, permit);
+        _this.emit('permission', permit);
       }).on('steps:added', _this.documentService.onStepsAdded).on('metadata:changed', _this.metadataService.onMetadataChanged).on('participant:telepointer', function (payload) {
         return _this.participantsService.onParticipantTelepointer(payload, _this.sessionId);
       }).on('presence:joined', _this.participantsService.onPresenceJoined).on('presence', _this.participantsService.onPresence).on('participant:left', _this.participantsService.onParticipantLeft).on('participant:updated', _this.participantsService.onParticipantUpdated).on('disconnect', _this.onDisconnected.bind((0, _assertThisInitialized2.default)(_this))).on('error', _this.onErrorHandled).on('status', _this.namespaceService.onNamespaceStatusChanged).connect(shouldSkipDocumentInit);

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

@@ -11,11 +11,14 @@ var _provider = require("./provider");
 var _socket = require("socket.io-client");
 var _utils = require("./helpers/utils");
 var _config = require("./config");
+var _featureFlags = require("./feature-flags");
 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) {
   var _URL = new URL(url),
     pathname = _URL.pathname;
+  var isWebsocketFirst = (0, _featureFlags.getCollabProviderFeatureFlag)('connectWebsocketFirst');
+  var transports = isWebsocketFirst ? ['websocket', 'polling'] : ['polling', 'websocket'];
 
   // to limit the reconnection flooding towards collab service, here we set the reconnectionDelayMax to 128s.
   return (0, _socket.io)(url, {
@@ -24,7 +27,7 @@ function createSocketIOSocket(url, auth, productInfo) {
     randomizationFactor: _config.SOCKET_IO_OPTIONS.RANDOMIZATION_FACTOR,
     closeOnBeforeunload: false,
     withCredentials: true,
-    transports: ['polling', 'websocket'],
+    transports: transports,
     path: "/".concat(pathname.split('/')[1], "/socket.io"),
     auth: auth,
     extraHeaders: {

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 = "9.23.1";
+var version = exports.version = "9.24.1";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/feature-flags/index.js

@@ -1,7 +1,8 @@
 const defaultNCSFeatureFlags = {
   testFF: false,
   blockViewOnly: false,
-  reconcileOnRecovery: false
+  reconcileOnRecovery: false,
+  connectWebsocketFirst: false
 };
 
 /**
@@ -11,7 +12,8 @@ const productKeys = {
   confluence: {
     testFF: 'confluence.frontend.collab.provider.testFF',
     blockViewOnly: 'confluence.frontend.ncs.block-view-only',
-    reconcileOnRecovery: 'confluence.frontend.ncs.reconcile-on-recovery'
+    reconcileOnRecovery: 'confluence.frontend.ncs.reconcile-on-recovery',
+    connectWebsocketFirst: 'confluence.frontend.ncs.connect-websocket-first'
   }
 };
 const filterFeatureFlagNames = flags => {

package/dist/es2019/provider/index.js

@@ -126,6 +126,7 @@ export class Provider extends Emitter {
         });
       }).on('restore', this.documentService.onRestore).on('permission', permit => {
         this.permit = Object.assign(this.permit, permit);
+        this.emit('permission', permit);
       }).on('steps:added', this.documentService.onStepsAdded).on('metadata:changed', this.metadataService.onMetadataChanged).on('participant:telepointer', payload => this.participantsService.onParticipantTelepointer(payload, this.sessionId)).on('presence:joined', this.participantsService.onPresenceJoined).on('presence', this.participantsService.onPresence).on('participant:left', this.participantsService.onParticipantLeft).on('participant:updated', this.participantsService.onParticipantUpdated).on('disconnect', this.onDisconnected.bind(this)).on('error', this.onErrorHandled).on('status', this.namespaceService.onNamespaceStatusChanged).connect(shouldSkipDocumentInit);
     });
     _defineProperty(this, "setUserId", id => {

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

@@ -2,10 +2,13 @@ import { Provider } from './provider';
 import { io } from 'socket.io-client';
 import { getProduct, getSubProduct } from './helpers/utils';
 import { SOCKET_IO_OPTIONS } from './config';
+import { getCollabProviderFeatureFlag } from './feature-flags';
 export function createSocketIOSocket(url, auth, productInfo) {
   const {
     pathname
   } = new URL(url);
+  const isWebsocketFirst = getCollabProviderFeatureFlag('connectWebsocketFirst');
+  const transports = isWebsocketFirst ? ['websocket', 'polling'] : ['polling', 'websocket'];
 
   // to limit the reconnection flooding towards collab service, here we set the reconnectionDelayMax to 128s.
   return io(url, {
@@ -14,7 +17,7 @@ export function createSocketIOSocket(url, auth, productInfo) {
     randomizationFactor: SOCKET_IO_OPTIONS.RANDOMIZATION_FACTOR,
     closeOnBeforeunload: false,
     withCredentials: true,
-    transports: ['polling', 'websocket'],
+    transports,
     path: `/${pathname.split('/')[1]}/socket.io`,
     auth,
     extraHeaders: {

package/dist/es2019/version-wrapper.js

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

package/dist/esm/feature-flags/index.js

@@ -2,7 +2,8 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 var defaultNCSFeatureFlags = {
   testFF: false,
   blockViewOnly: false,
-  reconcileOnRecovery: false
+  reconcileOnRecovery: false,
+  connectWebsocketFirst: false
 };
 
 /**
@@ -12,7 +13,8 @@ var productKeys = {
   confluence: {
     testFF: 'confluence.frontend.collab.provider.testFF',
     blockViewOnly: 'confluence.frontend.ncs.block-view-only',
-    reconcileOnRecovery: 'confluence.frontend.ncs.reconcile-on-recovery'
+    reconcileOnRecovery: 'confluence.frontend.ncs.reconcile-on-recovery',
+    connectWebsocketFirst: 'confluence.frontend.ncs.connect-websocket-first'
   }
 };
 var filterFeatureFlagNames = function filterFeatureFlagNames(flags) {

package/dist/esm/provider/index.js

@@ -139,6 +139,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         });
       }).on('restore', _this.documentService.onRestore).on('permission', function (permit) {
         _this.permit = Object.assign(_this.permit, permit);
+        _this.emit('permission', permit);
       }).on('steps:added', _this.documentService.onStepsAdded).on('metadata:changed', _this.metadataService.onMetadataChanged).on('participant:telepointer', function (payload) {
         return _this.participantsService.onParticipantTelepointer(payload, _this.sessionId);
       }).on('presence:joined', _this.participantsService.onPresenceJoined).on('presence', _this.participantsService.onPresence).on('participant:left', _this.participantsService.onParticipantLeft).on('participant:updated', _this.participantsService.onParticipantUpdated).on('disconnect', _this.onDisconnected.bind(_assertThisInitialized(_this))).on('error', _this.onErrorHandled).on('status', _this.namespaceService.onNamespaceStatusChanged).connect(shouldSkipDocumentInit);

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

@@ -5,9 +5,12 @@ import { Provider } from './provider';
 import { io } from 'socket.io-client';
 import { getProduct, getSubProduct } from './helpers/utils';
 import { SOCKET_IO_OPTIONS } from './config';
+import { getCollabProviderFeatureFlag } from './feature-flags';
 export function createSocketIOSocket(url, auth, productInfo) {
   var _URL = new URL(url),
     pathname = _URL.pathname;
+  var isWebsocketFirst = getCollabProviderFeatureFlag('connectWebsocketFirst');
+  var transports = isWebsocketFirst ? ['websocket', 'polling'] : ['polling', 'websocket'];
 
   // to limit the reconnection flooding towards collab service, here we set the reconnectionDelayMax to 128s.
   return io(url, {
@@ -16,7 +19,7 @@ export function createSocketIOSocket(url, auth, productInfo) {
     randomizationFactor: SOCKET_IO_OPTIONS.RANDOMIZATION_FACTOR,
     closeOnBeforeunload: false,
     withCredentials: true,
-    transports: ['polling', 'websocket'],
+    transports: transports,
     path: "/".concat(pathname.split('/')[1], "/socket.io"),
     auth: auth,
     extraHeaders: {

package/dist/esm/version-wrapper.js

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

package/dist/types/feature-flags/types.d.ts

@@ -2,6 +2,7 @@ export interface NCSFeatureFlags {
     testFF?: boolean;
     blockViewOnly?: boolean;
     reconcileOnRecovery?: boolean;
+    connectWebsocketFirst?: boolean;
 }
 export interface WithNCSFeatureFlags {
     featureFlags?: NCSFeatureFlags;

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
 export { Provider } from './provider';
 export type { CollabEventDisconnectedData, Socket } from './types';
-export type { NewCollabSyncUpErrorAttributes, ResolvedEditorState, CollabMetadataPayload, CollabEventInitData, CollabInitPayload, CollabEventConnectionData, CollabConnectedPayload, CollabDisconnectedPayload, CollabDataPayload, CollabTelepointerPayload, CollabPresencePayload, CollabLocalStepsPayload, CollabEventRemoteData, CollabEventPresenceData, CollabEventConnectingData, CollabEventTelepointerData, CollabSendableSelection, CollabParticipant, CollabEvents, SyncUpErrorFunction, CollabEditProvider, ProviderError, ProviderParticipant, CollabEventLocalStepData, } from '@atlaskit/editor-common/collab';
+export type { NewCollabSyncUpErrorAttributes, ResolvedEditorState, CollabMetadataPayload, CollabEventInitData, CollabInitPayload, CollabEventConnectionData, CollabConnectedPayload, CollabDisconnectedPayload, CollabDataPayload, CollabTelepointerPayload, CollabPresencePayload, CollabLocalStepsPayload, CollabPermissionEventPayload, CollabEventRemoteData, CollabEventPresenceData, CollabEventConnectingData, CollabEventTelepointerData, CollabSendableSelection, CollabParticipant, CollabEvents, SyncUpErrorFunction, CollabEditProvider, ProviderError, ProviderParticipant, CollabEventLocalStepData, UserPermitType, } from '@atlaskit/editor-common/collab';
 export { PROVIDER_ERROR_CODE } from '@atlaskit/editor-common/collab';

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

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

package/dist/types/types.d.ts

@@ -5,8 +5,8 @@ import type { InternalError } from './errors/internal-errors';
 import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
 import type { GetUserType } from './participants/participants-helper';
 import type AnalyticsHelper from './analytics/analytics-helper';
-import type { CollabInitPayload, StepJson, CollabSendableSelection, Metadata } from '@atlaskit/editor-common/collab';
-export type { CollabParticipant, CollabEventInitData, CollabEventRemoteData, CollabEventConnectionData, CollabEventConnectingData, CollabEventPresenceData, ResolvedEditorState, CollabConnectedPayload, CollabConnectingPayload, CollabDisconnectedPayload, CollabInitPayload, CollabDataPayload, CollabTelepointerPayload, CollabPresencePayload, CollabMetadataPayload, CollabLocalStepsPayload, CollabCommitStatusEventPayload, CollabEvents, Metadata, StepJson, CollabEventTelepointerData, CollabSendableSelection, CollabEditProvider, NewCollabSyncUpErrorAttributes, SyncUpErrorFunction, CollabEventLocalStepData, } from '@atlaskit/editor-common/collab';
+import type { CollabInitPayload, StepJson, CollabSendableSelection, Metadata, UserPermitType } from '@atlaskit/editor-common/collab';
+export type { CollabParticipant, CollabEventInitData, CollabEventRemoteData, CollabEventConnectionData, CollabEventConnectingData, CollabEventPresenceData, ResolvedEditorState, CollabConnectedPayload, CollabConnectingPayload, CollabDisconnectedPayload, CollabInitPayload, CollabDataPayload, CollabTelepointerPayload, CollabPresencePayload, CollabMetadataPayload, CollabLocalStepsPayload, CollabCommitStatusEventPayload, CollabPermissionEventPayload, UserPermitType, CollabEvents, Metadata, StepJson, CollabEventTelepointerData, CollabSendableSelection, CollabEditProvider, NewCollabSyncUpErrorAttributes, SyncUpErrorFunction, CollabEventLocalStepData, } from '@atlaskit/editor-common/collab';
 export interface CollabEventDisconnectedData {
     sid: string;
     reason: 'CLIENT_DISCONNECT' | 'SERVER_DISCONNECT' | 'SOCKET_CLOSED' | 'SOCKET_ERROR' | 'SOCKET_TIMEOUT' | 'UNKNOWN_DISCONNECT';
@@ -108,11 +108,6 @@ export type BroadcastIncomingPayload = {
     timestamp?: number;
     data: PresencePayload | TelepointerPayload | StepsPayload | any;
 };
-export type UserPermitType = {
-    isPermittedToView: boolean;
-    isPermittedToComment: boolean;
-    isPermittedToEdit: boolean;
-};
 export type PresenceData = {
     sessionId: string;
     userId: string | undefined;

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

@@ -2,6 +2,7 @@ export interface NCSFeatureFlags {
     testFF?: boolean;
     blockViewOnly?: boolean;
     reconcileOnRecovery?: boolean;
+    connectWebsocketFirst?: boolean;
 }
 export interface WithNCSFeatureFlags {
     featureFlags?: NCSFeatureFlags;

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

@@ -1,4 +1,4 @@
 export { Provider } from './provider';
 export type { CollabEventDisconnectedData, Socket } from './types';
-export type { NewCollabSyncUpErrorAttributes, ResolvedEditorState, CollabMetadataPayload, CollabEventInitData, CollabInitPayload, CollabEventConnectionData, CollabConnectedPayload, CollabDisconnectedPayload, CollabDataPayload, CollabTelepointerPayload, CollabPresencePayload, CollabLocalStepsPayload, CollabEventRemoteData, CollabEventPresenceData, CollabEventConnectingData, CollabEventTelepointerData, CollabSendableSelection, CollabParticipant, CollabEvents, SyncUpErrorFunction, CollabEditProvider, ProviderError, ProviderParticipant, CollabEventLocalStepData, } from '@atlaskit/editor-common/collab';
+export type { NewCollabSyncUpErrorAttributes, ResolvedEditorState, CollabMetadataPayload, CollabEventInitData, CollabInitPayload, CollabEventConnectionData, CollabConnectedPayload, CollabDisconnectedPayload, CollabDataPayload, CollabTelepointerPayload, CollabPresencePayload, CollabLocalStepsPayload, CollabPermissionEventPayload, CollabEventRemoteData, CollabEventPresenceData, CollabEventConnectingData, CollabEventTelepointerData, CollabSendableSelection, CollabParticipant, CollabEvents, SyncUpErrorFunction, CollabEditProvider, ProviderError, ProviderParticipant, CollabEventLocalStepData, UserPermitType, } from '@atlaskit/editor-common/collab';
 export { PROVIDER_ERROR_CODE } from '@atlaskit/editor-common/collab';

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

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

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

@@ -5,8 +5,8 @@ import type { InternalError } from './errors/internal-errors';
 import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
 import type { GetUserType } from './participants/participants-helper';
 import type AnalyticsHelper from './analytics/analytics-helper';
-import type { CollabInitPayload, StepJson, CollabSendableSelection, Metadata } from '@atlaskit/editor-common/collab';
-export type { CollabParticipant, CollabEventInitData, CollabEventRemoteData, CollabEventConnectionData, CollabEventConnectingData, CollabEventPresenceData, ResolvedEditorState, CollabConnectedPayload, CollabConnectingPayload, CollabDisconnectedPayload, CollabInitPayload, CollabDataPayload, CollabTelepointerPayload, CollabPresencePayload, CollabMetadataPayload, CollabLocalStepsPayload, CollabCommitStatusEventPayload, CollabEvents, Metadata, StepJson, CollabEventTelepointerData, CollabSendableSelection, CollabEditProvider, NewCollabSyncUpErrorAttributes, SyncUpErrorFunction, CollabEventLocalStepData, } from '@atlaskit/editor-common/collab';
+import type { CollabInitPayload, StepJson, CollabSendableSelection, Metadata, UserPermitType } from '@atlaskit/editor-common/collab';
+export type { CollabParticipant, CollabEventInitData, CollabEventRemoteData, CollabEventConnectionData, CollabEventConnectingData, CollabEventPresenceData, ResolvedEditorState, CollabConnectedPayload, CollabConnectingPayload, CollabDisconnectedPayload, CollabInitPayload, CollabDataPayload, CollabTelepointerPayload, CollabPresencePayload, CollabMetadataPayload, CollabLocalStepsPayload, CollabCommitStatusEventPayload, CollabPermissionEventPayload, UserPermitType, CollabEvents, Metadata, StepJson, CollabEventTelepointerData, CollabSendableSelection, CollabEditProvider, NewCollabSyncUpErrorAttributes, SyncUpErrorFunction, CollabEventLocalStepData, } from '@atlaskit/editor-common/collab';
 export interface CollabEventDisconnectedData {
     sid: string;
     reason: 'CLIENT_DISCONNECT' | 'SERVER_DISCONNECT' | 'SOCKET_CLOSED' | 'SOCKET_ERROR' | 'SOCKET_TIMEOUT' | 'UNKNOWN_DISCONNECT';
@@ -108,11 +108,6 @@ export type BroadcastIncomingPayload = {
     timestamp?: number;
     data: PresencePayload | TelepointerPayload | StepsPayload | any;
 };
-export type UserPermitType = {
-    isPermittedToView: boolean;
-    isPermittedToComment: boolean;
-    isPermittedToEdit: boolean;
-};
 export type PresenceData = {
     sessionId: string;
     userId: string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.23.1",
+  "version": "9.24.1",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -39,7 +39,7 @@
   "dependencies": {
     "@atlaskit/analytics-gas-types": "^5.1.0",
     "@atlaskit/analytics-listeners": "^8.9.0",
-    "@atlaskit/editor-common": "^78.1.0",
+    "@atlaskit/editor-common": "^78.2.0",
     "@atlaskit/editor-json-transformer": "^8.10.0",
     "@atlaskit/editor-prosemirror": "3.0.0",
     "@atlaskit/prosemirror-collab": "^0.2.0",