@atlaskit/editor-plugin-annotation 2.9.1 → 2.9.2

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-plugin-annotation
 
+## 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

@@ -344,7 +344,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

@@ -308,7 +308,7 @@ 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;
@@ -342,13 +342,11 @@ 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;
               });

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 && (0, _platformFeatureFlags.fg)('platform_editor_comments_api_manager')) {
           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/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

@@ -328,7 +328,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

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

@@ -247,7 +247,7 @@ export const inlineCommentPlugin = options => {
                   }
 
                   // Flush the pending selections into the selected annotations list.
-                  flushPendingSelections(true)(view.state, view.dispatch);
+                  flushPendingSelections(options.editorAnalyticsAPI)(true)(view.state, view.dispatch);
                   latestSelectedAnnotations === null || latestSelectedAnnotations === void 0 ? void 0 : latestSelectedAnnotations.filter(annotation => (latestPendingSelectedAnnotations === null || latestPendingSelectedAnnotations === void 0 ? void 0 : latestPendingSelectedAnnotations.findIndex(pendingAnnotation => pendingAnnotation.id === annotation.id)) === -1).forEach(annotation => {
                     var _options$annotationMa, _getAnnotationInlineN;
                     (_options$annotationMa = options.annotationManager) === null || _options$annotationMa === void 0 ? void 0 : _options$annotationMa.emit({
@@ -278,13 +278,11 @@ export const inlineCommentPlugin = options => {
                   // 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.
-                  flushPendingSelections(false)(view.state, view.dispatch);
+                  flushPendingSelections(options.editorAnalyticsAPI)(false)(view.state, view.dispatch);
                 }
               }).catch(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.
-                flushPendingSelections(false)(view.state, view.dispatch);
+                flushPendingSelections(options.editorAnalyticsAPI)(false, 'pending-selection-preemptive-gate-error')(view.state, view.dispatch);
               }).finally(() => {
                 isPreemptiveGateActive = false;
               });

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

@@ -121,25 +121,17 @@ export const buildToolbar = editorAnalyticsAPI => ({
       }
     },
     onClick: (state, dispatch) => {
-      if (editorAnalyticsAPI) {
-        editorAnalyticsAPI.fireAnalyticsEvent({
-          action: ACTION.CLICKED,
-          actionSubject: ACTION_SUBJECT.BUTTON,
-          actionSubjectId: ACTION_SUBJECT_ID.CREATE_INLINE_COMMENT_FROM_HIGHLIGHT_ACTIONS_MENU,
-          eventType: EVENT_TYPE.UI,
-          attributes: {
-            source: 'highlightActionsMenu',
-            pageMode: 'edit'
-          }
-        });
-      }
-      if (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 ? void 0 : editorAnalyticsAPI.fireAnalyticsEvent({
+        action: ACTION.CLICKED,
+        actionSubject: ACTION_SUBJECT.BUTTON,
+        actionSubjectId: ACTION_SUBJECT_ID.CREATE_INLINE_COMMENT_FROM_HIGHLIGHT_ACTIONS_MENU,
+        eventType: EVENT_TYPE.UI,
+        attributes: {
+          source: 'highlightActionsMenu',
+          pageMode: 'edit'
         }
+      });
+      if (annotationManager && fg('platform_editor_comments_api_manager')) {
         annotationManager.checkPreemptiveGate().then(canStartDraft => {
           if (canStartDraft) {
             createCommentExperience === null || createCommentExperience === void 0 ? void 0 : createCommentExperience.start({
@@ -150,18 +142,30 @@ export const buildToolbar = editorAnalyticsAPI => ({
             });
             createCommentExperience === null || createCommentExperience === void 0 ? void 0 : createCommentExperience.initExperience.start();
             const 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 ? void 0 : editorAnalyticsAPI.fireAnalyticsEvent({
+                action: ACTION.ERROR,
+                actionSubject: ACTION_SUBJECT.ANNOTATION,
+                actionSubjectId: ACTION_SUBJECT_ID.INLINE_COMMENT,
+                eventType: EVENT_TYPE.OPERATIONAL,
+                attributes: {
+                  errorReason: `toolbar-start-draft-failed/${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(() => {
-          // TODO: EDITOR-595 - Handle preemptive gate check error. Something went very wrong in the gate.
+          editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 ? void 0 : editorAnalyticsAPI.fireAnalyticsEvent({
+            action: ACTION.ERROR,
+            actionSubject: ACTION_SUBJECT.ANNOTATION,
+            actionSubjectId: ACTION_SUBJECT_ID.INLINE_COMMENT,
+            eventType: EVENT_TYPE.OPERATIONAL,
+            attributes: {
+              errorReason: `toolbar-start-draft-preemptive-gate-error`
+            }
+          });
         });
         return true;
       } else {

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

@@ -44,13 +44,21 @@ export var clearDirtyMark = function clearDirtyMark() {
     type: ACTIONS.INLINE_COMMENT_CLEAR_DIRTY_MARK
   });
 };
-export var flushPendingSelections = function flushPendingSelections(canSetAsSelectedAnnotations) {
-  return createCommand({
-    type: ACTIONS.FLUSH_PENDING_SELECTIONS,
-    data: {
-      canSetAsSelectedAnnotations: canSetAsSelectedAnnotations
+export var flushPendingSelections = function flushPendingSelections(editorAnalyticsAPI) {
+  return function (canSetAsSelectedAnnotations, errorReason) {
+    var command = {
+      type: ACTIONS.FLUSH_PENDING_SELECTIONS,
+      data: {
+        canSetAsSelectedAnnotations: canSetAsSelectedAnnotations
+      }
+    };
+    if (!!errorReason) {
+      return createCommand(command, function (tr, state) {
+        return transform.addPreemptiveGateErrorAnalytics(editorAnalyticsAPI)(errorReason)(tr, state);
+      });
     }
-  });
+    return createCommand(command);
+  };
 };
 export var setPendingSelectedAnnotation = function setPendingSelectedAnnotation(id) {
   return createCommand({
@@ -124,32 +132,34 @@ export var removeInlineCommentNearSelection = function removeInlineCommentNearSe
     return true;
   };
 };
-export var 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);
+export var 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.addDeleteAnalytics(editorAnalyticsAPI)(tr, state));
+        return true;
+      }
+      return false;
+    };
   };
 };
 var getDraftCommandAction = function getDraftCommandAction(drafting, targetType, targetNodeId, supportedBlockNodes, isOpeningMediaCommentFromToolbar) {

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

@@ -130,11 +130,43 @@ var addResolveAnalytics = function addResolveAnalytics(editorAnalyticsAPI) {
     };
   };
 };
+var addPreemptiveGateErrorAnalytics = function addPreemptiveGateErrorAnalytics(editorAnalyticsAPI) {
+  return function (errorReason) {
+    return function (transaction, state) {
+      var analyticsEvent = {
+        action: ACTION.ERROR,
+        actionSubject: ACTION_SUBJECT.ANNOTATION,
+        actionSubjectId: ACTION_SUBJECT_ID.INLINE_COMMENT,
+        eventType: 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: ACTION.DELETED,
+      actionSubject: ACTION_SUBJECT.ANNOTATION,
+      actionSubjectId: ACTION_SUBJECT_ID.INLINE_COMMENT,
+      eventType: EVENT_TYPE.TRACK,
+      attributes: {}
+    };
+    editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent(analyticsEvent)(transaction);
+    return transaction;
+  };
+};
 export default {
   addAnnotationMark: addAnnotationMark,
   addInlineComment: addInlineComment,
   handleDraftState: handleDraftState,
   addOpenCloseAnalytics: addOpenCloseAnalytics,
   addInsertAnalytics: addInsertAnalytics,
-  addResolveAnalytics: addResolveAnalytics
+  addResolveAnalytics: addResolveAnalytics,
+  addPreemptiveGateErrorAnalytics: addPreemptiveGateErrorAnalytics,
+  addDeleteAnalytics: addDeleteAnalytics
 };

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

@@ -338,7 +338,7 @@ export var clearAnnotation = function clearAnnotation(editorView, options) {
         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

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

@@ -301,7 +301,7 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
                   }
 
                   // Flush the pending selections into the selected annotations list.
-                  flushPendingSelections(true)(view.state, view.dispatch);
+                  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;
@@ -335,13 +335,11 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
                   // 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.
-                  flushPendingSelections(false)(view.state, view.dispatch);
+                  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.
-                flushPendingSelections(false)(view.state, view.dispatch);
+                flushPendingSelections(options.editorAnalyticsAPI)(false, 'pending-selection-preemptive-gate-error')(view.state, view.dispatch);
               }).finally(function () {
                 isPreemptiveGateActive = false;
               });

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

@@ -116,25 +116,17 @@ export var buildToolbar = function buildToolbar(editorAnalyticsAPI) {
         }
       },
       onClick: function onClick(state, dispatch) {
-        if (editorAnalyticsAPI) {
-          editorAnalyticsAPI.fireAnalyticsEvent({
-            action: ACTION.CLICKED,
-            actionSubject: ACTION_SUBJECT.BUTTON,
-            actionSubjectId: ACTION_SUBJECT_ID.CREATE_INLINE_COMMENT_FROM_HIGHLIGHT_ACTIONS_MENU,
-            eventType: EVENT_TYPE.UI,
-            attributes: {
-              source: 'highlightActionsMenu',
-              pageMode: 'edit'
-            }
-          });
-        }
-        if (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: ACTION.CLICKED,
+          actionSubject: ACTION_SUBJECT.BUTTON,
+          actionSubjectId: ACTION_SUBJECT_ID.CREATE_INLINE_COMMENT_FROM_HIGHLIGHT_ACTIONS_MENU,
+          eventType: EVENT_TYPE.UI,
+          attributes: {
+            source: 'highlightActionsMenu',
+            pageMode: 'edit'
           }
+        });
+        if (annotationManager && fg('platform_editor_comments_api_manager')) {
           annotationManager.checkPreemptiveGate().then(function (canStartDraft) {
             if (canStartDraft) {
               createCommentExperience === null || createCommentExperience === void 0 || createCommentExperience.start({
@@ -145,18 +137,30 @@ export var buildToolbar = function buildToolbar(editorAnalyticsAPI) {
               });
               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: ACTION.ERROR,
+                  actionSubject: ACTION_SUBJECT.ANNOTATION,
+                  actionSubjectId: ACTION_SUBJECT_ID.INLINE_COMMENT,
+                  eventType: 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: ACTION.ERROR,
+              actionSubject: ACTION_SUBJECT.ANNOTATION,
+              actionSubjectId: ACTION_SUBJECT_ID.INLINE_COMMENT,
+              eventType: EVENT_TYPE.OPERATIONAL,
+              attributes: {
+                errorReason: "toolbar-start-draft-preemptive-gate-error"
+              }
+            });
           });
           return true;
         } else {

package/dist/types/editor-commands/index.d.ts

@@ -9,10 +9,10 @@ import type { InlineCommentInputMethod, TargetType } from '../types';
 export declare const updateInlineCommentResolvedState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (partialNewState: InlineCommentMap, resolveMethod?: RESOLVE_METHOD) => Command;
 export declare const closeComponent: () => Command;
 export declare const clearDirtyMark: () => Command;
-export declare const flushPendingSelections: (canSetAsSelectedAnnotations: boolean) => Command;
+export declare const flushPendingSelections: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (canSetAsSelectedAnnotations: boolean, errorReason?: string) => Command;
 export declare const setPendingSelectedAnnotation: (id: string) => Command;
 export declare const removeInlineCommentNearSelection: (id: string, supportedNodes?: string[]) => Command;
-export declare const removeInlineCommentFromDoc: (id: string, supportedNodes?: string[]) => Command;
+export declare const removeInlineCommentFromDoc: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (id: string, supportedNodes?: string[]) => Command;
 /**
  * Show active inline comments for a given block node, otherwise,
  * return false if the node has no comments or no unresolved comments.

package/dist/types/editor-commands/transform.d.ts

@@ -18,5 +18,7 @@ declare const _default: {
     addOpenCloseAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, method?: InlineCommentInputMethod) => (transaction: Transaction, state: EditorState) => Transaction;
     addInsertAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
     addResolveAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (method?: RESOLVE_METHOD | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
+    addPreemptiveGateErrorAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (errorReason?: string | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
+    addDeleteAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
 };
 export default _default;

package/dist/types-ts4.5/editor-commands/index.d.ts

@@ -9,10 +9,10 @@ import type { InlineCommentInputMethod, TargetType } from '../types';
 export declare const updateInlineCommentResolvedState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (partialNewState: InlineCommentMap, resolveMethod?: RESOLVE_METHOD) => Command;
 export declare const closeComponent: () => Command;
 export declare const clearDirtyMark: () => Command;
-export declare const flushPendingSelections: (canSetAsSelectedAnnotations: boolean) => Command;
+export declare const flushPendingSelections: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (canSetAsSelectedAnnotations: boolean, errorReason?: string) => Command;
 export declare const setPendingSelectedAnnotation: (id: string) => Command;
 export declare const removeInlineCommentNearSelection: (id: string, supportedNodes?: string[]) => Command;
-export declare const removeInlineCommentFromDoc: (id: string, supportedNodes?: string[]) => Command;
+export declare const removeInlineCommentFromDoc: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (id: string, supportedNodes?: string[]) => Command;
 /**
  * Show active inline comments for a given block node, otherwise,
  * return false if the node has no comments or no unresolved comments.

package/dist/types-ts4.5/editor-commands/transform.d.ts

@@ -18,5 +18,7 @@ declare const _default: {
     addOpenCloseAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, method?: InlineCommentInputMethod) => (transaction: Transaction, state: EditorState) => Transaction;
     addInsertAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
     addResolveAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (method?: RESOLVE_METHOD | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
+    addPreemptiveGateErrorAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (errorReason?: string | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
+    addDeleteAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
 };
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-annotation",
-	"version": "2.9.1",
+	"version": "2.9.2",
 	"description": "Annotation plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -42,7 +42,7 @@
 		"@atlaskit/icon": "^26.4.0",
 		"@atlaskit/onboarding": "^14.2.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^5.2.0",
+		"@atlaskit/tmp-editor-statsig": "^5.5.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {