@atlaskit/editor-plugin-annotation 2.9.1 → 2.9.3

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlaskit/editor-plugin-annotation
 
+## 2.9.3
+
+### Patch Changes
+
+- [#163361](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/163361)
+  [`76c3619bccda1`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/76c3619bccda1) -
+  Changed the annotation manager feature gate to instead use the existance of the manager rather
+  then a gate
+- Updated dependencies
+
+## 2.9.2
+
+### Patch Changes
+
+- [#162493](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/162493)
+  [`e2fed6abf826b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/e2fed6abf826b) -
+  Added some error reporting anayltics for the new annotation manager
+- Updated dependencies
+
 ## 2.9.1
 
 ### Patch Changes

package/dist/cjs/editor-commands/index.js

@@ -51,13 +51,21 @@ var clearDirtyMark = exports.clearDirtyMark = function clearDirtyMark() {
     type: _types.ACTIONS.INLINE_COMMENT_CLEAR_DIRTY_MARK
   });
 };
-var flushPendingSelections = exports.flushPendingSelections = function flushPendingSelections(canSetAsSelectedAnnotations) {
-  return (0, _pluginFactory.createCommand)({
-    type: _types.ACTIONS.FLUSH_PENDING_SELECTIONS,
-    data: {
-      canSetAsSelectedAnnotations: canSetAsSelectedAnnotations
+var flushPendingSelections = exports.flushPendingSelections = function flushPendingSelections(editorAnalyticsAPI) {
+  return function (canSetAsSelectedAnnotations, errorReason) {
+    var command = {
+      type: _types.ACTIONS.FLUSH_PENDING_SELECTIONS,
+      data: {
+        canSetAsSelectedAnnotations: canSetAsSelectedAnnotations
+      }
+    };
+    if (!!errorReason) {
+      return (0, _pluginFactory.createCommand)(command, function (tr, state) {
+        return _transform.default.addPreemptiveGateErrorAnalytics(editorAnalyticsAPI)(errorReason)(tr, state);
+      });
     }
-  });
+    return (0, _pluginFactory.createCommand)(command);
+  };
 };
 var setPendingSelectedAnnotation = exports.setPendingSelectedAnnotation = function setPendingSelectedAnnotation(id) {
   return (0, _pluginFactory.createCommand)({
@@ -131,32 +139,34 @@ var removeInlineCommentNearSelection = exports.removeInlineCommentNearSelection
     return true;
   };
 };
-var removeInlineCommentFromDoc = exports.removeInlineCommentFromDoc = function removeInlineCommentFromDoc(id) {
-  var supportedNodes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
-  return function (state, dispatch) {
-    var tr = state.tr;
-    state.doc.descendants(function (node, pos) {
-      // Inline comment on mediaInline is not supported as part of comments on media project
-      // Thus, we skip the decoration for mediaInline node
-      if (node.type.name === 'mediaInline') {
-        return false;
-      }
-      var isSupportedBlockNode = node.isBlock && (supportedNodes === null || supportedNodes === void 0 ? void 0 : supportedNodes.includes(node.type.name));
-      node.marks.filter(function (mark) {
-        return mark.type === state.schema.marks.annotation && mark.attrs.id === id;
-      }).forEach(function (mark) {
-        if (isSupportedBlockNode) {
-          tr.removeNodeMark(pos, mark);
-        } else {
-          tr.removeMark(pos, pos + node.nodeSize, mark);
+var removeInlineCommentFromDoc = exports.removeInlineCommentFromDoc = function removeInlineCommentFromDoc(editorAnalyticsAPI) {
+  return function (id) {
+    var supportedNodes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+    return function (state, dispatch) {
+      var tr = state.tr;
+      state.doc.descendants(function (node, pos) {
+        // Inline comment on mediaInline is not supported as part of comments on media project
+        // Thus, we skip the decoration for mediaInline node
+        if (node.type.name === 'mediaInline') {
+          return false;
         }
+        var isSupportedBlockNode = node.isBlock && (supportedNodes === null || supportedNodes === void 0 ? void 0 : supportedNodes.includes(node.type.name));
+        node.marks.filter(function (mark) {
+          return mark.type === state.schema.marks.annotation && mark.attrs.id === id;
+        }).forEach(function (mark) {
+          if (isSupportedBlockNode) {
+            tr.removeNodeMark(pos, mark);
+          } else {
+            tr.removeMark(pos, pos + node.nodeSize, mark);
+          }
+        });
       });
-    });
-    if (dispatch) {
-      dispatch(tr);
-      return true;
-    }
-    return false;
+      if (dispatch) {
+        dispatch(_transform.default.addDeleteAnalytics(editorAnalyticsAPI)(tr, state));
+        return true;
+      }
+      return false;
+    };
   };
 };
 var getDraftCommandAction = function getDraftCommandAction(drafting, targetType, targetNodeId, supportedBlockNodes, isOpeningMediaCommentFromToolbar) {

package/dist/cjs/editor-commands/transform.js

@@ -136,11 +136,43 @@ var addResolveAnalytics = function addResolveAnalytics(editorAnalyticsAPI) {
     };
   };
 };
+var addPreemptiveGateErrorAnalytics = function addPreemptiveGateErrorAnalytics(editorAnalyticsAPI) {
+  return function (errorReason) {
+    return function (transaction, state) {
+      var analyticsEvent = {
+        action: _analytics.ACTION.ERROR,
+        actionSubject: _analytics.ACTION_SUBJECT.ANNOTATION,
+        actionSubjectId: _analytics.ACTION_SUBJECT_ID.INLINE_COMMENT,
+        eventType: _analytics.EVENT_TYPE.OPERATIONAL,
+        attributes: {
+          errorReason: errorReason
+        }
+      };
+      editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent(analyticsEvent)(transaction);
+      return transaction;
+    };
+  };
+};
+var addDeleteAnalytics = function addDeleteAnalytics(editorAnalyticsAPI) {
+  return function (transaction, state) {
+    var analyticsEvent = {
+      action: _analytics.ACTION.DELETED,
+      actionSubject: _analytics.ACTION_SUBJECT.ANNOTATION,
+      actionSubjectId: _analytics.ACTION_SUBJECT_ID.INLINE_COMMENT,
+      eventType: _analytics.EVENT_TYPE.TRACK,
+      attributes: {}
+    };
+    editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent(analyticsEvent)(transaction);
+    return transaction;
+  };
+};
 var _default = exports.default = {
   addAnnotationMark: addAnnotationMark,
   addInlineComment: addInlineComment,
   handleDraftState: handleDraftState,
   addOpenCloseAnalytics: addOpenCloseAnalytics,
   addInsertAnalytics: addInsertAnalytics,
-  addResolveAnalytics: addResolveAnalytics
+  addResolveAnalytics: addResolveAnalytics,
+  addPreemptiveGateErrorAnalytics: addPreemptiveGateErrorAnalytics,
+  addDeleteAnalytics: addDeleteAnalytics
 };

package/dist/cjs/pm-plugins/annotation-manager-hooks.js

@@ -7,7 +7,6 @@ exports.startDraft = exports.setIsAnnotationSelected = exports.setIsAnnotationHo
 var _adfSchema = require("@atlaskit/adf-schema");
 var _utils = require("@atlaskit/editor-common/utils");
 var _utils2 = require("@atlaskit/editor-prosemirror/utils");
-var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _editorCommands = require("../editor-commands");
 var _types = require("../types");
 var _utils3 = require("./utils");
@@ -58,7 +57,7 @@ var startDraft = exports.startDraft = function startDraft(editorView, options) {
         reason: ERROR_REASON_DRAFT_IN_PROGRESS
       };
     }
-    if (!!(selectedAnnotations !== null && selectedAnnotations !== void 0 && selectedAnnotations.length) && (0, _platformFeatureFlags.fg)('platform_editor_comments_api_manager_select')) {
+    if (!!(selectedAnnotations !== null && selectedAnnotations !== void 0 && selectedAnnotations.length)) {
       // if there are selected annotations when starting a draft, we need to clear the selected annotations
       // before we start the draft.
       (0, _editorCommands.closeComponent)()(editorView.state, editorView.dispatch);
@@ -344,7 +343,7 @@ var clearAnnotation = exports.clearAnnotation = function clearAnnotation(editorV
         reason: ERROR_REASON_ID_INVALID
       };
     }
-    (0, _editorCommands.removeInlineCommentFromDoc)(id, options.provider.supportedBlockNodes)(editorView.state, editorView.dispatch);
+    (0, _editorCommands.removeInlineCommentFromDoc)(options.editorAnalyticsAPI)(id, options.provider.supportedBlockNodes)(editorView.state, editorView.dispatch);
     return {
       success: true,
       actionResult: undefined

package/dist/cjs/pm-plugins/inline-comment.js

@@ -93,6 +93,7 @@ var fetchState = /*#__PURE__*/function () {
 var initialState = function initialState() {
   var disallowOnWhitespace = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
   var featureFlagsPluginState = arguments.length > 1 ? arguments[1] : undefined;
+  var isAnnotationManagerEnabled = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
   return {
     annotations: {},
     selectedAnnotations: [],
@@ -107,7 +108,8 @@ var initialState = function initialState() {
     featureFlagsPluginState: featureFlagsPluginState,
     isDrafting: false,
     pendingSelectedAnnotations: [],
-    pendingSelectedAnnotationsUpdateCount: 0
+    pendingSelectedAnnotationsUpdateCount: 0,
+    isAnnotationManagerEnabled: isAnnotationManagerEnabled
   };
 };
 var hideToolbar = function hideToolbar(state, dispatch) {
@@ -164,7 +166,7 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
     annotationManager = options.annotationManager;
   return new _safePlugin.SafePlugin({
     key: _utils2.inlineCommentPluginKey,
-    state: (0, _pluginFactory.createPluginState)(options.dispatch, initialState(provider.disallowOnWhitespace, featureFlagsPluginState)),
+    state: (0, _pluginFactory.createPluginState)(options.dispatch, initialState(provider.disallowOnWhitespace, featureFlagsPluginState, !!annotationManager)),
     view: function view(editorView) {
       var allowAnnotationFn;
       var startDraftFn;
@@ -174,25 +176,23 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
       var setIsAnnotationSelectedFn;
       var setIsAnnotationHoveredFn;
       var clearAnnotationFn;
-      if (annotationManager && (0, _platformFeatureFlags.fg)('platform_editor_comments_api_manager')) {
+      if (annotationManager) {
         allowAnnotationFn = (0, _annotationManagerHooks.allowAnnotation)(editorView, options);
         startDraftFn = (0, _annotationManagerHooks.startDraft)(editorView, options);
         clearDraftFn = (0, _annotationManagerHooks.clearDraft)(editorView, options);
         applyDraftFn = (0, _annotationManagerHooks.applyDraft)(editorView, options);
         getDraftFn = (0, _annotationManagerHooks.getDraft)(editorView, options);
+        setIsAnnotationSelectedFn = (0, _annotationManagerHooks.setIsAnnotationSelected)(editorView, options);
+        setIsAnnotationHoveredFn = (0, _annotationManagerHooks.setIsAnnotationHovered)(editorView, options);
+        clearAnnotationFn = (0, _annotationManagerHooks.clearAnnotation)(editorView, options);
         annotationManager.hook('allowAnnotation', allowAnnotationFn);
         annotationManager.hook('startDraft', startDraftFn);
         annotationManager.hook('clearDraft', clearDraftFn);
         annotationManager.hook('applyDraft', applyDraftFn);
         annotationManager.hook('getDraft', getDraftFn);
-        if ((0, _platformFeatureFlags.fg)('platform_editor_comments_api_manager_select')) {
-          setIsAnnotationSelectedFn = (0, _annotationManagerHooks.setIsAnnotationSelected)(editorView, options);
-          setIsAnnotationHoveredFn = (0, _annotationManagerHooks.setIsAnnotationHovered)(editorView, options);
-          clearAnnotationFn = (0, _annotationManagerHooks.clearAnnotation)(editorView, options);
-          annotationManager.hook('setIsAnnotationSelected', setIsAnnotationSelectedFn);
-          annotationManager.hook('setIsAnnotationHovered', setIsAnnotationHoveredFn);
-          annotationManager.hook('clearAnnotation', clearAnnotationFn);
-        }
+        annotationManager.hook('setIsAnnotationSelected', setIsAnnotationSelectedFn);
+        annotationManager.hook('setIsAnnotationHovered', setIsAnnotationHoveredFn);
+        annotationManager.hook('clearAnnotation', clearAnnotationFn);
       }
       // Get initial state
       // Need to pass `editorView` to mitigate editor state going stale
@@ -277,7 +277,7 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
             // The selectComponentExperience is using a simplified object, which is why it's type asserted.
             (_options$selectCommen = options.selectCommentExperience) === null || _options$selectCommen === void 0 || _options$selectCommen.selectAnnotation.complete(selectedAnnotationId);
           }
-          if ((0, _platformFeatureFlags.fg)('platform_editor_comments_api_manager_select')) {
+          if (annotationManager) {
             // In the Editor, Annotations can be selected in three ways:
             // 1. By clicking on the annotation in the editor
             // 2. By using the annotation manager to select the annotation
@@ -295,7 +295,7 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
               // Need to set a lock to avoid calling gate multiple times. The lock will be released
               // when the preemptive gate is complete.
               isPreemptiveGateActive = true;
-              annotationManager === null || annotationManager === void 0 || annotationManager.checkPreemptiveGate().then(function (canSelectAnnotation) {
+              annotationManager.checkPreemptiveGate().then(function (canSelectAnnotation) {
                 var _ref8 = (0, _utils2.getPluginState)(view.state) || {},
                   isDrafting = _ref8.isDrafting,
                   latestPendingSelectedAnnotations = _ref8.pendingSelectedAnnotations,
@@ -308,14 +308,14 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
                   }
 
                   // Flush the pending selections into the selected annotations list.
-                  (0, _editorCommands.flushPendingSelections)(true)(view.state, view.dispatch);
+                  (0, _editorCommands.flushPendingSelections)(options.editorAnalyticsAPI)(true)(view.state, view.dispatch);
                   latestSelectedAnnotations === null || latestSelectedAnnotations === void 0 || latestSelectedAnnotations.filter(function (annotation) {
                     return (latestPendingSelectedAnnotations === null || latestPendingSelectedAnnotations === void 0 ? void 0 : latestPendingSelectedAnnotations.findIndex(function (pendingAnnotation) {
                       return pendingAnnotation.id === annotation.id;
                     })) === -1;
                   }).forEach(function (annotation) {
-                    var _options$annotationMa, _getAnnotationInlineN;
-                    (_options$annotationMa = options.annotationManager) === null || _options$annotationMa === void 0 || _options$annotationMa.emit({
+                    var _getAnnotationInlineN;
+                    annotationManager.emit({
                       name: 'annotationSelectionChanged',
                       data: {
                         annotationId: annotation.id,
@@ -327,9 +327,9 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
 
                   // Notify the annotation manager that the pending selection has changed.
                   latestPendingSelectedAnnotations === null || latestPendingSelectedAnnotations === void 0 || latestPendingSelectedAnnotations.forEach(function (_ref9) {
-                    var _options$annotationMa2, _getAnnotationInlineN2;
+                    var _getAnnotationInlineN2;
                     var id = _ref9.id;
-                    (_options$annotationMa2 = options.annotationManager) === null || _options$annotationMa2 === void 0 || _options$annotationMa2.emit({
+                    annotationManager.emit({
                       name: 'annotationSelectionChanged',
                       data: {
                         annotationId: id,
@@ -342,20 +342,18 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
                   // Clears the pending selections if the preemptive gate returns false.
                   // We should need to worry about dispatching change events here because the pending selections
                   // are being aborted and the selections will remain unchanged.
-                  (0, _editorCommands.flushPendingSelections)(false)(view.state, view.dispatch);
+                  (0, _editorCommands.flushPendingSelections)(options.editorAnalyticsAPI)(false)(view.state, view.dispatch);
                 }
               }).catch(function (error) {
-                // TODO: EDITOR-595 - Ensure and anlytic is fired to indicate which reports on the error.
-
                 // If an error has occured we will clear any pending selections to avoid accidentally setting the wrong thing.
-                (0, _editorCommands.flushPendingSelections)(false)(view.state, view.dispatch);
+                (0, _editorCommands.flushPendingSelections)(options.editorAnalyticsAPI)(false, 'pending-selection-preemptive-gate-error')(view.state, view.dispatch);
               }).finally(function () {
                 isPreemptiveGateActive = false;
               });
             }
           }
-          var _ref10 = (0, _utils2.getPluginState)(view.state) || {},
-            dirtyAnnotations = _ref10.dirtyAnnotations;
+          var _ref0 = (0, _utils2.getPluginState)(view.state) || {},
+            dirtyAnnotations = _ref0.dirtyAnnotations;
           if (!dirtyAnnotations) {
             return;
           }
@@ -368,7 +366,7 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
           if (updateSubscriber) {
             updateSubscriber.off('resolve', resolve).off('delete', resolve).off('unresolve', unResolve).off('create', unResolve).off('setvisibility', setVisibility).off('setselectedannotation', setSelectedAnnotationFn).off('sethoveredannotation', setHoveredAnnotationFn).off('removehoveredannotation', removeHoveredannotationFn).off('closeinlinecomment', closeInlineCommentFn);
           }
-          if (annotationManager && (0, _platformFeatureFlags.fg)('platform_editor_comments_api_manager')) {
+          if (annotationManager) {
             annotationManager.unhook('allowAnnotation', allowAnnotationFn);
             annotationManager.unhook('startDraft', startDraftFn);
             annotationManager.unhook('clearDraft', clearDraftFn);
@@ -418,13 +416,13 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
           if (isSelected && !(pluginState !== null && pluginState !== void 0 && pluginState.isInlineCommentViewClosed)) {
             return false;
           }
-          var _ref11 = pluginState || {},
-            annotations = _ref11.annotations;
+          var _ref1 = pluginState || {},
+            annotations = _ref1.annotations;
           var isUnresolved = annotations && annotations[annotationId] === false;
           if (!isUnresolved) {
             return false;
           }
-          if ((0, _platformFeatureFlags.fg)('platform_editor_comments_api_manager_select')) {
+          if (annotationManager) {
             var _pluginState$pendingS;
             // The manager disable setting the selected annotation on click because in the editor this is already
             // handled by the selection update handler. When the manager is enabled, and a selection changes it's pushed into
@@ -447,13 +445,13 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
       },
       decorations: function decorations(state) {
         // highlight comments, depending on state
-        var _ref12 = (0, _utils2.getPluginState)(state) || {},
-          draftDecorationSet = _ref12.draftDecorationSet,
-          annotations = _ref12.annotations,
-          selectedAnnotations = _ref12.selectedAnnotations,
-          isVisible = _ref12.isVisible,
-          isInlineCommentViewClosed = _ref12.isInlineCommentViewClosed,
-          hoveredAnnotations = _ref12.hoveredAnnotations;
+        var _ref10 = (0, _utils2.getPluginState)(state) || {},
+          draftDecorationSet = _ref10.draftDecorationSet,
+          annotations = _ref10.annotations,
+          selectedAnnotations = _ref10.selectedAnnotations,
+          isVisible = _ref10.isVisible,
+          isInlineCommentViewClosed = _ref10.isInlineCommentViewClosed,
+          hoveredAnnotations = _ref10.hoveredAnnotations;
         var decorations = draftDecorationSet !== null && draftDecorationSet !== void 0 ? draftDecorationSet : _view.DecorationSet.empty;
         var focusDecorations = [];
 

package/dist/cjs/pm-plugins/plugin-factory.js

@@ -9,7 +9,6 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 var _utils = require("@atlaskit/editor-common/utils");
 var _state = require("@atlaskit/editor-prosemirror/state");
 var _view = require("@atlaskit/editor-prosemirror/view");
-var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _reducer = _interopRequireDefault(require("./reducer"));
 var _utils2 = require("./utils");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
@@ -111,7 +110,6 @@ var getSelectionChangeHandlerNew = function getSelectionChangeHandlerNew(reopenC
 
     // NOTE: I've left this commented code here as a reference that the previous old code would reset the selected annotations
     // if the selection is empty. If this is no longer needed, we can remove this code.
-    // clean up with platform_editor_comments_api_manager_select
     // if (selectedAnnotations.length === 0) {
     // 	return {
     // 		...pluginState,
@@ -140,7 +138,11 @@ var getSelectionChangeHandlerNew = function getSelectionChangeHandlerNew(reopenC
 };
 var getSelectionChangedHandler = function getSelectionChangedHandler(reopenCommentView) {
   return function (tr, pluginState) {
-    return (0, _platformFeatureFlags.fg)('platform_editor_comments_api_manager_select') ? getSelectionChangeHandlerNew(reopenCommentView)(tr, pluginState) : getSelectionChangeHandlerOld(reopenCommentView)(tr, pluginState);
+    return pluginState.isAnnotationManagerEnabled ?
+    // if platform_editor_comments_api_manager == true
+    getSelectionChangeHandlerNew(reopenCommentView)(tr, pluginState) :
+    // else if platform_editor_comments_api_manager == false
+    getSelectionChangeHandlerOld(reopenCommentView)(tr, pluginState);
   };
 };
 var _pluginFactory = (0, _utils.pluginFactory)(_utils2.inlineCommentPluginKey, _reducer.default, {

package/dist/cjs/pm-plugins/reducer.js

@@ -38,7 +38,7 @@ var _default = exports.default = function _default(pluginState, action) {
         isOpeningMediaCommentFromToolbar: false
       }, (0, _platformFeatureFlags.fg)('platform_editor_annotation_selected_annotation') && {
         selectedAnnotations: []
-      }), (0, _platformFeatureFlags.fg)('platform_editor_comments_api_manager_select') && {
+      }), pluginState.isAnnotationManagerEnabled && {
         selectedAnnotations: []
       });
     case _types.ACTIONS.ADD_INLINE_COMMENT:
@@ -48,7 +48,7 @@ var _default = exports.default = function _default(pluginState, action) {
         annotations: _objectSpread(_objectSpread({}, pluginState.annotations), action.data.inlineComments),
         isInlineCommentViewClosed: false,
         selectAnnotationMethod: undefined
-      }, (0, _platformFeatureFlags.fg)('platform_editor_comments_api_manager_select') && {
+      }, pluginState.isAnnotationManagerEnabled && {
         skipSelectionHandling: true
       });
     case _types.ACTIONS.INLINE_COMMENT_SET_VISIBLE:

package/dist/cjs/pm-plugins/toolbar.js

@@ -123,25 +123,17 @@ var buildToolbar = exports.buildToolbar = function buildToolbar(editorAnalyticsA
         }
       },
       onClick: function onClick(state, dispatch) {
-        if (editorAnalyticsAPI) {
-          editorAnalyticsAPI.fireAnalyticsEvent({
-            action: _analytics.ACTION.CLICKED,
-            actionSubject: _analytics.ACTION_SUBJECT.BUTTON,
-            actionSubjectId: _analytics.ACTION_SUBJECT_ID.CREATE_INLINE_COMMENT_FROM_HIGHLIGHT_ACTIONS_MENU,
-            eventType: _analytics.EVENT_TYPE.UI,
-            attributes: {
-              source: 'highlightActionsMenu',
-              pageMode: 'edit'
-            }
-          });
-        }
-        if ((0, _platformFeatureFlags.fg)('platform_editor_comments_api_manager')) {
-          if (!annotationManager) {
-            // TODO: EDITOR-595 - If we've reached here and the manager is not initialized, we should
-            // dispatch an analytics event to indicate that the user has clicked the button but
-            // the action was not completed.
-            return false;
+        editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.fireAnalyticsEvent({
+          action: _analytics.ACTION.CLICKED,
+          actionSubject: _analytics.ACTION_SUBJECT.BUTTON,
+          actionSubjectId: _analytics.ACTION_SUBJECT_ID.CREATE_INLINE_COMMENT_FROM_HIGHLIGHT_ACTIONS_MENU,
+          eventType: _analytics.EVENT_TYPE.UI,
+          attributes: {
+            source: 'highlightActionsMenu',
+            pageMode: 'edit'
           }
+        });
+        if (annotationManager) {
           annotationManager.checkPreemptiveGate().then(function (canStartDraft) {
             if (canStartDraft) {
               createCommentExperience === null || createCommentExperience === void 0 || createCommentExperience.start({
@@ -152,18 +144,30 @@ var buildToolbar = exports.buildToolbar = function buildToolbar(editorAnalyticsA
               });
               createCommentExperience === null || createCommentExperience === void 0 || createCommentExperience.initExperience.start();
               var result = annotationManager.startDraft();
-              if (result.success) {
-                // TODO: EDITOR-595 - Ensure and anlytic is fired to indicate that the user has started a draft.
-              } else {
-                // TODO: EDITOR-595 - Fire an analytics event to indicate that the user has clicked the button
+              if (!result.success) {
+                // Fire an analytics event to indicate that the user has clicked the button
                 // but the action was not completed, the result should contain a reason.
+                editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.fireAnalyticsEvent({
+                  action: _analytics.ACTION.ERROR,
+                  actionSubject: _analytics.ACTION_SUBJECT.ANNOTATION,
+                  actionSubjectId: _analytics.ACTION_SUBJECT_ID.INLINE_COMMENT,
+                  eventType: _analytics.EVENT_TYPE.OPERATIONAL,
+                  attributes: {
+                    errorReason: "toolbar-start-draft-failed/".concat(result.reason)
+                  }
+                });
               }
-            } else {
-              // TODO: EDITOR-595 - Track the toolbar comment button was clicked but the preemptive gate
-              // check returned false and the draft cannot be started.
             }
           }).catch(function () {
-            // TODO: EDITOR-595 - Handle preemptive gate check error. Something went very wrong in the gate.
+            editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.fireAnalyticsEvent({
+              action: _analytics.ACTION.ERROR,
+              actionSubject: _analytics.ACTION_SUBJECT.ANNOTATION,
+              actionSubjectId: _analytics.ACTION_SUBJECT_ID.INLINE_COMMENT,
+              eventType: _analytics.EVENT_TYPE.OPERATIONAL,
+              attributes: {
+                errorReason: "toolbar-start-draft-preemptive-gate-error"
+              }
+            });
           });
           return true;
         } else {

package/dist/cjs/ui/InlineCommentView.js

@@ -20,8 +20,7 @@ var _editorCommands = require("../editor-commands");
 var _utils3 = require("../pm-plugins/utils");
 var _types = require("../types");
 var _AnnotationViewWrapper = require("./AnnotationViewWrapper");
-function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
-function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
 var findPosForDOM = function findPosForDOM(sel) {
   var $from = sel.$from,
     from = sel.from;

package/dist/es2019/editor-commands/index.js

@@ -31,12 +31,18 @@ export const closeComponent = () => createCommand({
 export const clearDirtyMark = () => createCommand({
   type: ACTIONS.INLINE_COMMENT_CLEAR_DIRTY_MARK
 });
-export const flushPendingSelections = canSetAsSelectedAnnotations => createCommand({
-  type: ACTIONS.FLUSH_PENDING_SELECTIONS,
-  data: {
-    canSetAsSelectedAnnotations
+export const flushPendingSelections = editorAnalyticsAPI => (canSetAsSelectedAnnotations, errorReason) => {
+  const command = {
+    type: ACTIONS.FLUSH_PENDING_SELECTIONS,
+    data: {
+      canSetAsSelectedAnnotations
+    }
+  };
+  if (!!errorReason) {
+    return createCommand(command, (tr, state) => transform.addPreemptiveGateErrorAnalytics(editorAnalyticsAPI)(errorReason)(tr, state));
   }
-});
+  return createCommand(command);
+};
 export const setPendingSelectedAnnotation = id => createCommand({
   type: ACTIONS.SET_PENDING_SELECTIONS,
   data: {
@@ -109,7 +115,7 @@ export const removeInlineCommentNearSelection = (id, supportedNodes = []) => (st
   }
   return true;
 };
-export const removeInlineCommentFromDoc = (id, supportedNodes = []) => (state, dispatch) => {
+export const removeInlineCommentFromDoc = editorAnalyticsAPI => (id, supportedNodes = []) => (state, dispatch) => {
   const {
     tr
   } = state;
@@ -129,7 +135,7 @@ export const removeInlineCommentFromDoc = (id, supportedNodes = []) => (state, d
     });
   });
   if (dispatch) {
-    dispatch(tr);
+    dispatch(transform.addDeleteAnalytics(editorAnalyticsAPI)(tr, state));
     return true;
   }
   return false;

package/dist/es2019/editor-commands/transform.js

@@ -109,11 +109,37 @@ const addResolveAnalytics = editorAnalyticsAPI => method => (transaction, state)
   editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 ? void 0 : editorAnalyticsAPI.attachAnalyticsEvent(resolvedPayload)(transaction);
   return transaction;
 };
+const addPreemptiveGateErrorAnalytics = editorAnalyticsAPI => errorReason => (transaction, state) => {
+  const analyticsEvent = {
+    action: ACTION.ERROR,
+    actionSubject: ACTION_SUBJECT.ANNOTATION,
+    actionSubjectId: ACTION_SUBJECT_ID.INLINE_COMMENT,
+    eventType: EVENT_TYPE.OPERATIONAL,
+    attributes: {
+      errorReason
+    }
+  };
+  editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 ? void 0 : editorAnalyticsAPI.attachAnalyticsEvent(analyticsEvent)(transaction);
+  return transaction;
+};
+const addDeleteAnalytics = editorAnalyticsAPI => (transaction, state) => {
+  const analyticsEvent = {
+    action: ACTION.DELETED,
+    actionSubject: ACTION_SUBJECT.ANNOTATION,
+    actionSubjectId: ACTION_SUBJECT_ID.INLINE_COMMENT,
+    eventType: EVENT_TYPE.TRACK,
+    attributes: {}
+  };
+  editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 ? void 0 : editorAnalyticsAPI.attachAnalyticsEvent(analyticsEvent)(transaction);
+  return transaction;
+};
 export default {
   addAnnotationMark,
   addInlineComment,
   handleDraftState,
   addOpenCloseAnalytics,
   addInsertAnalytics,
-  addResolveAnalytics
+  addResolveAnalytics,
+  addPreemptiveGateErrorAnalytics,
+  addDeleteAnalytics
 };

package/dist/es2019/pm-plugins/annotation-manager-hooks.js

@@ -1,7 +1,6 @@
 import { AnnotationTypes } from '@atlaskit/adf-schema';
 import { getAnnotationInlineNodeTypes, getRangeInlineNodeNames } from '@atlaskit/editor-common/utils';
 import { findDomRefAtPos } from '@atlaskit/editor-prosemirror/utils';
-import { fg } from '@atlaskit/platform-feature-flags';
 import { setInlineCommentDraftState, createAnnotation, setSelectedAnnotation, closeComponent, setHoveredAnnotation, removeInlineCommentFromDoc } from '../editor-commands';
 import { AnnotationSelectionType } from '../types';
 import { inlineCommentPluginKey, isSelectionValid } from './utils';
@@ -51,7 +50,7 @@ export const startDraft = (editorView, options) => () => {
       reason: ERROR_REASON_DRAFT_IN_PROGRESS
     };
   }
-  if (!!(selectedAnnotations !== null && selectedAnnotations !== void 0 && selectedAnnotations.length) && fg('platform_editor_comments_api_manager_select')) {
+  if (!!(selectedAnnotations !== null && selectedAnnotations !== void 0 && selectedAnnotations.length)) {
     // if there are selected annotations when starting a draft, we need to clear the selected annotations
     // before we start the draft.
     closeComponent()(editorView.state, editorView.dispatch);
@@ -328,7 +327,7 @@ export const clearAnnotation = (editorView, options) => id => {
       reason: ERROR_REASON_ID_INVALID
     };
   }
-  removeInlineCommentFromDoc(id, options.provider.supportedBlockNodes)(editorView.state, editorView.dispatch);
+  removeInlineCommentFromDoc(options.editorAnalyticsAPI)(id, options.provider.supportedBlockNodes)(editorView.state, editorView.dispatch);
   return {
     success: true,
     actionResult: undefined