@atlaskit/collab-provider 10.9.2 → 10.9.4

package/dist/cjs/errors/ncs-errors.js

@@ -25,7 +25,7 @@ var NCS_ERROR_CODE = exports.NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_C
   NCS_ERROR_CODE["RATE_LIMIT_ERROR"] = "RATE_LIMIT_ERROR";
   NCS_ERROR_CODE["PROSEMIRROR_SCHEMA_VALIDATION_ERROR"] = "PROSEMIRROR_SCHEMA_VALIDATION_ERROR";
   return NCS_ERROR_CODE;
-}({}); // TODO: Import emitted error codes from NCS
+}({}); // TODO: ED-26957 - Import emitted error codes from NCS
 // NCS Errors
 // - Step rejection errors
 // - Permission errors

package/dist/cjs/provider/commit-step.js

@@ -16,7 +16,7 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 var logger = (0, _utils.createLogger)('commit-step', 'black');
 var readyToCommit = exports.readyToCommit = true;
-var RESET_READYTOCOMMIT_INTERVAL_MS = exports.RESET_READYTOCOMMIT_INTERVAL_MS = 20000;
+var RESET_READYTOCOMMIT_INTERVAL_MS = exports.RESET_READYTOCOMMIT_INTERVAL_MS = 5000;
 var commitStepQueue = exports.commitStepQueue = function commitStepQueue(_ref) {
   var broadcast = _ref.broadcast,
     steps = _ref.steps,
@@ -30,7 +30,7 @@ var commitStepQueue = exports.commitStepQueue = function commitStepQueue(_ref) {
     __livePage = _ref.__livePage,
     hasRecovered = _ref.hasRecovered,
     collabMode = _ref.collabMode,
-    forcePublish = _ref.forcePublish;
+    reason = _ref.reason;
   if (!readyToCommit) {
     logger('Not ready to commit, skip');
     return;
@@ -92,8 +92,7 @@ var commitStepQueue = exports.commitStepQueue = function commitStepQueue(_ref) {
       collabMode: collabMode,
       steps: stepsWithClientAndUserId,
       version: version,
-      userId: userId,
-      forcePublish: forcePublish
+      userId: userId
     }, function (response) {
       var latency = new Date().getTime() - start;
       if (timer) {

package/dist/cjs/provider/index.js

@@ -277,27 +277,32 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
      * Used when returning the document to Confluence on publish.
      * @throws {GetFinalAcknowledgedStateError} Something went wrong while returning the acknowledged state
      */
-    (0, _defineProperty2.default)(_this, "getFinalAcknowledgedState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
-      var _this$analyticsHelper5;
-      return _regenerator.default.wrap(function _callee3$(_context3) {
-        while (1) switch (_context3.prev = _context3.next) {
-          case 0:
-            _context3.prev = 0;
-            _context3.next = 3;
-            return _this.documentService.getFinalAcknowledgedState();
-          case 3:
-            return _context3.abrupt("return", _context3.sent);
-          case 6:
-            _context3.prev = 6;
-            _context3.t0 = _context3["catch"](0);
-            (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 || _this$analyticsHelper5.sendErrorEvent(_context3.t0, 'Error while returning ADF version of the final draft document');
-            throw new _customErrors.GetFinalAcknowledgedStateError('Error while returning the final acknowledged state of the draft document', _context3.t0);
-          case 10:
-          case "end":
-            return _context3.stop();
-        }
-      }, _callee3, null, [[0, 6]]);
-    })));
+    (0, _defineProperty2.default)(_this, "getFinalAcknowledgedState", /*#__PURE__*/function () {
+      var _ref7 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(reason) {
+        var _this$analyticsHelper5;
+        return _regenerator.default.wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
+            case 0:
+              _context3.prev = 0;
+              _context3.next = 3;
+              return _this.documentService.getFinalAcknowledgedState(reason);
+            case 3:
+              return _context3.abrupt("return", _context3.sent);
+            case 6:
+              _context3.prev = 6;
+              _context3.t0 = _context3["catch"](0);
+              (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 || _this$analyticsHelper5.sendErrorEvent(_context3.t0, 'Error while returning ADF version of the final draft document');
+              throw new _customErrors.GetFinalAcknowledgedStateError('Error while returning the final acknowledged state of the draft document', _context3.t0);
+            case 10:
+            case "end":
+              return _context3.stop();
+          }
+        }, _callee3, null, [[0, 6]]);
+      }));
+      return function (_x2) {
+        return _ref7.apply(this, arguments);
+      };
+    }());
     (0, _defineProperty2.default)(_this, "getUnconfirmedSteps", function () {
       return _this.documentService.getUnconfirmedSteps();
     });
