@atlaskit/collab-provider 9.16.0 → 9.17.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/collab-provider
 
+## 9.17.0
+
+### Minor Changes
+
+- [#43813](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/43813) [`417f8592c91`](https://bitbucket.org/atlassian/atlassian-frontend/commits/417f8592c91) - block view only steps and metadata traffic
+
+## 9.16.1
+
+### Patch Changes
+
+- [#43417](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/43417) [`3f3c17f0273`](https://bitbucket.org/atlassian/atlassian-frontend/commits/3f3c17f0273) - ED-20971 Upgrade adf-schema package to ^34.0.0
+
 ## 9.16.0
 
 ### Minor Changes

package/dist/cjs/channel.js

@@ -606,6 +606,9 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
       // We should use `connect` for better cross platform compatibility(Mobile/Web).
       this.socket.on('connect', this.onConnect);
       this.socket.on('data', this.onReceiveData);
+      this.socket.on('permission', function (permit) {
+        _this2.emit('permission', permit);
+      });
       this.socket.on('steps:added', function (data) {
         _this2.emit('steps:added', data);
       });

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

@@ -10,7 +10,8 @@ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/sli
 var defaultNCSFeatureFlags = {
   testFF: false,
   socketMessageMetricsFF: false,
-  sendStepsQueueFF: false
+  sendStepsQueueFF: false,
+  blockViewOnlyFF: false
 };
 
 /**
@@ -20,7 +21,8 @@ var productKeys = {
   confluence: {
     testFF: 'confluence.frontend.collab.provider.testFF',
     socketMessageMetricsFF: 'confluence.frontend.collab.provider.socketMessageMetricsFF',
-    sendStepsQueueFF: 'confluence.frontend.collab.provider.sendStepsQueueFF'
+    sendStepsQueueFF: 'confluence.frontend.collab.provider.sendStepsQueueFF',
+    blockViewOnlyFF: 'confluence.frontend.collab.provider.blockViewOnlyFF'
   }
 };
 var filterFeatureFlagNames = function filterFeatureFlagNames(flags) {

package/dist/cjs/provider/index.js

@@ -50,6 +50,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     // It determines if the provider should initialize immediately and will only be true if:
     // the feature flag is enabled and the initial draft fetched from NCS is also passed in the config.
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isBufferingEnabled", false);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "permit", {});
     /**
      * Wrapper for this.emit, it binds scope for callbacks and waits for initialising of the editor before emitting events.
      * Waiting for the collab provider to become connected to the editor ensures the editor doesn't miss any events.
@@ -142,7 +143,9 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
           version: version,
           metadata: metadata
         });
-      }).on('restore', _this.documentService.onRestore).on('steps:added', _this.documentService.onStepsAdded).on('metadata:changed', _this.metadataService.onMetadataChanged).on('participant:telepointer', function (payload) {
+      }).on('restore', _this.documentService.onRestore).on('permission', function (permit) {
+        _this.permit = Object.assign(_this.permit, 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);
     });
@@ -379,6 +382,9 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     key: "send",
     value: function send(_tr, _oldState, newState) {
       try {
+        if (this.isViewOnly()) {
+          return;
+        }
         // Don't send steps while the document is locked (eg. when restoring the document)
         if (this.namespaceService.getIsNamespaceLocked()) {
           logger('The document is temporary locked');
@@ -392,8 +398,13 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
       }
     }
   }, {
-    key: "sendMessage",
-    value:
+    key: "isViewOnly",
+    value: function isViewOnly() {
+      return (0, _featureFlags.getCollabProviderFeatureFlag)('blockViewOnlyFF', this.config.featureFlags) && this.permit &&
+      // isPermittedToEdit or isPermittedToView can be undefined, must use `===` here.
+      this.permit.isPermittedToEdit === false && this.permit.isPermittedToView === true;
+    }
+
     /**
      * Send messages, such as telepointers, to NCS and other participants. Only used for telepointer data (text and node selections) in the editor and JWM. JWM does some weird serialisation stuff on the node selections.
      * Silently fails if an error occurs, since Presence isn't a critical functionality and self-restores over time.
@@ -402,7 +413,9 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
      * @param {CollabSendableSelection} data.selection Object representing the selected element
      * @param {string} data.sessionId Identifier identifying the session
      */
-    function sendMessage(data) {
+  }, {
+    key: "sendMessage",
+    value: function sendMessage(data) {
       try {
         if ((data === null || data === void 0 ? void 0 : data.type) === 'telepointer') {
           var payload = {
@@ -475,6 +488,9 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     key: "setTitle",
     value: function setTitle(title, broadcast) {
       try {
+        if (this.isViewOnly()) {
+          return;
+        }
         this.metadataService.setTitle(title, broadcast);
       } catch (error) {
         var _this$analyticsHelper12;
@@ -511,6 +527,9 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     key: "setMetadata",
     value: function setMetadata(metadata) {
       try {
+        if (this.isViewOnly()) {
+          return;
+        }
         this.metadataService.setMetadata(metadata);
       } catch (error) {
         var _this$analyticsHelper14;

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

package/dist/es2019/channel.js

@@ -409,6 +409,9 @@ export class Channel extends Emitter {
     // We should use `connect` for better cross platform compatibility(Mobile/Web).
     this.socket.on('connect', this.onConnect);
     this.socket.on('data', this.onReceiveData);
+    this.socket.on('permission', permit => {
+      this.emit('permission', permit);
+    });
     this.socket.on('steps:added', data => {
       this.emit('steps:added', data);
     });

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

@@ -1,7 +1,8 @@
 const defaultNCSFeatureFlags = {
   testFF: false,
   socketMessageMetricsFF: false,
-  sendStepsQueueFF: false
+  sendStepsQueueFF: false,
+  blockViewOnlyFF: false
 };
 
 /**
@@ -11,7 +12,8 @@ const productKeys = {
   confluence: {
     testFF: 'confluence.frontend.collab.provider.testFF',
     socketMessageMetricsFF: 'confluence.frontend.collab.provider.socketMessageMetricsFF',
-    sendStepsQueueFF: 'confluence.frontend.collab.provider.sendStepsQueueFF'
+    sendStepsQueueFF: 'confluence.frontend.collab.provider.sendStepsQueueFF',
+    blockViewOnlyFF: 'confluence.frontend.collab.provider.blockViewOnlyFF'
   }
 };
 const filterFeatureFlagNames = flags => {

package/dist/es2019/provider/index.js

@@ -28,6 +28,7 @@ export class Provider extends Emitter {
     // It determines if the provider should initialize immediately and will only be true if:
     // the feature flag is enabled and the initial draft fetched from NCS is also passed in the config.
     _defineProperty(this, "isBufferingEnabled", false);
+    _defineProperty(this, "permit", {});
     /**
      * Wrapper for this.emit, it binds scope for callbacks and waits for initialising of the editor before emitting events.
      * Waiting for the collab provider to become connected to the editor ensures the editor doesn't miss any events.
@@ -122,7 +123,9 @@ export class Provider extends Emitter {
           version,
           metadata
         });
-      }).on('restore', this.documentService.onRestore).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);
+      }).on('restore', this.documentService.onRestore).on('permission', permit => {
+        this.permit = Object.assign(this.permit, 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 => {
       this.userId = id;
@@ -320,6 +323,9 @@ export class Provider extends Emitter {
    */
   send(_tr, _oldState, newState) {
     try {
+      if (this.isViewOnly()) {
+        return;
+      }
       // Don't send steps while the document is locked (eg. when restoring the document)
       if (this.namespaceService.getIsNamespaceLocked()) {
         logger('The document is temporary locked');
@@ -332,6 +338,12 @@ export class Provider extends Emitter {
       throw new SendTransactionError('Error while sending steps for a transaction', error);
     }
   }
+  isViewOnly() {
+    return getCollabProviderFeatureFlag('blockViewOnlyFF', this.config.featureFlags) && this.permit &&
+    // isPermittedToEdit or isPermittedToView can be undefined, must use `===` here.
+    this.permit.isPermittedToEdit === false && this.permit.isPermittedToView === true;
+  }
+
   /**
    * Send messages, such as telepointers, to NCS and other participants. Only used for telepointer data (text and node selections) in the editor and JWM. JWM does some weird serialisation stuff on the node selections.
    * Silently fails if an error occurs, since Presence isn't a critical functionality and self-restores over time.
@@ -404,6 +416,9 @@ export class Provider extends Emitter {
    */
   setTitle(title, broadcast) {
     try {
+      if (this.isViewOnly()) {
+        return;
+      }
       this.metadataService.setTitle(title, broadcast);
     } catch (error) {
       var _this$analyticsHelper12;
@@ -436,6 +451,9 @@ export class Provider extends Emitter {
    */
   setMetadata(metadata) {
     try {
+      if (this.isViewOnly()) {
+        return;
+      }
       this.metadataService.setMetadata(metadata);
     } catch (error) {
       var _this$analyticsHelper14;

package/dist/es2019/version-wrapper.js

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

package/dist/esm/channel.js

@@ -599,6 +599,9 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
       // We should use `connect` for better cross platform compatibility(Mobile/Web).
       this.socket.on('connect', this.onConnect);
       this.socket.on('data', this.onReceiveData);
+      this.socket.on('permission', function (permit) {
+        _this2.emit('permission', permit);
+      });
       this.socket.on('steps:added', function (data) {
         _this2.emit('steps:added', data);
       });

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

@@ -2,7 +2,8 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 var defaultNCSFeatureFlags = {
   testFF: false,
   socketMessageMetricsFF: false,
-  sendStepsQueueFF: false
+  sendStepsQueueFF: false,
+  blockViewOnlyFF: false
 };
 
 /**
@@ -12,7 +13,8 @@ var productKeys = {
   confluence: {
     testFF: 'confluence.frontend.collab.provider.testFF',
     socketMessageMetricsFF: 'confluence.frontend.collab.provider.socketMessageMetricsFF',
-    sendStepsQueueFF: 'confluence.frontend.collab.provider.sendStepsQueueFF'
+    sendStepsQueueFF: 'confluence.frontend.collab.provider.sendStepsQueueFF',
+    blockViewOnlyFF: 'confluence.frontend.collab.provider.blockViewOnlyFF'
   }
 };
 var filterFeatureFlagNames = function filterFeatureFlagNames(flags) {

package/dist/esm/provider/index.js

@@ -43,6 +43,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     // It determines if the provider should initialize immediately and will only be true if:
     // the feature flag is enabled and the initial draft fetched from NCS is also passed in the config.
     _defineProperty(_assertThisInitialized(_this), "isBufferingEnabled", false);
+    _defineProperty(_assertThisInitialized(_this), "permit", {});
     /**
      * Wrapper for this.emit, it binds scope for callbacks and waits for initialising of the editor before emitting events.
      * Waiting for the collab provider to become connected to the editor ensures the editor doesn't miss any events.
@@ -135,7 +136,9 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
           version: version,
           metadata: metadata
         });
-      }).on('restore', _this.documentService.onRestore).on('steps:added', _this.documentService.onStepsAdded).on('metadata:changed', _this.metadataService.onMetadataChanged).on('participant:telepointer', function (payload) {
+      }).on('restore', _this.documentService.onRestore).on('permission', function (permit) {
+        _this.permit = Object.assign(_this.permit, 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);
     });
@@ -372,6 +375,9 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     key: "send",
     value: function send(_tr, _oldState, newState) {
       try {
+        if (this.isViewOnly()) {
+          return;
+        }
         // Don't send steps while the document is locked (eg. when restoring the document)
         if (this.namespaceService.getIsNamespaceLocked()) {
           logger('The document is temporary locked');
@@ -385,8 +391,13 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       }
     }
   }, {
-    key: "sendMessage",
-    value:
+    key: "isViewOnly",
+    value: function isViewOnly() {
+      return getCollabProviderFeatureFlag('blockViewOnlyFF', this.config.featureFlags) && this.permit &&
+      // isPermittedToEdit or isPermittedToView can be undefined, must use `===` here.
+      this.permit.isPermittedToEdit === false && this.permit.isPermittedToView === true;
+    }
+
     /**
      * Send messages, such as telepointers, to NCS and other participants. Only used for telepointer data (text and node selections) in the editor and JWM. JWM does some weird serialisation stuff on the node selections.
      * Silently fails if an error occurs, since Presence isn't a critical functionality and self-restores over time.
@@ -395,7 +406,9 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
      * @param {CollabSendableSelection} data.selection Object representing the selected element
      * @param {string} data.sessionId Identifier identifying the session
      */
-    function sendMessage(data) {
+  }, {
+    key: "sendMessage",
+    value: function sendMessage(data) {
       try {
         if ((data === null || data === void 0 ? void 0 : data.type) === 'telepointer') {
           var payload = {
@@ -468,6 +481,9 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     key: "setTitle",
     value: function setTitle(title, broadcast) {
       try {
+        if (this.isViewOnly()) {
+          return;
+        }
         this.metadataService.setTitle(title, broadcast);
       } catch (error) {
         var _this$analyticsHelper12;
@@ -504,6 +520,9 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     key: "setMetadata",
     value: function setMetadata(metadata) {
       try {
+        if (this.isViewOnly()) {
+          return;
+        }
         this.metadataService.setMetadata(metadata);
       } catch (error) {
         var _this$analyticsHelper14;

package/dist/esm/version-wrapper.js

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

package/dist/types/channel.d.ts

@@ -1,7 +1,7 @@
 import { Emitter } from './emitter';
 import type { Config, ChannelEvent, CatchupResponse, ReconcileResponse } from './types';
 import type { Socket } from 'socket.io-client';
-import AnalyticsHelper from './analytics/analytics-helper';
+import type AnalyticsHelper from './analytics/analytics-helper';
 import type { Metadata } from '@atlaskit/editor-common/collab';
 export declare class Channel extends Emitter<ChannelEvent> {
     private readonly RATE_LIMIT_TYPE_NONE;

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

@@ -2,6 +2,7 @@ export interface NCSFeatureFlags {
     testFF?: boolean;
     socketMessageMetricsFF?: boolean;
     sendStepsQueueFF?: boolean;
+    blockViewOnlyFF?: boolean;
 }
 export interface WithNCSFeatureFlags {
     featureFlags?: NCSFeatureFlags;

package/dist/types/provider/index.d.ts

@@ -15,6 +15,7 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
     private isProviderInitialized;
     private isBuffered;
     private isBufferingEnabled;
+    private permit;
     private sessionId?;
     private clientId?;
     private userId?;
@@ -79,6 +80,7 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
      * @param {InternalError} error The error to handle
      */
     private onErrorHandled;
+    private isViewOnly;
     /**
      * Send messages, such as telepointers, to NCS and other participants. Only used for telepointer data (text and node selections) in the editor and JWM. JWM does some weird serialisation stuff on the node selections.
      * Silently fails if an error occurs, since Presence isn't a critical functionality and self-restores over time.

package/dist/types/types.d.ts

@@ -146,6 +146,12 @@ export type NamespaceStatus = {
     timestamp: number;
     waitTimeInMs?: number;
 };
+export type Permit = {
+    reason?: string;
+    isPermittedToView?: boolean;
+    isPermittedToEdit?: boolean;
+    maintenanceMode?: boolean;
+};
 export type ChannelEvent = {
     connected: {
         sid: string;
@@ -164,6 +170,7 @@ export type ChannelEvent = {
     };
     'steps:added': StepsPayload;
     'metadata:changed': Metadata;
+    permission: Permit;
     error: InternalError;
     disconnect: {
         reason: string;

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

@@ -1,7 +1,7 @@
 import { Emitter } from './emitter';
 import type { Config, ChannelEvent, CatchupResponse, ReconcileResponse } from './types';
 import type { Socket } from 'socket.io-client';
-import AnalyticsHelper from './analytics/analytics-helper';
+import type AnalyticsHelper from './analytics/analytics-helper';
 import type { Metadata } from '@atlaskit/editor-common/collab';
 export declare class Channel extends Emitter<ChannelEvent> {
     private readonly RATE_LIMIT_TYPE_NONE;

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

@@ -2,6 +2,7 @@ export interface NCSFeatureFlags {
     testFF?: boolean;
     socketMessageMetricsFF?: boolean;
     sendStepsQueueFF?: boolean;
+    blockViewOnlyFF?: boolean;
 }
 export interface WithNCSFeatureFlags {
     featureFlags?: NCSFeatureFlags;

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

@@ -15,6 +15,7 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
     private isProviderInitialized;
     private isBuffered;
     private isBufferingEnabled;
+    private permit;
     private sessionId?;
     private clientId?;
     private userId?;
@@ -79,6 +80,7 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
      * @param {InternalError} error The error to handle
      */
     private onErrorHandled;
+    private isViewOnly;
     /**
      * Send messages, such as telepointers, to NCS and other participants. Only used for telepointer data (text and node selections) in the editor and JWM. JWM does some weird serialisation stuff on the node selections.
      * Silently fails if an error occurs, since Presence isn't a critical functionality and self-restores over time.

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

@@ -146,6 +146,12 @@ export type NamespaceStatus = {
     timestamp: number;
     waitTimeInMs?: number;
 };
+export type Permit = {
+    reason?: string;
+    isPermittedToView?: boolean;
+    isPermittedToEdit?: boolean;
+    maintenanceMode?: boolean;
+};
 export type ChannelEvent = {
     connected: {
         sid: string;
@@ -164,6 +170,7 @@ export type ChannelEvent = {
     };
     'steps:added': StepsPayload;
     'metadata:changed': Metadata;
+    permission: Permit;
     error: InternalError;
     disconnect: {
         reason: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.16.0",
+  "version": "9.17.0",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -36,7 +36,7 @@
   "dependencies": {
     "@atlaskit/analytics-gas-types": "^5.1.0",
     "@atlaskit/analytics-listeners": "^8.7.0",
-    "@atlaskit/editor-common": "^76.22.0",
+    "@atlaskit/editor-common": "^76.23.0",
     "@atlaskit/editor-json-transformer": "^8.10.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
     "@atlaskit/prosemirror-collab": "^0.2.0",
@@ -62,7 +62,7 @@
     }
   },
   "devDependencies": {
-    "@atlaskit/adf-schema": "^33.2.3",
+    "@atlaskit/adf-schema": "^34.0.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "typescript": "~4.9.5"
   },