@atlaskit/collab-provider 14.1.1 → 14.1.2

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/collab-provider
 
+## 14.1.2
+
+### Patch Changes
+
+- [`0d4df322f7f0b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0d4df322f7f0b) -
+  Add additional offline analytics on reconnection
+
 ## 14.1.1
 
 ### Patch Changes

package/dist/cjs/document/null-document-service.js

@@ -59,6 +59,11 @@ var NullDocumentService = exports.NullDocumentService = /*#__PURE__*/function ()
     value: function getUnconfirmedSteps() {
       return undefined;
     }
+  }, {
+    key: "getUnconfirmedStepsOrigins",
+    value: function getUnconfirmedStepsOrigins() {
+      return undefined;
+    }
   }, {
     key: "getCurrentPmVersion",
     value: function getCurrentPmVersion() {

package/dist/cjs/provider/get-offline-steps-length.js

@@ -0,0 +1,36 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getOfflineReplaceStepsLength = getOfflineReplaceStepsLength;
+exports.getOfflineStepsLength = getOfflineStepsLength;
+var _transform = require("@atlaskit/editor-prosemirror/transform");
+function getOfflineSteps(steps, origins) {
+  if (!steps || !origins || steps.length !== origins.length) {
+    return undefined;
+  }
+  if (origins.some(function (s) {
+    return (s === null || s === void 0 ? void 0 : s.getMeta('isOffline')) === true || (s === null || s === void 0 ? void 0 : s.getMeta('wasOffline')) === true;
+  })) {
+    var mapped = steps.filter(function (step, idx) {
+      var origin = origins[idx];
+      if (!origin) {
+        return false;
+      }
+      var createdOffline = origin.getMeta('isOffline') || origin.getMeta('wasOffline');
+      return createdOffline;
+    });
+    return mapped;
+  }
+}
+function getOfflineStepsLength(steps, origins) {
+  var _getOfflineSteps;
+  return (_getOfflineSteps = getOfflineSteps(steps, origins)) === null || _getOfflineSteps === void 0 ? void 0 : _getOfflineSteps.length;
+}
+function getOfflineReplaceStepsLength(steps, origins) {
+  var _getOfflineSteps2;
+  return (_getOfflineSteps2 = getOfflineSteps(steps, origins)) === null || _getOfflineSteps2 === void 0 ? void 0 : _getOfflineSteps2.filter(function (s) {
+    return s instanceof _transform.ReplaceStep;
+  }).length;
+}

package/dist/cjs/provider/index.js

@@ -17,6 +17,7 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 var _uuid = require("uuid");
 var _emitter = require("../emitter");
 var _channel = require("../channel");
+var _experiments = require("@atlaskit/tmp-editor-statsig/experiments");
 var _utils = require("../helpers/utils");
 var _analyticsHelper = _interopRequireDefault(require("../analytics/analytics-helper"));
 var _telepointersHelper = require("../participants/telepointers-helper");
@@ -34,6 +35,7 @@ var _api = require("../api/api");
 var _performance = require("../analytics/performance");
 var _nullApi = require("../api/null-api");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _getOfflineStepsLength = require("./get-offline-steps-length");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(t).constructor) : o.apply(t, e)); }
@@ -146,6 +148,8 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
         Date.now() - _this.disconnectedAt >= OUT_OF_SYNC_PERIOD) {
           _this.documentService.throttledCatchupv2(_const.CatchupEventReason.RECONNECTED, {
             disconnectionPeriodSeconds: Math.floor((Date.now() - _this.disconnectedAt) / 1000),
+            offlineStepsLength: (0, _experiments.editorExperiment)('platform_editor_offline_editing_web', true) ? (0, _getOfflineStepsLength.getOfflineStepsLength)(_this.documentService.getUnconfirmedSteps(), _this.documentService.getUnconfirmedStepsOrigins()) : undefined,
+            offlineReplaceStepsLength: (0, _experiments.editorExperiment)('platform_editor_offline_editing_web', true) ? (0, _getOfflineStepsLength.getOfflineReplaceStepsLength)(_this.documentService.getUnconfirmedSteps(), _this.documentService.getUnconfirmedStepsOrigins()) : undefined,
             unconfirmedStepsLength: unconfirmedStepsLength
           }, (0, _platformFeatureFlags.fg)('add_session_id_to_catchup_query') ? _this.sessionId : undefined);
         }

package/dist/es2019/document/null-document-service.js

@@ -26,6 +26,9 @@ export class NullDocumentService {
   getUnconfirmedSteps() {
     return undefined;
   }
+  getUnconfirmedStepsOrigins() {
+    return undefined;
+  }
   getCurrentPmVersion() {
     return -1;
   }

package/dist/es2019/provider/get-offline-steps-length.js

@@ -0,0 +1,25 @@
+import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+function getOfflineSteps(steps, origins) {
+  if (!steps || !origins || steps.length !== origins.length) {
+    return undefined;
+  }
+  if (origins.some(s => (s === null || s === void 0 ? void 0 : s.getMeta('isOffline')) === true || (s === null || s === void 0 ? void 0 : s.getMeta('wasOffline')) === true)) {
+    const mapped = steps.filter((step, idx) => {
+      const origin = origins[idx];
+      if (!origin) {
+        return false;
+      }
+      const createdOffline = origin.getMeta('isOffline') || origin.getMeta('wasOffline');
+      return createdOffline;
+    });
+    return mapped;
+  }
+}
+export function getOfflineStepsLength(steps, origins) {
+  var _getOfflineSteps;
+  return (_getOfflineSteps = getOfflineSteps(steps, origins)) === null || _getOfflineSteps === void 0 ? void 0 : _getOfflineSteps.length;
+}
+export function getOfflineReplaceStepsLength(steps, origins) {
+  var _getOfflineSteps2;
+  return (_getOfflineSteps2 = getOfflineSteps(steps, origins)) === null || _getOfflineSteps2 === void 0 ? void 0 : _getOfflineSteps2.filter(s => s instanceof ReplaceStep).length;
+}

package/dist/es2019/provider/index.js

@@ -3,6 +3,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { v4 as uuidv4 } from 'uuid';
 import { Emitter } from '../emitter';
 import { Channel } from '../channel';
+import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { createLogger, logObfuscatedSteps } from '../helpers/utils';
 import AnalyticsHelper from '../analytics/analytics-helper';
 import { telepointerCallback } from '../participants/telepointers-helper';
@@ -20,6 +21,7 @@ import { Api } from '../api/api';
 import { shouldTelepointerBeSampled } from '../analytics/performance';
 import { NullApi } from '../api/null-api';
 import { fg } from '@atlaskit/platform-feature-flags';
+import { getOfflineStepsLength, getOfflineReplaceStepsLength } from './get-offline-steps-length';
 const logger = createLogger('Provider', 'black');
 const OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 
@@ -126,6 +128,8 @@ export class Provider extends Emitter {
         Date.now() - this.disconnectedAt >= OUT_OF_SYNC_PERIOD) {
           this.documentService.throttledCatchupv2(CatchupEventReason.RECONNECTED, {
             disconnectionPeriodSeconds: Math.floor((Date.now() - this.disconnectedAt) / 1000),
+            offlineStepsLength: editorExperiment('platform_editor_offline_editing_web', true) ? getOfflineStepsLength(this.documentService.getUnconfirmedSteps(), this.documentService.getUnconfirmedStepsOrigins()) : undefined,
+            offlineReplaceStepsLength: editorExperiment('platform_editor_offline_editing_web', true) ? getOfflineReplaceStepsLength(this.documentService.getUnconfirmedSteps(), this.documentService.getUnconfirmedStepsOrigins()) : undefined,
             unconfirmedStepsLength: unconfirmedStepsLength
           }, fg('add_session_id_to_catchup_query') ? this.sessionId : undefined);
         }

package/dist/esm/document/null-document-service.js

@@ -52,6 +52,11 @@ export var NullDocumentService = /*#__PURE__*/function () {
     value: function getUnconfirmedSteps() {
       return undefined;
     }
+  }, {
+    key: "getUnconfirmedStepsOrigins",
+    value: function getUnconfirmedStepsOrigins() {
+      return undefined;
+    }
   }, {
     key: "getCurrentPmVersion",
     value: function getCurrentPmVersion() {

package/dist/esm/provider/get-offline-steps-length.js

@@ -0,0 +1,29 @@
+import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+function getOfflineSteps(steps, origins) {
+  if (!steps || !origins || steps.length !== origins.length) {
+    return undefined;
+  }
+  if (origins.some(function (s) {
+    return (s === null || s === void 0 ? void 0 : s.getMeta('isOffline')) === true || (s === null || s === void 0 ? void 0 : s.getMeta('wasOffline')) === true;
+  })) {
+    var mapped = steps.filter(function (step, idx) {
+      var origin = origins[idx];
+      if (!origin) {
+        return false;
+      }
+      var createdOffline = origin.getMeta('isOffline') || origin.getMeta('wasOffline');
+      return createdOffline;
+    });
+    return mapped;
+  }
+}
+export function getOfflineStepsLength(steps, origins) {
+  var _getOfflineSteps;
+  return (_getOfflineSteps = getOfflineSteps(steps, origins)) === null || _getOfflineSteps === void 0 ? void 0 : _getOfflineSteps.length;
+}
+export function getOfflineReplaceStepsLength(steps, origins) {
+  var _getOfflineSteps2;
+  return (_getOfflineSteps2 = getOfflineSteps(steps, origins)) === null || _getOfflineSteps2 === void 0 ? void 0 : _getOfflineSteps2.filter(function (s) {
+    return s instanceof ReplaceStep;
+  }).length;
+}

package/dist/esm/provider/index.js

@@ -16,6 +16,7 @@ function _superPropGet(t, o, e, r) { var p = _get(_getPrototypeOf(1 & r ? t.prot
 import { v4 as uuidv4 } from 'uuid';
 import { Emitter } from '../emitter';
 import { Channel } from '../channel';
+import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { createLogger, logObfuscatedSteps } from '../helpers/utils';
 import AnalyticsHelper from '../analytics/analytics-helper';
 import { telepointerCallback } from '../participants/telepointers-helper';
@@ -33,6 +34,7 @@ import { Api } from '../api/api';
 import { shouldTelepointerBeSampled } from '../analytics/performance';
 import { NullApi } from '../api/null-api';
 import { fg } from '@atlaskit/platform-feature-flags';
+import { getOfflineStepsLength, getOfflineReplaceStepsLength } from './get-offline-steps-length';
 var logger = createLogger('Provider', 'black');
 var OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 
@@ -140,6 +142,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         Date.now() - _this.disconnectedAt >= OUT_OF_SYNC_PERIOD) {
           _this.documentService.throttledCatchupv2(CatchupEventReason.RECONNECTED, {
             disconnectionPeriodSeconds: Math.floor((Date.now() - _this.disconnectedAt) / 1000),
+            offlineStepsLength: editorExperiment('platform_editor_offline_editing_web', true) ? getOfflineStepsLength(_this.documentService.getUnconfirmedSteps(), _this.documentService.getUnconfirmedStepsOrigins()) : undefined,
+            offlineReplaceStepsLength: editorExperiment('platform_editor_offline_editing_web', true) ? getOfflineReplaceStepsLength(_this.documentService.getUnconfirmedSteps(), _this.documentService.getUnconfirmedStepsOrigins()) : undefined,
             unconfirmedStepsLength: unconfirmedStepsLength
           }, fg('add_session_id_to_catchup_query') ? _this.sessionId : undefined);
         }

package/dist/types/document/null-document-service.d.ts

@@ -14,6 +14,7 @@ export declare class NullDocumentService implements DocumentServiceInterface {
     getFinalAcknowledgedState(reason: GetResolvedEditorStateReason): Promise<ResolvedEditorState>;
     getIsNamespaceLocked(): boolean;
     getUnconfirmedSteps(): undefined;
+    getUnconfirmedStepsOrigins(): undefined;
     getCurrentPmVersion(): number;
     onErrorHandled: () => void;
 }

package/dist/types/provider/get-offline-steps-length.d.ts

@@ -0,0 +1,4 @@
+import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+export declare function getOfflineStepsLength(steps: readonly ProseMirrorStep[] | undefined, origins: readonly Transaction[] | undefined): number | undefined;
+export declare function getOfflineReplaceStepsLength(steps: readonly ProseMirrorStep[] | undefined, origins: readonly Transaction[] | undefined): number | undefined;

package/dist/types/types.d.ts

@@ -238,6 +238,8 @@ export interface Catchupv2Options {
 }
 export type ReconnectionMetadata = {
     disconnectionPeriodSeconds: number | undefined;
+    offlineReplaceStepsLength: number | undefined;
+    offlineStepsLength: number | undefined;
     unconfirmedStepsLength: number | undefined;
 };
 export type ProductInformation = {

package/dist/types-ts4.5/document/null-document-service.d.ts

@@ -14,6 +14,7 @@ export declare class NullDocumentService implements DocumentServiceInterface {
     getFinalAcknowledgedState(reason: GetResolvedEditorStateReason): Promise<ResolvedEditorState>;
     getIsNamespaceLocked(): boolean;
     getUnconfirmedSteps(): undefined;
+    getUnconfirmedStepsOrigins(): undefined;
     getCurrentPmVersion(): number;
     onErrorHandled: () => void;
 }

package/dist/types-ts4.5/provider/get-offline-steps-length.d.ts

@@ -0,0 +1,4 @@
+import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+export declare function getOfflineStepsLength(steps: readonly ProseMirrorStep[] | undefined, origins: readonly Transaction[] | undefined): number | undefined;
+export declare function getOfflineReplaceStepsLength(steps: readonly ProseMirrorStep[] | undefined, origins: readonly Transaction[] | undefined): number | undefined;

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

@@ -238,6 +238,8 @@ export interface Catchupv2Options {
 }
 export type ReconnectionMetadata = {
     disconnectionPeriodSeconds: number | undefined;
+    offlineReplaceStepsLength: number | undefined;
+    offlineStepsLength: number | undefined;
     unconfirmedStepsLength: number | undefined;
 };
 export type ProductInformation = {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "14.1.1",
+	"version": "14.1.2",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"