@atlaskit/collab-provider 7.6.2 → 7.7.0

package/dist/es2019/analytics/index.js

@@ -1,4 +1,5 @@
-import { ATTRIBUTES_PACKAGE, EVENT_SUBJECT, COLLAB_SERVICE } from '../helpers/const';
+import { EVENT_SUBJECT, COLLAB_SERVICE } from '../helpers/const';
+import { name as packageName, version as packageVersion } from '../version-wrapper';
 export const fireAnalyticsEvent = (analyticsClient, payload) => {
   if (!analyticsClient || !payload) {
     return;
@@ -24,7 +25,8 @@ export const triggerCollabAnalyticsEvent = (analyticsEvent, analyticsClient) =>
     actionSubject: EVENT_SUBJECT,
     source: 'unknown',
     attributes: {
-      packageName: ATTRIBUTES_PACKAGE,
+      packageName,
+      packageVersion,
       collabService: COLLAB_SERVICE.NCS,
       ...analyticsEvent.attributes
     }

package/dist/es2019/analytics/performance.js

@@ -5,6 +5,8 @@ export let MEASURE_NAME;
   MEASURE_NAME["SOCKET_CONNECT"] = "socketConnect";
   MEASURE_NAME["DOCUMENT_INIT"] = "documentInit";
   MEASURE_NAME["CONVERT_PM_TO_ADF"] = "convertPMToADF";
+  MEASURE_NAME["ADD_STEPS"] = "addSteps";
+  MEASURE_NAME["COMMIT_UNCONFIRMED_STEPS"] = "commitUnconfirmedSteps";
 })(MEASURE_NAME || (MEASURE_NAME = {}));
 
 const isPerformanceAPIAvailable = () => {

package/dist/es2019/channel.js

@@ -71,6 +71,20 @@ export class Channel extends Emitter {
             userId,
             metadata
           });
+        } else {
+          // Page is been just restored, need to fix all the participants as well.
+          const {
+            doc,
+            version,
+            userId,
+            metadata
+          } = data;
+          this.emit('restore', {
+            doc,
+            version,
+            userId,
+            metadata
+          });
         }
       } else {
         this.emit('steps:added', data);
@@ -169,6 +183,10 @@ export class Channel extends Emitter {
     });
     this.socket.on('metadata:changed', payload => {
       this.emit('metadata:changed', payload);
+    }); // ESS-2916 namespace status event - lock/unlock
+
+    this.socket.on('status', data => {
+      this.emit('status', data);
     });
     this.socket.on('disconnect', async reason => {
       this.connected = false;

package/dist/es2019/config.js

@@ -1,5 +1,5 @@
 export const SOCKET_IO_OPTIONS = {
   RECONNECTION_DELAY_MAX: 128 * 1000,
-  RECONNECTION_DELAY: 1000,
-  RANDOMIZATION_FACTOR: 0.1
+  RECONNECTION_DELAY: 200,
+  RANDOMIZATION_FACTOR: 0.5
 };

package/dist/es2019/helpers/const.js

@@ -1,4 +1,3 @@
-export const ATTRIBUTES_PACKAGE = 'collabProvider';
 export const EVENT_SUBJECT = 'collab';
 export let COLLAB_SERVICE;
 
@@ -16,6 +15,8 @@ export let EVENT_ACTION;
   EVENT_ACTION["ADD_STEPS"] = "addSteps";
   EVENT_ACTION["CONVERT_PM_TO_ADF"] = "convertPMToADF";
   EVENT_ACTION["UPDATE_PARTICIPANTS"] = "updateParticipants";
+  EVENT_ACTION["COMMIT_UNCONFIRMED_STEPS"] = "commitUnconfirmedSteps";
+  EVENT_ACTION["REINITIALISE_DOCUMENT"] = "reinitialiseDocument";
 })(EVENT_ACTION || (EVENT_ACTION = {}));
 
 export let EVENT_STATUS;
@@ -25,4 +26,4 @@ export let EVENT_STATUS;
   EVENT_STATUS["FAILURE"] = "FAILURE";
 })(EVENT_STATUS || (EVENT_STATUS = {}));
 
-export const ACK_MAX_TRY = 10;
+export const ACK_MAX_TRY = 30;

package/dist/es2019/provider/index.js

