@atlaskit/collab-provider 8.3.0 → 8.4.0

package/dist/es2019/provider/index.js

@@ -9,7 +9,7 @@ import { createLogger, getParticipant, sleep } from '../helpers/utils';
 import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
 import AnalyticsHelper from '../analytics';
 import { catchup } from './catchup';
-import { ErrorCodeMapper, errorCodeMapper } from '../error-code-mapper';
+import { ErrorCodeMapper, errorCodeMapper } from '../errors/error-code-mapper';
 import { disconnectedReasonMapper } from '../disconnected-reason-mapper';
 import { MEASURE_NAME, startMeasure, stopMeasure } from '../analytics/performance';
 import { commitStep } from './commit-step';
@@ -22,7 +22,7 @@ const CATCHUP_THROTTLE = 1 * 1000; // 1 second
 const OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 const noop = () => {};
 export const MAX_STEP_REJECTED_ERROR = 15;
-const throttledCommitStep = throttle(commitStep, SEND_STEPS_THROTTLE, {
+export const throttledCommitStep = throttle(commitStep, SEND_STEPS_THROTTLE, {
   leading: false,
   trailing: true
 });
@@ -491,98 +491,107 @@ export class Provider extends Emitter {
     });
     _defineProperty(this, "getCurrentState", async () => {
       try {
-        var _this$metadata$title;
+        var _this$metadata$title, _this$analyticsHelper20;
+        startMeasure(MEASURE_NAME.GET_CURRENT_STATE, this.analyticsHelper);
+
         // Convert ProseMirror document in Editor state to ADF document
         const state = this.getState();
         const adfDocument = new JSONTransformer().encode(state.doc);
-        return {
+        const currentState = {
           content: adfDocument,
           title: (_this$metadata$title = this.metadata.title) === null || _this$metadata$title === void 0 ? void 0 : _this$metadata$title.toString(),
           stepVersion: getVersion(state)
         };
+        const measure = stopMeasure(MEASURE_NAME.GET_CURRENT_STATE, this.analyticsHelper);
+        (_this$analyticsHelper20 = this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendActionEvent(EVENT_ACTION.GET_CURRENT_STATE, EVENT_STATUS.SUCCESS, {
+          latency: measure === null || measure === void 0 ? void 0 : measure.duration
+        });
+        return currentState;
       } catch (error) {
-        var _this$analyticsHelper20;
-        (_this$analyticsHelper20 = this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendErrorEvent(error, 'Error while returning ADF version of current draft document');
-        throw error;
+        var _this$analyticsHelper21, _this$analyticsHelper22;
+        const measure = stopMeasure(MEASURE_NAME.GET_CURRENT_STATE, this.analyticsHelper);
+        (_this$analyticsHelper21 = this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.sendActionEvent(EVENT_ACTION.GET_CURRENT_STATE, EVENT_STATUS.FAILURE, {
+          latency: measure === null || measure === void 0 ? void 0 : measure.duration
+        });
+        (_this$analyticsHelper22 = this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.sendErrorEvent(error, 'Error while returning ADF version of current draft document');
+        throw error; // Reject the promise so the consumer can react to it failing
       }
     });
     _defineProperty(this, "commitUnconfirmedSteps", async () => {
-      let count = 0;
       const unconfirmedSteps = this.getUnconfirmedSteps();
-      if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
-        var _this$analyticsHelper22;
-        startMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
-        // 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 = this.getUnconfirmedStepsOrigins();
-        const lastTr = unconfirmedTrs === null || unconfirmedTrs === void 0 ? void 0 : unconfirmedTrs[unconfirmedTrs.length - 1];
-        let isLastTrConfirmed = false;
-        while (!isLastTrConfirmed) {
-          this.sendStepsFromCurrentState();
-          await sleep(1000);
-          const nextUnconfirmedSteps = this.getUnconfirmedSteps();
-          if (nextUnconfirmedSteps !== null && nextUnconfirmedSteps !== void 0 && nextUnconfirmedSteps.length) {
-            const nextUnconfirmedTrs = this.getUnconfirmedStepsOrigins();
-            isLastTrConfirmed = !(nextUnconfirmedTrs !== null && nextUnconfirmedTrs !== void 0 && nextUnconfirmedTrs.some(tr => tr === lastTr));
-          } else {
-            isLastTrConfirmed = true;
-          }
-          if (!isLastTrConfirmed && count++ >= ACK_MAX_TRY) {
-            var _this$analyticsHelper21;
-            if (this.onSyncUpError) {
-              const state = this.getState();
-              this.onSyncUpError({
-                lengthOfUnconfirmedSteps: nextUnconfirmedSteps === null || nextUnconfirmedSteps === void 0 ? void 0 : nextUnconfirmedSteps.length,
-                tries: count,
-                maxRetries: ACK_MAX_TRY,
-                clientId: this.clientId,
-                version: getVersion(state)
-              });
+      try {
+        if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
+          var _this$analyticsHelper23;
+          startMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
+          let count = 0;
+          // 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 = this.getUnconfirmedStepsOrigins();
+          const lastTr = unconfirmedTrs === null || unconfirmedTrs === void 0 ? void 0 : unconfirmedTrs[unconfirmedTrs.length - 1];
+          let isLastTrConfirmed = false;
+          while (!isLastTrConfirmed) {
+            this.sendStepsFromCurrentState();
+            await sleep(1000);
+            const nextUnconfirmedSteps = this.getUnconfirmedSteps();
+            if (nextUnconfirmedSteps !== null && nextUnconfirmedSteps !== void 0 && nextUnconfirmedSteps.length) {
+              const nextUnconfirmedTrs = this.getUnconfirmedStepsOrigins();
+              isLastTrConfirmed = !(nextUnconfirmedTrs !== null && nextUnconfirmedTrs !== void 0 && nextUnconfirmedTrs.some(tr => tr === lastTr));
+            } else {
+              isLastTrConfirmed = true;
+            }
+            if (!isLastTrConfirmed && count++ >= ACK_MAX_TRY) {
+              if (this.onSyncUpError) {
+                const state = this.getState();
+                this.onSyncUpError({
+                  lengthOfUnconfirmedSteps: nextUnconfirmedSteps === null || nextUnconfirmedSteps === void 0 ? void 0 : nextUnconfirmedSteps.length,
+                  tries: count,
+                  maxRetries: ACK_MAX_TRY,
+                  clientId: this.clientId,
+                  version: getVersion(state)
+                });
+              }
+              throw new Error("Can't sync up with Collab Service");
             }
-            const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
-            (_this$analyticsHelper21 = this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.FAILURE, {
-              latency: measure === null || measure === void 0 ? void 0 : measure.duration,
-              // upon failure, emit the number of unconfirmed steps we attempted to sync
-              numUnconfirmedSteps: nextUnconfirmedSteps === null || nextUnconfirmedSteps === void 0 ? void 0 : nextUnconfirmedSteps.length
-            });
-            throw new Error("Can't sync up with Collab Service");
           }
+          const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
+          (_this$analyticsHelper23 = this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 ? void 0 : _this$analyticsHelper23.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.SUCCESS, {
+            latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+            // upon success, emit the total number of unconfirmed steps we synced
+            numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
+          });
         }
+      } catch (error) {
+        var _this$analyticsHelper24, _this$analyticsHelper25;
         const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
-        (_this$analyticsHelper22 = this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.SUCCESS, {
+        (_this$analyticsHelper24 = this.analyticsHelper) === null || _this$analyticsHelper24 === void 0 ? void 0 : _this$analyticsHelper24.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.FAILURE, {
           latency: measure === null || measure === void 0 ? void 0 : measure.duration,
-          // upon success, emit the total number of unconfirmed steps we synced
           numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
         });
+        (_this$analyticsHelper25 = this.analyticsHelper) === null || _this$analyticsHelper25 === void 0 ? void 0 : _this$analyticsHelper25.sendErrorEvent(error, 'Error while committing unconfirmed steps');
+        throw error;
       }
     });
     _defineProperty(this, "getFinalAcknowledgedState", async () => {
-      // Moved these out of the try catch to maintain the current logic for throwing / not throwing errors
-      startMeasure(MEASURE_NAME.PUBLISH_PAGE, this.analyticsHelper);
-      await this.commitUnconfirmedSteps();
       try {
-        var _this$analyticsHelper23;
+        var _this$analyticsHelper26;
+        startMeasure(MEASURE_NAME.PUBLISH_PAGE, this.analyticsHelper);
+        await this.commitUnconfirmedSteps();
         const currentState = await this.getCurrentState();
         const measure = stopMeasure(MEASURE_NAME.PUBLISH_PAGE, this.analyticsHelper);
-        (_this$analyticsHelper23 = this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 ? void 0 : _this$analyticsHelper23.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, EVENT_STATUS.SUCCESS, {
+        (_this$analyticsHelper26 = this.analyticsHelper) === null || _this$analyticsHelper26 === void 0 ? void 0 : _this$analyticsHelper26.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, EVENT_STATUS.SUCCESS, {
           latency: measure === null || measure === void 0 ? void 0 : measure.duration
         });
         return currentState;
       } catch (error) {
-        var _this$analyticsHelper24, _this$analyticsHelper25, _this$metadata$title2;
-        const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
-        (_this$analyticsHelper24 = this.analyticsHelper) === null || _this$analyticsHelper24 === void 0 ? void 0 : _this$analyticsHelper24.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, EVENT_STATUS.FAILURE, {
+        var _this$analyticsHelper27, _this$analyticsHelper28;
+        const measure = stopMeasure(MEASURE_NAME.PUBLISH_PAGE, this.analyticsHelper);
+        (_this$analyticsHelper27 = this.analyticsHelper) === null || _this$analyticsHelper27 === void 0 ? void 0 : _this$analyticsHelper27.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, EVENT_STATUS.FAILURE, {
           latency: measure === null || measure === void 0 ? void 0 : measure.duration
         });
-        (_this$analyticsHelper25 = this.analyticsHelper) === null || _this$analyticsHelper25 === void 0 ? void 0 : _this$analyticsHelper25.sendErrorEvent(error, 'Error while returning ADF version of the final draft document');
-        // TODO: We should likely throw here after we stop using this for draft sync, there is no way of knowing what happened otherwise, but this is what it was doing before
-        return {
-          content: undefined,
-          title: (_this$metadata$title2 = this.metadata.title) === null || _this$metadata$title2 === void 0 ? void 0 : _this$metadata$title2.toString(),
-          stepVersion: getVersion(this.getState())
-        };
+        (_this$analyticsHelper28 = this.analyticsHelper) === null || _this$analyticsHelper28 === void 0 ? void 0 : _this$analyticsHelper28.sendErrorEvent(error, 'Error while returning ADF version of the final draft document');
+        throw error; // Reject the promise so the consumer can react to it failing
       }
     });
     _defineProperty(this, "onNamespaceStatusChanged", async data => {
@@ -641,8 +650,8 @@ export class Provider extends Emitter {
         this.isChannelInitialized = true;
       }
     } catch (initError) {
-      var _this$analyticsHelper26;
-      (_this$analyticsHelper26 = this.analyticsHelper) === null || _this$analyticsHelper26 === void 0 ? void 0 : _this$analyticsHelper26.sendErrorEvent(initError, 'Error while initialising the provider');
+      var _this$analyticsHelper29;
+      (_this$analyticsHelper29 = this.analyticsHelper) === null || _this$analyticsHelper29 === void 0 ? void 0 : _this$analyticsHelper29.sendErrorEvent(initError, 'Error while initialising the provider');
       // Throw error so consumers are aware the initialisation failed when initialising themselves
       throw initError;
     }
@@ -752,9 +761,9 @@ export class Provider extends Emitter {
           setTimeout(() => this.sendStepsFromCurrentState(), 100);
         }
       } catch (error) {
-        var _this$analyticsHelper27;
+        var _this$analyticsHelper30;
         logger(`Processing steps failed with error: ${error}. Triggering catch up call.`);
-        (_this$analyticsHelper27 = this.analyticsHelper) === null || _this$analyticsHelper27 === void 0 ? void 0 : _this$analyticsHelper27.sendErrorEvent(error, 'Error while processing steps');
+        (_this$analyticsHelper30 = this.analyticsHelper) === null || _this$analyticsHelper30 === void 0 ? void 0 : _this$analyticsHelper30.sendErrorEvent(error, 'Error while processing steps');
         this.throttledCatchup();
       }
     }
@@ -775,9 +784,9 @@ export class Provider extends Emitter {
         const callback = telepointerCallback(this.config.documentAri);
         this.channel.broadcast('participant:telepointer', payload, callback);
       } catch (error) {
-        var _this$analyticsHelper28;
+        var _this$analyticsHelper31;
         // We don't want to throw errors for Presence features as they tend to self-restore
-        (_this$analyticsHelper28 = this.analyticsHelper) === null || _this$analyticsHelper28 === void 0 ? void 0 : _this$analyticsHelper28.sendErrorEvent(error, 'Error while sending message - telepointer');
+        (_this$analyticsHelper31 = this.analyticsHelper) === null || _this$analyticsHelper31 === void 0 ? void 0 : _this$analyticsHelper31.sendErrorEvent(error, 'Error while sending message - telepointer');
       }
     }
   }
@@ -790,11 +799,14 @@ export class Provider extends Emitter {
         }
       });
     } catch (error) {
-      var _this$analyticsHelper29;
+      var _this$analyticsHelper32;
       // We don't want to throw errors for Presence features as they tend to self-restore
-      (_this$analyticsHelper29 = this.analyticsHelper) === null || _this$analyticsHelper29 === void 0 ? void 0 : _this$analyticsHelper29.sendErrorEvent(error, 'Error while emitting telepointers from steps');
+      (_this$analyticsHelper32 = this.analyticsHelper) === null || _this$analyticsHelper32 === void 0 ? void 0 : _this$analyticsHelper32.sendErrorEvent(error, 'Error while emitting telepointers from steps');
     }
   }
+
+  // Note: this gets triggered on page reload for Firefox (not other browsers) because of closeOnBeforeunload: false
+
   destroy() {
     return this.disconnect();
   }

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/collab-provider";
-export const version = "8.3.0";
+export const version = "8.4.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": "8.3.0",
+	"version": "8.4.0",
 	"sideEffects": false
 }

package/dist/esm/analytics/index.js

@@ -60,7 +60,8 @@ var AnalyticsHelper = /*#__PURE__*/function () {
         eventAction: EVENT_ACTION.ERROR,
         attributes: {
           documentAri: this.documentAri,
-          errorMessage: errorMessage
+          errorMessage: errorMessage,
+          errorName: error instanceof Error ? error.name : undefined
         },
         nonPrivacySafeAttributes: {
           error: error

package/dist/esm/analytics/performance.js

@@ -4,6 +4,7 @@ export var MEASURE_NAME;
   MEASURE_NAME["DOCUMENT_INIT"] = "documentInit";
   MEASURE_NAME["COMMIT_UNCONFIRMED_STEPS"] = "commitUnconfirmedSteps";
   MEASURE_NAME["PUBLISH_PAGE"] = "publishPage";
+  MEASURE_NAME["GET_CURRENT_STATE"] = "getCurrentState";
 })(MEASURE_NAME || (MEASURE_NAME = {}));
 var isPerformanceAPIAvailable = function isPerformanceAPIAvailable() {
   return typeof window !== 'undefined' && 'performance' in window && ['measure', 'clearMeasures', 'clearMarks', 'getEntriesByName', 'getEntriesByType'].every(function (api) {