@atlaskit/collab-provider 9.15.5 → 9.16.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/collab-provider
 
+## 9.16.1
+
+### Patch Changes
+
+- [#43417](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/43417) [`3f3c17f0273`](https://bitbucket.org/atlassian/atlassian-frontend/commits/3f3c17f0273) - ED-20971 Upgrade adf-schema package to ^34.0.0
+
+## 9.16.0
+
+### Minor Changes
+
+- [#43426](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/43426) [`850d2e49924`](https://bitbucket.org/atlassian/atlassian-frontend/commits/850d2e49924) - Add feature flag for send steps queue
+
 ## 9.15.5
 
 ### Patch Changes

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

@@ -47,6 +47,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
   function DocumentService(participantsService, analyticsHelper, fetchCatchup, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService) {
     var _this = this;
     var enableErrorOnFailedDocumentApply = arguments.length > 9 && arguments[9] !== undefined ? arguments[9] : false;
+    var enableSendStepsQueue = arguments.length > 10 && arguments[10] !== undefined ? arguments[10] : false;
     (0, _classCallCheck2.default)(this, DocumentService);
     // Fires analytics to editor when collab editor cannot sync up
     (0, _defineProperty2.default)(this, "stepRejectCounter", 0);
@@ -531,6 +532,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
     this.onErrorHandled = onErrorHandled;
     this.metadataService = metadataService;
     this.enableErrorOnFailedDocumentApply = enableErrorOnFailedDocumentApply;
+    this.enableSendStepsQueue = enableSendStepsQueue;
     this.stepQueue = new _stepQueueState.StepQueueState();
   }
   (0, _createClass2.default)(DocumentService, [{
@@ -648,21 +650,43 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       if (!(unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length)) {
         return;
       }
-
-      // Avoid reference issues using a
-      // method outside of the provider
-      // scope
-      (0, _commitStep.throttledCommitStep)({
-        broadcast: this.broadcast,
-        userId: this.getUserId(),
-        clientId: this.clientId,
-        steps: unconfirmedSteps,
-        version: version,
-        onStepsAdded: this.onStepsAdded,
-        onErrorHandled: this.onErrorHandled,
-        analyticsHelper: this.analyticsHelper,
-        emit: this.providerEmitCallback
-      });
+      if (this.enableSendStepsQueue) {
+        // This is where we would call the sendStepsQueue instead of throttledCommitStep
+        // Only send 1% of events to avoid useless logging
+        if (Math.random() < 0.01) {
+          var _this$analyticsHelper28;
+          (_this$analyticsHelper28 = this.analyticsHelper) === null || _this$analyticsHelper28 === void 0 || _this$analyticsHelper28.sendActionEvent(_const.EVENT_ACTION.SEND_STEPS_QUEUE, _const.EVENT_STATUS.INFO);
+        }
+        // Avoid reference issues using a
+        // method outside of the provider
+        // scope
+        (0, _commitStep.throttledCommitStep)({
+          broadcast: this.broadcast,
+          userId: this.getUserId(),
+          clientId: this.clientId,
+          steps: unconfirmedSteps,
+          version: version,
+          onStepsAdded: this.onStepsAdded,
+          onErrorHandled: this.onErrorHandled,
+          analyticsHelper: this.analyticsHelper,
+          emit: this.providerEmitCallback
+        });
+      } else {
+        // Avoid reference issues using a
+        // method outside of the provider
+        // scope
+        (0, _commitStep.throttledCommitStep)({
+          broadcast: this.broadcast,
+          userId: this.getUserId(),
+          clientId: this.clientId,
+          steps: unconfirmedSteps,
+          version: version,
+          onStepsAdded: this.onStepsAdded,
+          onErrorHandled: this.onErrorHandled,
+          analyticsHelper: this.analyticsHelper,
+          emit: this.providerEmitCallback
+        });
+      }
     }
   }]);
   return DocumentService;

package/dist/cjs/feature-flags/index.js

@@ -9,7 +9,8 @@ exports.getProductSpecificFeatureFlags = void 0;
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var defaultNCSFeatureFlags = {
   testFF: false,
-  socketMessageMetricsFF: false
+  socketMessageMetricsFF: false,
+  sendStepsQueueFF: false
 };
 
 /**
@@ -18,7 +19,8 @@ var defaultNCSFeatureFlags = {
 var productKeys = {
   confluence: {
     testFF: 'confluence.frontend.collab.provider.testFF',
-    socketMessageMetricsFF: 'confluence.frontend.collab.provider.socketMessageMetricsFF'
+    socketMessageMetricsFF: 'confluence.frontend.collab.provider.socketMessageMetricsFF',
+    sendStepsQueueFF: 'confluence.frontend.collab.provider.sendStepsQueueFF'
   }
 };
 var filterFeatureFlagNames = function filterFeatureFlagNames(flags) {

package/dist/cjs/helpers/const.js

@@ -23,8 +23,9 @@ var EVENT_ACTION = exports.EVENT_ACTION = /*#__PURE__*/function (EVENT_ACTION) {
   EVENT_ACTION["PROVIDER_INITIALIZED"] = "providerInitialized";
   EVENT_ACTION["PROVIDER_SETUP"] = "providerSetup";
   EVENT_ACTION["HAS_UNCONFIRMED_STEPS"] = "hasUnconfirmedSteps";
+  EVENT_ACTION["SEND_STEPS_QUEUE"] = "sendStepsQueue";
   return EVENT_ACTION;
-}({}); // https://data-portal.internal.atlassian.com/analytics/registry/56141
+}({}); // Temporary, used to confirm feature flag
 var EVENT_STATUS = exports.EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {
   EVENT_STATUS["SUCCESS"] = "SUCCESS";
   EVENT_STATUS["FAILURE"] = "FAILURE";

package/dist/cjs/provider/index.js

@@ -27,6 +27,7 @@ var _namespaceService = require("../namespace/namespace-service");
 var _participantsService = require("../participants/participants-service");
 var _errorCodeMapper = require("../errors/error-code-mapper");
 var _const = require("../helpers/const");
+var _featureFlags = require("../feature-flags");
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
 var logger = (0, _utils.createLogger)('Provider', 'black');
@@ -268,7 +269,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     _this.metadataService = new _metadataService.MetadataService(_this.emitCallback, _this.channel.sendMetadata);
     _this.documentService = new _documentService.DocumentService(_this.participantsService, _this.analyticsHelper, _this.channel.fetchCatchup, _this.channel.fetchReconcile, _this.emitCallback, _this.channel.broadcast, function () {
       return _this.userId;
-    }, _this.onErrorHandled, _this.metadataService, _this.config.enableErrorOnFailedDocumentApply);
+    }, _this.onErrorHandled, _this.metadataService, _this.config.enableErrorOnFailedDocumentApply, (0, _featureFlags.getCollabProviderFeatureFlag)('sendStepsQueueFF', _this.config.featureFlags));
     _this.namespaceService = new _namespaceService.NamespaceService();
     return _this;
   }

