@atlaskit/editor-plugin-collab-edit 1.18.0 → 1.19.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-plugin-collab-edit
 
+## 1.19.0
+
+### Minor Changes
+
+- [#132314](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/132314)
+  [`92f67ece07ca1`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/92f67ece07ca1) -
+  Refined logic of sanitizeStep to include stepInstance information
+- [#132314](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/132314)
+  [`92f67ece07ca1`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/92f67ece07ca1) -
+  Improve implementation of serializeStep to include stepInstance namefor more detailed analytics
+  log.
+
 ## 1.18.0
 
 ### Minor Changes

package/dist/cjs/plugin.js

@@ -181,7 +181,7 @@ var collabEditPlugin = exports.collabEditPlugin = function collabEditPlugin(_ref
             return (0, _trackAndFilterSpammingSteps.createPlugin)(function (tr) {
               var _api$analytics;
               var sanitizedSteps = tr.steps.map(function (step) {
-                return (0, _trackSteps.sanitizeStep)(step);
+                return (0, _trackAndFilterSpammingSteps.sanitizeFilteredStep)(step);
               });
               api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 || (_api$analytics = _api$analytics.actions) === null || _api$analytics === void 0 || _api$analytics.fireAnalyticsEvent({
                 action: _analytics.ACTION.STEPS_FILTERED,

package/dist/cjs/pm-plugins/track-and-filter-spamming-steps.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.createPlugin = exports.createFilterTransaction = void 0;
 exports.generateTransactionKey = generateTransactionKey;
-exports.trackSpammingStepsPluginKey = void 0;
+exports.trackSpammingStepsPluginKey = exports.sanitizeFilteredStep = void 0;
 var _steps = require("@atlaskit/adf-schema/steps");
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _state = require("@atlaskit/editor-prosemirror/state");
@@ -13,6 +13,61 @@ var _transform = require("@atlaskit/editor-prosemirror/transform");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var THRESHOLD = 50; // 50 milliseconds
 
+/**
+ * Sanitizes a given ProseMirror step by extracting its type and non-UCG relevant attributes.
+ *
+ * @param {Step} step - The ProseMirror step to be sanitized.
+ * @returns {SanitizedFilteredStep} - The sanitized step with only necessary information.
+ *
+ * @example
+ * ```
+ * const step = new AttrStep(10, 'colwidth', [123, 451] );
+ * const sanitized = sanitizeFilteredStep(step);
+ *
+ * // Output: { stepType: 'attr', stepInstance: 'AttrStep', attr: 'example' }
+ * ```
+ */
+var sanitizeFilteredStep = exports.sanitizeFilteredStep = function sanitizeFilteredStep(step) {
+  var serializedStep = step.toJSON();
+  var sanitizedStep = {
+    stepType: serializedStep.stepType,
+    stepInstance: 'unknown'
+  };
+  if (step instanceof _transform.AttrStep) {
+    sanitizedStep.attr = step.attr;
+    sanitizedStep.stepInstance = 'AttrStep';
+  } else if (step instanceof _transform.DocAttrStep) {
+    sanitizedStep.attr = step.attr;
+    sanitizedStep.stepInstance = 'DocAttrStep';
+  } else if (step instanceof _steps.SetAttrsStep) {
+    // Combines all attrs keys separated by _ to one single string
+    sanitizedStep.attr = Object.keys(step.attrs).sort().join('_');
+    sanitizedStep.stepInstance = 'SetAttrsStep';
+  } else if (step instanceof _transform.AddMarkStep) {
+    sanitizedStep.markType = step.mark.type.name;
+    sanitizedStep.stepInstance = 'AddMarkStep';
+  } else if (step instanceof _transform.RemoveMarkStep) {
+    sanitizedStep.markType = step.mark.type.name;
+    sanitizedStep.stepInstance = 'RemoveMarkStep';
+  } else if (step instanceof _transform.RemoveNodeMarkStep) {
+    sanitizedStep.markType = step.mark.type.name;
+    sanitizedStep.stepInstance = 'RemoveNodeMarkStep';
+  } else if (step instanceof _transform.AddNodeMarkStep) {
+    sanitizedStep.markType = step.mark.type.name;
+    sanitizedStep.stepInstance = 'AddNodeMarkStep';
+  } else if (step instanceof _transform.ReplaceStep) {
+    sanitizedStep.stepInstance = 'ReplaceStep';
+  } else if (step instanceof _transform.ReplaceAroundStep) {
+    sanitizedStep.stepInstance = 'ReplaceAroundStep';
+  } else if (step instanceof _steps.AnalyticsStep) {
+    sanitizedStep.stepInstance = 'AnalyticsStep';
+  } else if (step instanceof _steps.InsertTypeAheadStep) {
+    sanitizedStep.stepInstance = 'InsertTypeAheadStep';
+  } else if (step instanceof _steps.LinkMetaStep) {
+    sanitizedStep.stepInstance = 'LinkMetaStep';
+  }
+  return sanitizedStep;
+};
 var createFilterTransaction = exports.createFilterTransaction = function createFilterTransaction(recentTransactionsTimestamps, trackFilteredTransaction) {
   return function (tr) {
     if (Boolean(tr.getMeta('appendTransaction'))) {

package/dist/cjs/track-steps.js

@@ -47,8 +47,7 @@ function groupBy(array, keyGetter) {
 var sanitizeStep = exports.sanitizeStep = function sanitizeStep(step) {
   var serializedStep = step.toJSON();
   var sanitizedStep = {
-    stepType: serializedStep.stepType,
-    stepInstance: step.constructor.name
+    stepType: serializedStep.stepType
   };
   if (step instanceof _transform.AttrStep || step instanceof _transform.DocAttrStep) {
     sanitizedStep.attr = step.attr;

package/dist/es2019/plugin.js

@@ -7,10 +7,10 @@ import { sendTransaction } from './events/send-transaction';
 import { createPlugin } from './pm-plugins/main';
 import { pluginKey as mainPluginKey } from './pm-plugins/main/plugin-key';
 import { nativeCollabProviderPlugin } from './pm-plugins/native-collab-provider-plugin';
-import { createPlugin as trackSpammingStepsPlugin } from './pm-plugins/track-and-filter-spamming-steps';
+import { sanitizeFilteredStep, createPlugin as trackSpammingStepsPlugin } from './pm-plugins/track-and-filter-spamming-steps';
 import { createPlugin as createLastOrganicChangePlugin, trackLastOrganicChangePluginKey } from './pm-plugins/track-last-organic-change';
 import { createPlugin as createTrackNCSInitializationPlugin, trackNCSInitializationPluginKey } from './pm-plugins/track-ncs-initialization';
-import { sanitizeStep, track } from './track-steps';
+import { track } from './track-steps';
 import { getAvatarColor } from './utils';
 const providerBuilder = collabEditProviderPromise => async (codeToExecute, onError) => {
   try {
@@ -134,7 +134,7 @@ export const collabEditPlugin = ({
           name: 'trackAndFilterSpammingSteps',
           plugin: () => trackSpammingStepsPlugin(tr => {
             var _api$analytics, _api$analytics$action;
-            const sanitizedSteps = tr.steps.map(step => sanitizeStep(step));
+            const sanitizedSteps = tr.steps.map(step => sanitizeFilteredStep(step));
             api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : (_api$analytics$action = _api$analytics.actions) === null || _api$analytics$action === void 0 ? void 0 : _api$analytics$action.fireAnalyticsEvent({
               action: ACTION.STEPS_FILTERED,
               actionSubject: ACTION_SUBJECT.COLLAB,

package/dist/es2019/pm-plugins/track-and-filter-spamming-steps.js

@@ -1,10 +1,65 @@
 import { AnalyticsStep, InsertTypeAheadStep, LinkMetaStep, SetAttrsStep } from '@atlaskit/adf-schema/steps';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import { AddMarkStep, AddNodeMarkStep, AttrStep, RemoveMarkStep, RemoveNodeMarkStep, ReplaceAroundStep, ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+import { AddMarkStep, AddNodeMarkStep, AttrStep, DocAttrStep, RemoveMarkStep, RemoveNodeMarkStep, ReplaceAroundStep, ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 import { fg } from '@atlaskit/platform-feature-flags';
 const THRESHOLD = 50; // 50 milliseconds
 
+/**
+ * Sanitizes a given ProseMirror step by extracting its type and non-UCG relevant attributes.
+ *
+ * @param {Step} step - The ProseMirror step to be sanitized.
+ * @returns {SanitizedFilteredStep} - The sanitized step with only necessary information.
+ *
+ * @example
+ * ```
+ * const step = new AttrStep(10, 'colwidth', [123, 451] );
+ * const sanitized = sanitizeFilteredStep(step);
+ *
+ * // Output: { stepType: 'attr', stepInstance: 'AttrStep', attr: 'example' }
+ * ```
+ */
+export const sanitizeFilteredStep = step => {
+  const serializedStep = step.toJSON();
+  const sanitizedStep = {
+    stepType: serializedStep.stepType,
+    stepInstance: 'unknown'
+  };
+  if (step instanceof AttrStep) {
+    sanitizedStep.attr = step.attr;
+    sanitizedStep.stepInstance = 'AttrStep';
+  } else if (step instanceof DocAttrStep) {
+    sanitizedStep.attr = step.attr;
+    sanitizedStep.stepInstance = 'DocAttrStep';
+  } else if (step instanceof SetAttrsStep) {
+    // Combines all attrs keys separated by _ to one single string
+    sanitizedStep.attr = Object.keys(step.attrs).sort().join('_');
+    sanitizedStep.stepInstance = 'SetAttrsStep';
+  } else if (step instanceof AddMarkStep) {
+    sanitizedStep.markType = step.mark.type.name;
+    sanitizedStep.stepInstance = 'AddMarkStep';
+  } else if (step instanceof RemoveMarkStep) {
+    sanitizedStep.markType = step.mark.type.name;
+    sanitizedStep.stepInstance = 'RemoveMarkStep';
+  } else if (step instanceof RemoveNodeMarkStep) {
+    sanitizedStep.markType = step.mark.type.name;
+    sanitizedStep.stepInstance = 'RemoveNodeMarkStep';
+  } else if (step instanceof AddNodeMarkStep) {
+    sanitizedStep.markType = step.mark.type.name;
+    sanitizedStep.stepInstance = 'AddNodeMarkStep';
+  } else if (step instanceof ReplaceStep) {
+    sanitizedStep.stepInstance = 'ReplaceStep';
+  } else if (step instanceof ReplaceAroundStep) {
+    sanitizedStep.stepInstance = 'ReplaceAroundStep';
+  } else if (step instanceof AnalyticsStep) {
+    sanitizedStep.stepInstance = 'AnalyticsStep';
+  } else if (step instanceof InsertTypeAheadStep) {
+    sanitizedStep.stepInstance = 'InsertTypeAheadStep';
+  } else if (step instanceof LinkMetaStep) {
+    sanitizedStep.stepInstance = 'LinkMetaStep';
+  }
+  return sanitizedStep;
+};
 export const createFilterTransaction = (recentTransactionsTimestamps, trackFilteredTransaction) => {
   return tr => {
     if (Boolean(tr.getMeta('appendTransaction'))) {

package/dist/es2019/track-steps.js

@@ -36,8 +36,7 @@ function groupBy(array, keyGetter) {
 export const sanitizeStep = step => {
   const serializedStep = step.toJSON();
   const sanitizedStep = {
-    stepType: serializedStep.stepType,
-    stepInstance: step.constructor.name
+    stepType: serializedStep.stepType
   };
   if (step instanceof AttrStep || step instanceof DocAttrStep) {
     sanitizedStep.attr = step.attr;

package/dist/esm/plugin.js

@@ -13,10 +13,10 @@ import { sendTransaction } from './events/send-transaction';
 import { createPlugin } from './pm-plugins/main';
 import { pluginKey as mainPluginKey } from './pm-plugins/main/plugin-key';
 import { nativeCollabProviderPlugin } from './pm-plugins/native-collab-provider-plugin';
-import { createPlugin as trackSpammingStepsPlugin } from './pm-plugins/track-and-filter-spamming-steps';
+import { sanitizeFilteredStep, createPlugin as trackSpammingStepsPlugin } from './pm-plugins/track-and-filter-spamming-steps';
 import { createPlugin as createLastOrganicChangePlugin, trackLastOrganicChangePluginKey } from './pm-plugins/track-last-organic-change';
 import { createPlugin as createTrackNCSInitializationPlugin, trackNCSInitializationPluginKey } from './pm-plugins/track-ncs-initialization';
-import { sanitizeStep, track } from './track-steps';
+import { track } from './track-steps';
 import { getAvatarColor } from './utils';
 var providerBuilder = function providerBuilder(collabEditProviderPromise) {
   return /*#__PURE__*/function () {
@@ -174,7 +174,7 @@ export var collabEditPlugin = function collabEditPlugin(_ref4) {
             return trackSpammingStepsPlugin(function (tr) {
               var _api$analytics;
               var sanitizedSteps = tr.steps.map(function (step) {
-                return sanitizeStep(step);
+                return sanitizeFilteredStep(step);
               });
               api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 || (_api$analytics = _api$analytics.actions) === null || _api$analytics === void 0 || _api$analytics.fireAnalyticsEvent({
                 action: ACTION.STEPS_FILTERED,

package/dist/esm/pm-plugins/track-and-filter-spamming-steps.js

@@ -1,10 +1,65 @@
 import { AnalyticsStep, InsertTypeAheadStep, LinkMetaStep, SetAttrsStep } from '@atlaskit/adf-schema/steps';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import { AddMarkStep, AddNodeMarkStep, AttrStep, RemoveMarkStep, RemoveNodeMarkStep, ReplaceAroundStep, ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+import { AddMarkStep, AddNodeMarkStep, AttrStep, DocAttrStep, RemoveMarkStep, RemoveNodeMarkStep, ReplaceAroundStep, ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 import { fg } from '@atlaskit/platform-feature-flags';
 var THRESHOLD = 50; // 50 milliseconds
 
+/**
+ * Sanitizes a given ProseMirror step by extracting its type and non-UCG relevant attributes.
+ *
+ * @param {Step} step - The ProseMirror step to be sanitized.
+ * @returns {SanitizedFilteredStep} - The sanitized step with only necessary information.
+ *
+ * @example
+ * ```
+ * const step = new AttrStep(10, 'colwidth', [123, 451] );
+ * const sanitized = sanitizeFilteredStep(step);
+ *
+ * // Output: { stepType: 'attr', stepInstance: 'AttrStep', attr: 'example' }
+ * ```
+ */
+export var sanitizeFilteredStep = function sanitizeFilteredStep(step) {
+  var serializedStep = step.toJSON();
+  var sanitizedStep = {
+    stepType: serializedStep.stepType,
+    stepInstance: 'unknown'
+  };
+  if (step instanceof AttrStep) {
+    sanitizedStep.attr = step.attr;
+    sanitizedStep.stepInstance = 'AttrStep';
+  } else if (step instanceof DocAttrStep) {
+    sanitizedStep.attr = step.attr;
+    sanitizedStep.stepInstance = 'DocAttrStep';
+  } else if (step instanceof SetAttrsStep) {
+    // Combines all attrs keys separated by _ to one single string
+    sanitizedStep.attr = Object.keys(step.attrs).sort().join('_');
+    sanitizedStep.stepInstance = 'SetAttrsStep';
+  } else if (step instanceof AddMarkStep) {
+    sanitizedStep.markType = step.mark.type.name;
+    sanitizedStep.stepInstance = 'AddMarkStep';
+  } else if (step instanceof RemoveMarkStep) {
+    sanitizedStep.markType = step.mark.type.name;
+    sanitizedStep.stepInstance = 'RemoveMarkStep';
+  } else if (step instanceof RemoveNodeMarkStep) {
+    sanitizedStep.markType = step.mark.type.name;
+    sanitizedStep.stepInstance = 'RemoveNodeMarkStep';
+  } else if (step instanceof AddNodeMarkStep) {
+    sanitizedStep.markType = step.mark.type.name;
+    sanitizedStep.stepInstance = 'AddNodeMarkStep';
+  } else if (step instanceof ReplaceStep) {
+    sanitizedStep.stepInstance = 'ReplaceStep';
+  } else if (step instanceof ReplaceAroundStep) {
+    sanitizedStep.stepInstance = 'ReplaceAroundStep';
+  } else if (step instanceof AnalyticsStep) {
+    sanitizedStep.stepInstance = 'AnalyticsStep';
+  } else if (step instanceof InsertTypeAheadStep) {
+    sanitizedStep.stepInstance = 'InsertTypeAheadStep';
+  } else if (step instanceof LinkMetaStep) {
+    sanitizedStep.stepInstance = 'LinkMetaStep';
+  }
+  return sanitizedStep;
+};
 export var createFilterTransaction = function createFilterTransaction(recentTransactionsTimestamps, trackFilteredTransaction) {
   return function (tr) {
     if (Boolean(tr.getMeta('appendTransaction'))) {

package/dist/esm/track-steps.js

@@ -40,8 +40,7 @@ function groupBy(array, keyGetter) {
 export var sanitizeStep = function sanitizeStep(step) {
   var serializedStep = step.toJSON();
   var sanitizedStep = {
-    stepType: serializedStep.stepType,
-    stepInstance: step.constructor.name
+    stepType: serializedStep.stepType
   };
   if (step instanceof AttrStep || step instanceof DocAttrStep) {
     sanitizedStep.attr = step.attr;

package/dist/types/pm-plugins/track-and-filter-spamming-steps.d.ts

@@ -8,6 +8,27 @@ export type RecentTransactionTimestamp = {
 };
 export type RecentTransactionTimestamps = Map<string, RecentTransactionTimestamp>;
 export type TrackFilteredTransaction = (tr: Transaction) => void;
+export type SanitizedFilteredStep = {
+    stepType: string;
+    stepInstance?: string;
+    attr?: string;
+    markType?: string;
+};
+/**
+ * Sanitizes a given ProseMirror step by extracting its type and non-UCG relevant attributes.
+ *
+ * @param {Step} step - The ProseMirror step to be sanitized.
+ * @returns {SanitizedFilteredStep} - The sanitized step with only necessary information.
+ *
+ * @example
+ * ```
+ * const step = new AttrStep(10, 'colwidth', [123, 451] );
+ * const sanitized = sanitizeFilteredStep(step);
+ *
+ * // Output: { stepType: 'attr', stepInstance: 'AttrStep', attr: 'example' }
+ * ```
+ */
+export declare const sanitizeFilteredStep: (step: Step) => SanitizedFilteredStep;
 export declare const createFilterTransaction: (recentTransactionsTimestamps: RecentTransactionTimestamps, trackFilteredTransaction: TrackFilteredTransaction) => (tr: Transaction) => boolean;
 export declare function generateTransactionKey(tr: Transaction): string;
 export declare const trackSpammingStepsPluginKey: PluginKey<TrackSpammingStepsMetadata>;

package/dist/types/track-steps.d.ts

@@ -2,7 +2,6 @@ import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/stat
 import type { Step } from '@atlaskit/editor-prosemirror/transform';
 export type SanitizedStep = {
     stepType: string;
-    stepInstance: string;
     attr?: string;
     markType?: string;
 };

package/dist/types-ts4.5/pm-plugins/track-and-filter-spamming-steps.d.ts

@@ -8,6 +8,27 @@ export type RecentTransactionTimestamp = {
 };
 export type RecentTransactionTimestamps = Map<string, RecentTransactionTimestamp>;
 export type TrackFilteredTransaction = (tr: Transaction) => void;
+export type SanitizedFilteredStep = {
+    stepType: string;
+    stepInstance?: string;
+    attr?: string;
+    markType?: string;
+};
+/**
+ * Sanitizes a given ProseMirror step by extracting its type and non-UCG relevant attributes.
+ *
+ * @param {Step} step - The ProseMirror step to be sanitized.
+ * @returns {SanitizedFilteredStep} - The sanitized step with only necessary information.
+ *
+ * @example
+ * ```
+ * const step = new AttrStep(10, 'colwidth', [123, 451] );
+ * const sanitized = sanitizeFilteredStep(step);
+ *
+ * // Output: { stepType: 'attr', stepInstance: 'AttrStep', attr: 'example' }
+ * ```
+ */
+export declare const sanitizeFilteredStep: (step: Step) => SanitizedFilteredStep;
 export declare const createFilterTransaction: (recentTransactionsTimestamps: RecentTransactionTimestamps, trackFilteredTransaction: TrackFilteredTransaction) => (tr: Transaction) => boolean;
 export declare function generateTransactionKey(tr: Transaction): string;
 export declare const trackSpammingStepsPluginKey: PluginKey<TrackSpammingStepsMetadata>;

package/dist/types-ts4.5/track-steps.d.ts

@@ -2,7 +2,6 @@ import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/stat
 import type { Step } from '@atlaskit/editor-prosemirror/transform';
 export type SanitizedStep = {
     stepType: string;
-    stepInstance: string;
     attr?: string;
     markType?: string;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-collab-edit",
-	"version": "1.18.0",
+	"version": "1.19.0",
 	"description": "Collab Edit plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -34,7 +34,7 @@
 	"dependencies": {
 		"@atlaskit/adf-schema": "^40.9.0",
 		"@atlaskit/custom-steps": "^0.7.0",
-		"@atlaskit/editor-common": "^88.4.0",
+		"@atlaskit/editor-common": "^88.5.0",
 		"@atlaskit/editor-plugin-analytics": "1.8.2",
 		"@atlaskit/editor-plugin-editor-viewmode": "^2.1.0",
 		"@atlaskit/editor-plugin-feature-flags": "^1.2.0",