@atlaskit/collab-provider 8.3.0 → 8.5.0

package/CHANGELOG.md

@@ -1,5 +1,55 @@
 # @atlaskit/collab-provider
 
+## 8.5.0
+
+### Minor Changes
+
+- [`2192c9417d7`](https://bitbucket.org/atlassian/atlassian-frontend/commits/2192c9417d7) - [ESS-3335] Review Collab Provider API error handling & types
+- [`c75fcb75c4e`](https://bitbucket.org/atlassian/atlassian-frontend/commits/c75fcb75c4e) - ESS-3241 Added unit tests for document restore.  
+  ESS-3238 Internal refactor of collab provider, split document code from provider to document service.
+  Remove unused userId field from CollabInitPayload, it is never sent as part of the CollabInitPayload.
+- [`27b106a736b`](https://bitbucket.org/atlassian/atlassian-frontend/commits/27b106a736b) - ESS-3274 Refactor participant logic our of Provider class
+- [`bdd8d88cad0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/bdd8d88cad0) - [ESS-3332] Improved error mapping
+- [`1d52016f25d`](https://bitbucket.org/atlassian/atlassian-frontend/commits/1d52016f25d) - Refactor collab-provider to accept a getAnalyticsClient Promise. And resolve when sending event.
+  Ticket: https://product-fabric.atlassian.net/browse/CCP-2863
+- [`dfd96d6b48a`](https://bitbucket.org/atlassian/atlassian-frontend/commits/dfd96d6b48a) - [ESS-3333] Update to the structure of errors emitted on the collab provider
+
+  Upgrade instructions:
+
+  - Change the type of the errors emitted on the provider from `CollabEventError` to `ProviderError`
+  - Remove the reliance on the `status` field of the emitted errors, switch to using either the error code (exported as enum `PROVIDER_ERROR_CODE`) or the error flag `recoverable` indicating whether the provider can recover from the emitted error or not
+
+  The mapping from the old status codes to the error codes is:
+
+  - Status 403: PROVIDER_ERROR_CODE.NO_PERMISSION_ERROR, PROVIDER_ERROR_CODE.INVALID_USER_TOKEN
+  - Status 404: PROVIDER_ERROR_CODE.DOCUMENT_NOT_FOUND
+  - Status 423: PROVIDER_ERROR_CODE.LOCKED
+  - Status 500: PROVIDER_ERROR_CODE.FAIL_TO_SAVE, PROVIDER_ERROR_CODE.DOCUMENT_RESTORE_ERROR, PROVIDER_ERROR_CODE.INTERNAL_SERVICE_ERROR
+
+- [`078a6d029f0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/078a6d029f0) - ESS-3333 temporarily re-add error status to fix product fabric from breaking changes
+
+### Patch Changes
+
+- [`8217befcee0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8217befcee0) - logs the ignoring of steps for data versions older than current version in DocumentService.onStepsAdded()
+- [`66f07c721c4`](https://bitbucket.org/atlassian/atlassian-frontend/commits/66f07c721c4) - Add JSDoc to provider errors that are emitted to editor
+- Updated dependencies
+
+## 8.4.0
+
+### Minor Changes
+
+- [`eae755e434a`](https://bitbucket.org/atlassian/atlassian-frontend/commits/eae755e434a) - [ESS-3269] Don't return an empty document if something goes wrong when returning the final acknowledge state from the collab provider
+- [`ca548613b49`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ca548613b49) - ESS-3218 Add new configuration option throwOnNotConnected, which will throw not connected errors when attempting to save data whilst client is offline.
+- [`329d3bb4e05`](https://bitbucket.org/atlassian/atlassian-frontend/commits/329d3bb4e05) - ESS-2962: added canCache flag in Config for Collab-provider. Channel now stores token locally if canCache flag is passed. Uses local token for reconnections if connection is lost for errors other that 401 and 403.
+- [`1b9c38c7f48`](https://bitbucket.org/atlassian/atlassian-frontend/commits/1b9c38c7f48) - [ESS-3269] Added error handling and metrics for retrieving the current state
+
+### Patch Changes
+
+- [`2a076027203`](https://bitbucket.org/atlassian/atlassian-frontend/commits/2a076027203) - NO-ISSUE fix the permission error on permissionTokenRefresh
+- [`bde10feab09`](https://bitbucket.org/atlassian/atlassian-frontend/commits/bde10feab09) - Avoid using callbacks when initialising socket connection
+- [`f9a6a671d14`](https://bitbucket.org/atlassian/atlassian-frontend/commits/f9a6a671d14) - add comment to indicate that disconnect handler will be called when Firefox reload
+- Updated dependencies
+
 ## 8.3.0
 
 ### Minor Changes

package/dist/cjs/analytics/{index.js → analytics-helper.js}

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = 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"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
@@ -55,10 +57,11 @@ var triggerAnalyticsEvent = function triggerAnalyticsEvent(analyticsEvent, analy
   }
 };
 var AnalyticsHelper = /*#__PURE__*/function () {
-  function AnalyticsHelper(documentAri, analyticsClient) {
+  function AnalyticsHelper(documentAri, analyticsClient, getAnalyticsClient) {
     (0, _classCallCheck2.default)(this, AnalyticsHelper);
-    this.analyticsClient = analyticsClient;
     this.documentAri = documentAri;
+    this.analyticsClient = analyticsClient;
+    this.getAnalyticsClient = getAnalyticsClient;
   }
   (0, _createClass2.default)(AnalyticsHelper, [{
     key: "sendErrorEvent",
@@ -67,13 +70,14 @@ var AnalyticsHelper = /*#__PURE__*/function () {
         eventAction: _const.EVENT_ACTION.ERROR,
         attributes: {
           documentAri: this.documentAri,
-          errorMessage: errorMessage
+          errorMessage: errorMessage,
+          errorName: error instanceof Error ? error.name : undefined
         },
         nonPrivacySafeAttributes: {
           error: error
         }
       };
-      triggerAnalyticsEvent(errorAnalyticsEvent, this.analyticsClient);
+      this.sendEvent(errorAnalyticsEvent);
     }
   }, {
     key: "sendActionEvent",
@@ -86,8 +90,44 @@ var AnalyticsHelper = /*#__PURE__*/function () {
           eventStatus: status
         }, attributes)
       };
-      triggerAnalyticsEvent(analyticsEvent, this.analyticsClient);
+      this.sendEvent(analyticsEvent);
     }
+  }, {
+    key: "sendEvent",
+    value: function () {
+      var _sendEvent = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(event) {
+        return _regenerator.default.wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                if (!(this.getAnalyticsClient && !this.analyticsClient)) {
+                  _context.next = 9;
+                  break;
+                }
+                _context.prev = 1;
+                _context.next = 4;
+                return this.getAnalyticsClient;
+              case 4:
+                this.analyticsClient = _context.sent;
+                _context.next = 9;
+                break;
+              case 7:
+                _context.prev = 7;
+                _context.t0 = _context["catch"](1);
+              case 9:
+                triggerAnalyticsEvent(event, this.analyticsClient);
+              case 10:
+              case "end":
+                return _context.stop();
+            }
+          }
+        }, _callee, this, [[1, 7]]);
+      }));
+      function sendEvent(_x) {
+        return _sendEvent.apply(this, arguments);
+      }
+      return sendEvent;
+    }()
   }]);
   return AnalyticsHelper;
 }();

package/dist/cjs/analytics/performance.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.MEASURE_NAME = void 0;
+exports.measureMap = exports.isPerformanceAPIAvailable = exports.MEASURE_NAME = void 0;
 exports.startMeasure = startMeasure;
 exports.stopMeasure = stopMeasure;
 var MEASURE_NAME;
@@ -13,17 +13,19 @@ exports.MEASURE_NAME = MEASURE_NAME;
   MEASURE_NAME["DOCUMENT_INIT"] = "documentInit";
   MEASURE_NAME["COMMIT_UNCONFIRMED_STEPS"] = "commitUnconfirmedSteps";
   MEASURE_NAME["PUBLISH_PAGE"] = "publishPage";
+  MEASURE_NAME["GET_CURRENT_STATE"] = "getCurrentState";
 })(MEASURE_NAME || (exports.MEASURE_NAME = MEASURE_NAME = {}));
 var isPerformanceAPIAvailable = function isPerformanceAPIAvailable() {
   return typeof window !== 'undefined' && 'performance' in window && ['measure', 'clearMeasures', 'clearMarks', 'getEntriesByName', 'getEntriesByType'].every(function (api) {
     return !!performance[api];
   });
 };
-var hasPerformanceAPIAvailable = isPerformanceAPIAvailable();
+exports.isPerformanceAPIAvailable = isPerformanceAPIAvailable;
 var measureMap = new Map();
+exports.measureMap = measureMap;
 function startMeasure(measureName, analyticsHelper) {
   try {
-    if (!hasPerformanceAPIAvailable) {
+    if (!isPerformanceAPIAvailable()) {
       return;
     }
     performance.mark("".concat(measureName, "::start"));
@@ -35,7 +37,7 @@ function startMeasure(measureName, analyticsHelper) {
 function stopMeasure(measureName, analyticsHelper, onMeasureComplete) {
   var start;
   try {
-    if (!hasPerformanceAPIAvailable) {
+    if (!isPerformanceAPIAvailable()) {
       return;
     }
 
@@ -73,7 +75,7 @@ function stopMeasure(measureName, analyticsHelper, onMeasureComplete) {
   }
 }
 function clearMeasure(measureName) {
-  if (!hasPerformanceAPIAvailable) {
+  if (!isPerformanceAPIAvailable()) {
     return;
   }
   measureMap.delete(measureName);