@@ -50,6 +50,7 @@ const throttledCommitStep = throttle(commitStep, SEND_STEPS_THROTTLE, {
   trailing: true
 });
 export class Provider extends Emitter {
+  // To keep track of the namespace event changes from the server.
   constructor(config) {
     super();
 
@@ -61,6 +62,8 @@ export class Provider extends Emitter {
 
     _defineProperty(this, "isChannelInitialized", false);
 
+    _defineProperty(this, "isNamespaceLocked", false);
+
     _defineProperty(this, "initializeChannel", () => {
       this.channel.on('connected', ({
         sid,
@@ -88,7 +91,42 @@ export class Provider extends Emitter {
           version,
           metadata
         });
-      }).on('steps:added', this.onStepsAdded.bind(this)).on('participant:telepointer', this.onParticipantTelepointer.bind(this)).on('presence:joined', this.onPresenceJoined.bind(this)).on('presence', this.onPresence.bind(this)).on('participant:left', this.onParticipantLeft.bind(this)).on('participant:updated', this.onParticipantUpdated.bind(this)).on('metadata:changed', this.onMetadataChanged.bind(this)).on('disconnect', this.onDisconnected.bind(this)).on('error', this.onErrorHandled.bind(this)).connect();
+      }).on('restore', this.onRestore.bind(this)).on('steps:added', this.onStepsAdded.bind(this)).on('participant:telepointer', this.onParticipantTelepointer.bind(this)).on('presence:joined', this.onPresenceJoined.bind(this)).on('presence', this.onPresence.bind(this)).on('participant:left', this.onParticipantLeft.bind(this)).on('participant:updated', this.onParticipantUpdated.bind(this)).on('metadata:changed', this.onMetadataChanged.bind(this)).on('disconnect', this.onDisconnected.bind(this)).on('error', this.onErrorHandled.bind(this)).on('status', this.onNamespaceStatusChanged.bind(this)).connect();
+    });
+
+    _defineProperty(this, "onRestore", ({
+      doc,
+      version,
+      metadata
+    }) => {
+      // Preseve the unconfirmed steps to prevent data loss.
+      const {
+        steps: unconfirmedSteps
+      } = this.getUnconfirmedSteps() || {
+        steps: []
+      }; // Reset the editor,
+      //  - Repalce the document, keep in sync with the server
+      //  - Repalce the version number, so editor is in sync with NCS server and can commit new changes.
+      //  - Repalce the metadata
+      //  - Reserve the cursore position, in case a cursor jump.
+
+      this.updateDocumentWithMetadata({
+        doc,
+        version,
+        metadata,
+        reserveCursor: true
+      });
+      triggerCollabAnalyticsEvent({
+        eventAction: EVENT_ACTION.REINITIALISE_DOCUMENT,
+        attributes: {
+          numUnconfirmedSteps: unconfirmedSteps.length,
+          documentAri: this.config.documentAri
+        }
+      }, this.analyticsClient); // Re-apply the unconfirmed steps, not 100% of them can be applied, if document is changed significantly.
+
+      if (unconfirmedSteps.length > 0) {
+        this.applyLocalsteps(unconfirmedSteps);
+      }
     });
 
     _defineProperty(this, "onStepsAdded", data => {
@@ -216,12 +254,14 @@ export class Provider extends Emitter {
     _defineProperty(this, "onErrorHandled", error => {
       if (error && error.data) {
         if (error.data.code === 'HEAD_VERSION_UPDATE_FAILED' || error.data.code === 'VERSION_NUMBER_ALREADY_EXISTS') {
+          const measure = stopMeasure(MEASURE_NAME.ADD_STEPS);
           triggerCollabAnalyticsEvent({
             eventAction: EVENT_ACTION.ADD_STEPS,
             attributes: {
               eventStatus: EVENT_STATUS.FAILURE,
               error,
-              documentAri: this.config.documentAri
+              documentAri: this.config.documentAri,
+              latency: measure === null || measure === void 0 ? void 0 : measure.duration
             }
           }, this.analyticsClient);
           this.stepRejectCounter++;
@@ -468,17 +508,18 @@ export class Provider extends Emitter {
       let unconfirmedState = this.getUnconfirmedSteps();
 
       if (unconfirmedState && unconfirmedState.steps.length) {
-        // We use origins here as steps can be rebased. When steps are rebased a new step is created.
+        startMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS); // We use origins here as steps can be rebased. When steps are rebased a new step is created.
         // This means that we can not track if it has been removed from the unconfirmed array or not.
         // Origins points to the original transaction that the step was created in. This is never changed
         // and gets passed down when a step is rebased.
+
         const unconfirmedTrs = unconfirmedState.origins;
         const lastTr = unconfirmedTrs[unconfirmedTrs.length - 1];
         let isLastTrConfirmed = false;
 
         while (!isLastTrConfirmed) {
           this.sendStepsFromCurrentState();
-          await sleep(500);
+          await sleep(1000);
           const nextUnconfirmedState = this.getUnconfirmedSteps();
 
           if (nextUnconfirmedState && nextUnconfirmedState.steps.length) {
@@ -500,9 +541,32 @@ export class Provider extends Emitter {
               });
             }
 
-            throw new Error("Can't syncup with Collab Service");
+            const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS);
+            triggerCollabAnalyticsEvent({
+              eventAction: EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS,
+              attributes: {
+                eventStatus: EVENT_STATUS.FAILURE,
+                latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+                documentAri: this.config.documentAri,
+                // upon failure, emit the number of unconfirmed steps we attempted to sync
+                numUnconfirmedSteps: nextUnconfirmedState === null || nextUnconfirmedState === void 0 ? void 0 : nextUnconfirmedState.steps.length
+              }
+            }, this.analyticsClient);
+            throw new Error("Can't sync up with Collab Service");
           }
         }
+
+        const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS);
+        triggerCollabAnalyticsEvent({
+          eventAction: EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS,
+          attributes: {
+            eventStatus: EVENT_STATUS.SUCCESS,
+            latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+            documentAri: this.config.documentAri,
+            // upon success, emit the total number of unconfirmed steps we synced
+            numUnconfirmedSteps: unconfirmedState.steps.length
+          }
+        }, this.analyticsClient);
       }
 
       const state = this.getState(); // Convert ProseMirror document in Editor state to ADF document
@@ -542,6 +606,37 @@ export class Provider extends Emitter {
       };
     });
 
+    _defineProperty(this, "onNamespaceStatusChanged", async data => {
+      const {
+        isLocked,
+        waitTimeInMs,
+        timestamp
+      } = data;
+      const start = Date.now();
+      logger(`Received a namespace status changed event `, {
+        data
+      });
+
+      if (isLocked && waitTimeInMs) {
+        this.isNamespaceLocked = true;
+        logger(`Received a namespace status change event `, {
+          isLocked
+        }); // To protect the collab editing process from locked out due to BE
+
+        setTimeout(() => {
+          logger(`The namespace lock has expired`, {
+            waitTime: Date.now() - start,
+            timestamp
+          });
+          this.isNamespaceLocked = false;
+        }, waitTimeInMs);
+        return;
+      }
+
+      this.isNamespaceLocked = false;
+      logger(`The page lock has expired`);
+    });
+
     this.config = config;
     this.channel = new Channel(config);
     this.isChannelInitialized = false;
@@ -607,17 +702,23 @@ export class Provider extends Emitter {
       return;
     }
 
+    if (this.isNamespaceLocked) {
+      logger('The document is temporary locked');
+      return;
+    }
+
     const {
       steps
     } = sendable;
 
     if (!steps || !steps.length) {
       return;
-    } // Avoid reference issues using a
+    }
+
+    startMeasure(MEASURE_NAME.ADD_STEPS); // Avoid reference issues using a
     // method outside of the provider
     // scope
 
-
     throttledCommitStep({
       channel: this.channel,
       userId: this.userId,
@@ -625,10 +726,7 @@ export class Provider extends Emitter {
       steps,
       version
     });
-  }
-  /**
-   * Called when we receive steps from the service
-   */
+  } // Triggered when page recovery has emitted an 'init' event on a page client is currently connected to.
 
 
   queueSteps(data) {
@@ -674,14 +772,16 @@ export class Provider extends Emitter {
         json: steps,
         version,
         userIds: clientIds
-      }); // If steps can apply to local editor sucessfully, no need to accumulate the error counter.
+      }); // If steps can apply to local editor successfully, no need to accumulate the error counter.
 
       this.stepRejectCounter = 0;
