@atlaskit/collab-provider 8.2.0 → 8.3.0

package/dist/cjs/disconnected-reason-mapper.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.socketIOReasons = exports.DisconnectReason = void 0;
+exports.socketIOReasons = exports.disconnectedReasonMapper = exports.DisconnectReason = void 0;
 // See https://socket.io/docs/v3/client-socket-instance#disconnect for emitted reasons
 var socketIOReasons = {
   IO_CLIENT_DISCONNECT: 'io client disconnect',
@@ -26,4 +26,21 @@ exports.DisconnectReason = DisconnectReason;
   DisconnectReason["SOCKET_ERROR"] = "SOCKET_ERROR";
   DisconnectReason["SOCKET_TIMEOUT"] = "SOCKET_TIMEOUT";
   DisconnectReason["UNKNOWN_DISCONNECT"] = "UNKNOWN_DISCONNECT";
-})(DisconnectReason || (exports.DisconnectReason = DisconnectReason = {}));
+})(DisconnectReason || (exports.DisconnectReason = DisconnectReason = {}));
+var disconnectedReasonMapper = function disconnectedReasonMapper(reason) {
+  switch (reason) {
+    case socketIOReasons.IO_CLIENT_DISCONNECT:
+      return DisconnectReason.CLIENT_DISCONNECT;
+    case socketIOReasons.IO_SERVER_DISCONNECT:
+      return DisconnectReason.SERVER_DISCONNECT;
+    case socketIOReasons.TRANSPORT_CLOSED:
+      return DisconnectReason.SOCKET_CLOSED;
+    case socketIOReasons.TRANSPORT_ERROR:
+      return DisconnectReason.SOCKET_ERROR;
+    case socketIOReasons.PING_TIMEOUT:
+      return DisconnectReason.SOCKET_TIMEOUT;
+    default:
+      return DisconnectReason.UNKNOWN_DISCONNECT;
+  }
+};
+exports.disconnectedReasonMapper = disconnectedReasonMapper;

package/dist/cjs/error-code-mapper.js

@@ -31,6 +31,10 @@ var ErrorCodeMapper = {
     code: 'FAIL_TO_SAVE',
     message: 'Collab service is not able to save changes'
   },
+  restoreError: {
+    code: 'DOCUMENT_RESTORE_ERROR',
+    message: 'Collab service unable to restore document'
+  },
   internalError: {
     code: 'INTERNAL_SERVICE_ERROR',
     message: 'Collab service has experienced an internal server error'
@@ -62,12 +66,23 @@ var errorCodeMapper = function errorCodeMapper(error) {
         code: ErrorCodeMapper.failToSave.code,
         message: ErrorCodeMapper.failToSave.message
       };
-    default:
+    case 'DOCUMENT_RESTORE_ERROR':
+      return {
+        status: 500,
+        code: ErrorCodeMapper.restoreError.code,
+        message: ErrorCodeMapper.restoreError.message
+      };
+    // Temporarily re-added so we don't emit errors to Confluence by default as they will disconnect the collab provider
+    case 'CATCHUP_FAILED':
+    case 'GET_QUERY_TIME_OUT':
+    case 'INIT_DATA_LOAD_FAILED':
       return {
         status: 500,
         code: ErrorCodeMapper.internalError.code,
         message: ErrorCodeMapper.internalError.message
       };
+    default:
+      break;
   }
 };
 exports.errorCodeMapper = errorCodeMapper;

package/dist/cjs/helpers/const.js

