@atlaskit/collab-provider 9.17.4 → 9.18.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/collab-provider
 
+## 9.18.0
+
+### Minor Changes
+
+- [#57982](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/57982) [`858a68983294`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/858a68983294) - removing catchup logic for stale draft
+
+## 9.17.5
+
+### Patch Changes
+
+- [#57454](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/57454) [`3f18e6719122`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/3f18e6719122) - Add provider error code logging
+
 ## 9.17.4
 
 ### Patch Changes

package/dist/cjs/analytics/analytics-helper.js

@@ -96,6 +96,20 @@ var AnalyticsHelper = exports.default = /*#__PURE__*/function () {
       };
       this.sendEvent(errorAnalyticsEvent);
     }
+  }, {
+    key: "sendProviderErrorEvent",
+    value: function sendProviderErrorEvent(error) {
+      var errorAnalyticsEvent = {
+        eventAction: _const.EVENT_ACTION.ERROR,
+        attributes: {
+          documentAri: this.documentAri,
+          errorMessage: 'Error emitted',
+          errorCode: error.code,
+          mappedError: error
+        }
+      };
+      this.sendEvent(errorAnalyticsEvent);
+    }
   }, {
     key: "sendActionEvent",
     value: function sendActionEvent(action, status, attributes // This breaks discriminated unions, because there is no obvious field to discriminate against any more

package/dist/cjs/provider/index.js

@@ -32,7 +32,6 @@ function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflec
 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');
 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;
@@ -108,22 +107,15 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
 
         // Early initialization with initial draft passed via provider
         if (_this.initialDraft && initialized && !_this.isProviderInitialized) {
-          // Call catchup if the draft has become stale since being passed to provider
-          if (_this.isDraftTimestampStale()) {
-            _this.documentService.throttledCatchup();
-          }
-          // If the initial draft is already up to date, update the document with that of the initial draft
-          else {
-            var _this$initialDraft = _this.initialDraft,
-              document = _this$initialDraft.document,
-              version = _this$initialDraft.version,
-              metadata = _this$initialDraft.metadata;
-            _this.updateDocumentAndMetadata({
-              doc: document,
-              version: version,
-              metadata: metadata
-            });
-          }
+          var _this$initialDraft = _this.initialDraft,
+            document = _this$initialDraft.document,
+            version = _this$initialDraft.version,
+            metadata = _this$initialDraft.metadata;
+          _this.updateDocumentAndMetadata({
+            doc: document,
+            version: version,
+            metadata: metadata
+          });
         }
         // If already initialized, `connected` means reconnected
         if (initialized && _this.disconnectedAt &&
@@ -173,10 +165,10 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
         var _this$analyticsHelper2;
         (_this$analyticsHelper2 = _this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 || _this$analyticsHelper2.sendErrorEvent(error, 'Error handled');
         var mappedError = (0, _errorCodeMapper.errorCodeMapper)(error);
-        // Temporarily only emit errors to Confluence very intentionally because they will disconnect the collab provider
+        // Only emit errors to Confluence very intentionally because they will disconnect the collab provider
         if (mappedError) {
           var _this$analyticsHelper3;
-          (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 || _this$analyticsHelper3.sendErrorEvent(mappedError, 'Error emitted');
+          (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 || _this$analyticsHelper3.sendProviderErrorEvent(mappedError);
           _this.emit('error', mappedError);
         }
       }
@@ -362,21 +354,6 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
       }
     }
 
-    /**
-     * Checks the provider's initial draft timestamp to determine if it is stale.
-     * Returns true only if the time elapsed since the draft timestamp is greater than or
-     * equal to a predetermined timeout. Returns false in all other cases.
-     */
-  }, {
-    key: "isDraftTimestampStale",
-    value: function isDraftTimestampStale() {
-      var _this$initialDraft3;
-      if (!((_this$initialDraft3 = this.initialDraft) !== null && _this$initialDraft3 !== void 0 && _this$initialDraft3.timestamp)) {
-        return false;
-      }
-      return Date.now() - this.initialDraft.timestamp >= PRELOAD_DRAFT_SYNC_PERIOD;
-    }
-
     /**
      * Send steps from transaction to NCS (and as a consequence to other participants), called from the collab-edit plugin in the editor
      * @param {Transaction} _tr Deprecated, included to keep API consistent with Synchrony provider

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.17.4";
+var version = exports.version = "9.18.0";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/analytics/analytics-helper.js

@@ -81,6 +81,18 @@ export default class AnalyticsHelper {
     };
     this.sendEvent(errorAnalyticsEvent);
   }
+  sendProviderErrorEvent(error) {
+    const errorAnalyticsEvent = {
+      eventAction: EVENT_ACTION.ERROR,
+      attributes: {
+        documentAri: this.documentAri,
+        errorMessage: 'Error emitted',
+        errorCode: error.code,
+        mappedError: error
+      }
+    };
+    this.sendEvent(errorAnalyticsEvent);
+  }
   sendActionEvent(action, status, attributes // This breaks discriminated unions, because there is no obvious field to discriminate against any more
   ) {
     const analyticsEvent = {

package/dist/es2019/provider/index.js

@@ -14,7 +14,6 @@ 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
 
 export const MAX_STEP_REJECTED_ERROR = 15;
 export const MAX_STEP_REJECTED_ERROR_AGGRESSIVE = 2;
@@ -86,23 +85,16 @@ export class Provider extends Emitter {
 
         // Early initialization with initial draft passed via provider
         if (this.initialDraft && initialized && !this.isProviderInitialized) {
-          // Call catchup if the draft has become stale since being passed to provider
-          if (this.isDraftTimestampStale()) {
-            this.documentService.throttledCatchup();
-          }
-          // If the initial draft is already up to date, update the document with that of the initial draft
-          else {
-            const {
-              document,
-              version,
-              metadata
-            } = this.initialDraft;
-            this.updateDocumentAndMetadata({
-              doc: document,
-              version,
-              metadata
-            });
-          }
+          const {
+            document,
+            version,
+            metadata
+          } = this.initialDraft;
+          this.updateDocumentAndMetadata({
+            doc: document,
+            version,
+            metadata
+          });
         }
         // If already initialized, `connected` means reconnected
         if (initialized && this.disconnectedAt &&
@@ -151,10 +143,10 @@ export class Provider extends Emitter {
         var _this$analyticsHelper2;
         (_this$analyticsHelper2 = this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 ? void 0 : _this$analyticsHelper2.sendErrorEvent(error, 'Error handled');
         const mappedError = errorCodeMapper(error);
-        // Temporarily only emit errors to Confluence very intentionally because they will disconnect the collab provider
+        // Only emit errors to Confluence very intentionally because they will disconnect the collab provider
         if (mappedError) {
           var _this$analyticsHelper3;
-          (_this$analyticsHelper3 = this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(mappedError, 'Error emitted');
+          (_this$analyticsHelper3 = this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendProviderErrorEvent(mappedError);
           this.emit('error', mappedError);
         }
       }
@@ -307,19 +299,6 @@ export class Provider extends Emitter {
     }
   }
 
-  /**
-   * Checks the provider's initial draft timestamp to determine if it is stale.
-   * Returns true only if the time elapsed since the draft timestamp is greater than or
-   * equal to a predetermined timeout. Returns false in all other cases.
-   */
-  isDraftTimestampStale() {
-    var _this$initialDraft;
-    if (!((_this$initialDraft = this.initialDraft) !== null && _this$initialDraft !== void 0 && _this$initialDraft.timestamp)) {
-      return false;
-    }
-    return Date.now() - this.initialDraft.timestamp >= PRELOAD_DRAFT_SYNC_PERIOD;
-  }
-
   /**
    * Send steps from transaction to NCS (and as a consequence to other participants), called from the collab-edit plugin in the editor
    * @param {Transaction} _tr Deprecated, included to keep API consistent with Synchrony provider

package/dist/es2019/version-wrapper.js

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

package/dist/esm/analytics/analytics-helper.js

@@ -89,6 +89,20 @@ var AnalyticsHelper = /*#__PURE__*/function () {
       };
       this.sendEvent(errorAnalyticsEvent);
     }
+  }, {
+    key: "sendProviderErrorEvent",
+    value: function sendProviderErrorEvent(error) {
+      var errorAnalyticsEvent = {
+        eventAction: EVENT_ACTION.ERROR,
+        attributes: {
+          documentAri: this.documentAri,
+          errorMessage: 'Error emitted',
+          errorCode: error.code,
+          mappedError: error
+        }
+      };
+      this.sendEvent(errorAnalyticsEvent);
+    }
   }, {
     key: "sendActionEvent",
     value: function sendActionEvent(action, status, attributes // This breaks discriminated unions, because there is no obvious field to discriminate against any more

package/dist/esm/provider/index.js

@@ -25,7 +25,6 @@ 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
 
 export var MAX_STEP_REJECTED_ERROR = 15;
 export var MAX_STEP_REJECTED_ERROR_AGGRESSIVE = 2;
@@ -101,22 +100,15 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
 
         // Early initialization with initial draft passed via provider
         if (_this.initialDraft && initialized && !_this.isProviderInitialized) {
-          // Call catchup if the draft has become stale since being passed to provider
-          if (_this.isDraftTimestampStale()) {
-            _this.documentService.throttledCatchup();
-          }
-          // If the initial draft is already up to date, update the document with that of the initial draft
-          else {
-            var _this$initialDraft = _this.initialDraft,
-              document = _this$initialDraft.document,
-              version = _this$initialDraft.version,
-              metadata = _this$initialDraft.metadata;
-            _this.updateDocumentAndMetadata({
-              doc: document,
-              version: version,
-              metadata: metadata
-            });
-          }
+          var _this$initialDraft = _this.initialDraft,
+            document = _this$initialDraft.document,
+            version = _this$initialDraft.version,
+            metadata = _this$initialDraft.metadata;
+          _this.updateDocumentAndMetadata({
+            doc: document,
+            version: version,
+            metadata: metadata
+          });
         }
         // If already initialized, `connected` means reconnected
         if (initialized && _this.disconnectedAt &&
@@ -166,10 +158,10 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         var _this$analyticsHelper2;
         (_this$analyticsHelper2 = _this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 || _this$analyticsHelper2.sendErrorEvent(error, 'Error handled');
         var mappedError = errorCodeMapper(error);
-        // Temporarily only emit errors to Confluence very intentionally because they will disconnect the collab provider
+        // Only emit errors to Confluence very intentionally because they will disconnect the collab provider
         if (mappedError) {
           var _this$analyticsHelper3;
-          (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 || _this$analyticsHelper3.sendErrorEvent(mappedError, 'Error emitted');
+          (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 || _this$analyticsHelper3.sendProviderErrorEvent(mappedError);
           _this.emit('error', mappedError);
         }
       }
@@ -355,21 +347,6 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       }
     }
 
-    /**
-     * Checks the provider's initial draft timestamp to determine if it is stale.
-     * Returns true only if the time elapsed since the draft timestamp is greater than or
-     * equal to a predetermined timeout. Returns false in all other cases.
-     */
-  }, {
-    key: "isDraftTimestampStale",
-    value: function isDraftTimestampStale() {
-      var _this$initialDraft3;
-      if (!((_this$initialDraft3 = this.initialDraft) !== null && _this$initialDraft3 !== void 0 && _this$initialDraft3.timestamp)) {
-        return false;
-      }
-      return Date.now() - this.initialDraft.timestamp >= PRELOAD_DRAFT_SYNC_PERIOD;
-    }
-
     /**
      * Send steps from transaction to NCS (and as a consequence to other participants), called from the collab-edit plugin in the editor
      * @param {Transaction} _tr Deprecated, included to keep API consistent with Synchrony provider

package/dist/esm/version-wrapper.js

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

package/dist/types/analytics/analytics-helper.d.ts

@@ -1,4 +1,5 @@
 import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
+import type { ProviderError } from '@atlaskit/editor-common/collab';
 import type { ActionAnalyticsEvent, EVENT_STATUS } from '../helpers/const';
 export default class AnalyticsHelper {
     analyticsClient: AnalyticsWebClient | undefined;
@@ -6,6 +7,7 @@ export default class AnalyticsHelper {
     documentAri: string;
     constructor(documentAri: string, analyticsClient?: AnalyticsWebClient, getAnalyticsClient?: Promise<AnalyticsWebClient>);
     sendErrorEvent(error: unknown, errorMessage: string): void;
+    sendProviderErrorEvent(error: ProviderError): void;
     sendActionEvent(action: ActionAnalyticsEvent['eventAction'], status: EVENT_STATUS, attributes?: Omit<ActionAnalyticsEvent['attributes'], 'documentAri' | 'eventStatus'>): void;
     private sendEvent;
 }

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

@@ -52,7 +52,7 @@ export type ErrorAnalyticsEvent = {
         documentAri?: string;
         mappedError?: ProviderError;
     } & DocumentUpdateErrorAttributes;
-    nonPrivacySafeAttributes: {
+    nonPrivacySafeAttributes?: {
         error: unknown;
     };
 };

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

@@ -63,12 +63,6 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
         onSyncUpError?: SyncUpErrorFunction;
     }): this;
     private checkForCookies;
-    /**
-     * Checks the provider's initial draft timestamp to determine if it is stale.
-     * Returns true only if the time elapsed since the draft timestamp is greater than or
-     * equal to a predetermined timeout. Returns false in all other cases.
-     */
-    private isDraftTimestampStale;
     /**
      * Send steps from transaction to NCS (and as a consequence to other participants), called from the collab-edit plugin in the editor
      * @param {Transaction} _tr Deprecated, included to keep API consistent with Synchrony provider

package/dist/types/types.d.ts

@@ -20,7 +20,6 @@ export interface InitialDraft {
     document: JSONDocNode;
     version: number;
     metadata?: Metadata;
-    timestamp?: number;
 }
 export interface Config {
     url: string;

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

@@ -1,4 +1,5 @@
 import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
+import type { ProviderError } from '@atlaskit/editor-common/collab';
 import type { ActionAnalyticsEvent, EVENT_STATUS } from '../helpers/const';
 export default class AnalyticsHelper {
     analyticsClient: AnalyticsWebClient | undefined;
@@ -6,6 +7,7 @@ export default class AnalyticsHelper {
     documentAri: string;
     constructor(documentAri: string, analyticsClient?: AnalyticsWebClient, getAnalyticsClient?: Promise<AnalyticsWebClient>);
     sendErrorEvent(error: unknown, errorMessage: string): void;
+    sendProviderErrorEvent(error: ProviderError): void;
     sendActionEvent(action: ActionAnalyticsEvent['eventAction'], status: EVENT_STATUS, attributes?: Omit<ActionAnalyticsEvent['attributes'], 'documentAri' | 'eventStatus'>): void;
     private sendEvent;
 }

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

@@ -52,7 +52,7 @@ export type ErrorAnalyticsEvent = {
         documentAri?: string;
         mappedError?: ProviderError;
     } & DocumentUpdateErrorAttributes;
-    nonPrivacySafeAttributes: {
+    nonPrivacySafeAttributes?: {
         error: unknown;
     };
 };

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

@@ -63,12 +63,6 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
         onSyncUpError?: SyncUpErrorFunction;
     }): this;
     private checkForCookies;
-    /**
-     * Checks the provider's initial draft timestamp to determine if it is stale.
-     * Returns true only if the time elapsed since the draft timestamp is greater than or
-     * equal to a predetermined timeout. Returns false in all other cases.
-     */
-    private isDraftTimestampStale;
     /**
      * Send steps from transaction to NCS (and as a consequence to other participants), called from the collab-edit plugin in the editor
      * @param {Transaction} _tr Deprecated, included to keep API consistent with Synchrony provider

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

@@ -20,7 +20,6 @@ export interface InitialDraft {
     document: JSONDocNode;
     version: number;
     metadata?: Metadata;
-    timestamp?: number;
 }
 export interface Config {
     url: string;

package/package.json

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