@atlaskit/collab-provider 9.15.2 → 9.15.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/collab-provider
 
+## 9.15.3
+
+### Patch Changes
+
+- [#41977](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/41977) [`5b2f6d283ef`](https://bitbucket.org/atlassian/atlassian-frontend/commits/5b2f6d283ef) - clean up catchup retry feature flag
+
 ## 9.15.2
 
 ### Patch Changes

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

@@ -42,13 +42,11 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
    * @param getUserId - Callback to fetch the current user's ID
    * @param onErrorHandled - Callback to handle
    * @param metadataService
-   * @param failedStepsBeforeCatchupOnPublish - Control MAX_STEP_REJECTED_ERROR during page publishes.
    * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
    */
   function DocumentService(participantsService, analyticsHelper, fetchCatchup, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService) {
     var _this = this;
-    var failedStepsBeforeCatchupOnPublish = arguments.length > 9 && arguments[9] !== undefined ? arguments[9] : _provider.MAX_STEP_REJECTED_ERROR;
-    var enableErrorOnFailedDocumentApply = arguments.length > 10 && arguments[10] !== undefined ? arguments[10] : false;
+    var enableErrorOnFailedDocumentApply = arguments.length > 9 && arguments[9] !== undefined ? arguments[9] : false;
     (0, _classCallCheck2.default)(this, DocumentService);
     // Fires analytics to editor when collab editor cannot sync up
     (0, _defineProperty2.default)(this, "stepRejectCounter", 0);
@@ -507,7 +505,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       (_this$analyticsHelper23 = _this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 || _this$analyticsHelper23.sendActionEvent(_const.EVENT_ACTION.SEND_STEPS_RETRY, _const.EVENT_STATUS.INFO, {
         count: _this.stepRejectCounter
       });
-      var maxRetries = _this.aggressiveCatchup ? _this.failedStepsBeforeCatchupOnPublish : _provider.MAX_STEP_REJECTED_ERROR;
+      var maxRetries = _this.aggressiveCatchup ? _provider.MAX_STEP_REJECTED_ERROR_AGGRESSIVE : _provider.MAX_STEP_REJECTED_ERROR;
       if (_this.stepRejectCounter >= maxRetries) {
         var _this$analyticsHelper24;
         logger("The steps were rejected too many times (tries=".concat(_this.stepRejectCounter, ", limit=").concat(_provider.MAX_STEP_REJECTED_ERROR, "). Trying to catch-up."));
@@ -532,7 +530,6 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
     this.getUserId = getUserId;
     this.onErrorHandled = onErrorHandled;
     this.metadataService = metadataService;
-    this.failedStepsBeforeCatchupOnPublish = failedStepsBeforeCatchupOnPublish;
     this.enableErrorOnFailedDocumentApply = enableErrorOnFailedDocumentApply;
     this.stepQueue = new _stepQueueState.StepQueueState();
   }

package/dist/cjs/provider/index.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.Provider = exports.MAX_STEP_REJECTED_ERROR = void 0;
+exports.Provider = exports.MAX_STEP_REJECTED_ERROR_AGGRESSIVE = exports.MAX_STEP_REJECTED_ERROR = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
@@ -34,6 +34,7 @@ var OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 var PRELOAD_DRAFT_SYNC_PERIOD = 15 * 1000; // 15 seconds
 
 var MAX_STEP_REJECTED_ERROR = exports.MAX_STEP_REJECTED_ERROR = 15;
+var MAX_STEP_REJECTED_ERROR_AGGRESSIVE = exports.MAX_STEP_REJECTED_ERROR_AGGRESSIVE = 2;
 var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
   (0, _inherits2.default)(Provider, _Emitter);
   var _super = _createSuper(Provider);
@@ -267,7 +268,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.failedStepLimitBeforeCatchupOnPublish, _this.config.enableErrorOnFailedDocumentApply);
+    }, _this.onErrorHandled, _this.metadataService, _this.config.enableErrorOnFailedDocumentApply);
     _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.2";
+var version = exports.version = "9.15.3";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

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

@@ -6,7 +6,7 @@ import throttle from 'lodash/throttle';
 import { throttledCommitStep } from '../provider/commit-step';
 import { MEASURE_NAME, startMeasure, stopMeasure } from '../analytics/performance';
 import { JSONTransformer } from '@atlaskit/editor-json-transformer';
-import { MAX_STEP_REJECTED_ERROR } from '../provider';
+import { MAX_STEP_REJECTED_ERROR, MAX_STEP_REJECTED_ERROR_AGGRESSIVE } from '../provider';
 import { catchup } from './catchup';
 import { StepQueueState } from './step-queue-state';
 import { CantSyncUpError, INTERNAL_ERROR_CODE, UpdateDocumentError } from '../errors/error-types';
