@atlaskit/collab-provider 7.4.2 → 7.5.0

package/dist/esm/helpers/utils.js

@@ -23,4 +23,14 @@ export function sleep(ms) {
   return new Promise(function (resolve) {
     setTimeout(resolve, ms);
   });
-}
+}
+export var getProduct = function getProduct(productInfo) {
+  var _productInfo$product;
+
+  return (_productInfo$product = productInfo === null || productInfo === void 0 ? void 0 : productInfo.product) !== null && _productInfo$product !== void 0 ? _productInfo$product : 'unknown';
+};
+export var getSubProduct = function getSubProduct(productInfo) {
+  var _productInfo$subProdu;
+
+  return (_productInfo$subProdu = productInfo === null || productInfo === void 0 ? void 0 : productInfo.subProduct) !== null && _productInfo$subProdu !== void 0 ? _productInfo$subProdu : !!(productInfo !== null && productInfo !== void 0 && productInfo.product) ? 'none' : 'unknown';
+};

package/dist/esm/provider/catchup.js

@@ -1,5 +1,5 @@
-import _regeneratorRuntime from "@babel/runtime/regenerator";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
 
 function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
 

package/dist/esm/provider/index.js

@@ -1,7 +1,6 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
-import _regeneratorRuntime from "@babel/runtime/regenerator";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
@@ -12,6 +11,7 @@ import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstruct
 import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 var _excluded = ["type"];
+import _regeneratorRuntime from "@babel/runtime/regenerator";
 
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
 
@@ -24,14 +24,16 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 import { getVersion, sendableSteps } from 'prosemirror-collab';
 import throttle from 'lodash/throttle';
 import isequal from 'lodash/isEqual';
+import { JSONTransformer } from '@atlaskit/editor-json-transformer';
 import { Emitter } from '../emitter';
 import { Channel } from '../channel';
 import { createLogger, getParticipant, sleep } from '../helpers/utils';
-import { ACK_MAX_TRY } from '../helpers/const';
-import { triggerAnalyticsForCatchupFailed, triggerAnalyticsForStepsRejected, triggerAnalyticsForStepsAddedSuccessfully } from '../analytics';
+import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
+import { triggerCollabAnalyticsEvent } from '../analytics';
 import { catchup } from './catchup';
 import { errorCodeMapper } from '../error-code-mapper';
 import { DisconnectReason, socketIOReasons } from '../disconnected-reason-mapper';
+import { MEASURE_NAME, startMeasure, stopMeasure } from '../analytics/performance';
 var logger = createLogger('Provider', 'black');
 var PARTICIPANT_UPDATE_INTERVAL = 300 * 1000; // 300 seconds
 
