@atlaskit/collab-provider 7.7.0 → 8.0.0

package/dist/es2019/channel.js

@@ -5,8 +5,9 @@ import { Emitter } from './emitter';
 import { ErrorCodeMapper } from './error-code-mapper';
 import { createLogger, getProduct, getSubProduct } from './helpers/utils';
 import { MEASURE_NAME, startMeasure, stopMeasure } from './analytics/performance';
-import { triggerCollabAnalyticsEvent } from './analytics';
+import { triggerAnalyticsEvent } from './analytics';
 import { EVENT_ACTION, EVENT_STATUS } from './helpers/const';
+import { ExperiencePerformanceTypes, ExperienceTypes, UFOExperience } from '@atlaskit/ufo';
 const logger = createLogger('Channel', 'green');
 export class Channel extends Emitter {
   constructor(config) {
@@ -18,6 +19,18 @@ export class Channel extends Emitter {
 
     _defineProperty(this, "initialized", false);
 
+    _defineProperty(this, "initExperience", new UFOExperience('collab-provider.document-init', {
+      type: ExperienceTypes.Load,
+      performanceType: ExperiencePerformanceTypes.Custom,
+      performanceConfig: {
+        histogram: {
+          [ExperiencePerformanceTypes.Custom]: {
+            duration: '250_500_1000_1500_2000_3000_4000'
+          }
+        }
+      }
+    }));
+
     _defineProperty(this, "getInitialized", () => this.initialized);
 
     _defineProperty(this, "getConnected", () => this.connected);
@@ -28,7 +41,7 @@ export class Channel extends Emitter {
       this.connected = true;
       logger('Connected.', this.socket.id);
       const measure = stopMeasure(MEASURE_NAME.SOCKET_CONNECT);
-      triggerCollabAnalyticsEvent({
+      triggerAnalyticsEvent({
         eventAction: EVENT_ACTION.CONNECTION,
         attributes: {
           eventStatus: EVENT_STATUS.SUCCESS,
@@ -49,7 +62,8 @@ export class Channel extends Emitter {
       if (data.type === 'initial') {
         if (!this.initialized) {
           const measure = stopMeasure(MEASURE_NAME.DOCUMENT_INIT);
-          triggerCollabAnalyticsEvent({
+          this.initExperience.success();
+          triggerAnalyticsEvent({
             eventAction: EVENT_ACTION.DOCUMENT_INIT,
             attributes: {
               eventStatus: EVENT_STATUS.SUCCESS,
@@ -107,6 +121,7 @@ export class Channel extends Emitter {
 
     if (!this.initialized) {
       startMeasure(MEASURE_NAME.DOCUMENT_INIT);
+      this.initExperience.start();
     }
 
     const {
@@ -124,9 +139,10 @@ export class Channel extends Emitter {
     if (permissionTokenRefresh) {
       authCb = cb => {
         permissionTokenRefresh().then(token => {
-          cb({
-            // The permission token.
-            token,
+          cb({ // The permission token.
+            ...(token ? {
+              token
+            } : {}),
             // The initialized status. If false, BE will send document, otherwise not.
             initialized: this.initialized,
             // ESS-1009 Allow to opt-in into 404 response
@@ -208,7 +224,7 @@ export class Channel extends Emitter {
 
     this.socket.on('connect_error', error => {
       const measure = stopMeasure(MEASURE_NAME.SOCKET_CONNECT);
-      triggerCollabAnalyticsEvent({
+      triggerAnalyticsEvent({
         eventAction: EVENT_ACTION.CONNECTION,
         attributes: {
           eventStatus: EVENT_STATUS.FAILURE,
@@ -236,6 +252,8 @@ export class Channel extends Emitter {
 
   async fetchCatchup(fromVersion) {
     try {
+      var _await$this$config$pe;
+
       const {
         doc,
         version,
@@ -248,7 +266,7 @@ export class Channel extends Emitter {
         },
         requestInit: {
           headers: { ...(this.config.permissionTokenRefresh ? {
-              'x-token': await this.config.permissionTokenRefresh()
+              'x-token': (_await$this$config$pe = await this.config.permissionTokenRefresh()) !== null && _await$this$config$pe !== void 0 ? _await$this$config$pe : undefined
             } : {}),
             'x-product': getProduct(this.config.productInfo),
             'x-subproduct': getSubProduct(this.config.productInfo)
@@ -279,7 +297,7 @@ export class Channel extends Emitter {
    */
 
 
-  broadcast(type, data) {
+  broadcast(type, data, callback) {
     if (!this.connected || !this.socket) {
       return;
     }
@@ -287,7 +305,7 @@ export class Channel extends Emitter {
     this.socket.emit('broadcast', {
       type,
       ...data
-    });
+    }, callback);
   }
 
   sendMetadata(metadata) {

package/dist/es2019/helpers/const.js

@@ -26,4 +26,12 @@ export let EVENT_STATUS;
   EVENT_STATUS["FAILURE"] = "FAILURE";
 })(EVENT_STATUS || (EVENT_STATUS = {}));
 
+export let ADD_STEPS_TYPE;
+
+(function (ADD_STEPS_TYPE) {
+  ADD_STEPS_TYPE["ACCEPTED"] = "ACCEPTED";
+  ADD_STEPS_TYPE["REJECTED"] = "REJECTED";
+  ADD_STEPS_TYPE["ERROR"] = "ERROR";
+})(ADD_STEPS_TYPE || (ADD_STEPS_TYPE = {}));
+
 export const ACK_MAX_TRY = 30;

package/dist/es2019/provider/catchup.js

@@ -50,7 +50,7 @@ export const catchup = async opt => {
        * newer.
        */
 
-      opt.fitlerQueue(data => data.version > serverVersion); // We are too far behind - replace the entire document
+      opt.filterQueue(data => data.version > serverVersion); // We are too far behind - replace the entire document
 
       logger(`Replacing document: ${doc}`);
       logger(`getting metadata: ${metadata}`); // Replace local document and version number
@@ -84,7 +84,7 @@ export const catchup = async opt => {
         const newUnconfirmedSteps = rebaseSteps(unconfirmedSteps, mapping);
         logger(`Re-aply ${newUnconfirmedSteps.length} mapped unconfirmed steps: ${JSON.stringify(newUnconfirmedSteps)}`); // Re-aply local steps
 
-        opt.applyLocalsteps(newUnconfirmedSteps);
+        opt.applyLocalSteps(newUnconfirmedSteps);
       }
     }
   }

package/dist/es2019/provider/index.js

@@ -1,15 +1,18 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { getVersion, sendableSteps } from 'prosemirror-collab';
 import throttle from 'lodash/throttle';
-import isequal from 'lodash/isEqual';
+import isEqual from 'lodash/isEqual';
+import countBy from 'lodash/countBy';
 import { JSONTransformer } from '@atlaskit/editor-json-transformer';
+import { ExperiencePerformanceTypes, ExperienceTypes, UFOExperience } from '@atlaskit/ufo';
 import { Emitter } from '../emitter';
 import { Channel } from '../channel';
 import { createLogger, getParticipant, sleep } from '../helpers/utils';
-import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
-import { triggerCollabAnalyticsEvent } from '../analytics';
+import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS, ADD_STEPS_TYPE } from '../helpers/const';
+import { triggerAnalyticsEvent } from '../analytics';
 import { catchup } from './catchup';
 import { errorCodeMapper } from '../error-code-mapper';
+import { AcknowledgementResponseTypes } from '../types';
 import { DisconnectReason, socketIOReasons } from '../disconnected-reason-mapper';
 import { MEASURE_NAME, startMeasure, stopMeasure } from '../analytics/performance';
 const logger = createLogger('Provider', 'black');
@@ -32,16 +35,71 @@ const commitStep = ({
   steps,
   version,
   userId,
-  clientId
+  clientId,
+  documentAri,
+  analyticsClient,
+  onStepsAdded,
+  onErrorHandled
 }) => {
   const stepsWithClientAndUserId = steps.map(step => ({ ...step.toJSON(),
     clientId,
     userId
   }));
+  const start = new Date().getTime();
   channel.broadcast('steps:commit', {
     steps: stepsWithClientAndUserId,
     version,
     userId
+  }, response => {
+    const latency = new Date().getTime() - start;
+
+    if (response.type === AcknowledgementResponseTypes.SUCCESS) {
+      onStepsAdded({
+        steps: stepsWithClientAndUserId,
+        version: response.version
+      }, true);
+      let analyticStepEvent = {
+        eventAction: EVENT_ACTION.ADD_STEPS,
+        attributes: {
+          eventStatus: EVENT_STATUS.SUCCESS,
+          type: ADD_STEPS_TYPE.ACCEPTED,
+          documentAri,
+          latency
+        }
+      };
+      analyticStepEvent.attributes.stepType = countBy(stepsWithClientAndUserId, stepWithClientAndUserId => stepWithClientAndUserId.stepType);
+      triggerAnalyticsEvent(analyticStepEvent, analyticsClient);
+    } else if (response.type === AcknowledgementResponseTypes.ERROR) {
+      var _response$error, _response$error$data, _response$error2, _response$error2$data;
+
+      onErrorHandled(response.error, true);
+      triggerAnalyticsEvent({
+        eventAction: EVENT_ACTION.ADD_STEPS,
+        attributes: {
+          eventStatus: EVENT_STATUS.FAILURE,
+          // User tried committing steps but they were rejected because:
+          // - HEAD_VERSION_UPDATE_FAILED: the collab service's latest stored step tail version didn't correspond to the head version of the first step submitted
+          // - VERSION_NUMBER_ALREADY_EXISTS: while storing the steps there was a conflict meaning someone else wrote steps into the database more quickly
+          type: ((_response$error = response.error) === null || _response$error === void 0 ? void 0 : (_response$error$data = _response$error.data) === null || _response$error$data === void 0 ? void 0 : _response$error$data.code) === 'HEAD_VERSION_UPDATE_FAILED' || ((_response$error2 = response.error) === null || _response$error2 === void 0 ? void 0 : (_response$error2$data = _response$error2.data) === null || _response$error2$data === void 0 ? void 0 : _response$error2$data.code) === 'VERSION_NUMBER_ALREADY_EXISTS' ? ADD_STEPS_TYPE.REJECTED : ADD_STEPS_TYPE.ERROR,
+          documentAri,
+          latency,
+          error: response.error
+        }
+      }, analyticsClient);
+    } else {
+      triggerAnalyticsEvent({
+        eventAction: EVENT_ACTION.ADD_STEPS,
+        attributes: {
+          eventStatus: EVENT_STATUS.FAILURE,
+          type: ADD_STEPS_TYPE.ERROR,
+          documentAri,
+          latency,
+          error: {
+            message: 'Invalid Acknowledgement'
+          }
+        }
+      }, analyticsClient);
+    }
   });
 };
 
@@ -99,16 +157,16 @@ export class Provider extends Emitter {
       version,
       metadata
     }) => {
-      // Preseve the unconfirmed steps to prevent data loss.
+      // Preserve 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.
+      //  - Replace the document, keep in sync with the server
+      //  - Replace the version number, so editor is in sync with NCS server and can commit new changes.
+      //  - Replace the metadata
+      //  - Reserve the cursor position, in case a cursor jump.
 
       this.updateDocumentWithMetadata({
         doc,
@@ -116,7 +174,7 @@ export class Provider extends Emitter {
         metadata,
         reserveCursor: true
       });
-      triggerCollabAnalyticsEvent({
+      triggerAnalyticsEvent({
         eventAction: EVENT_ACTION.REINITIALISE_DOCUMENT,
         attributes: {
           numUnconfirmedSteps: unconfirmedSteps.length,
@@ -125,11 +183,11 @@ export class Provider extends Emitter {
       }, 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);
+        this.applyLocalSteps(unconfirmedSteps);
       }
     });
 
-    _defineProperty(this, "onStepsAdded", data => {
+    _defineProperty(this, "onStepsAdded", (data, disableAnalytics = false) => {
       logger(`Received steps`, {
         steps: data.steps,
         version: data.version
@@ -146,7 +204,7 @@ export class Provider extends Emitter {
       if (data.version === currentVersion) {
         logger(`Received steps we already have. Ignoring.`);
       } else if (data.version === expectedVersion) {
-        this.processSteps(data);
+        this.processSteps(data, disableAnalytics);
       } else if (data.version > expectedVersion) {
         logger(`Version too high. Expected "${expectedVersion}" but got "${data.version}. Current local version is ${currentVersion}.`);
         this.queueSteps(data);
@@ -163,7 +221,7 @@ export class Provider extends Emitter {
       trailing: true
     }));
 
-    _defineProperty(this, "fitlerQueue", condition => {
+    _defineProperty(this, "filterQueue", condition => {
       this.queue = this.queue.filter(condition);
     });
 
@@ -188,7 +246,7 @@ export class Provider extends Emitter {
       }
     });
 
-    _defineProperty(this, "applyLocalsteps", steps => {
+    _defineProperty(this, "applyLocalSteps", steps => {
       // Re-aply local steps
       this.emit('local-steps', {
         steps
@@ -204,7 +262,7 @@ export class Provider extends Emitter {
     });
 
     _defineProperty(this, "catchup", async () => {
-      startMeasure(MEASURE_NAME.CALLING_CATCHUP_API); // if the queue is already paused, we are busy with something else, so don't proceed.
+      const start = new Date().getTime(); // if the queue is already paused, we are busy with something else, so don't proceed.
 
       if (this.pauseQueue) {
         logger(`Queue is paused. Aborting.`);
@@ -218,27 +276,27 @@ export class Provider extends Emitter {
           getCurrentPmVersion: this.getCurrentPmVersion,
           fetchCatchup: this.channel.fetchCatchup.bind(this.channel),
           getUnconfirmedSteps: this.getUnconfirmedSteps,
-          fitlerQueue: this.fitlerQueue,
+          filterQueue: this.filterQueue,
           updateDocumentWithMetadata: this.updateDocumentWithMetadata,
-          applyLocalsteps: this.applyLocalsteps
+          applyLocalSteps: this.applyLocalSteps
         });
-        const measure = stopMeasure(MEASURE_NAME.CALLING_CATCHUP_API);
-        triggerCollabAnalyticsEvent({
+        const latency = new Date().getTime() - start;
+        triggerAnalyticsEvent({
           eventAction: EVENT_ACTION.CATCHUP,
           attributes: {
             eventStatus: EVENT_STATUS.SUCCESS,
-            latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+            latency,
             documentAri: this.config.documentAri
           }
         }, this.analyticsClient);
       } catch (error) {
-        const measure = stopMeasure(MEASURE_NAME.CALLING_CATCHUP_API);
-        triggerCollabAnalyticsEvent({
+        const latency = new Date().getTime() - start;
+        triggerAnalyticsEvent({
           eventAction: EVENT_ACTION.CATCHUP,
           attributes: {
             eventStatus: EVENT_STATUS.FAILURE,
             error: error,
-            latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+            latency,
             documentAri: this.config.documentAri
           }
         }, this.analyticsClient);
@@ -251,27 +309,32 @@ export class Provider extends Emitter {
       }
     });
 
-    _defineProperty(this, "onErrorHandled", error => {
-      if (error && error.data) {
+    _defineProperty(this, "onErrorHandled", (error, disableAnalytics = false) => {
+      if (error !== null && error !== void 0 && error.data) {
+        // User tried committing steps but they were rejected because:
+        // HEAD_VERSION_UPDATE_FAILED: the collab service's latest stored step tail version didn't correspond to the head version of the first step submitted
+        // VERSION_NUMBER_ALREADY_EXISTS: while storing the steps there was a conflict meaning someone else wrote steps into the database more quickly
         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,
-              latency: measure === null || measure === void 0 ? void 0 : measure.duration
-            }
-          }, this.analyticsClient);
-          this.stepRejectCounter++;
-        }
+          // TODO: Remove this analytics logic once we have validated the ack messages and aren't likely to go back to a generic error handler
+          if (!disableAnalytics) {
+            triggerAnalyticsEvent({
+              eventAction: EVENT_ACTION.ADD_STEPS,
+              attributes: {
+                eventStatus: EVENT_STATUS.FAILURE,
+                type: ADD_STEPS_TYPE.REJECTED,
+                error,
+                documentAri: this.config.documentAri
+              }
+            }, this.analyticsClient);
+          }
 
-        logger(`The stepRejectCounter("${this.stepRejectCounter}")`);
+          this.stepRejectCounter++;
+          logger(`Steps rejected (tries=${this.stepRejectCounter})`);
 
-        if (this.stepRejectCounter >= MAX_STEP_REJECTED_ERROR) {
-          logger(`The stepRejected("${this.stepRejectCounter}") exceed maximun("${MAX_STEP_REJECTED_ERROR}"), trigger catch`);
-          this.throttledCatchup();
+          if (this.stepRejectCounter >= MAX_STEP_REJECTED_ERROR) {
+            logger(`The steps were rejected too many times (tries=${this.stepRejectCounter}, limit=${MAX_STEP_REJECTED_ERROR}). Trying to catch-up.`);
+            this.throttledCatchup();
+          }
         }
 
         const errorToEmit = errorCodeMapper(error);
@@ -281,7 +344,7 @@ export class Provider extends Emitter {
         }
       }
 
-      logger(`Error from collab service`, error);
+      logger('Error from collab service', error);
     });
 
     _defineProperty(this, "queue", []);
@@ -317,7 +380,7 @@ export class Provider extends Emitter {
     });
 
     _defineProperty(this, "onMetadataChanged", metadata => {
-      if (metadata !== undefined && !isequal(this.metadata, metadata)) {
+      if (metadata !== undefined && !isEqual(this.metadata, metadata)) {
         this.metadata = metadata;
         this.emit('metadata:changed', metadata);
       }
@@ -441,7 +504,7 @@ export class Provider extends Emitter {
       if (joined.length || left.length) {
         var _this$participants$si;
 
-        triggerCollabAnalyticsEvent({
+        triggerAnalyticsEvent({
           eventAction: EVENT_ACTION.UPDATE_PARTICIPANTS,
           attributes: {
             participants: (_this$participants$si = this.participants.size) !== null && _this$participants$si !== void 0 ? _this$participants$si : 1,
@@ -542,7 +605,7 @@ export class Provider extends Emitter {
             }
 
             const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS);
-            triggerCollabAnalyticsEvent({
+            triggerAnalyticsEvent({
               eventAction: EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS,
               attributes: {
                 eventStatus: EVENT_STATUS.FAILURE,
@@ -557,7 +620,7 @@ export class Provider extends Emitter {
         }
 
         const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS);
-        triggerCollabAnalyticsEvent({
+        triggerAnalyticsEvent({
           eventAction: EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS,
           attributes: {
             eventStatus: EVENT_STATUS.SUCCESS,
@@ -577,7 +640,7 @@ export class Provider extends Emitter {
         startMeasure(MEASURE_NAME.CONVERT_PM_TO_ADF);
         adfDocument = new JSONTransformer().encode(state.doc);
         const measure = stopMeasure(MEASURE_NAME.CONVERT_PM_TO_ADF);
-        triggerCollabAnalyticsEvent({
+        triggerAnalyticsEvent({
           eventAction: EVENT_ACTION.CONVERT_PM_TO_ADF,
           attributes: {
             eventStatus: EVENT_STATUS.SUCCESS,
@@ -587,7 +650,7 @@ export class Provider extends Emitter {
         }, this.analyticsClient);
       } catch (error) {
         const measure = stopMeasure(MEASURE_NAME.CONVERT_PM_TO_ADF);
-        triggerCollabAnalyticsEvent({
+        triggerAnalyticsEvent({
           eventAction: EVENT_ACTION.CONVERT_PM_TO_ADF,
           attributes: {
             eventStatus: EVENT_STATUS.FAILURE,
@@ -713,18 +776,21 @@ export class Provider extends Emitter {
 
     if (!steps || !steps.length) {
       return;
-    }
-
-    startMeasure(MEASURE_NAME.ADD_STEPS); // Avoid reference issues using a
+    } // Avoid reference issues using a
     // method outside of the provider
     // scope
 
+
     throttledCommitStep({
       channel: this.channel,
       userId: this.userId,
       clientId: this.clientId,
       steps,
-      version
+      version,
+      documentAri: this.config.documentAri,
+      analyticsClient: this.analyticsClient,
+      onStepsAdded: this.onStepsAdded.bind(this),
+      onErrorHandled: this.onErrorHandled.bind(this)
     });
   } // Triggered when page recovery has emitted an 'init' event on a page client is currently connected to.
 
@@ -757,14 +823,14 @@ export class Provider extends Emitter {
     }
   }
 
-  processSteps(data) {
+  processSteps(data, disableAnalytics = false) {
     const {
       version,
       steps
     } = data;
     logger(`Processing data. Version "${version}".`);
 
-    if (steps && steps.length) {
+    if (steps !== null && steps !== void 0 && steps.length) {
       const clientIds = steps.map(({
         clientId
       }) => clientId);
@@ -774,16 +840,21 @@ export class Provider extends Emitter {
         userIds: clientIds
       }); // 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,
-          latency: measure === null || measure === void 0 ? void 0 : measure.duration
-        }
-      }, this.analyticsClient);
+      this.stepRejectCounter = 0; // TODO: Remove this analytics logic after we've validated the ack call-backs
+
+      if (!disableAnalytics && clientIds.indexOf(this.clientId) >= 0) {
+        let analyticStepEvent = {
+          eventAction: EVENT_ACTION.ADD_STEPS,
+          attributes: {
+            eventStatus: EVENT_STATUS.SUCCESS,
+            type: ADD_STEPS_TYPE.ACCEPTED,
+            documentAri: this.config.documentAri
+          }
+        };
+        analyticStepEvent.attributes.stepType = countBy(steps, step => step.stepType);
+        triggerAnalyticsEvent(analyticStepEvent, this.analyticsClient);
+      }
+
       this.emitTelepointersFromSteps(steps); // Resend local steps if none of the received steps originated with us!
 
       if (clientIds.indexOf(this.clientId) === -1) {
@@ -813,6 +884,21 @@ export class Provider extends Emitter {
 
     switch (type) {
       case 'telepointer':
+        const telepointerExperience = new UFOExperience('collab-provider.telepointer', {
+          type: ExperienceTypes.Operation,
+          performanceType: ExperiencePerformanceTypes.Custom,
+          performanceConfig: {
+            histogram: {
+              [ExperiencePerformanceTypes.Custom]: {
+                duration: '250_500_1000_1500_2000_3000_4000'
+              }
+            }
+          }
+        });
+        telepointerExperience.addMetadata({
+          documentAri: this.config.documentAri
+        });
+        telepointerExperience.start();
         const {
           selection
         } = rest;
@@ -821,6 +907,20 @@ export class Provider extends Emitter {
           userId: userId,
           sessionId: sessionId,
           clientId: clientId
+        }, response => {
+          if (response.type === AcknowledgementResponseTypes.SUCCESS) {
+            telepointerExperience.success();
+          } else if (response.type === AcknowledgementResponseTypes.ERROR) {
+            const errorMessage = response.error;
+            telepointerExperience.addMetadata({
+              error: errorMessage
+            });
+            logger('Error from collab service with telepointer broadcast', errorMessage);
+            telepointerExperience.failure();
+          } else {
+            // Abort if invalid ACK sent
+            telepointerExperience.abort();
+          }
         });
         break;
     }

package/dist/es2019/types.js

@@ -1 +1,7 @@
-export {};
+// Channel
+export let AcknowledgementResponseTypes;
+
+(function (AcknowledgementResponseTypes) {
+  AcknowledgementResponseTypes["SUCCESS"] = "SUCCESS";
+  AcknowledgementResponseTypes["ERROR"] = "ERROR";
+})(AcknowledgementResponseTypes || (AcknowledgementResponseTypes = {}));

package/dist/es2019/version-wrapper.js

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

package/dist/esm/analytics/index.js

@@ -6,35 +6,28 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 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) {
+export var triggerAnalyticsEvent = function triggerAnalyticsEvent(analyticsEvent, analyticsClient) {
+  if (!analyticsClient) {
     return;
   }
 
-  var client = analyticsClient;
-  var requestIdleCallbackFunction = window.requestIdleCallback;
-  var runItLater = typeof requestIdleCallbackFunction === 'function' ? requestIdleCallbackFunction : window.requestAnimationFrame; // Let the browser figure out
-  // when it should send those events
-
-  runItLater(function () {
-    client.sendOperationalEvent(_objectSpread(_objectSpread({
-      action: 'collab'
-    }, payload), {}, {
-      source: payload.source || 'unknown',
-      tags: ['editor']
-    }));
-  });
-};
-export var triggerCollabAnalyticsEvent = function triggerCollabAnalyticsEvent(analyticsEvent, analyticsClient) {
   var payload = {
-    action: analyticsEvent.eventAction,
     actionSubject: EVENT_SUBJECT,
-    source: 'unknown',
     attributes: _objectSpread({
       packageName: packageName,
       packageVersion: packageVersion,
       collabService: COLLAB_SERVICE.NCS
-    }, analyticsEvent.attributes)
-  };
-  fireAnalyticsEvent(analyticsClient, payload);
+    }, analyticsEvent.attributes),
+    tags: ['editor'],
+    action: analyticsEvent.eventAction,
+    source: 'unknown' // Adds zero analytics value, but event validation throws an error if you don't add it :-(
+
+  }; // Let the browser figure out
+  // when it should send those events
+
+  var requestIdleCallbackFunction = window.requestIdleCallback;
+  var runItLater = typeof requestIdleCallbackFunction === 'function' ? requestIdleCallbackFunction : window.requestAnimationFrame;
+  runItLater(function () {
+    analyticsClient.sendOperationalEvent(payload);
+  });
 };

package/dist/esm/analytics/performance.js

@@ -1,11 +1,9 @@
 export var MEASURE_NAME;
 
 (function (MEASURE_NAME) {
-  MEASURE_NAME["CALLING_CATCHUP_API"] = "callingCatchupApi";
   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 = {}));