@@ -29,10 +29,9 @@ export class DocumentService {
    * @param getUserId - Callback to fetch the current user's ID
    * @param onErrorHandled - Callback to handle
    * @param metadataService
-   * @param failedStepsBeforeCatchupOnPublish - Control MAX_STEP_REJECTED_ERROR during page publishes.
    * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
    */
-  constructor(participantsService, analyticsHelper, fetchCatchup, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, failedStepsBeforeCatchupOnPublish = MAX_STEP_REJECTED_ERROR, enableErrorOnFailedDocumentApply = false) {
+  constructor(participantsService, analyticsHelper, fetchCatchup, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, enableErrorOnFailedDocumentApply = false) {
     // Fires analytics to editor when collab editor cannot sync up
     _defineProperty(this, "stepRejectCounter", 0);
     _defineProperty(this, "aggressiveCatchup", false);
@@ -419,7 +418,7 @@ export class DocumentService {
       (_this$analyticsHelper23 = this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 ? void 0 : _this$analyticsHelper23.sendActionEvent(EVENT_ACTION.SEND_STEPS_RETRY, EVENT_STATUS.INFO, {
         count: this.stepRejectCounter
       });
-      let maxRetries = this.aggressiveCatchup ? this.failedStepsBeforeCatchupOnPublish : MAX_STEP_REJECTED_ERROR;
+      let maxRetries = this.aggressiveCatchup ? MAX_STEP_REJECTED_ERROR_AGGRESSIVE : MAX_STEP_REJECTED_ERROR;
       if (this.stepRejectCounter >= maxRetries) {
         var _this$analyticsHelper24;
         logger(`The steps were rejected too many times (tries=${this.stepRejectCounter}, limit=${MAX_STEP_REJECTED_ERROR}). Trying to catch-up.`);
@@ -442,7 +441,6 @@ export class DocumentService {
     this.getUserId = getUserId;
     this.onErrorHandled = onErrorHandled;
     this.metadataService = metadataService;
-    this.failedStepsBeforeCatchupOnPublish = failedStepsBeforeCatchupOnPublish;
     this.enableErrorOnFailedDocumentApply = enableErrorOnFailedDocumentApply;
     this.stepQueue = new StepQueueState();
   }

package/dist/es2019/provider/index.js

@@ -16,6 +16,7 @@ const OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 const PRELOAD_DRAFT_SYNC_PERIOD = 15 * 1000; // 15 seconds
 
 export const MAX_STEP_REJECTED_ERROR = 15;
+export const MAX_STEP_REJECTED_ERROR_AGGRESSIVE = 2;
 export class Provider extends Emitter {
   constructor(config) {
     super();
@@ -220,7 +221,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.failedStepLimitBeforeCatchupOnPublish, 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);
     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.2";
+export const version = "9.15.3";
 export const nextMajorVersion = () => {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

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

@@ -12,7 +12,7 @@ import throttle from 'lodash/throttle';
 import { throttledCommitStep } from '../provider/commit-step';
 import { MEASURE_NAME, startMeasure, stopMeasure } from '../analytics/performance';
 import { JSONTransformer } from '@atlaskit/editor-json-transformer';
-import { MAX_STEP_REJECTED_ERROR } from '../provider';
+import { MAX_STEP_REJECTED_ERROR, MAX_STEP_REJECTED_ERROR_AGGRESSIVE } from '../provider';
 import { catchup } from './catchup';
 import { StepQueueState } from './step-queue-state';
 import { CantSyncUpError, INTERNAL_ERROR_CODE, UpdateDocumentError } from '../errors/error-types';
@@ -35,13 +35,11 @@ export var DocumentService = /*#__PURE__*/function () {
    * @param getUserId - Callback to fetch the current user's ID
    * @param onErrorHandled - Callback to handle
    * @param metadataService
-   * @param failedStepsBeforeCatchupOnPublish - Control MAX_STEP_REJECTED_ERROR during page publishes.
    * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
    */
   function DocumentService(participantsService, analyticsHelper, fetchCatchup, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService) {
     var _this = this;
-    var failedStepsBeforeCatchupOnPublish = arguments.length > 9 && arguments[9] !== undefined ? arguments[9] : MAX_STEP_REJECTED_ERROR;
-    var enableErrorOnFailedDocumentApply = arguments.length > 10 && arguments[10] !== undefined ? arguments[10] : false;
+    var enableErrorOnFailedDocumentApply = arguments.length > 9 && arguments[9] !== undefined ? arguments[9] : false;
     _classCallCheck(this, DocumentService);
     // Fires analytics to editor when collab editor cannot sync up
     _defineProperty(this, "stepRejectCounter", 0);
@@ -500,7 +498,7 @@ export var DocumentService = /*#__PURE__*/function () {
       (_this$analyticsHelper23 = _this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 || _this$analyticsHelper23.sendActionEvent(EVENT_ACTION.SEND_STEPS_RETRY, EVENT_STATUS.INFO, {
         count: _this.stepRejectCounter
       });
-      var maxRetries = _this.aggressiveCatchup ? _this.failedStepsBeforeCatchupOnPublish : MAX_STEP_REJECTED_ERROR;
+      var maxRetries = _this.aggressiveCatchup ? MAX_STEP_REJECTED_ERROR_AGGRESSIVE : MAX_STEP_REJECTED_ERROR;
       if (_this.stepRejectCounter >= maxRetries) {
         var _this$analyticsHelper24;
         logger("The steps were rejected too many times (tries=".concat(_this.stepRejectCounter, ", limit=").concat(MAX_STEP_REJECTED_ERROR, "). Trying to catch-up."));
@@ -525,7 +523,6 @@ export var DocumentService = /*#__PURE__*/function () {
     this.getUserId = getUserId;
     this.onErrorHandled = onErrorHandled;
     this.metadataService = metadataService;
-    this.failedStepsBeforeCatchupOnPublish = failedStepsBeforeCatchupOnPublish;
     this.enableErrorOnFailedDocumentApply = enableErrorOnFailedDocumentApply;
     this.stepQueue = new StepQueueState();
   }

package/dist/esm/provider/index.js

@@ -27,6 +27,7 @@ var OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 var PRELOAD_DRAFT_SYNC_PERIOD = 15 * 1000; // 15 seconds
 
 export var MAX_STEP_REJECTED_ERROR = 15;
+export var MAX_STEP_REJECTED_ERROR_AGGRESSIVE = 2;
 export var Provider = /*#__PURE__*/function (_Emitter) {
   _inherits(Provider, _Emitter);
   var _super = _createSuper(Provider);
@@ -260,7 +261,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.failedStepLimitBeforeCatchupOnPublish, _this.config.enableErrorOnFailedDocumentApply);
+    }, _this.onErrorHandled, _this.metadataService, _this.config.enableErrorOnFailedDocumentApply);
     _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.2";
+export var version = "9.15.3";
 export var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

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

@@ -18,7 +18,6 @@ export declare class DocumentService {
     private getUserId;
     private onErrorHandled;
     private metadataService;
-    private failedStepsBeforeCatchupOnPublish;
     private enableErrorOnFailedDocumentApply;
     private getState;
     private onSyncUpError?;
@@ -38,10 +37,9 @@ export declare class DocumentService {
      * @param getUserId - Callback to fetch the current user's ID
      * @param onErrorHandled - Callback to handle
      * @param metadataService
-     * @param failedStepsBeforeCatchupOnPublish - Control MAX_STEP_REJECTED_ERROR during page publishes.
      * @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, failedStepsBeforeCatchupOnPublish?: number, 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);
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      */

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

@@ -4,6 +4,7 @@ import { Emitter } from '../emitter';
 import type { Config } from '../types';
 import type { CollabEditProvider, CollabEvents, CollabTelepointerPayload, ResolvedEditorState, Metadata, SyncUpErrorFunction } from '@atlaskit/editor-common/collab';
 export declare const MAX_STEP_REJECTED_ERROR = 15;
+export declare const MAX_STEP_REJECTED_ERROR_AGGRESSIVE = 2;
 type BaseEvents = Pick<CollabEditProvider<CollabEvents>, 'setup' | 'send' | 'sendMessage'>;
 export declare class Provider extends Emitter<CollabEvents> implements BaseEvents {
     private channel;

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

@@ -18,7 +18,6 @@ export declare class DocumentService {
     private getUserId;
     private onErrorHandled;
     private metadataService;
-    private failedStepsBeforeCatchupOnPublish;
     private enableErrorOnFailedDocumentApply;
     private getState;
     private onSyncUpError?;
@@ -38,10 +37,9 @@ export declare class DocumentService {
      * @param getUserId - Callback to fetch the current user's ID
      * @param onErrorHandled - Callback to handle
      * @param metadataService
-     * @param failedStepsBeforeCatchupOnPublish - Control MAX_STEP_REJECTED_ERROR during page publishes.
      * @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, failedStepsBeforeCatchupOnPublish?: number, 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);
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      */

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

@@ -4,6 +4,7 @@ import { Emitter } from '../emitter';
 import type { Config } from '../types';
 import type { CollabEditProvider, CollabEvents, CollabTelepointerPayload, ResolvedEditorState, Metadata, SyncUpErrorFunction } from '@atlaskit/editor-common/collab';
 export declare const MAX_STEP_REJECTED_ERROR = 15;
+export declare const MAX_STEP_REJECTED_ERROR_AGGRESSIVE = 2;
 type BaseEvents = Pick<CollabEditProvider<CollabEvents>, 'setup' | 'send' | 'sendMessage'>;
 export declare class Provider extends Emitter<CollabEvents> implements BaseEvents {
     private channel;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.15.2",
+  "version": "9.15.3",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -36,7 +36,7 @@
   "dependencies": {
     "@atlaskit/analytics-gas-types": "^5.1.0",
     "@atlaskit/analytics-listeners": "^8.7.0",
-    "@atlaskit/editor-common": "^76.11.0",
+    "@atlaskit/editor-common": "^76.15.0",
     "@atlaskit/editor-json-transformer": "^8.10.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
     "@atlaskit/prosemirror-collab": "^0.2.0",