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

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/editor-plugin-collab-edit
 
+## 1.18.0
+
+### Minor Changes
+
+- [`6035369220646`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/6035369220646) -
+  Refined logic of sanitizeStep to include stepInstance information
+
+## 1.17.0
+
+### Minor Changes
+
+- [#134540](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/134540)
+  [`46242fbed9aeb`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/46242fbed9aeb) -
+  Exclude AnalyticsStep, ReplaceStep and ReplaceAround step from filtering
+
 ## 1.16.1
 
 ### Patch Changes

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

@@ -22,6 +22,12 @@ var createFilterTransaction = exports.createFilterTransaction = function createF
     if (isRemote) {
       return true;
     }
+    var containsExcludedSteps = tr.steps.some(function (step) {
+      return step instanceof _steps.AnalyticsStep || step instanceof _transform.ReplaceStep || step instanceof _transform.ReplaceAroundStep;
+    });
+    if (containsExcludedSteps) {
+      return true;
+    }
     if (tr.docChanged && tr.doc.eq(tr.before)) {
       var transactionKey = generateTransactionKey(tr);
       if (!transactionKey) {
@@ -58,12 +64,12 @@ var createFilterTransaction = exports.createFilterTransaction = function createF
 
 // Helper function to create a u ique transaction key
 function generateTransactionKey(tr) {
-  return tr.steps.map(function (step) {
-    if (step instanceof _transform.RemoveNodeMarkStep || step instanceof _transform.AddNodeMarkStep || step instanceof _steps.SetAttrsStep || step instanceof _transform.AttrStep || step instanceof _steps.AnalyticsStep) {
+  var stepPositions = tr.steps.map(function (step) {
+    if (step instanceof _transform.RemoveNodeMarkStep || step instanceof _transform.AddNodeMarkStep || step instanceof _steps.SetAttrsStep || step instanceof _transform.AttrStep) {
       if (step.pos !== undefined) {
         return "".concat(step.pos);
       }
-    } else if (step instanceof _transform.AddMarkStep || step instanceof _transform.RemoveMarkStep || step instanceof _transform.ReplaceAroundStep || step instanceof _transform.ReplaceStep) {
+    } else if (step instanceof _transform.AddMarkStep || step instanceof _transform.RemoveMarkStep) {
       return "from_".concat(step.from, "_to_").concat(step.to);
     } else if (step instanceof _steps.LinkMetaStep) {
       return "from_".concat(step.toJSON().from, "_to_").concat(step.toJSON().to);
@@ -71,7 +77,13 @@ function generateTransactionKey(tr) {
       return "insertTypeAheadStep";
     }
     return '';
-  }).join('_');
+  });
+  if (stepPositions.some(function (step) {
+    return Boolean(step);
+  })) {
+    return stepPositions.join('_');
+  }
+  return '';
 }
 var trackSpammingStepsPluginKey = exports.trackSpammingStepsPluginKey = new _state.PluginKey('trackAndFilterSpammingStepsPluginKey');
 var createPlugin = exports.createPlugin = function createPlugin(trackFilteredTransaction) {

package/dist/cjs/track-steps.js

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

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

@@ -14,6 +14,12 @@ export const createFilterTransaction = (recentTransactionsTimestamps, trackFilte
     if (isRemote) {
       return true;
     }
+    const containsExcludedSteps = tr.steps.some(step => {
+      return step instanceof AnalyticsStep || step instanceof ReplaceStep || step instanceof ReplaceAroundStep;
+    });
+    if (containsExcludedSteps) {
+      return true;
+    }
     if (tr.docChanged && tr.doc.eq(tr.before)) {
       const transactionKey = generateTransactionKey(tr);
       if (!transactionKey) {
@@ -50,12 +56,12 @@ export const createFilterTransaction = (recentTransactionsTimestamps, trackFilte
 
 // Helper function to create a u ique transaction key
 export function generateTransactionKey(tr) {
-  return tr.steps.map(step => {
-    if (step instanceof RemoveNodeMarkStep || step instanceof AddNodeMarkStep || step instanceof SetAttrsStep || step instanceof AttrStep || step instanceof AnalyticsStep) {
+  const stepPositions = tr.steps.map(step => {
+    if (step instanceof RemoveNodeMarkStep || step instanceof AddNodeMarkStep || step instanceof SetAttrsStep || step instanceof AttrStep) {
       if (step.pos !== undefined) {
         return `${step.pos}`;
       }
-    } else if (step instanceof AddMarkStep || step instanceof RemoveMarkStep || step instanceof ReplaceAroundStep || step instanceof ReplaceStep) {
+    } else if (step instanceof AddMarkStep || step instanceof RemoveMarkStep) {
       return `from_${step.from}_to_${step.to}`;
     } else if (step instanceof LinkMetaStep) {
       return `from_${step.toJSON().from}_to_${step.toJSON().to}`;
@@ -63,7 +69,11 @@ export function generateTransactionKey(tr) {
       return `insertTypeAheadStep`;
     }
     return '';
-  }).join('_');
+  });
+  if (stepPositions.some(step => Boolean(step))) {
+    return stepPositions.join('_');
+  }
+  return '';
 }
 export const trackSpammingStepsPluginKey = new PluginKey('trackAndFilterSpammingStepsPluginKey');
 export const createPlugin = trackFilteredTransaction => {

package/dist/es2019/track-steps.js

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

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

@@ -14,6 +14,12 @@ export var createFilterTransaction = function createFilterTransaction(recentTran
     if (isRemote) {
       return true;
     }
+    var containsExcludedSteps = tr.steps.some(function (step) {
+      return step instanceof AnalyticsStep || step instanceof ReplaceStep || step instanceof ReplaceAroundStep;
+    });
+    if (containsExcludedSteps) {
+      return true;
+    }
     if (tr.docChanged && tr.doc.eq(tr.before)) {
       var transactionKey = generateTransactionKey(tr);
       if (!transactionKey) {
@@ -50,12 +56,12 @@ export var createFilterTransaction = function createFilterTransaction(recentTran
 
 // Helper function to create a u ique transaction key
 export function generateTransactionKey(tr) {
-  return tr.steps.map(function (step) {
-    if (step instanceof RemoveNodeMarkStep || step instanceof AddNodeMarkStep || step instanceof SetAttrsStep || step instanceof AttrStep || step instanceof AnalyticsStep) {
+  var stepPositions = tr.steps.map(function (step) {
+    if (step instanceof RemoveNodeMarkStep || step instanceof AddNodeMarkStep || step instanceof SetAttrsStep || step instanceof AttrStep) {
       if (step.pos !== undefined) {
         return "".concat(step.pos);
       }
-    } else if (step instanceof AddMarkStep || step instanceof RemoveMarkStep || step instanceof ReplaceAroundStep || step instanceof ReplaceStep) {
+    } else if (step instanceof AddMarkStep || step instanceof RemoveMarkStep) {
       return "from_".concat(step.from, "_to_").concat(step.to);
     } else if (step instanceof LinkMetaStep) {
       return "from_".concat(step.toJSON().from, "_to_").concat(step.toJSON().to);
@@ -63,7 +69,13 @@ export function generateTransactionKey(tr) {
       return "insertTypeAheadStep";
     }
     return '';
-  }).join('_');
+  });
+  if (stepPositions.some(function (step) {
+    return Boolean(step);
+  })) {
+    return stepPositions.join('_');
+  }
+  return '';
 }
 export var trackSpammingStepsPluginKey = new PluginKey('trackAndFilterSpammingStepsPluginKey');
 export var createPlugin = function createPlugin(trackFilteredTransaction) {

package/dist/esm/track-steps.js

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

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

@@ -2,6 +2,7 @@ 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/track-steps.d.ts

@@ -2,6 +2,7 @@ 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.16.1",
+	"version": "1.18.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.2.0",
+		"@atlaskit/editor-common": "^88.4.0",
 		"@atlaskit/editor-plugin-analytics": "1.8.2",
 		"@atlaskit/editor-plugin-editor-viewmode": "^2.1.0",
 		"@atlaskit/editor-plugin-feature-flags": "^1.2.0",