@@ -354,7 +359,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     }
     _this.sendStepsTimer = setInterval(function () {
       logger('Intervally sendStepsFromCurrentState');
-      _this.documentService.sendStepsFromCurrentState(true);
+      _this.documentService.sendStepsFromCurrentState(true, undefined);
     }, 5000);
     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 = "10.9.2";
+var version = exports.version = "10.9.4";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/channel.js

@@ -139,7 +139,7 @@ export class Channel extends Emitter {
           const measure = stopMeasure(MEASURE_NAME.DOCUMENT_INIT, this.analyticsHelper);
           (_this$initExperience = this.initExperience) === null || _this$initExperience === void 0 ? void 0 : _this$initExperience.success();
           (_this$analyticsHelper6 = this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendActionEvent(EVENT_ACTION.DOCUMENT_INIT,
-          // TODO: detect when document init fails and fire corresponding event for it
+          // TODO: ED-26957 - detect when document init fails and fire corresponding event for it
           EVENT_STATUS.SUCCESS, {
             latency: measure === null || measure === void 0 ? void 0 : measure.duration,
             resetReason: data.resetReason,

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

@@ -1,6 +1,7 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import throttle from 'lodash/throttle';
 import { fg } from '@atlaskit/platform-feature-flags';
+import { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import { getCollabState, sendableSteps } from '@atlaskit/prosemirror-collab';
 import { Transaction } from '@atlaskit/editor-prosemirror/state';
 import { JSONTransformer } from '@atlaskit/editor-json-transformer';
@@ -13,6 +14,7 @@ import { commitStepQueue } from '../provider/commit-step';
 import { CantSyncUpError, UpdateDocumentError } from '../errors/custom-errors';
 import { catchupv2 } from './catchupv2';
 import { StepQueueState } from './step-queue-state';
+import { getConflictChanges } from './getConflictChanges';
 const CATCHUP_THROTTLE = 1 * 1000; // 1 second
 
 const noop = () => {};
@@ -52,7 +54,7 @@ export class DocumentService {
      */
     _defineProperty(this, "throttledCatchupv2", throttle((reason, reconnectionMetadata) => this.catchupv2(reason, reconnectionMetadata), CATCHUP_THROTTLE, {
       leading: false,
-      // TODO: why shouldn't this be leading?
+      // TODO: ED-26957 - why shouldn't this be leading?
       trailing: true
     }));
     /**
@@ -396,14 +398,14 @@ export class DocumentService {
         });
       }
     });
-    _defineProperty(this, "getFinalAcknowledgedState", async () => {
+    _defineProperty(this, "getFinalAcknowledgedState", async reason => {
       this.aggressiveCatchup = true;
       try {
         var _this$analyticsHelper18;
         startMeasure(MEASURE_NAME.PUBLISH_PAGE, this.analyticsHelper);
         let finalAcknowledgedState;
         try {
-          await this.commitUnconfirmedSteps();
+          await this.commitUnconfirmedSteps(reason);
           finalAcknowledgedState = await this.getCurrentState();
         } catch (error) {
           // if fails to commit unconfirmed steps, send reconcile request to NCS BE and return the doc to CC
@@ -522,7 +524,7 @@ export class DocumentService {
      * Commit the unconfirmed local steps to the back-end service
      * @throws {Error} Couldn't sync the steps after retrying 30 times
      */
-    _defineProperty(this, "commitUnconfirmedSteps", async () => {
+    _defineProperty(this, "commitUnconfirmedSteps", async reason => {
       const unconfirmedSteps = this.getUnconfirmedSteps();
       try {
         if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
@@ -542,7 +544,7 @@ export class DocumentService {
           }
           while (!isLastTrConfirmed) {
             // forcePublish = true, this is because commitUnconfirmedSteps is only called when the Editor publishes a document
-            this.sendStepsFromCurrentState(undefined, true);
+            this.sendStepsFromCurrentState(undefined, reason);
             await sleep(500);
             const nextUnconfirmedSteps = this.getUnconfirmedSteps();
             if (nextUnconfirmedSteps !== null && nextUnconfirmedSteps !== void 0 && nextUnconfirmedSteps.length) {
@@ -657,10 +659,22 @@ export class DocumentService {
     const state = (_this$getState7 = this.getState) === null || _this$getState7 === void 0 ? void 0 : _this$getState7.call(this);
     const unconfirmedSteps = state ? (_getCollabState = getCollabState(state)) === null || _getCollabState === void 0 ? void 0 : _getCollabState.unconfirmed : undefined;
     if (steps.length > 0 && state && unconfirmedSteps && unconfirmedSteps.length > 0) {
-      // In the future we can determine the type of conflict
-      this.providerEmitCallback('data:conflict', {
-        offlineDoc: state.doc
+      const {
+        schema,
+        tr
+      } = state;
+      const remoteSteps = steps.map(s => ProseMirrorStep.fromJSON(schema, s));
+      const conflicts = getConflictChanges({
+        localSteps: unconfirmedSteps,
+        remoteSteps,
+        tr
       });
+      if (conflicts.deleted.length > 0 || conflicts.inserted.length > 0) {
+        this.providerEmitCallback('data:conflict', {
+          offlineDoc: state.doc,
+          ...conflicts
+        });
+      }
     }
   }
   processQueue() {
@@ -744,7 +758,7 @@ export class DocumentService {
    * The getState function will return the current EditorState
    * from the EditorView.
    */
-  sendStepsFromCurrentState(sendAnalyticsEvent, forcePublish) {
+  sendStepsFromCurrentState(sendAnalyticsEvent, reason) {
     var _this$getState8;
     const state = (_this$getState8 = this.getState) === null || _this$getState8 === void 0 ? void 0 : _this$getState8.call(this);
     if (!state) {
@@ -752,13 +766,14 @@ export class DocumentService {
       (_this$analyticsHelper33 = this.analyticsHelper) === null || _this$analyticsHelper33 === void 0 ? void 0 : _this$analyticsHelper33.sendErrorEvent(new Error('Editor state is undefined'), 'sendStepsFromCurrentState called without state');
       return;
     }
-    this.send(null, null, state, sendAnalyticsEvent, forcePublish);
+    this.send(null, null, state, sendAnalyticsEvent, reason);
   }
   /**
    * 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, sendAnalyticsEvent, forcePublish) {
+  send(tr, _oldState, newState, sendAnalyticsEvent, reason // only used for publish and draft-sync events - when called through getFinalAcknowledgedState
+  ) {
     const unconfirmedStepsData = sendableSteps(newState);
     const version = this.getVersionFromCollabState(newState, 'collab-provider: send');
 
@@ -841,7 +856,7 @@ export class DocumentService {
       __livePage: this.options.__livePage,
       hasRecovered: this.hasRecovered,
       collabMode: this.participantsService.getCollabMode(),
-      forcePublish
+      reason
     });
   }
 }

package/dist/es2019/document/getConflictChanges.js

@@ -0,0 +1,161 @@
+import { ChangeSet } from 'prosemirror-changeset';
+const simplifySteps = steps => {
+  return steps.reduce((acc, step) => {
+    const lastStep = acc[acc.length - 1];
+    if (lastStep) {
+      const mergedStep = lastStep.merge(step);
+      if (mergedStep) {
+        acc[acc.length - 1] = mergedStep;
+        return acc;
+      }
+    }
+    return acc.concat(step);
+  }, []);
+};
+function findContentChanges(doc, steps) {
+  let changes = ChangeSet.create(doc);
+  let latestDoc = doc;
+  simplifySteps(steps).forEach((step, index) => {
+    const stepResult = step.apply(latestDoc);
+    if (stepResult.failed !== null || stepResult.doc === null) {
+      return;
+    }
+    latestDoc = stepResult.doc;
+    changes = changes.addSteps(latestDoc, [step.getMap()], {
+      step: index
+    });
+  });
+  return changes;
+}
+
+/**
+ * Iterate through the changesets to find overlapping regions that indicate conflicting
+ * changes
+ */
+const getConflicts = ({
+  localChanges,
+  localDoc,
+  remoteChanges,
+  remoteDoc
+}) => {
+  const conflictingChanges = [];
+  localChanges.changes.forEach(localChange => {
+    remoteChanges.changes.forEach(remoteChange => {
+      if (
+      // Local change is inside remote change
+      localChange.fromA >= remoteChange.fromA && localChange.toA <= remoteChange.toA ||
+      // Remote change is inside local change
+      remoteChange.fromA >= localChange.fromA && remoteChange.toA <= localChange.toA ||
+      // Partial overlap with the end
+      localChange.fromA >= remoteChange.fromA && localChange.fromA < remoteChange.toA && localChange.toA > remoteChange.toA ||
+      // Partial overlap with the start
+      localChange.fromA < remoteChange.fromA && localChange.toA > remoteChange.fromA && localChange.toA <= remoteChange.toA) {
+        conflictingChanges.push({
+          from: Math.min(localChange.fromA, remoteChange.fromA),
+          to: Math.max(localChange.toA, remoteChange.toA),
+          local: localDoc.slice(localChange.fromB, localChange.toB, true),
+          remote: remoteDoc.slice(remoteChange.fromB, remoteChange.toB)
+        });
+      }
+    });
+  });
+  return conflictingChanges;
+};
+
+/**
+ * Almost a copy of the rebaseSteps in the collab algorithm (which gets called
+ * synchronously after this).
+ *
+ * This also tracks the intermediate documents so we can generate the changesets
+ * to use for finding any overlapping regions.
+ * See: `packages/editor/prosemirror-collab/src/index.ts`
+ */
+const rebaseSteps = ({
+  localSteps,
+  remoteSteps,
+  tr
+}) => {
+  var _tr$mapping$maps;
+  for (let i = (localSteps === null || localSteps === void 0 ? void 0 : localSteps.length) - 1; i >= 0; i--) {
+    tr.step(localSteps[i].inverted);
+  }
+  const originalDoc = tr.doc;
+  const mapStart = (_tr$mapping$maps = tr.mapping.maps) === null || _tr$mapping$maps === void 0 ? void 0 : _tr$mapping$maps.length;
+  for (let i = 0; i < remoteSteps.length; i++) {
+    tr.step(remoteSteps[i]);
+  }
+  const remoteDoc = tr.doc;
+  for (let i = 0, mapFrom = localSteps.length; i < localSteps.length; i++) {
+    const mapped = localSteps[i].step.map(tr.mapping.slice(mapFrom));
+    mapFrom--;
+    if (mapped && !tr.maybeStep(mapped).failed) {
+      // Open ticket for setMirror https://github.com/ProseMirror/prosemirror/issues/869
+      // @ts-expect-error
+      tr.mapping.setMirror(mapFrom, tr.steps.length - 1);
+    }
+  }
+  return {
+    mapStart,
+    originalDoc,
+    remoteDoc
+  };
+};
+
+/**
+ * Gets the conflicts between the local document and the remote document based on steps.
+ * It assumes the steps will be rebased using the `prosemirror-collab` algorithm synchronously after this
+ * Therefore the `tr` property is based on the document before rebasing.
+ *
+ * In the future we could possibly use `prosemirror-recreate-steps` (or similar approach)
+ * and tweak this to work for arbitrary diffs between offline and remote documents.
+ *
+ * @param localSteps Local steps applied between now and the server steps
+ * @param remoteSteps Steps retrieved from the server
+ * @param tr Transaction of the current document (expected to happen with local steps applied, before remote are applied)
+ * @returns All the conflicts (inserted + deleted) which can be applied to the current document
+ */
+export function getConflictChanges({
+  localSteps,
+  remoteSteps,
+  tr
+}) {
+  const localDoc = tr.doc;
+  const {
+    originalDoc,
+    remoteDoc,
+    mapStart
+  } = rebaseSteps({
+    localSteps,
+    remoteSteps,
+    tr
+  });
+  const localChanges = findContentChanges(originalDoc, localSteps.map(s => s.step));
+  const remoteChanges = findContentChanges(originalDoc, remoteSteps);
+
+  // This is the mapping between the original document and our final one which can be used to
+  // map conflict positions (which are based on the original doc)
+  const mapping = tr.mapping.slice(mapStart);
+
+  // Find the overlapping conflicts - these are based on the positions of the original document so are
+  // common to both local and remote documents.
+  // The above mapping allows us to bring these positions to where they are in the current document
+  const conflictingChanges = getConflicts({
+    localChanges,
+    localDoc,
+    remoteDoc,
+    remoteChanges
+  });
+  const isConflictChange = value => Boolean(value);
+  return {
+    inserted: conflictingChanges.filter(i => i.remote.size !== 0).map(i => ({
+      ...i,
+      from: mapping.map(i.from, -1),
+      to: mapping.map(i.to)
+    })).filter(isConflictChange),
+    deleted: conflictingChanges.filter(d => d.remote.size === 0).map(d => ({
+      ...d,
+      from: mapping.map(d.from),
+      to: mapping.map(d.to)
+    })).filter(isConflictChange)
+  };
+}

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

@@ -17,7 +17,7 @@ export class NullDocumentService {
   getCurrentState() {
     return Promise.resolve({});
   }
-  getFinalAcknowledgedState() {
+  getFinalAcknowledgedState(reason) {
     return Promise.resolve({});
   }
   getIsNamespaceLocked() {

package/dist/es2019/errors/ncs-errors.js

@@ -21,7 +21,7 @@ export let NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
   return NCS_ERROR_CODE;
 }({});
 
-// TODO: Import emitted error codes from NCS
+// TODO: ED-26957 - Import emitted error codes from NCS
 
 // NCS Errors
 // - Step rejection errors

package/dist/es2019/provider/commit-step.js

@@ -6,7 +6,7 @@ import { NCS_ERROR_CODE } from '../errors/ncs-errors';
 import { createLogger } from '../helpers/utils';
 const logger = createLogger('commit-step', 'black');
 export let readyToCommit = true;
-export const RESET_READYTOCOMMIT_INTERVAL_MS = 20000;
+export const RESET_READYTOCOMMIT_INTERVAL_MS = 5000;
 export const commitStepQueue = ({
   broadcast,
   steps,
@@ -20,7 +20,7 @@ export const commitStepQueue = ({
   __livePage,
   hasRecovered,
   collabMode,
-  forcePublish
+  reason
 }) => {
   if (!readyToCommit) {
     logger('Not ready to commit, skip');
@@ -84,8 +84,7 @@ export const commitStepQueue = ({
       collabMode,
       steps: stepsWithClientAndUserId,
       version,
-      userId,
-      forcePublish
+      userId
     }, response => {
       const latency = new Date().getTime() - start;
       if (timer) {

package/dist/es2019/provider/index.js

@@ -228,9 +228,9 @@ export class Provider extends Emitter {
      * Used when returning the document to Confluence on publish.
      * @throws {GetFinalAcknowledgedStateError} Something went wrong while returning the acknowledged state
      */
-    _defineProperty(this, "getFinalAcknowledgedState", async () => {
+    _defineProperty(this, "getFinalAcknowledgedState", async reason => {
       try {
-        return await this.documentService.getFinalAcknowledgedState();
+        return await this.documentService.getFinalAcknowledgedState(reason);
       } catch (error) {
         var _this$analyticsHelper5;
         (_this$analyticsHelper5 = this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendErrorEvent(error, 'Error while returning ADF version of the final draft document');
@@ -291,7 +291,7 @@ export class Provider extends Emitter {
     }
     this.sendStepsTimer = setInterval(() => {
       logger('Intervally sendStepsFromCurrentState');
-      this.documentService.sendStepsFromCurrentState(true);
+      this.documentService.sendStepsFromCurrentState(true, undefined);
     }, 5000);
   }
   // eslint-disable-next-line @repo/internal/deprecations/deprecation-ticket-required -- Ignored via go/ED-25883

package/dist/es2019/version-wrapper.js

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

package/dist/esm/channel.js

@@ -196,7 +196,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
           var measure = stopMeasure(MEASURE_NAME.DOCUMENT_INIT, _this.analyticsHelper);
           (_this$initExperience = _this.initExperience) === null || _this$initExperience === void 0 || _this$initExperience.success();
           (_this$analyticsHelper6 = _this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 || _this$analyticsHelper6.sendActionEvent(EVENT_ACTION.DOCUMENT_INIT,
-          // TODO: detect when document init fails and fire corresponding event for it
+          // TODO: ED-26957 - detect when document init fails and fire corresponding event for it
           EVENT_STATUS.SUCCESS, {
             latency: measure === null || measure === void 0 ? void 0 : measure.duration,
             resetReason: data.resetReason,