@@ -3,28 +3,23 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.EVENT_SUBJECT = exports.EVENT_STATUS = exports.EVENT_ACTION = exports.CONFLUENCE = exports.COLLAB_SERVICE = exports.ADD_STEPS_TYPE = exports.ACK_MAX_TRY = void 0;
-var EVENT_SUBJECT = 'collab';
-exports.EVENT_SUBJECT = EVENT_SUBJECT;
-var COLLAB_SERVICE;
-exports.COLLAB_SERVICE = COLLAB_SERVICE;
-(function (COLLAB_SERVICE) {
-  COLLAB_SERVICE["NCS"] = "ncs";
-  COLLAB_SERVICE["SYNCHRONY"] = "synchrony";
-})(COLLAB_SERVICE || (exports.COLLAB_SERVICE = COLLAB_SERVICE = {}));
+exports.EVENT_STATUS = exports.EVENT_ACTION = exports.CONFLUENCE = exports.ADD_STEPS_TYPE = exports.ACK_MAX_TRY = void 0;
 var EVENT_ACTION;
 exports.EVENT_ACTION = EVENT_ACTION;
 (function (EVENT_ACTION) {
   EVENT_ACTION["CONNECTION"] = "connection";
+  EVENT_ACTION["RECONNECTION"] = "reconnection";
   EVENT_ACTION["CATCHUP"] = "catchup";
   EVENT_ACTION["DOCUMENT_INIT"] = "documentInit";
   EVENT_ACTION["ADD_STEPS"] = "addSteps";
-  EVENT_ACTION["CONVERT_PM_TO_ADF"] = "convertPMToADF";
   EVENT_ACTION["UPDATE_PARTICIPANTS"] = "updateParticipants";
   EVENT_ACTION["COMMIT_UNCONFIRMED_STEPS"] = "commitUnconfirmedSteps";
   EVENT_ACTION["REINITIALISE_DOCUMENT"] = "reinitialiseDocument";
   EVENT_ACTION["INIT_PROVIDER"] = "initProvider";
   EVENT_ACTION["ERROR"] = "error";
+  EVENT_ACTION["MEASURE_PERFORMANCE"] = "measurePerformance";
+  EVENT_ACTION["INIT_UFO_EXPERIENCE"] = "initUFOExperience";
+  EVENT_ACTION["PUBLISH_PAGE"] = "publishPage";
 })(EVENT_ACTION || (exports.EVENT_ACTION = EVENT_ACTION = {}));
 var EVENT_STATUS;
 exports.EVENT_STATUS = EVENT_STATUS;

package/dist/cjs/provider/catchup.js

