@atlaskit/collab-provider 8.3.0 → 8.5.0

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

@@ -0,0 +1,495 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
+import { getVersion, sendableSteps } from '@atlaskit/prosemirror-collab';
+import { createLogger, sleep } from '../helpers/utils';
+import throttle from 'lodash/throttle';
+import { MEASURE_NAME, startMeasure, stopMeasure } from '../analytics/performance';
+import { JSONTransformer } from '@atlaskit/editor-json-transformer';
+import { MAX_STEP_REJECTED_ERROR, throttledCommitStep } from '../provider';
+import { catchup } from './catchup';
+import isEqual from 'lodash/isEqual';
+import { StepQueueState } from './step-queue-state';
+import { INTERNAL_ERROR_CODE } from '../errors/error-types';
+const CATCHUP_THROTTLE = 1 * 1000; // 1 second
+
+const noop = () => {};
+const logger = createLogger('documentService', 'black');
+export class DocumentService {
+  // Fires analytics to editor when collab editor cannot sync up
+
+  /**
+   *
+   * @param participantsService - The participants service, used when users are detected active when making changes to the document
+   * and to emit their telepointers from steps they add
+   * @param analyticsHelper - Helper for analytics events
+   * @param fetchCatchup - Function to fetch "catchup" data, data required to rebase current steps to the latest version.
+   * @param providerEmitCallback - Callback for emitting events to listeners on the provider
+   * @param broadcastMetadata - Callback for broadcasting metadata changes to other clients
+   * @param broadcast - Callback for broadcasting events to other clients
+   * @param getUserId - Callback to fetch the current user's ID
+   * @param onErrorHandled - Callback to handle
+   */
+  constructor(participantsService, analyticsHelper, fetchCatchup, providerEmitCallback, broadcastMetadata, broadcast, getUserId, onErrorHandled) {
+    _defineProperty(this, "stepRejectCounter", 0);
+    _defineProperty(this, "metadata", {});
+    _defineProperty(this, "onMetadataChanged", metadata => {
+      if (metadata !== undefined && !isEqual(this.metadata, metadata)) {
+        this.metadata = metadata;
+        this.providerEmitCallback('metadata:changed', metadata);
+      }
+    });
+    _defineProperty(this, "getMetaData", () => this.metadata);
+    _defineProperty(this, "throttledCatchup", throttle(() => this.catchup(), CATCHUP_THROTTLE, {
+      leading: false,
+      // TODO: why shouldn't this be leading?
+      trailing: true
+    }));
+    _defineProperty(this, "catchup", async () => {
+      const start = new Date().getTime();
+      // if the queue is already paused, we are busy with something else, so don't proceed.
+      if (this.stepQueue.isPaused()) {
+        logger(`Queue is paused. Aborting.`);
+        return;
+      }
+      this.stepQueue.pauseQueue();
+      try {
+        var _this$analyticsHelper;
+        await catchup({
+          getCurrentPmVersion: this.getCurrentPmVersion,
+          fetchCatchup: this.fetchCatchup,
+          getUnconfirmedSteps: this.getUnconfirmedSteps,
+          filterQueue: this.stepQueue.filterQueue,
+          updateDocumentWithMetadata: this.updateDocumentWithMetadata,
+          applyLocalSteps: this.applyLocalSteps
+        });
+        const latency = new Date().getTime() - start;
+        (_this$analyticsHelper = this.analyticsHelper) === null || _this$analyticsHelper === void 0 ? void 0 : _this$analyticsHelper.sendActionEvent(EVENT_ACTION.CATCHUP, EVENT_STATUS.SUCCESS, {
+          latency
+        });
+      } catch (error) {
+        var _this$analyticsHelper2, _this$analyticsHelper3;
+        const latency = new Date().getTime() - start;
+        (_this$analyticsHelper2 = this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 ? void 0 : _this$analyticsHelper2.sendActionEvent(EVENT_ACTION.CATCHUP, EVENT_STATUS.FAILURE, {
+          latency
+        });
+        (_this$analyticsHelper3 = this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(error, 'Error while catching up');
+        logger(`Catch-Up Failed:`, error.message);
+      } finally {
+        this.stepQueue.resumeQueue();
+        this.processQueue();
+        this.sendStepsFromCurrentState(); // this will eventually retry catchup as it calls commitStep which will either catchup on onStepsAdded or onErrorHandled
+        this.stepRejectCounter = 0;
+      }
+    });
+    _defineProperty(this, "getCurrentPmVersion", () => {
+      var _this$getState;
+      const state = (_this$getState = this.getState) === null || _this$getState === void 0 ? void 0 : _this$getState.call(this);
+      if (!state) {
+        var _this$analyticsHelper4;
+        (_this$analyticsHelper4 = this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendErrorEvent(new Error('No editor state when calling ProseMirror function'), 'getCurrentPmVersion called without state');
+        return 0;
+      }
+      return getVersion(state);
+    });
+    _defineProperty(this, "getCurrentState", async () => {
+      try {
+        var _this$metadata$title, _this$analyticsHelper5;
+        startMeasure(MEASURE_NAME.GET_CURRENT_STATE, this.analyticsHelper);
+
+        // Convert ProseMirror document in Editor state to ADF document
+        const state = this.getState();
+        const adfDocument = new JSONTransformer().encode(state.doc);
+        const currentState = {
+          content: adfDocument,
+          title: (_this$metadata$title = this.metadata.title) === null || _this$metadata$title === void 0 ? void 0 : _this$metadata$title.toString(),
+          stepVersion: getVersion(state)
+        };
+        const measure = stopMeasure(MEASURE_NAME.GET_CURRENT_STATE, this.analyticsHelper);
+        (_this$analyticsHelper5 = this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendActionEvent(EVENT_ACTION.GET_CURRENT_STATE, EVENT_STATUS.SUCCESS, {
+          latency: measure === null || measure === void 0 ? void 0 : measure.duration
+        });
+        return currentState;
+      } catch (error) {
+        var _this$analyticsHelper6, _this$analyticsHelper7;
+        const measure = stopMeasure(MEASURE_NAME.GET_CURRENT_STATE, this.analyticsHelper);
+        (_this$analyticsHelper6 = this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendActionEvent(EVENT_ACTION.GET_CURRENT_STATE, EVENT_STATUS.FAILURE, {
+          latency: measure === null || measure === void 0 ? void 0 : measure.duration
+        });
+        (_this$analyticsHelper7 = this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(error, 'Error while returning ADF version of current draft document');
+        throw error; // Reject the promise so the consumer can react to it failing
+      }
+    });
+    _defineProperty(this, "getUnconfirmedStepsOrigins", () => {
+      var _this$getState2, _sendableSteps;
+      const state = (_this$getState2 = this.getState) === null || _this$getState2 === void 0 ? void 0 : _this$getState2.call(this);
+      if (!state) {
+        var _this$analyticsHelper8;
+        (_this$analyticsHelper8 = this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 ? void 0 : _this$analyticsHelper8.sendErrorEvent(new Error('No editor state when calling ProseMirror function'), 'getUnconfirmedStepsOrigins called without state');
+        return;
+      }
+      return (_sendableSteps = sendableSteps(state)) === null || _sendableSteps === void 0 ? void 0 : _sendableSteps.origins;
+    });
+    _defineProperty(this, "getUnconfirmedSteps", () => {
+      var _this$getState3, _sendableSteps2;
+      const state = (_this$getState3 = this.getState) === null || _this$getState3 === void 0 ? void 0 : _this$getState3.call(this);
+      if (!state) {
+        var _this$analyticsHelper9;
+        (_this$analyticsHelper9 = this.analyticsHelper) === null || _this$analyticsHelper9 === void 0 ? void 0 : _this$analyticsHelper9.sendErrorEvent(new Error('No editor state when calling ProseMirror function'), 'getUnconfirmedSteps called without state');
+        return;
+      }
+      return (_sendableSteps2 = sendableSteps(state)) === null || _sendableSteps2 === void 0 ? void 0 : _sendableSteps2.steps;
+    });
+    _defineProperty(this, "applyLocalSteps", steps => {
+      // Re-apply local steps
+      this.providerEmitCallback('local-steps', {
+        steps
+      });
+    });
+    _defineProperty(this, "updateDocumentWithMetadata", ({
+      doc,
+      version,
+      metadata,
+      reserveCursor
+    }) => {
+      this.providerEmitCallback('init', {
+        doc,
+        version,
+        metadata,
+        ...(reserveCursor ? {
+          reserveCursor
+        } : {})
+      });
+      if (metadata && Object.keys(metadata).length > 0) {
+        this.metadata = metadata;
+        this.providerEmitCallback('metadata:changed', metadata);
+      }
+    });
+    _defineProperty(this, "onStepsAdded", data => {
+      logger(`Received steps`, {
+        steps: data.steps,
+        version: data.version
+      });
+      if (!data.steps) {
+        logger(`No steps.. waiting..`);
+        return;
+      }
+      try {
+        const currentVersion = this.getCurrentPmVersion();
+        const expectedVersion = currentVersion + data.steps.length;
+        if (data.version <= currentVersion) {
+          logger(`Received steps we already have. Ignoring.`);
+        } else if (data.version === expectedVersion) {
+          this.processSteps(data);
+        } else if (data.version > expectedVersion) {
+          logger(`Version too high. Expected "${expectedVersion}" but got "${data.version}. Current local version is ${currentVersion}.`);
+          this.stepQueue.queueSteps(data);
+          this.throttledCatchup();
+        }
+        this.participantsService.updateLastActive(data.steps.map(({
+          userId
+        }) => userId));
+      } catch (stepsAddedError) {
+        var _this$analyticsHelper10;
+        (_this$analyticsHelper10 = this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 ? void 0 : _this$analyticsHelper10.sendErrorEvent(stepsAddedError, 'Error while adding steps in the provider');
+        this.onErrorHandled({
+          message: 'Error while adding steps in the provider',
+          data: {
+            status: 500,
+            // Meaningless, remove when we review error structure
+            code: INTERNAL_ERROR_CODE.ADD_STEPS_ERROR
+          }
+        });
+      }
+    });
+    _defineProperty(this, "onRestore", ({
+      doc,
+      version,
+      metadata
+    }) => {
+      // Preserve the unconfirmed steps to prevent data loss.
+      const unconfirmedSteps = this.getUnconfirmedSteps();
+      try {
+        var _this$analyticsHelper11;
+        // Reset the editor,
+        //  - Replace the document, keep in sync with the server
+        //  - Replace the version number, so editor is in sync with NCS server and can commit new changes.
+        //  - Replace the metadata
+        //  - Reserve the cursor position, in case a cursor jump.
+        this.updateDocumentWithMetadata({
+          doc,
+          version,
+          metadata,
+          reserveCursor: true
+        });
+
+        // Re-apply the unconfirmed steps, not 100% of them can be applied, if document is changed significantly.
+        if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
+          this.applyLocalSteps(unconfirmedSteps);
+        }
+        (_this$analyticsHelper11 = this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 ? void 0 : _this$analyticsHelper11.sendActionEvent(EVENT_ACTION.REINITIALISE_DOCUMENT, EVENT_STATUS.SUCCESS, {
+          numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
+        });
+      } catch (restoreError) {
+        var _this$analyticsHelper12, _this$analyticsHelper13;
+        (_this$analyticsHelper12 = this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 ? void 0 : _this$analyticsHelper12.sendActionEvent(EVENT_ACTION.REINITIALISE_DOCUMENT, EVENT_STATUS.FAILURE, {
+          numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
+        });
+        (_this$analyticsHelper13 = this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 ? void 0 : _this$analyticsHelper13.sendErrorEvent(restoreError, 'Error while reinitialising document');
+        this.onErrorHandled({
+          message: 'Caught error while trying to recover the document',
+          data: {
+            status: 500,
+            // Meaningless, remove when we review error structure
+            code: INTERNAL_ERROR_CODE.DOCUMENT_RESTORE_ERROR
+          }
+        });
+      }
+    });
+    _defineProperty(this, "getFinalAcknowledgedState", async () => {
+      try {
+        var _this$analyticsHelper14;
+        startMeasure(MEASURE_NAME.PUBLISH_PAGE, this.analyticsHelper);
+        await this.commitUnconfirmedSteps();
+        const currentState = await this.getCurrentState();
+        const measure = stopMeasure(MEASURE_NAME.PUBLISH_PAGE, this.analyticsHelper);
+        (_this$analyticsHelper14 = this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 ? void 0 : _this$analyticsHelper14.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, EVENT_STATUS.SUCCESS, {
+          latency: measure === null || measure === void 0 ? void 0 : measure.duration
+        });
+        return currentState;
+      } catch (error) {
+        var _this$analyticsHelper15, _this$analyticsHelper16;
+        const measure = stopMeasure(MEASURE_NAME.PUBLISH_PAGE, this.analyticsHelper);
+        (_this$analyticsHelper15 = this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 ? void 0 : _this$analyticsHelper15.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, EVENT_STATUS.FAILURE, {
+          latency: measure === null || measure === void 0 ? void 0 : measure.duration
+        });
+        (_this$analyticsHelper16 = this.analyticsHelper) === null || _this$analyticsHelper16 === void 0 ? void 0 : _this$analyticsHelper16.sendErrorEvent(error, 'Error while returning ADF version of the final draft document');
+        throw error; // Reject the promise so the consumer can react to it failing
+      }
+    });
+    _defineProperty(this, "commitUnconfirmedSteps", async () => {
+      const unconfirmedSteps = this.getUnconfirmedSteps();
+      try {
+        if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
+          var _this$analyticsHelper17;
+          startMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
+          let count = 0;
+          // We use origins here as steps can be rebased. When steps are rebased a new step is created.
+          // This means that we can not track if it has been removed from the unconfirmed array or not.
+          // Origins points to the original transaction that the step was created in. This is never changed
+          // and gets passed down when a step is rebased.
+          const unconfirmedTrs = this.getUnconfirmedStepsOrigins();
+          const lastTr = unconfirmedTrs === null || unconfirmedTrs === void 0 ? void 0 : unconfirmedTrs[unconfirmedTrs.length - 1];
+          let isLastTrConfirmed = false;
+          while (!isLastTrConfirmed) {
+            this.sendStepsFromCurrentState();
+            await sleep(1000);
+            const nextUnconfirmedSteps = this.getUnconfirmedSteps();
+            if (nextUnconfirmedSteps !== null && nextUnconfirmedSteps !== void 0 && nextUnconfirmedSteps.length) {
+              const nextUnconfirmedTrs = this.getUnconfirmedStepsOrigins();
+              isLastTrConfirmed = !(nextUnconfirmedTrs !== null && nextUnconfirmedTrs !== void 0 && nextUnconfirmedTrs.some(tr => tr === lastTr));
+            } else {
+              isLastTrConfirmed = true;
+            }
+            if (!isLastTrConfirmed && count++ >= ACK_MAX_TRY) {
+              if (this.onSyncUpError) {
+                const state = this.getState();
+                this.onSyncUpError({
+                  lengthOfUnconfirmedSteps: nextUnconfirmedSteps === null || nextUnconfirmedSteps === void 0 ? void 0 : nextUnconfirmedSteps.length,
+                  tries: count,
+                  maxRetries: ACK_MAX_TRY,
+                  clientId: this.clientId,
+                  version: getVersion(state)
+                });
+              }
+              throw new Error("Can't sync up with Collab Service");
+            }
+          }
+          const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
+          (_this$analyticsHelper17 = this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 ? void 0 : _this$analyticsHelper17.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.SUCCESS, {
+            latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+            // upon success, emit the total number of unconfirmed steps we synced
+            numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
+          });
+        }
+      } catch (error) {
+        var _this$analyticsHelper18, _this$analyticsHelper19;
+        const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
+        (_this$analyticsHelper18 = this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.FAILURE, {
+          latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+          numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
+        });
+        (_this$analyticsHelper19 = this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 ? void 0 : _this$analyticsHelper19.sendErrorEvent(error, 'Error while committing unconfirmed steps');
+        throw error;
+      }
+    });
+    _defineProperty(this, "onStepRejectedError", () => {
+      this.stepRejectCounter++;
+      logger(`Steps rejected (tries=${this.stepRejectCounter})`);
+      if (this.stepRejectCounter >= MAX_STEP_REJECTED_ERROR) {
+        logger(`The steps were rejected too many times (tries=${this.stepRejectCounter}, limit=${MAX_STEP_REJECTED_ERROR}). Trying to catch-up.`);
+        this.throttledCatchup();
+      } else {
+        // If committing steps failed try again automatically in 1s
+        // This makes it more likely that unconfirmed steps trigger a catch-up
+        // within 15s even if there is no one editing actively (or draft sync polling)
+        // reducing the risk of data loss at the expense of step commits
+        setTimeout(() => this.sendStepsFromCurrentState(), 1000);
+      }
+    });
+    this.participantsService = participantsService;
+    this.analyticsHelper = analyticsHelper;
+    this.fetchCatchup = fetchCatchup;
+    this.providerEmitCallback = providerEmitCallback;
+    this.broadcastMetadata = broadcastMetadata;
+    this.broadcast = broadcast;
+    this.getUserId = getUserId;
+    this.onErrorHandled = onErrorHandled;
+    this.stepQueue = new StepQueueState();
+  }
+
+  /**
+   * Called when a metadata is changed externally from other clients/backend.
+   */
+
+  setTitle(title, broadcast) {
+    if (broadcast) {
+      this.broadcastMetadata({
+        title
+      });
+    }
+    Object.assign(this.metadata, {
+      title
+    });
+  }
+  setEditorWidth(editorWidth, broadcast) {
+    if (broadcast) {
+      this.broadcastMetadata({
+        editorWidth
+      });
+    }
+    Object.assign(this.metadata, {
+      editorWidth
+    });
+  }
+
+  /**
+   * Updates the local metadata and broadcasts the metadata to other clients/backend.
+   * @param metadata
+   */
+  setMetadata(metadata) {
+    this.broadcastMetadata(metadata);
+    Object.assign(this.metadata, metadata);
+  }
+
+  /**
+   * To prevent calling catchup to often, use lodash throttle to reduce the frequency
+   */
+
+  processQueue() {
+    if (this.stepQueue.isPaused()) {
+      logger(`Queue is paused. Aborting.`);
+      return;
+    }
+    logger(`Looking for processable data.`);
+    if (this.stepQueue.getQueue().length > 0) {
+      const firstItem = this.stepQueue.shift();
+      const currentVersion = this.getCurrentPmVersion();
+      const expectedVersion = currentVersion + firstItem.steps.length;
+      if (firstItem.version === expectedVersion) {
+        logger(`Applying data from queue!`);
+        this.processSteps(firstItem);
+        // recur
+        this.processQueue();
+      }
+    }
+  }
+  processSteps(data) {
+    const {
+      version,
+      steps
+    } = data;
+    logger(`Processing data. Version "${version}".`);
+    if (steps !== null && steps !== void 0 && steps.length) {
+      try {
+        const clientIds = steps.map(({
+          clientId
+        }) => clientId);
+        this.providerEmitCallback('data', {
+          json: steps,
+          version,
+          userIds: clientIds
+        });
+        // If steps can apply to local editor successfully, no need to accumulate the error counter.
+        this.stepRejectCounter = 0;
+        this.participantsService.emitTelepointersFromSteps(steps, this.providerEmitCallback);
+
+        // Resend local steps if none of the received steps originated with us!
+        if (clientIds.indexOf(this.clientId) === -1) {
+          setTimeout(() => this.sendStepsFromCurrentState(), 100);
+        }
+      } catch (error) {
+        var _this$analyticsHelper20;
+        logger(`Processing steps failed with error: ${error}. Triggering catch up call.`);
+        (_this$analyticsHelper20 = this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendErrorEvent(error, 'Error while processing steps');
+        this.throttledCatchup();
+      }
+    }
+  }
+  setup({
+    getState,
+    onSyncUpError,
+    clientId
+  }) {
+    this.getState = getState;
+    this.onSyncUpError = onSyncUpError || noop;
+    this.clientId = clientId;
+    return this;
+  }
+
+  /**
+   * We can use this function to throttle/delay
+   * Any send steps operation
+   *
+   * The getState function will return the current EditorState
+   * from the EditorView.
+   */
+  sendStepsFromCurrentState() {
+    var _this$getState4;
+    const state = (_this$getState4 = this.getState) === null || _this$getState4 === void 0 ? void 0 : _this$getState4.call(this);
+    if (!state) {
+      return;
+    }
+    this.send(null, null, state);
+  }
+  /**
+   * Send steps from transaction to other participants
+   * It needs the superfluous arguments because we keep the interface of the send API the same as the Synchrony plugin
+   */
+  send(_tr, _oldState, newState) {
+    const unconfirmedStepsData = sendableSteps(newState);
+    const version = getVersion(newState);
+
+    // Don't send any steps before we're ready.
+    if (!unconfirmedStepsData) {
+      return;
+    }
+    const unconfirmedSteps = unconfirmedStepsData.steps;
+    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
+    });
+  }
+}

package/dist/es2019/document/step-queue-state.js

@@ -0,0 +1,30 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { createLogger } from '../helpers/utils';
+const logger = createLogger('documentService-queue', 'black');
+export class StepQueueState {
+  constructor() {
+    _defineProperty(this, "queuePaused", false);
+    _defineProperty(this, "queue", []);
+    _defineProperty(this, "getQueue", () => {
+      return this.queue;
+    });
+    _defineProperty(this, "filterQueue", condition => {
+      this.queue = this.queue.filter(condition);
+    });
+    _defineProperty(this, "isPaused", () => this.queuePaused);
+    _defineProperty(this, "pauseQueue", () => {
+      this.queuePaused = true;
+    });
+    _defineProperty(this, "resumeQueue", () => {
+      this.queuePaused = false;
+    });
+    _defineProperty(this, "shift", () => {
+      return this.queue.shift();
+    });
+  }
+  queueSteps(data) {
+    logger(`Queueing data for version "${data.version}".`);
+    const orderedQueue = [...this.queue, data].sort((a, b) => a.version > b.version ? 1 : -1);
+    this.queue = orderedQueue;
+  }
+}

package/dist/es2019/errors/error-code-mapper.js

@@ -0,0 +1,102 @@
+import { NCS_ERROR_CODE } from './error-types';
+import { INTERNAL_ERROR_CODE, PROVIDER_ERROR_CODE } from './error-types';
+
+/*
+ * Maps internal collab provider errors to an emitted error format
+ */
+export const errorCodeMapper = error => {
+  var _error$data, _error$data2, _error$data3;
+  switch ((_error$data = error.data) === null || _error$data === void 0 ? void 0 : _error$data.code) {
+    case NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED:
+    case NCS_ERROR_CODE.VERSION_NUMBER_ALREADY_EXISTS:
+      // This should never be called with these errors
+      return;
+    case INTERNAL_ERROR_CODE.ADD_STEPS_ERROR:
+    case INTERNAL_ERROR_CODE.RECONNECTION_ERROR:
+    case INTERNAL_ERROR_CODE.CONNECTION_ERROR:
+      // These errors shouldn't be emitted, we're hoping the provider self-recovers over time
+      return;
+    case NCS_ERROR_CODE.INSUFFICIENT_EDITING_PERMISSION:
+    case INTERNAL_ERROR_CODE.TOKEN_PERMISSION_ERROR:
+      return {
+        code: PROVIDER_ERROR_CODE.NO_PERMISSION_ERROR,
+        message: 'User does not have permissions to access this document or document is not found',
+        reason: error.data.meta.reason,
+        recoverable: true,
+        status: 403
+      };
+    case NCS_ERROR_CODE.FORBIDDEN_USER_TOKEN:
+      return {
+        code: PROVIDER_ERROR_CODE.INVALID_USER_TOKEN,
+        message: 'The user token was invalid',
+        recoverable: true,
+        status: 403
+      };
+    case INTERNAL_ERROR_CODE.DOCUMENT_NOT_FOUND:
+      return {
+        code: PROVIDER_ERROR_CODE.DOCUMENT_NOT_FOUND,
+        message: 'The requested document is not found',
+        recoverable: true,
+        status: 404
+      };
+    case NCS_ERROR_CODE.TENANT_INSTANCE_MAINTENANCE:
+    case NCS_ERROR_CODE.LOCKED_DOCUMENT:
+      return {
+        code: PROVIDER_ERROR_CODE.LOCKED,
+        message: 'The document is currently not available, please try again later',
+        recoverable: true
+      };
+    case NCS_ERROR_CODE.DYNAMO_ERROR:
+      return {
+        code: PROVIDER_ERROR_CODE.FAIL_TO_SAVE,
+        message: 'Collab service is not able to save changes',
+        recoverable: false,
+        status: 500
+      };
+    case INTERNAL_ERROR_CODE.DOCUMENT_RESTORE_ERROR:
+      return {
+        code: PROVIDER_ERROR_CODE.DOCUMENT_RESTORE_ERROR,
+        message: 'Collab service unable to restore document',
+        recoverable: false,
+        status: 500
+      };
+    case NCS_ERROR_CODE.INIT_DATA_LOAD_FAILED:
+      return {
+        code: PROVIDER_ERROR_CODE.INITIALISATION_ERROR,
+        message: "The initial document couldn't be loaded from the collab service",
+        recoverable: false,
+        status: 500
+      };
+    case INTERNAL_ERROR_CODE.RECONNECTION_NETWORK_ISSUE:
+      return {
+        code: PROVIDER_ERROR_CODE.NETWORK_ISSUE,
+        message: "Couldn't reconnect to the collab service due to network issues",
+        recoverable: true,
+        status: 500
+      };
+    case NCS_ERROR_CODE.NAMESPACE_INVALID:
+    case NCS_ERROR_CODE.INVALID_ACTIVATION_ID:
+    case NCS_ERROR_CODE.INVALID_DOCUMENT_ARI:
+    case NCS_ERROR_CODE.INVALID_CLOUD_ID:
+      return {
+        code: PROVIDER_ERROR_CODE.INVALID_PROVIDER_CONFIGURATION,
+        message: 'Invalid provider configuration',
+        recoverable: false,
+        reason: (_error$data2 = error.data) === null || _error$data2 === void 0 ? void 0 : _error$data2.code,
+        status: 400
+      };
+    case NCS_ERROR_CODE.NAMESPACE_NOT_FOUND:
+    case NCS_ERROR_CODE.ERROR_MAPPING_ERROR:
+    case NCS_ERROR_CODE.EMPTY_BROADCAST:
+    case INTERNAL_ERROR_CODE.CATCHUP_FAILED:
+      return {
+        code: PROVIDER_ERROR_CODE.INTERNAL_SERVICE_ERROR,
+        message: 'Collab Provider experienced an unrecoverable error',
+        recoverable: false,
+        reason: (_error$data3 = error.data) === null || _error$data3 === void 0 ? void 0 : _error$data3.code,
+        status: 500
+      };
+    default:
+      return;
+  }
+};