package/dist/cjs/version-wrapper.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = exports.name = "@atlaskit/collab-provider";
-var version = exports.version = "9.15.5";
+var version = exports.version = "9.16.1";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

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

@@ -31,7 +31,7 @@ export class DocumentService {
    * @param metadataService
    * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
    */
-  constructor(participantsService, analyticsHelper, fetchCatchup, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, enableErrorOnFailedDocumentApply = false) {
+  constructor(participantsService, analyticsHelper, fetchCatchup, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, enableErrorOnFailedDocumentApply = false, enableSendStepsQueue = false) {
     // Fires analytics to editor when collab editor cannot sync up
     _defineProperty(this, "stepRejectCounter", 0);
     _defineProperty(this, "aggressiveCatchup", false);
@@ -442,6 +442,7 @@ export class DocumentService {
     this.onErrorHandled = onErrorHandled;
     this.metadataService = metadataService;
     this.enableErrorOnFailedDocumentApply = enableErrorOnFailedDocumentApply;
+    this.enableSendStepsQueue = enableSendStepsQueue;
     this.stepQueue = new StepQueueState();
   }
   processQueue() {
@@ -547,20 +548,42 @@ export class DocumentService {
     if (!(unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length)) {
       return;
     }
-
-    // Avoid reference issues using a
-    // method outside of the provider
-    // scope
-    throttledCommitStep({
-      broadcast: this.broadcast,
-      userId: this.getUserId(),
-      clientId: this.clientId,
-      steps: unconfirmedSteps,
-      version,
-      onStepsAdded: this.onStepsAdded,
-      onErrorHandled: this.onErrorHandled,
-      analyticsHelper: this.analyticsHelper,
-      emit: this.providerEmitCallback
-    });
+    if (this.enableSendStepsQueue) {
+      // This is where we would call the sendStepsQueue instead of throttledCommitStep
+      // Only send 1% of events to avoid useless logging
+      if (Math.random() < 0.01) {
+        var _this$analyticsHelper28;
+        (_this$analyticsHelper28 = this.analyticsHelper) === null || _this$analyticsHelper28 === void 0 ? void 0 : _this$analyticsHelper28.sendActionEvent(EVENT_ACTION.SEND_STEPS_QUEUE, EVENT_STATUS.INFO);
+      }
+      // Avoid reference issues using a
+      // method outside of the provider
+      // scope
+      throttledCommitStep({
+        broadcast: this.broadcast,
+        userId: this.getUserId(),
+        clientId: this.clientId,
+        steps: unconfirmedSteps,
+        version,
+        onStepsAdded: this.onStepsAdded,
+        onErrorHandled: this.onErrorHandled,
+        analyticsHelper: this.analyticsHelper,
+        emit: this.providerEmitCallback
+      });
+    } else {
+      // Avoid reference issues using a
+      // method outside of the provider
+      // scope
+      throttledCommitStep({
+        broadcast: this.broadcast,
+        userId: this.getUserId(),
+        clientId: this.clientId,
+        steps: unconfirmedSteps,
+        version,
+        onStepsAdded: this.onStepsAdded,
+        onErrorHandled: this.onErrorHandled,
+        analyticsHelper: this.analyticsHelper,
+        emit: this.providerEmitCallback
+      });
+    }
   }
 }

package/dist/es2019/feature-flags/index.js

@@ -1,6 +1,7 @@
 const defaultNCSFeatureFlags = {
   testFF: false,
-  socketMessageMetricsFF: false
+  socketMessageMetricsFF: false,
+  sendStepsQueueFF: false
 };
 
 /**
@@ -9,7 +10,8 @@ const defaultNCSFeatureFlags = {
 const productKeys = {
   confluence: {
     testFF: 'confluence.frontend.collab.provider.testFF',
-    socketMessageMetricsFF: 'confluence.frontend.collab.provider.socketMessageMetricsFF'
+    socketMessageMetricsFF: 'confluence.frontend.collab.provider.socketMessageMetricsFF',
+    sendStepsQueueFF: 'confluence.frontend.collab.provider.sendStepsQueueFF'
   }
 };
 const filterFeatureFlagNames = flags => {

package/dist/es2019/helpers/const.js

@@ -17,8 +17,9 @@ export let EVENT_ACTION = /*#__PURE__*/function (EVENT_ACTION) {
   EVENT_ACTION["PROVIDER_INITIALIZED"] = "providerInitialized";
   EVENT_ACTION["PROVIDER_SETUP"] = "providerSetup";
   EVENT_ACTION["HAS_UNCONFIRMED_STEPS"] = "hasUnconfirmedSteps";
+  EVENT_ACTION["SEND_STEPS_QUEUE"] = "sendStepsQueue";
   return EVENT_ACTION;
-}({}); // https://data-portal.internal.atlassian.com/analytics/registry/56141
+}({}); // Temporary, used to confirm feature flag
 export let EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {
   EVENT_STATUS["SUCCESS"] = "SUCCESS";
   EVENT_STATUS["FAILURE"] = "FAILURE";

package/dist/es2019/provider/index.js

@@ -11,6 +11,7 @@ import { NamespaceService } from '../namespace/namespace-service';
 import { ParticipantsService } from '../participants/participants-service';
 import { errorCodeMapper } from '../errors/error-code-mapper';
 import { EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
+import { getCollabProviderFeatureFlag } from '../feature-flags';
 const logger = createLogger('Provider', 'black');
 const OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 const PRELOAD_DRAFT_SYNC_PERIOD = 15 * 1000; // 15 seconds
@@ -221,7 +222,7 @@ export class Provider extends Emitter {
     this.isProviderInitialized = false;
     this.participantsService = new ParticipantsService(this.analyticsHelper, undefined, this.emitCallback, this.config.getUser, this.channel.broadcast, this.channel.sendPresenceJoined, this.getPresenceData, this.setUserId);
     this.metadataService = new MetadataService(this.emitCallback, this.channel.sendMetadata);
-    this.documentService = new DocumentService(this.participantsService, this.analyticsHelper, this.channel.fetchCatchup, this.channel.fetchReconcile, this.emitCallback, this.channel.broadcast, () => this.userId, this.onErrorHandled, this.metadataService, this.config.enableErrorOnFailedDocumentApply);
+    this.documentService = new DocumentService(this.participantsService, this.analyticsHelper, this.channel.fetchCatchup, this.channel.fetchReconcile, this.emitCallback, this.channel.broadcast, () => this.userId, this.onErrorHandled, this.metadataService, this.config.enableErrorOnFailedDocumentApply, getCollabProviderFeatureFlag('sendStepsQueueFF', this.config.featureFlags));
     this.namespaceService = new NamespaceService();
   }
   /**

package/dist/es2019/version-wrapper.js

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

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

@@ -40,6 +40,7 @@ export var DocumentService = /*#__PURE__*/function () {
   function DocumentService(participantsService, analyticsHelper, fetchCatchup, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService) {
     var _this = this;
     var enableErrorOnFailedDocumentApply = arguments.length > 9 && arguments[9] !== undefined ? arguments[9] : false;
+    var enableSendStepsQueue = arguments.length > 10 && arguments[10] !== undefined ? arguments[10] : false;
     _classCallCheck(this, DocumentService);
     // Fires analytics to editor when collab editor cannot sync up
     _defineProperty(this, "stepRejectCounter", 0);
@@ -524,6 +525,7 @@ export var DocumentService = /*#__PURE__*/function () {
     this.onErrorHandled = onErrorHandled;
     this.metadataService = metadataService;
     this.enableErrorOnFailedDocumentApply = enableErrorOnFailedDocumentApply;
+    this.enableSendStepsQueue = enableSendStepsQueue;
     this.stepQueue = new StepQueueState();
   }
   _createClass(DocumentService, [{
@@ -641,21 +643,43 @@ export var DocumentService = /*#__PURE__*/function () {
       if (!(unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length)) {
         return;
       }
-
-      // Avoid reference issues using a
-      // method outside of the provider
-      // scope
-      throttledCommitStep({
-        broadcast: this.broadcast,
-        userId: this.getUserId(),
-        clientId: this.clientId,
-        steps: unconfirmedSteps,
-        version: version,
-        onStepsAdded: this.onStepsAdded,
-        onErrorHandled: this.onErrorHandled,
-        analyticsHelper: this.analyticsHelper,
-        emit: this.providerEmitCallback
-      });
+      if (this.enableSendStepsQueue) {
+        // This is where we would call the sendStepsQueue instead of throttledCommitStep
+        // Only send 1% of events to avoid useless logging
+        if (Math.random() < 0.01) {
+          var _this$analyticsHelper28;
+          (_this$analyticsHelper28 = this.analyticsHelper) === null || _this$analyticsHelper28 === void 0 || _this$analyticsHelper28.sendActionEvent(EVENT_ACTION.SEND_STEPS_QUEUE, EVENT_STATUS.INFO);
+        }
+        // Avoid reference issues using a
+        // method outside of the provider
+        // scope
+        throttledCommitStep({
+          broadcast: this.broadcast,
+          userId: this.getUserId(),
+          clientId: this.clientId,
+          steps: unconfirmedSteps,
+          version: version,
+          onStepsAdded: this.onStepsAdded,
+          onErrorHandled: this.onErrorHandled,
+          analyticsHelper: this.analyticsHelper,
+          emit: this.providerEmitCallback
+        });
+      } else {
+        // Avoid reference issues using a
+        // method outside of the provider
+        // scope
+        throttledCommitStep({
+          broadcast: this.broadcast,
+          userId: this.getUserId(),
+          clientId: this.clientId,
+          steps: unconfirmedSteps,
+          version: version,
+          onStepsAdded: this.onStepsAdded,
+          onErrorHandled: this.onErrorHandled,
+          analyticsHelper: this.analyticsHelper,
+          emit: this.providerEmitCallback
+        });
+      }
     }
   }]);
   return DocumentService;

package/dist/esm/feature-flags/index.js

@@ -1,7 +1,8 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 var defaultNCSFeatureFlags = {
   testFF: false,
-  socketMessageMetricsFF: false
+  socketMessageMetricsFF: false,
+  sendStepsQueueFF: false
 };
 
 /**
@@ -10,7 +11,8 @@ var defaultNCSFeatureFlags = {
 var productKeys = {
   confluence: {
     testFF: 'confluence.frontend.collab.provider.testFF',
-    socketMessageMetricsFF: 'confluence.frontend.collab.provider.socketMessageMetricsFF'
+    socketMessageMetricsFF: 'confluence.frontend.collab.provider.socketMessageMetricsFF',
+    sendStepsQueueFF: 'confluence.frontend.collab.provider.sendStepsQueueFF'
   }
 };
 var filterFeatureFlagNames = function filterFeatureFlagNames(flags) {

package/dist/esm/helpers/const.js

@@ -17,8 +17,9 @@ export var EVENT_ACTION = /*#__PURE__*/function (EVENT_ACTION) {
   EVENT_ACTION["PROVIDER_INITIALIZED"] = "providerInitialized";
   EVENT_ACTION["PROVIDER_SETUP"] = "providerSetup";
   EVENT_ACTION["HAS_UNCONFIRMED_STEPS"] = "hasUnconfirmedSteps";
+  EVENT_ACTION["SEND_STEPS_QUEUE"] = "sendStepsQueue";
   return EVENT_ACTION;
-}({}); // https://data-portal.internal.atlassian.com/analytics/registry/56141
+}({}); // Temporary, used to confirm feature flag
 export var EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {
   EVENT_STATUS["SUCCESS"] = "SUCCESS";
   EVENT_STATUS["FAILURE"] = "FAILURE";

package/dist/esm/provider/index.js

@@ -22,6 +22,7 @@ import { NamespaceService } from '../namespace/namespace-service';
 import { ParticipantsService } from '../participants/participants-service';
 import { errorCodeMapper } from '../errors/error-code-mapper';
 import { EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
+import { getCollabProviderFeatureFlag } from '../feature-flags';
 var logger = createLogger('Provider', 'black');
 var OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 var PRELOAD_DRAFT_SYNC_PERIOD = 15 * 1000; // 15 seconds
@@ -261,7 +262,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     _this.metadataService = new MetadataService(_this.emitCallback, _this.channel.sendMetadata);
     _this.documentService = new DocumentService(_this.participantsService, _this.analyticsHelper, _this.channel.fetchCatchup, _this.channel.fetchReconcile, _this.emitCallback, _this.channel.broadcast, function () {
       return _this.userId;
-    }, _this.onErrorHandled, _this.metadataService, _this.config.enableErrorOnFailedDocumentApply);
+    }, _this.onErrorHandled, _this.metadataService, _this.config.enableErrorOnFailedDocumentApply, getCollabProviderFeatureFlag('sendStepsQueueFF', _this.config.featureFlags));
     _this.namespaceService = new NamespaceService();
     return _this;
   }

package/dist/esm/version-wrapper.js

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

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

@@ -19,6 +19,7 @@ export declare class DocumentService {
     private onErrorHandled;
     private metadataService;
     private enableErrorOnFailedDocumentApply;
+    private enableSendStepsQueue;
     private getState;
     private onSyncUpError?;
     private stepQueue;
@@ -39,7 +40,7 @@ export declare class DocumentService {
      * @param metadataService
      * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
      */
-    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>, fetchReconcile: (currentStateDoc: string) => Promise<ReconcileResponse>, providerEmitCallback: (evt: keyof CollabEvents, data: any) => void, broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, getUserId: () => string | undefined, onErrorHandled: (error: InternalError) => void, metadataService: MetadataService, enableErrorOnFailedDocumentApply?: boolean);
+    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>, fetchReconcile: (currentStateDoc: string) => Promise<ReconcileResponse>, providerEmitCallback: (evt: keyof CollabEvents, data: any) => void, broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, getUserId: () => string | undefined, onErrorHandled: (error: InternalError) => void, metadataService: MetadataService, enableErrorOnFailedDocumentApply?: boolean, enableSendStepsQueue?: boolean);
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      */

package/dist/types/feature-flags/types.d.ts

@@ -1,6 +1,7 @@
 export interface NCSFeatureFlags {
     testFF?: boolean;
     socketMessageMetricsFF?: boolean;
+    sendStepsQueueFF?: boolean;
 }
 export interface WithNCSFeatureFlags {
     featureFlags?: NCSFeatureFlags;

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

@@ -17,7 +17,8 @@ export declare enum EVENT_ACTION {
     WEBSOCKET_MESSAGE_VOLUME_METRIC = "websocketMessageVolumeMetric",
     PROVIDER_INITIALIZED = "providerInitialized",
     PROVIDER_SETUP = "providerSetup",
-    HAS_UNCONFIRMED_STEPS = "hasUnconfirmedSteps"
+    HAS_UNCONFIRMED_STEPS = "hasUnconfirmedSteps",
+    SEND_STEPS_QUEUE = "sendStepsQueue"
 }
 export declare enum EVENT_STATUS {
     SUCCESS = "SUCCESS",
@@ -254,7 +255,13 @@ type ProviderHasUnconfirmedStepsAnalyticsEvent = {
         numUnconfirmedSteps: number;
     };
 };
-export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent | WebsocketMessageVolumeMetricEvent | ProviderInitializedAnalyticsEvent | ProviderSetupAnalyticsEvent | ProviderHasUnconfirmedStepsAnalyticsEvent;
+type SendStepsQueueAnalyticsEvent = {
+    eventAction: EVENT_ACTION.SEND_STEPS_QUEUE;
+    attributes: {
+        documentAri?: string;
+    };
+};
+export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent | WebsocketMessageVolumeMetricEvent | ProviderInitializedAnalyticsEvent | ProviderSetupAnalyticsEvent | ProviderHasUnconfirmedStepsAnalyticsEvent | SendStepsQueueAnalyticsEvent;
 export declare const ACK_MAX_TRY = 60;
 export declare const CONFLUENCE = "confluence";
 export {};

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

@@ -19,6 +19,7 @@ export declare class DocumentService {
     private onErrorHandled;
     private metadataService;
     private enableErrorOnFailedDocumentApply;
+    private enableSendStepsQueue;
     private getState;
     private onSyncUpError?;
     private stepQueue;
@@ -39,7 +40,7 @@ export declare class DocumentService {
      * @param metadataService
      * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
      */
-    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>, fetchReconcile: (currentStateDoc: string) => Promise<ReconcileResponse>, providerEmitCallback: (evt: keyof CollabEvents, data: any) => void, broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, getUserId: () => string | undefined, onErrorHandled: (error: InternalError) => void, metadataService: MetadataService, enableErrorOnFailedDocumentApply?: boolean);
+    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>, fetchReconcile: (currentStateDoc: string) => Promise<ReconcileResponse>, providerEmitCallback: (evt: keyof CollabEvents, data: any) => void, broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, getUserId: () => string | undefined, onErrorHandled: (error: InternalError) => void, metadataService: MetadataService, enableErrorOnFailedDocumentApply?: boolean, enableSendStepsQueue?: boolean);
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      */

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

@@ -1,6 +1,7 @@
 export interface NCSFeatureFlags {
     testFF?: boolean;
     socketMessageMetricsFF?: boolean;
+    sendStepsQueueFF?: boolean;
 }
 export interface WithNCSFeatureFlags {
     featureFlags?: NCSFeatureFlags;

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

@@ -17,7 +17,8 @@ export declare enum EVENT_ACTION {
     WEBSOCKET_MESSAGE_VOLUME_METRIC = "websocketMessageVolumeMetric",
     PROVIDER_INITIALIZED = "providerInitialized",
     PROVIDER_SETUP = "providerSetup",
-    HAS_UNCONFIRMED_STEPS = "hasUnconfirmedSteps"
+    HAS_UNCONFIRMED_STEPS = "hasUnconfirmedSteps",
+    SEND_STEPS_QUEUE = "sendStepsQueue"
 }
 export declare enum EVENT_STATUS {
     SUCCESS = "SUCCESS",
@@ -254,7 +255,13 @@ type ProviderHasUnconfirmedStepsAnalyticsEvent = {
         numUnconfirmedSteps: number;
     };
 };
-export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent | WebsocketMessageVolumeMetricEvent | ProviderInitializedAnalyticsEvent | ProviderSetupAnalyticsEvent | ProviderHasUnconfirmedStepsAnalyticsEvent;
+type SendStepsQueueAnalyticsEvent = {
+    eventAction: EVENT_ACTION.SEND_STEPS_QUEUE;
+    attributes: {
+        documentAri?: string;
+    };
+};
+export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent | WebsocketMessageVolumeMetricEvent | ProviderInitializedAnalyticsEvent | ProviderSetupAnalyticsEvent | ProviderHasUnconfirmedStepsAnalyticsEvent | SendStepsQueueAnalyticsEvent;
 export declare const ACK_MAX_TRY = 60;
 export declare const CONFLUENCE = "confluence";
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.15.5",
+  "version": "9.16.1",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -62,7 +62,7 @@
     }
   },
   "devDependencies": {
-    "@atlaskit/adf-schema": "^33.2.3",
+    "@atlaskit/adf-schema": "^34.0.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "typescript": "~4.9.5"
   },