@atlaskit/collab-provider 8.2.0 → 8.4.0

package/CHANGELOG.md

@@ -1,5 +1,54 @@
 # @atlaskit/collab-provider
 
+## 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
+
+- [`1d36e909618`](https://bitbucket.org/atlassian/atlassian-frontend/commits/1d36e909618) - Log error on document restore
+- [`0529b1b833c`](https://bitbucket.org/atlassian/atlassian-frontend/commits/0529b1b833c) - Trigger catch up call on process steps failing
+- [`4f005660ce2`](https://bitbucket.org/atlassian/atlassian-frontend/commits/4f005660ce2) - Log step commit errors to analytics
+- [`6034004a812`](https://bitbucket.org/atlassian/atlassian-frontend/commits/6034004a812) - Log errors on reconnection failure
+- [`a261b2a9e6a`](https://bitbucket.org/atlassian/atlassian-frontend/commits/a261b2a9e6a) - [ESS-3183] Catch any errors in Presence functionality so an uncaught error there doesn't impact regular operation of the collab provider
+- [`7f35ae7d99c`](https://bitbucket.org/atlassian/atlassian-frontend/commits/7f35ae7d99c) - [ESS-2815] Added network status to analytics events
+- [`80feb6de229`](https://bitbucket.org/atlassian/atlassian-frontend/commits/80feb6de229) - [ESS-2815] Emit an error to consumers if the reconnections fails 8 times due to the network issues
+- [`611d9c643c6`](https://bitbucket.org/atlassian/atlassian-frontend/commits/611d9c643c6) - [ESS-3183] Retry syncing unconfirmed steps
+
+### Patch Changes
+
+- [`fccc5952d49`](https://bitbucket.org/atlassian/atlassian-frontend/commits/fccc5952d49) - Revert emitting errors to Confluence by default
+- [`0d25bcca6bb`](https://bitbucket.org/atlassian/atlassian-frontend/commits/0d25bcca6bb) - Added more comprehensive error handling for performance/analytics/ufo events in collab provider
+- [`e97495c5748`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e97495c5748) - Extract emitTelepointer logic from Provider
+- [`260d1355cc6`](https://bitbucket.org/atlassian/atlassian-frontend/commits/260d1355cc6) - Reconnect collab provider immediately when browser emits online event.
+- [`5725fb45955`](https://bitbucket.org/atlassian/atlassian-frontend/commits/5725fb45955) - Introduce a file for UFO.
+
+  Introduce a file for commit step logic, which was already separate from the provider class
+
+- [`2b648e4db70`](https://bitbucket.org/atlassian/atlassian-frontend/commits/2b648e4db70) - NO-ISSUE Remove the analytics fall-back after validating acks work as expected
+- [`35c5e7dd9d5`](https://bitbucket.org/atlassian/atlassian-frontend/commits/35c5e7dd9d5) - NO-ISSUE deduplicate the analytics types dependency (again)
+- [`1c255047a29`](https://bitbucket.org/atlassian/atlassian-frontend/commits/1c255047a29) - improve catchup error handling
+- [`c9ad25cf224`](https://bitbucket.org/atlassian/atlassian-frontend/commits/c9ad25cf224) - [ESS-3183] Create abstraction around sending analytics events for errors or action events
+- [`607a34f4426`](https://bitbucket.org/atlassian/atlassian-frontend/commits/607a34f4426) - Pass through the analytics web client in places it was missing
+- [`efb112b06ab`](https://bitbucket.org/atlassian/atlassian-frontend/commits/efb112b06ab) - Move disonnected reason mapper
+- [`9e6ceda8977`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9e6ceda8977) - Provide the reason for a page reset
+- [`6956eedc944`](https://bitbucket.org/atlassian/atlassian-frontend/commits/6956eedc944) - Tighten type definitions on analytics events
+- Updated dependencies
+
 ## 8.2.0
 
 ### Minor Changes

package/dist/cjs/analytics/index.js

@@ -4,34 +4,92 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.triggerAnalyticsEvent = void 0;
+exports.default = void 0;
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _const = require("../helpers/const");
 var _versionWrapper = require("../version-wrapper");
+var _singleton = require("../connectivity/singleton");
 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 EVENT_SUBJECT = 'collab';
+var COLLAB_SERVICE;
+(function (COLLAB_SERVICE) {
+  COLLAB_SERVICE["NCS"] = "ncs";
+  COLLAB_SERVICE["SYNCHRONY"] = "synchrony";
+})(COLLAB_SERVICE || (COLLAB_SERVICE = {}));
 var triggerAnalyticsEvent = function triggerAnalyticsEvent(analyticsEvent, analyticsClient) {
   if (!analyticsClient) {
     return;
   }
   var payload = {
-    actionSubject: _const.EVENT_SUBJECT,
+    actionSubject: EVENT_SUBJECT,
     attributes: _objectSpread({
       packageName: _versionWrapper.name,
       packageVersion: _versionWrapper.version,
-      collabService: _const.COLLAB_SERVICE.NCS
+      collabService: COLLAB_SERVICE.NCS,
+      network: {
+        status: _singleton.network.getStatus()
+      }
     }, analyticsEvent.attributes),
     tags: ['editor'],
     action: analyticsEvent.eventAction,
     source: 'unknown' // Adds zero analytics value, but event validation throws an error if you don't add it :-(
   };
 
+  if (analyticsEvent.eventAction === _const.EVENT_ACTION.ERROR) {
+    payload.nonPrivacySafeAttributes = analyticsEvent.nonPrivacySafeAttributes;
+  }
+
   // Let the browser figure out
   // when it should send those events
-  var requestIdleCallbackFunction = window.requestIdleCallback;
-  var runItLater = typeof requestIdleCallbackFunction === 'function' ? requestIdleCallbackFunction : window.requestAnimationFrame;
-  runItLater(function () {
-    analyticsClient.sendOperationalEvent(payload);
-  });
+  try {
+    var requestIdleCallbackFunction = window.requestIdleCallback;
+    var runItLater = typeof requestIdleCallbackFunction === 'function' ? requestIdleCallbackFunction : window.requestAnimationFrame;
+    runItLater(function () {
+      analyticsClient.sendOperationalEvent(payload);
+    });
+  } catch (error) {
+    // silently fail for now https://product-fabric.atlassian.net/browse/ESS-3112
+  }
 };
-exports.triggerAnalyticsEvent = triggerAnalyticsEvent;
+var AnalyticsHelper = /*#__PURE__*/function () {
+  function AnalyticsHelper(documentAri, analyticsClient) {
+    (0, _classCallCheck2.default)(this, AnalyticsHelper);
+    this.analyticsClient = analyticsClient;
+    this.documentAri = documentAri;
+  }
+  (0, _createClass2.default)(AnalyticsHelper, [{
+    key: "sendErrorEvent",
+    value: function sendErrorEvent(error, errorMessage) {
+      var errorAnalyticsEvent = {
+        eventAction: _const.EVENT_ACTION.ERROR,
+        attributes: {
+          documentAri: this.documentAri,
+          errorMessage: errorMessage,
+          errorName: error instanceof Error ? error.name : undefined
+        },
+        nonPrivacySafeAttributes: {
+          error: error
+        }
+      };
+      triggerAnalyticsEvent(errorAnalyticsEvent, this.analyticsClient);
+    }
+  }, {
+    key: "sendActionEvent",
+    value: function sendActionEvent(action, status, attributes // This breaks discriminated unions, because there is no obvious field to discriminate against any more
+    ) {
+      var analyticsEvent = {
+        eventAction: action,
+        attributes: _objectSpread({
+          documentAri: this.documentAri,
+          eventStatus: status
+        }, attributes)
+      };
+      triggerAnalyticsEvent(analyticsEvent, this.analyticsClient);
+    }
+  }]);
+  return AnalyticsHelper;
+}();
+exports.default = AnalyticsHelper;

package/dist/cjs/analytics/performance.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.MEASURE_NAME = void 0;
-exports.clearMeasure = clearMeasure;
 exports.startMeasure = startMeasure;
 exports.stopMeasure = stopMeasure;
 var MEASURE_NAME;
@@ -12,8 +11,9 @@ exports.MEASURE_NAME = MEASURE_NAME;
 (function (MEASURE_NAME) {
   MEASURE_NAME["SOCKET_CONNECT"] = "socketConnect";
   MEASURE_NAME["DOCUMENT_INIT"] = "documentInit";
-  MEASURE_NAME["CONVERT_PM_TO_ADF"] = "convertPMToADF";
   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) {
@@ -22,45 +22,56 @@ var isPerformanceAPIAvailable = function isPerformanceAPIAvailable() {
 };
 var hasPerformanceAPIAvailable = isPerformanceAPIAvailable();
 var measureMap = new Map();
-function startMeasure(measureName) {
-  if (!hasPerformanceAPIAvailable) {
-    return;
+function startMeasure(measureName, analyticsHelper) {
+  try {
+    if (!hasPerformanceAPIAvailable) {
+      return;
+    }
+    performance.mark("".concat(measureName, "::start"));
+    measureMap.set(measureName, performance.now());
+  } catch (error) {
+    analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(error, 'Error while measuring performance when marking the start');
   }
-  performance.mark("".concat(measureName, "::start"));
-  measureMap.set(measureName, performance.now());
 }
-function stopMeasure(measureName, onMeasureComplete) {
-  if (!hasPerformanceAPIAvailable) {
-    return;
-  }
-
-  // `startMeasure` is not called with `measureName` before.
-  if (!measureMap.get(measureName)) {
-    return;
-  }
-  performance.mark("".concat(measureName, "::end"));
-  var start = onMeasureComplete ? measureMap.get(measureName) : undefined;
+function stopMeasure(measureName, analyticsHelper, onMeasureComplete) {
+  var start;
   try {
+    if (!hasPerformanceAPIAvailable) {
+      return;
+    }
+
+    // `startMeasure` is not called with `measureName` before.
+    if (!measureMap.get(measureName)) {
+      return;
+    }
+    performance.mark("".concat(measureName, "::end"));
+    start = onMeasureComplete ? measureMap.get(measureName) : undefined;
     performance.measure(measureName, "".concat(measureName, "::start"), "".concat(measureName, "::end"));
-  } catch (e) {}
-  var entry = performance.getEntriesByName(measureName).pop();
-  clearMeasure(measureName);
-  var measure;
-  if (entry) {
-    measure = {
-      duration: entry.duration,
-      startTime: entry.startTime
-    };
-  } else if (start) {
-    measure = {
-      duration: performance.now() - start,
-      startTime: start
-    };
+  } catch (error) {
+    analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(error, 'Error while measuring performance when marking the end');
   }
-  if (measure && onMeasureComplete) {
-    onMeasureComplete(measure.duration, measure.startTime);
+  try {
+    var entry = performance.getEntriesByName(measureName).pop();
+    clearMeasure(measureName);
+    var measure;
+    if (entry) {
+      measure = {
+        duration: entry.duration,
+        startTime: entry.startTime
+      };
+    } else if (start) {
+      measure = {
+        duration: performance.now() - start,
+        startTime: start
+      };
+    }
+    if (measure && onMeasureComplete) {
+      onMeasureComplete(measure.duration, measure.startTime);
+    }
+    return measure;
+  } catch (error) {
+    analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(error, 'Error while measuring performance when completing the measurement');
   }
-  return measure;
 }
 function clearMeasure(measureName) {
   if (!hasPerformanceAPIAvailable) {

package/dist/cjs/analytics/ufo.js

@@ -0,0 +1,33 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createDocInitExp = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _ufo = require("@atlaskit/ufo");
+var createDocumentInitExperience = function createDocumentInitExperience() {
+  return new _ufo.UFOExperience('collab-provider.document-init', {
+    type: _ufo.ExperienceTypes.Load,
+    performanceType: _ufo.ExperiencePerformanceTypes.Custom,
+    performanceConfig: {
+      histogram: (0, _defineProperty2.default)({}, _ufo.ExperiencePerformanceTypes.Custom, {
+        duration: '250_500_1000_1500_2000_3000_4000'
+      })
+    }
+  });
+};
+var withErrorHandling = function withErrorHandling(createExperience, analyticsHelper) {
+  var initExperience;
+  try {
+    initExperience = createExperience();
+  } catch (error) {
+    analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(error, 'Error while initialising a UFO experience');
+  }
+  return initExperience;
+};
+var createDocInitExp = function createDocInitExp(analyticsHelper) {
+  return withErrorHandling(createDocumentInitExperience, analyticsHelper);
+};
+exports.createDocInitExp = createDocInitExp;