@@ -42,7 +42,7 @@ function rebaseSteps(steps, mapping) {
 }
 var catchup = /*#__PURE__*/function () {
   var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(opt) {
-    var _yield$opt$fetchCatch, doc, serverStepMaps, serverVersion, metadata, currentPmVersion, _ref2, unconfirmedSteps, _ref3, _unconfirmedSteps, stepMaps, mapping, newUnconfirmedSteps;
+    var _yield$opt$fetchCatch, doc, serverStepMaps, serverVersion, metadata, currentPmVersion, unconfirmedSteps, _unconfirmedSteps, stepMaps, mapping, newUnconfirmedSteps;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) {
         switch (_context.prev = _context.next) {
@@ -61,9 +61,7 @@ var catchup = /*#__PURE__*/function () {
                 logger("Could not determine server version");
               } else if (serverVersion <= currentPmVersion) {
                 // there are no step maps in this case after page recovery
-                _ref2 = opt.getUnconfirmedSteps() || {
-                  steps: []
-                }, unconfirmedSteps = _ref2.steps; // replace the entire document
+                unconfirmedSteps = opt.getUnconfirmedSteps(); // replace the entire document
                 logger("Replacing document: ".concat(doc));
                 logger("getting metadata: ".concat(metadata));
                 // Replace local document and version number
@@ -73,15 +71,13 @@ var catchup = /*#__PURE__*/function () {
                   metadata: metadata,
                   reserveCursor: true
                 });
-                if (unconfirmedSteps.length) {
+                if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
                   opt.applyLocalSteps(unconfirmedSteps);
                 }
               } else {
                 // Please, do not use those steps inside of async
                 // method. That will lead to outdated steps
-                _ref3 = opt.getUnconfirmedSteps() || {
-                  steps: []
-                }, _unconfirmedSteps = _ref3.steps;
+                _unconfirmedSteps = opt.getUnconfirmedSteps();
                 logger("Too far behind[current: v".concat(currentPmVersion, ", server: v").concat(serverVersion, ". ").concat(serverStepMaps.length, " steps need to catchup]"));
                 /**
                  * Remove steps from queue where the version is older than
@@ -108,12 +104,12 @@ var catchup = /*#__PURE__*/function () {
                 // steps back into the editor, so we don't lose any data. But before that, we need to rebase
                 // those steps since their position could be changed after replacing.
                 // https://prosemirror.net/docs/guide/#transform.rebasing
-                if (_unconfirmedSteps.length) {
+                if (_unconfirmedSteps !== null && _unconfirmedSteps !== void 0 && _unconfirmedSteps.length) {
                   // Create StepMap from StepMap JSON
                   // eslint-disable-next-line no-unused-vars
-                  stepMaps = serverStepMaps.map(function (_ref4) {
-                    var ranges = _ref4.ranges,
-                      inverted = _ref4.inverted;
+                  stepMaps = serverStepMaps.map(function (_ref2) {
+                    var ranges = _ref2.ranges,
+                      inverted = _ref2.inverted;
                     // Due to @types/prosemirror-transform mismatch with the actual
                     // constructor, hack to set the `inverted`.
                     var stepMap = new _prosemirrorTransform.StepMap(ranges);

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

@@ -0,0 +1,66 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.commitStep = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _countBy = _interopRequireDefault(require("lodash/countBy"));
+var _const = require("../helpers/const");
+var _types = require("../types");
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+var commitStep = function commitStep(_ref) {
+  var channel = _ref.channel,
+    steps = _ref.steps,
+    version = _ref.version,
+    userId = _ref.userId,
+    clientId = _ref.clientId,
+    onStepsAdded = _ref.onStepsAdded,
+    onErrorHandled = _ref.onErrorHandled,
+    analyticsHelper = _ref.analyticsHelper;
+  var stepsWithClientAndUserId = steps.map(function (step) {
+    return _objectSpread(_objectSpread({}, step.toJSON()), {}, {
+      clientId: clientId,
+      userId: userId
+    });
+  });
+  var start = new Date().getTime();
+  channel.broadcast('steps:commit', {
+    steps: stepsWithClientAndUserId,
+    version: version,
+    userId: userId
+  }, function (response) {
+    var latency = new Date().getTime() - start;
+    if (response.type === _types.AcknowledgementResponseTypes.SUCCESS) {
+      onStepsAdded({
+        steps: stepsWithClientAndUserId,
+        version: response.version
+      });
+      analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendActionEvent(_const.EVENT_ACTION.ADD_STEPS, _const.EVENT_STATUS.SUCCESS, {
+        type: _const.ADD_STEPS_TYPE.ACCEPTED,
+        latency: latency,
+        stepType: (0, _countBy.default)(stepsWithClientAndUserId, function (stepWithClientAndUserId) {
+          return stepWithClientAndUserId.stepType;
+        })
+      });
+    } else if (response.type === _types.AcknowledgementResponseTypes.ERROR) {
+      var _response$error, _response$error$data, _response$error2, _response$error2$data;
+      onErrorHandled(response.error);
+      analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendActionEvent(_const.EVENT_ACTION.ADD_STEPS, _const.EVENT_STATUS.FAILURE, {
+        // User tried committing steps but they were rejected because:
+        // - HEAD_VERSION_UPDATE_FAILED: the collab service's latest stored step tail version didn't correspond to the head version of the first step submitted
+        // - VERSION_NUMBER_ALREADY_EXISTS: while storing the steps there was a conflict meaning someone else wrote steps into the database more quickly
+        type: ((_response$error = response.error) === null || _response$error === void 0 ? void 0 : (_response$error$data = _response$error.data) === null || _response$error$data === void 0 ? void 0 : _response$error$data.code) === 'HEAD_VERSION_UPDATE_FAILED' || ((_response$error2 = response.error) === null || _response$error2 === void 0 ? void 0 : (_response$error2$data = _response$error2.data) === null || _response$error2$data === void 0 ? void 0 : _response$error2$data.code) === 'VERSION_NUMBER_ALREADY_EXISTS' ? _const.ADD_STEPS_TYPE.REJECTED : _const.ADD_STEPS_TYPE.ERROR,
+        latency: latency
+      });
+      analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(response.error, 'Error while adding steps - Acknowledgement Error');
+    } else {
+      analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(
+      // @ts-expect-error We didn't type the invalid type case
+      new Error("Response type: ".concat((response === null || response === void 0 ? void 0 : response.type) || 'No response type')), 'Error while adding steps - Invalid Acknowledgement');
+    }
+  });
+};
+exports.commitStep = commitStep;