+      const measure = stopMeasure(MEASURE_NAME.ADD_STEPS);
       triggerCollabAnalyticsEvent({
         eventAction: EVENT_ACTION.ADD_STEPS,
         attributes: {
           eventStatus: EVENT_STATUS.SUCCESS,
-          documentAri: this.config.documentAri
+          documentAri: this.config.documentAri,
+          latency: measure === null || measure === void 0 ? void 0 : measure.duration
         }
       }, this.analyticsClient);
       this.emitTelepointersFromSteps(steps); // Resend local steps if none of the received steps originated with us!
@@ -801,5 +901,9 @@ export class Provider extends Emitter {
     this.channel.disconnect();
     return this;
   }
+  /**
+   * ESS-2916 namespace status event- lock/unlock
+   */
+
 
 }

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

@@ -11,6 +11,7 @@ export function createSocketIOSocket(url, auth, productInfo) {
     reconnectionDelayMax: SOCKET_IO_OPTIONS.RECONNECTION_DELAY_MAX,
     reconnectionDelay: SOCKET_IO_OPTIONS.RECONNECTION_DELAY,
     randomizationFactor: SOCKET_IO_OPTIONS.RANDOMIZATION_FACTOR,
+    closeOnBeforeunload: false,
     withCredentials: true,
     transports: ['polling', 'websocket'],
     path: `/${pathname.split('/')[1]}/socket.io`,

package/dist/es2019/version-wrapper.js

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

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "7.6.2",
+	"version": "7.7.0",
 	"sideEffects": false
 }