@@ -202,22 +204,26 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     });
 
     _defineProperty(_assertThisInitialized(_this), "catchup", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
+      var measure, _measure;
+
       return _regeneratorRuntime.wrap(function _callee$(_context) {
         while (1) {
           switch (_context.prev = _context.next) {
             case 0:
+              startMeasure(MEASURE_NAME.CALLING_CATCHUP_API); // if the queue is already paused, we are busy with something else, so don't proceed.
+
               if (!_this.pauseQueue) {
-                _context.next = 3;
+                _context.next = 4;
                 break;
               }
 
               logger("Queue is paused. Aborting.");
               return _context.abrupt("return");
 
-            case 3:
+            case 4:
               _this.pauseQueue = true;
-              _context.prev = 4;
-              _context.next = 7;
+              _context.prev = 5;
+              _context.next = 8;
               return catchup({
                 getCurrentPmVersion: _this.getCurrentPmVersion,
                 fetchCatchup: _this.channel.fetchCatchup.bind(_this.channel),
@@ -227,18 +233,34 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
                 applyLocalsteps: _this.applyLocalsteps
               });
 
-            case 7:
-              _context.next = 13;
+            case 8:
+              measure = stopMeasure(MEASURE_NAME.CALLING_CATCHUP_API);
+              triggerCollabAnalyticsEvent({
+                eventAction: EVENT_ACTION.CATCHUP,
+                attributes: {
+                  eventStatus: EVENT_STATUS.SUCCESS,
+                  latency: measure === null || measure === void 0 ? void 0 : measure.duration
+                }
+              }, _this.analyticsClient);
+              _context.next = 17;
               break;
 
-            case 9:
-              _context.prev = 9;
-              _context.t0 = _context["catch"](4);
-              triggerAnalyticsForCatchupFailed(_this.analyticsClient, _context.t0);
+            case 12:
+              _context.prev = 12;
+              _context.t0 = _context["catch"](5);
+              _measure = stopMeasure(MEASURE_NAME.CALLING_CATCHUP_API);
+              triggerCollabAnalyticsEvent({
+                eventAction: EVENT_ACTION.CATCHUP,
+                attributes: {
+                  eventStatus: EVENT_STATUS.FAILURE,
+                  error: _context.t0,
+                  latency: _measure === null || _measure === void 0 ? void 0 : _measure.duration
+                }
+              }, _this.analyticsClient);
               logger("Catch-Up Failed:", _context.t0.message);
 
-            case 13:
-              _context.prev = 13;
+            case 17:
+              _context.prev = 17;
               _this.pauseQueue = false;
 
               _this.processQueue();
@@ -246,20 +268,26 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
               _this.sendStepsFromCurrentState();
 
               _this.stepRejectCounter = 0;
-              return _context.finish(13);
+              return _context.finish(17);
 
-            case 19:
+            case 23:
             case "end":
               return _context.stop();
           }
         }
-      }, _callee, null, [[4, 9, 13, 19]]);
+      }, _callee, null, [[5, 12, 17, 23]]);
     })));
 
     _defineProperty(_assertThisInitialized(_this), "onErrorHandled", function (error) {
       if (error && error.data) {
         if (error.data.code === 'HEAD_VERSION_UPDATE_FAILED' || error.data.code === 'VERSION_NUMBER_ALREADY_EXISTS') {
-          triggerAnalyticsForStepsRejected(_this.analyticsClient, error);
+          triggerCollabAnalyticsEvent({
+            eventAction: EVENT_ACTION.ADD_STEPS,
+            attributes: {
+              eventStatus: EVENT_STATUS.FAILURE,
+              error: error
+            }
+          }, _this.analyticsClient);
           _this.stepRejectCounter++;
         }
 
@@ -530,7 +558,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     _defineProperty(_assertThisInitialized(_this), "getFinalAcknowledgedState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4() {
       var _this$metadata$title;
 
-      var maxAttemptsToSync, count, unconfirmedState, state;
+      var maxAttemptsToSync, count, unconfirmedState, state, adfDocument, measure, _measure2;
+
       return _regeneratorRuntime.wrap(function _callee4$(_context4) {
         while (1) {
           switch (_context4.prev = _context4.next) {
@@ -614,14 +643,39 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
               })(), "t0", 5);
 
             case 5:
-              state = _this.getState();
+              state = _this.getState(); // Convert ProseMirror document in Editor state to ADF document
+
+              try {
+                startMeasure(MEASURE_NAME.CONVERT_PM_TO_ADF);
+                adfDocument = new JSONTransformer().encode(state.doc);
+                measure = stopMeasure(MEASURE_NAME.CONVERT_PM_TO_ADF);
+                triggerCollabAnalyticsEvent({
+                  eventAction: EVENT_ACTION.CONVERT_PM_TO_ADF,
+                  attributes: {
+                    eventStatus: EVENT_STATUS.SUCCESS,
+                    latency: measure === null || measure === void 0 ? void 0 : measure.duration
+                  }
+                }, _this.analyticsClient);
+              } catch (error) {
+                _measure2 = stopMeasure(MEASURE_NAME.CONVERT_PM_TO_ADF);
+                triggerCollabAnalyticsEvent({
+                  eventAction: EVENT_ACTION.CONVERT_PM_TO_ADF,
+                  attributes: {
+                    eventStatus: EVENT_STATUS.FAILURE,
+                    latency: _measure2 === null || _measure2 === void 0 ? void 0 : _measure2.duration,
+                    error: error
+                  }
+                }, _this.analyticsClient);
+                logger("Error when converting PM document to ADF: ", error);
+              }
+
               return _context4.abrupt("return", {
-                content: state.doc.toJSON(),
+                content: adfDocument,
                 title: (_this$metadata$title = _this.metadata.title) === null || _this$metadata$title === void 0 ? void 0 : _this$metadata$title.toString(),
                 stepVersion: getVersion(state)
               });
 
-            case 7:
+            case 8:
             case "end":
               return _context4.stop();
           }
@@ -777,7 +831,12 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         }); // If steps can apply to local editor sucessfully, no need to accumulate the error counter.
 
         this.stepRejectCounter = 0;
-        triggerAnalyticsForStepsAddedSuccessfully(this.analyticsClient);
+        triggerCollabAnalyticsEvent({
+          eventAction: EVENT_ACTION.ADD_STEPS,
+          attributes: {
+            eventStatus: EVENT_STATUS.SUCCESS
+          }
+        }, this.analyticsClient);
         this.emitTelepointersFromSteps(steps); // Resend local steps if none of the received steps originated with us!
 
         if (clientIds.indexOf(this.clientId) === -1) {

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

@@ -6,15 +6,25 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 import { Provider } from './provider';
 import { io } from 'socket.io-client';
-export function createSocketIOSocket(url, auth) {
+import { getProduct, getSubProduct } from './helpers/utils';
+import { SOCKET_IO_OPTIONS } from './config';
+export function createSocketIOSocket(url, auth, productInfo) {
   var _URL = new URL(url),
-      pathname = _URL.pathname;
+      pathname = _URL.pathname; // to limit the reconnection flooding towards collab service, here we set the reconnectionDelayMax to 128s.
+
 
   return io(url, {
+    reconnectionDelayMax: SOCKET_IO_OPTIONS.RECONNECTION_DELAY_MAX,
+    reconnectionDelay: SOCKET_IO_OPTIONS.RECONNECTION_DELAY,
+    randomizationFactor: SOCKET_IO_OPTIONS.RANDOMIZATION_FACTOR,
     withCredentials: true,
     transports: ['polling', 'websocket'],
     path: "/".concat(pathname.split('/')[1], "/socket.io"),
-    auth: auth
+    auth: auth,
+    extraHeaders: {
+      'x-product': getProduct(productInfo),
+      'x-subproduct': getSubProduct(productInfo)
+    }
   });
 }
 export function createSocketIOCollabProvider(config) {

package/dist/esm/version.json

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

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

@@ -1,9 +1,5 @@
 import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
 import { GasPurePayload } from '@atlaskit/analytics-gas-types';
-import { ErrorPayload } from '../types';
-export declare const buildAnalyticsPayload: (subject: string, payload?: any) => GasPurePayload;
-export declare const fireAnalyticsEvent: (analyticsClient?: AnalyticsWebClient | undefined, analyticsEvent?: GasPurePayload | undefined) => void;
-export declare const triggerAnalyticsForStepsAddedSuccessfully: (analyticsClient?: AnalyticsWebClient | undefined) => void;
-export declare const triggerAnalyticsForStepsRejected: (analyticsClient?: AnalyticsWebClient | undefined, error?: ErrorPayload | undefined) => void;
-export declare const triggerAnalyticsForCatchupFailed: (analyticsClient?: AnalyticsWebClient | undefined, error?: ErrorPayload | undefined) => void;
-export declare const triggerAnalyticsForCatchupSuccessfulWithLatency: (analyticsClient?: AnalyticsWebClient | undefined, latency?: number | undefined) => void;
+import { AnalyticsEvent } from '../helpers/const';
+export declare const fireAnalyticsEvent: (analyticsClient?: AnalyticsWebClient | undefined, payload?: GasPurePayload | undefined) => void;
+export declare const triggerCollabAnalyticsEvent: (analyticsEvent: AnalyticsEvent, analyticsClient?: AnalyticsWebClient | undefined) => void;

package/dist/types/analytics/performance.d.ts

@@ -1,5 +1,12 @@
-declare type MeasureName = 'callingCatchupApi';
-export declare function startMeasure(measureName: MeasureName): void;
-export declare function stopMeasure(measureName: MeasureName, onMeasureComplete?: (duration: number, startTime: number) => void): void;
+export declare enum MEASURE_NAME {
+    CALLING_CATCHUP_API = "callingCatchupApi",
+    SOCKET_CONNECT = "socketConnect",
+    DOCUMENT_INIT = "documentInit",
+    CONVERT_PM_TO_ADF = "convertPMToADF"
+}
+export declare function startMeasure(measureName: MEASURE_NAME): void;
+export declare function stopMeasure(measureName: MEASURE_NAME, onMeasureComplete?: (duration: number, startTime: number) => void): {
+    duration: number;
+    startTime: number;
+} | undefined;
 export declare function clearMeasure(measureName: string): void;
-export {};

package/dist/types/config.d.ts

@@ -0,0 +1,5 @@
+export declare const SOCKET_IO_OPTIONS: {
+    RECONNECTION_DELAY_MAX: number;
+    RECONNECTION_DELAY: number;
+    RANDOMIZATION_FACTOR: number;
+};

package/dist/types/helpers/const.d.ts

@@ -1,6 +1,24 @@
-export declare const STEPS_ADDED = "collabStepsAddedSuccess";
-export declare const STEPS_REJECTED = "collabStepsAddedRejected";
+import { ErrorPayload } from '../types';
 export declare const ATTRIBUTES_PACKAGE = "collabProvider";
-export declare const CATCHUP_SUCCESS = "collabCatchupSuccess";
-export declare const CATCHUP_FAILURE = "collabCatchupFailure";
+export declare const EVENT_SUBJECT = "collab";
+export declare enum EVENT_ACTION {
+    CONNECTION = "connection",
+    CATCHUP = "catchup",
+    DOCUMENT_INIT = "documentInit",
+    ADD_STEPS = "addSteps",
+    CONVERT_PM_TO_ADF = "convertPMToADF"
+}
+export declare enum EVENT_STATUS {
+    SUCCESS = "SUCCESS",
+    FAILURE = "FAILURE"
+}
+export declare type AnalyticsEvent = {
+    eventAction: EVENT_ACTION;
+    attributes: {
+        eventStatus: EVENT_STATUS;
+        meetsSLO?: boolean;
+        latency?: number;
+        error?: ErrorPayload;
+    };
+};
 export declare const ACK_MAX_TRY = 10;

package/dist/types/helpers/utils.d.ts

@@ -1,3 +1,4 @@
+import type { ProductInformation } from '../types';
 export declare const createLogger: (prefix: string, color?: string) => (msg: string, data?: any) => void;
 export declare const getParticipant: (userId: string) => {
     userId: string;
@@ -6,3 +7,5 @@ export declare const getParticipant: (userId: string) => {
     email: string;
 };
 export declare function sleep(ms: number): Promise<unknown>;
+export declare const getProduct: (productInfo?: ProductInformation | undefined) => string;
+export declare const getSubProduct: (productInfo?: ProductInformation | undefined) => string;

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

@@ -1,4 +1,4 @@
 import { Provider } from './provider';
-import { Socket, Config } from './types';
-export declare function createSocketIOSocket(url: string, auth?: (cb: (data: object) => void) => void): Socket;
+import { Socket, Config, ProductInformation } from './types';
+export declare function createSocketIOSocket(url: string, auth?: (cb: (data: object) => void) => void, productInfo?: ProductInformation): Socket;
 export declare function createSocketIOCollabProvider(config: Omit<Config, 'createSocket'>): Provider;

package/dist/types/types.d.ts

@@ -15,12 +15,13 @@ export interface Config {
     lifecycle?: Lifecycle;
     storage?: Storage;
     need404?: boolean;
-    createSocket(path: string, auth?: (cb: (data: object) => void) => void): Socket;
+    createSocket: (path: string, auth?: (cb: (data: object) => void) => void, productInfo?: ProductInformation) => Socket;
     analyticsClient?: AnalyticsWebClient;
     getUser?(userId: string): Promise<Pick<CollabParticipant, 'avatar' | 'email' | 'name'> & {
         userId: string;
     }>;
     permissionTokenRefresh?: () => Promise<string>;
+    productInfo?: ProductInformation;
 }
 interface SimpleEventEmitter {
     on(event: string, fn: Function): SimpleEventEmitter;
@@ -46,6 +47,7 @@ export interface CollabErrorPayload {
     status: number;
     code: string;
     message: string;
+    reason?: string;
 }
 export interface CollabInitPayload extends EditorCollabInitData {
     doc: any;
@@ -114,7 +116,10 @@ export declare type ErrorPayload = {
     data?: {
         status: number;
         code?: string;
-        meta?: string;
+        meta?: string | {
+            description: string;
+            reason?: string;
+        };
     };
 };
 export declare type ChannelEvent = {
@@ -158,4 +163,8 @@ export interface CatchupOptions {
     updateDocumentWithMetadata: ({ doc, version, metadata, reserveCursor, }: CollabInitPayload) => void;
     applyLocalsteps: (steps: Step[]) => void;
 }
+export declare type ProductInformation = {
+    product: string;
+    subProduct?: string;
+};
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "7.4.2",
+  "version": "7.5.0",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -22,8 +22,8 @@
   },
   "dependencies": {
     "@atlaskit/analytics-gas-types": "5.0.7",
-    "@atlaskit/analytics-listeners": "^8.2.0",
-    "@atlaskit/editor-common": "^68.0.0",
+    "@atlaskit/analytics-listeners": "^8.3.0",
+    "@atlaskit/editor-common": "^69.1.0",
     "@atlaskit/editor-json-transformer": "^8.7.0",
     "@atlaskit/util-service-support": "^6.1.0",
     "@babel/runtime": "^7.0.0",
@@ -44,7 +44,8 @@
     }
   },
   "devDependencies": {
-    "@atlaskit/editor-test-helpers": "^17.0.0",
+    "@atlaskit/adf-schema": "^23.3.0",
+    "@atlaskit/editor-test-helpers": "^17.1.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@types/prosemirror-collab": "^1.1.1",
     "@types/prosemirror-model": "^1.11.0",