package/dist/esm/analytics/index.js

@@ -4,7 +4,8 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
-import { ATTRIBUTES_PACKAGE, EVENT_SUBJECT, COLLAB_SERVICE } from '../helpers/const';
+import { EVENT_SUBJECT, COLLAB_SERVICE } from '../helpers/const';
+import { name as packageName, version as packageVersion } from '../version-wrapper';
 export var fireAnalyticsEvent = function fireAnalyticsEvent(analyticsClient, payload) {
   if (!analyticsClient || !payload) {
     return;
@@ -30,7 +31,8 @@ export var triggerCollabAnalyticsEvent = function triggerCollabAnalyticsEvent(an
     actionSubject: EVENT_SUBJECT,
     source: 'unknown',
     attributes: _objectSpread({
-      packageName: ATTRIBUTES_PACKAGE,
+      packageName: packageName,
+      packageVersion: packageVersion,
       collabService: COLLAB_SERVICE.NCS
     }, analyticsEvent.attributes)
   };

package/dist/esm/analytics/performance.js

@@ -5,6 +5,8 @@ export var MEASURE_NAME;
   MEASURE_NAME["SOCKET_CONNECT"] = "socketConnect";
   MEASURE_NAME["DOCUMENT_INIT"] = "documentInit";
   MEASURE_NAME["CONVERT_PM_TO_ADF"] = "convertPMToADF";
+  MEASURE_NAME["ADD_STEPS"] = "addSteps";
+  MEASURE_NAME["COMMIT_UNCONFIRMED_STEPS"] = "commitUnconfirmedSteps";
 })(MEASURE_NAME || (MEASURE_NAME = {}));
 
 var isPerformanceAPIAvailable = function isPerformanceAPIAvailable() {

package/dist/esm/channel.js

@@ -102,6 +102,19 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
             userId: userId,
             metadata: metadata
           });
+        } else {
+          // Page is been just restored, need to fix all the participants as well.
+          var _doc = data.doc,
+              _version = data.version,
+              _userId = data.userId,
+              _metadata = data.metadata;
+
+          _this.emit('restore', {
+            doc: _doc,
+            version: _version,
+            userId: _userId,
+            metadata: _metadata
+          });
         }
       } else {
         _this.emit('steps:added', data);
@@ -201,6 +214,10 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
       });
       this.socket.on('metadata:changed', function (payload) {
         _this2.emit('metadata:changed', payload);
+      }); // ESS-2916 namespace status event - lock/unlock
+
+      this.socket.on('status', function (data) {
+        _this2.emit('status', data);
       });
       this.socket.on('disconnect', /*#__PURE__*/function () {
         var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(reason) {

package/dist/esm/config.js

@@ -1,5 +1,5 @@
 export var SOCKET_IO_OPTIONS = {
   RECONNECTION_DELAY_MAX: 128 * 1000,
-  RECONNECTION_DELAY: 1000,
-  RANDOMIZATION_FACTOR: 0.1
+  RECONNECTION_DELAY: 200,
+  RANDOMIZATION_FACTOR: 0.5
 };

package/dist/esm/helpers/const.js

@@ -1,4 +1,3 @@
-export var ATTRIBUTES_PACKAGE = 'collabProvider';
 export var EVENT_SUBJECT = 'collab';
 export var COLLAB_SERVICE;
 
@@ -16,6 +15,8 @@ export var EVENT_ACTION;
   EVENT_ACTION["ADD_STEPS"] = "addSteps";
   EVENT_ACTION["CONVERT_PM_TO_ADF"] = "convertPMToADF";
   EVENT_ACTION["UPDATE_PARTICIPANTS"] = "updateParticipants";
+  EVENT_ACTION["COMMIT_UNCONFIRMED_STEPS"] = "commitUnconfirmedSteps";
+  EVENT_ACTION["REINITIALISE_DOCUMENT"] = "reinitialiseDocument";
 })(EVENT_ACTION || (EVENT_ACTION = {}));
 
 export var EVENT_STATUS;
@@ -25,4 +26,4 @@ export var EVENT_STATUS;
   EVENT_STATUS["FAILURE"] = "FAILURE";
 })(EVENT_STATUS || (EVENT_STATUS = {}));
 
-export var ACK_MAX_TRY = 10;
+export var ACK_MAX_TRY = 30;