@atlaskit/editor-plugin-collab-edit 3.7.2 → 3.8.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-plugin-collab-edit
 
+## 3.8.0
+
+### Minor Changes
+
+- [#154562](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/154562)
+  [`9a3495cb72638`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/9a3495cb72638) -
+  Support AnalyticsStep filtering for collab
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 3.7.2
 
 ### Patch Changes

package/dist/cjs/collabEditPlugin.js

@@ -201,14 +201,22 @@ var collabEditPlugin = exports.collabEditPlugin = function collabEditPlugin(_ref
         useNativePlugin = _ref5$useNativePlugin === void 0 ? false : _ref5$useNativePlugin,
         _ref5$userId = _ref5.userId,
         userId = _ref5$userId === void 0 ? null : _ref5$userId;
+      var transformUnconfirmed = function transformUnconfirmed(steps) {
+        var transformed = steps;
+        if ((0, _experiments.editorExperiment)('platform_editor_reduce_noisy_steps_ncs', true)) {
+          transformed = (0, _mergeUnconfirmed.filterAnalyticsSteps)(transformed);
+        }
+        if ((0, _experiments.editorExperiment)('platform_editor_offline_editing_web', true)) {
+          transformed = (0, _mergeUnconfirmed.mergeUnconfirmedSteps)(transformed, api);
+        }
+        return transformed;
+      };
       var plugins = [].concat((0, _toConsumableArray2.default)(useNativePlugin ? [{
         name: 'pmCollab',
         plugin: function plugin() {
           return (0, _prosemirrorCollab.collab)({
             clientID: userId,
-            transformUnconfirmed: (0, _experiments.editorExperiment)('platform_editor_offline_editing_web', true) ? function (steps) {
-              return (0, _mergeUnconfirmed.mergeUnconfirmedSteps)(steps, api);
-            } : undefined
+            transformUnconfirmed: transformUnconfirmed
           });
         }
       }, {

package/dist/cjs/pm-plugins/events/send-transaction.js

@@ -4,7 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.sendTransaction = void 0;
+var _steps = require("@atlaskit/adf-schema/steps");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _experiments = require("@atlaskit/tmp-editor-statsig/experiments");
 var _actions = require("../actions");
 var _pluginKey = require("../main/plugin-key");
 var sendTransaction = exports.sendTransaction = function sendTransaction(_ref) {
@@ -20,15 +22,23 @@ var sendTransaction = exports.sendTransaction = function sendTransaction(_ref) {
       return tr.docChanged;
     });
     var currentPluginState = _pluginKey.pluginKey.getState(newEditorState);
+    var tr = oldEditorState.tr;
+    var trNoAnalytics = docChangedTransaction === null || docChangedTransaction === void 0 ? void 0 : docChangedTransaction.steps.reduce(function (nextTr, step) {
+      if (!(step instanceof _steps.AnalyticsStep)) {
+        return nextTr.step(step);
+      }
+      return nextTr;
+    }, tr);
     if (!(currentPluginState !== null && currentPluginState !== void 0 && currentPluginState.isReady)) {
       return;
     }
+    var newTransaction = (0, _experiments.editorExperiment)('platform_editor_reduce_noisy_steps_ncs', true) ? trNoAnalytics : docChangedTransaction;
     var shouldSendStepForSynchronyCollabProvider = !originalTransaction.getMeta('isRemote') &&
     // TODO: ED-8995 - We need to do this check to reduce the number of race conditions when working with tables.
     // This metadata is coming from the scaleTable command in table-resizing plugin
-    !originalTransaction.getMeta('scaleTable') && docChangedTransaction;
+    !originalTransaction.getMeta('scaleTable') && ((0, _experiments.editorExperiment)('platform_editor_reduce_noisy_steps_ncs', true) ? newTransaction === null || newTransaction === void 0 ? void 0 : newTransaction.docChanged : true);
     if (useNativePlugin || shouldSendStepForSynchronyCollabProvider) {
-      provider.send(docChangedTransaction, oldEditorState, newEditorState);
+      provider.send(newTransaction, oldEditorState, newEditorState);
     }
     var prevPluginState = _pluginKey.pluginKey.getState(oldEditorState);
     var _ref2 = prevPluginState || {},

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

@@ -4,12 +4,15 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.LockableRebaseable = void 0;
+exports.filterAnalyticsSteps = filterAnalyticsSteps;
 exports.mergeUnconfirmedSteps = mergeUnconfirmedSteps;
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _steps = require("@atlaskit/adf-schema/steps");
 var _state = require("@atlaskit/editor-prosemirror/state");
 // Based on: `packages/editor/prosemirror-collab/src/index.ts`
-var LockableRebaseable = /*#__PURE__*/(0, _createClass2.default)(function LockableRebaseable(step, inverted, origin) {
+var LockableRebaseable = exports.LockableRebaseable = /*#__PURE__*/(0, _createClass2.default)(function LockableRebaseable(step, inverted, origin) {
   (0, _classCallCheck2.default)(this, LockableRebaseable);
   this.step = step;
   this.inverted = inverted;
@@ -53,4 +56,21 @@ function mergeUnconfirmedSteps(steps, api) {
     return acc.concat(new LockableRebaseable(rebaseable.step, rebaseable.inverted, rebaseable.origin instanceof _state.Transaction ? rebaseable.origin.setMeta('isOffline', rebaseable.origin.getMeta('isOffline') === true || isOffline) : rebaseable.origin));
   }, []);
   return mergedSteps;
+}
+
+/**
+ * Filter out AnalyticsStep from the steps.
+ *
+ * @param steps Rebaseable steps
+ * @returns Rebaseable steps
+ * @example
+ */
+function filterAnalyticsSteps(steps) {
+  var filteredSteps = steps.reduce(function (acc, rebaseable) {
+    if (rebaseable.step instanceof _steps.AnalyticsStep) {
+      return acc;
+    }
+    return acc.concat(new LockableRebaseable(rebaseable.step, rebaseable.inverted, rebaseable.origin));
+  }, []);
+  return filteredSteps;
 }

package/dist/es2019/collabEditPlugin.js

@@ -8,7 +8,7 @@ import { addSynchronyErrorAnalytics } from './pm-plugins/analytics';
 import { sendTransaction } from './pm-plugins/events/send-transaction';
 import { createPlugin } from './pm-plugins/main';
 import { pluginKey as mainPluginKey } from './pm-plugins/main/plugin-key';
-import { mergeUnconfirmedSteps } from './pm-plugins/mergeUnconfirmed';
+import { filterAnalyticsSteps, mergeUnconfirmedSteps } from './pm-plugins/mergeUnconfirmed';
 import { nativeCollabProviderPlugin } from './pm-plugins/native-collab-provider-plugin';
 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';
@@ -156,11 +156,21 @@ export const collabEditPlugin = ({
         useNativePlugin = false,
         userId = null
       } = options || {};
+      const transformUnconfirmed = steps => {
+        let transformed = steps;
+        if (editorExperiment('platform_editor_reduce_noisy_steps_ncs', true)) {
+          transformed = filterAnalyticsSteps(transformed);
+        }
+        if (editorExperiment('platform_editor_offline_editing_web', true)) {
+          transformed = mergeUnconfirmedSteps(transformed, api);
+        }
+        return transformed;
+      };
       const plugins = [...(useNativePlugin ? [{
         name: 'pmCollab',
         plugin: () => collab({
           clientID: userId,
-          transformUnconfirmed: editorExperiment('platform_editor_offline_editing_web', true) ? steps => mergeUnconfirmedSteps(steps, api) : undefined
+          transformUnconfirmed
         })
       }, {
         name: 'nativeCollabProviderPlugin',

package/dist/es2019/pm-plugins/events/send-transaction.js

@@ -1,4 +1,6 @@
+import { AnalyticsStep } from '@atlaskit/adf-schema/steps';
 import { fg } from '@atlaskit/platform-feature-flags';
+import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { getSendableSelection } from '../actions';
 import { pluginKey } from '../main/plugin-key';
 export const sendTransaction = ({
@@ -12,15 +14,23 @@ export const sendTransaction = ({
 }) => provider => {
   const docChangedTransaction = transactions.find(tr => tr.docChanged);
   const currentPluginState = pluginKey.getState(newEditorState);
+  const tr = oldEditorState.tr;
+  const trNoAnalytics = docChangedTransaction === null || docChangedTransaction === void 0 ? void 0 : docChangedTransaction.steps.reduce((nextTr, step) => {
+    if (!(step instanceof AnalyticsStep)) {
+      return nextTr.step(step);
+    }
+    return nextTr;
+  }, tr);
   if (!(currentPluginState !== null && currentPluginState !== void 0 && currentPluginState.isReady)) {
     return;
   }
+  const newTransaction = editorExperiment('platform_editor_reduce_noisy_steps_ncs', true) ? trNoAnalytics : docChangedTransaction;
   const shouldSendStepForSynchronyCollabProvider = !originalTransaction.getMeta('isRemote') &&
   // TODO: ED-8995 - We need to do this check to reduce the number of race conditions when working with tables.
   // This metadata is coming from the scaleTable command in table-resizing plugin
-  !originalTransaction.getMeta('scaleTable') && docChangedTransaction;
+  !originalTransaction.getMeta('scaleTable') && (editorExperiment('platform_editor_reduce_noisy_steps_ncs', true) ? newTransaction === null || newTransaction === void 0 ? void 0 : newTransaction.docChanged : true);
   if (useNativePlugin || shouldSendStepForSynchronyCollabProvider) {
-    provider.send(docChangedTransaction, oldEditorState, newEditorState);
+    provider.send(newTransaction, oldEditorState, newEditorState);
   }
   const prevPluginState = pluginKey.getState(oldEditorState);
   const {

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

@@ -1,6 +1,7 @@
+import { AnalyticsStep } from '@atlaskit/adf-schema/steps';
 import { Transaction } from '@atlaskit/editor-prosemirror/state';
 // Based on: `packages/editor/prosemirror-collab/src/index.ts`
-class LockableRebaseable {
+export class LockableRebaseable {
   constructor(step, inverted, origin) {
     this.step = step;
     this.inverted = inverted;
@@ -45,4 +46,21 @@ export function mergeUnconfirmedSteps(steps, api) {
     return acc.concat(new LockableRebaseable(rebaseable.step, rebaseable.inverted, rebaseable.origin instanceof Transaction ? rebaseable.origin.setMeta('isOffline', rebaseable.origin.getMeta('isOffline') === true || isOffline) : rebaseable.origin));
   }, []);
   return mergedSteps;
+}
+
+/**
+ * Filter out AnalyticsStep from the steps.
+ *
+ * @param steps Rebaseable steps
+ * @returns Rebaseable steps
+ * @example
+ */
+export function filterAnalyticsSteps(steps) {
+  const filteredSteps = steps.reduce((acc, rebaseable) => {
+    if (rebaseable.step instanceof AnalyticsStep) {
+      return acc;
+    }
+    return acc.concat(new LockableRebaseable(rebaseable.step, rebaseable.inverted, rebaseable.origin));
+  }, []);
+  return filteredSteps;
 }

package/dist/esm/collabEditPlugin.js

@@ -14,7 +14,7 @@ import { addSynchronyErrorAnalytics } from './pm-plugins/analytics';
 import { sendTransaction } from './pm-plugins/events/send-transaction';
 import { createPlugin } from './pm-plugins/main';
 import { pluginKey as mainPluginKey } from './pm-plugins/main/plugin-key';
-import { mergeUnconfirmedSteps } from './pm-plugins/mergeUnconfirmed';
+import { filterAnalyticsSteps, mergeUnconfirmedSteps } from './pm-plugins/mergeUnconfirmed';
 import { nativeCollabProviderPlugin } from './pm-plugins/native-collab-provider-plugin';
 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';
@@ -194,14 +194,22 @@ export var collabEditPlugin = function collabEditPlugin(_ref4) {
         useNativePlugin = _ref5$useNativePlugin === void 0 ? false : _ref5$useNativePlugin,
         _ref5$userId = _ref5.userId,
         userId = _ref5$userId === void 0 ? null : _ref5$userId;
+      var transformUnconfirmed = function transformUnconfirmed(steps) {
+        var transformed = steps;
+        if (editorExperiment('platform_editor_reduce_noisy_steps_ncs', true)) {
+          transformed = filterAnalyticsSteps(transformed);
+        }
+        if (editorExperiment('platform_editor_offline_editing_web', true)) {
+          transformed = mergeUnconfirmedSteps(transformed, api);
+        }
+        return transformed;
+      };
       var plugins = [].concat(_toConsumableArray(useNativePlugin ? [{
         name: 'pmCollab',
         plugin: function plugin() {
           return collab({
             clientID: userId,
-            transformUnconfirmed: editorExperiment('platform_editor_offline_editing_web', true) ? function (steps) {
-              return mergeUnconfirmedSteps(steps, api);
-            } : undefined
+            transformUnconfirmed: transformUnconfirmed
           });
         }
       }, {

package/dist/esm/pm-plugins/events/send-transaction.js

@@ -1,4 +1,6 @@
+import { AnalyticsStep } from '@atlaskit/adf-schema/steps';
 import { fg } from '@atlaskit/platform-feature-flags';
+import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { getSendableSelection } from '../actions';
 import { pluginKey } from '../main/plugin-key';
 export var sendTransaction = function sendTransaction(_ref) {
@@ -14,15 +16,23 @@ export var sendTransaction = function sendTransaction(_ref) {
       return tr.docChanged;
     });
     var currentPluginState = pluginKey.getState(newEditorState);
+    var tr = oldEditorState.tr;
+    var trNoAnalytics = docChangedTransaction === null || docChangedTransaction === void 0 ? void 0 : docChangedTransaction.steps.reduce(function (nextTr, step) {
+      if (!(step instanceof AnalyticsStep)) {
+        return nextTr.step(step);
+      }
+      return nextTr;
+    }, tr);
     if (!(currentPluginState !== null && currentPluginState !== void 0 && currentPluginState.isReady)) {
       return;
     }
+    var newTransaction = editorExperiment('platform_editor_reduce_noisy_steps_ncs', true) ? trNoAnalytics : docChangedTransaction;
     var shouldSendStepForSynchronyCollabProvider = !originalTransaction.getMeta('isRemote') &&
     // TODO: ED-8995 - We need to do this check to reduce the number of race conditions when working with tables.
     // This metadata is coming from the scaleTable command in table-resizing plugin
-    !originalTransaction.getMeta('scaleTable') && docChangedTransaction;
+    !originalTransaction.getMeta('scaleTable') && (editorExperiment('platform_editor_reduce_noisy_steps_ncs', true) ? newTransaction === null || newTransaction === void 0 ? void 0 : newTransaction.docChanged : true);
     if (useNativePlugin || shouldSendStepForSynchronyCollabProvider) {
-      provider.send(docChangedTransaction, oldEditorState, newEditorState);
+      provider.send(newTransaction, oldEditorState, newEditorState);
     }
     var prevPluginState = pluginKey.getState(oldEditorState);
     var _ref2 = prevPluginState || {},

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

@@ -1,8 +1,9 @@
 import _createClass from "@babel/runtime/helpers/createClass";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import { AnalyticsStep } from '@atlaskit/adf-schema/steps';
 import { Transaction } from '@atlaskit/editor-prosemirror/state';
 // Based on: `packages/editor/prosemirror-collab/src/index.ts`
-var LockableRebaseable = /*#__PURE__*/_createClass(function LockableRebaseable(step, inverted, origin) {
+export var LockableRebaseable = /*#__PURE__*/_createClass(function LockableRebaseable(step, inverted, origin) {
   _classCallCheck(this, LockableRebaseable);
   this.step = step;
   this.inverted = inverted;
@@ -46,4 +47,21 @@ export function mergeUnconfirmedSteps(steps, api) {
     return acc.concat(new LockableRebaseable(rebaseable.step, rebaseable.inverted, rebaseable.origin instanceof Transaction ? rebaseable.origin.setMeta('isOffline', rebaseable.origin.getMeta('isOffline') === true || isOffline) : rebaseable.origin));
   }, []);
   return mergedSteps;
+}
+
+/**
+ * Filter out AnalyticsStep from the steps.
+ *
+ * @param steps Rebaseable steps
+ * @returns Rebaseable steps
+ * @example
+ */
+export function filterAnalyticsSteps(steps) {
+  var filteredSteps = steps.reduce(function (acc, rebaseable) {
+    if (rebaseable.step instanceof AnalyticsStep) {
+      return acc;
+    }
+    return acc.concat(new LockableRebaseable(rebaseable.step, rebaseable.inverted, rebaseable.origin));
+  }, []);
+  return filteredSteps;
 }

package/dist/types/pm-plugins/mergeUnconfirmed.d.ts

@@ -2,7 +2,7 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import type { Transform as ProseMirrorTransform } from '@atlaskit/editor-prosemirror/transform';
 import type { CollabEditPlugin } from '../collabEditPluginType';
-declare class LockableRebaseable {
+export declare class LockableRebaseable {
     readonly step: ProseMirrorStep;
     readonly inverted: ProseMirrorStep;
     readonly origin: ProseMirrorTransform;
@@ -19,4 +19,11 @@ declare class LockableRebaseable {
  * @returns Rebaseable steps
  */
 export declare function mergeUnconfirmedSteps(steps: LockableRebaseable[], api: ExtractInjectionAPI<CollabEditPlugin> | undefined): LockableRebaseable[];
-export {};
+/**
+ * Filter out AnalyticsStep from the steps.
+ *
+ * @param steps Rebaseable steps
+ * @returns Rebaseable steps
+ * @example
+ */
+export declare function filterAnalyticsSteps(steps: LockableRebaseable[]): LockableRebaseable[];

package/dist/types-ts4.5/pm-plugins/mergeUnconfirmed.d.ts

@@ -2,7 +2,7 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import type { Transform as ProseMirrorTransform } from '@atlaskit/editor-prosemirror/transform';
 import type { CollabEditPlugin } from '../collabEditPluginType';
-declare class LockableRebaseable {
+export declare class LockableRebaseable {
     readonly step: ProseMirrorStep;
     readonly inverted: ProseMirrorStep;
     readonly origin: ProseMirrorTransform;
@@ -19,4 +19,11 @@ declare class LockableRebaseable {
  * @returns Rebaseable steps
  */
 export declare function mergeUnconfirmedSteps(steps: LockableRebaseable[], api: ExtractInjectionAPI<CollabEditPlugin> | undefined): LockableRebaseable[];
-export {};
+/**
+ * Filter out AnalyticsStep from the steps.
+ *
+ * @param steps Rebaseable steps
+ * @returns Rebaseable steps
+ * @example
+ */
+export declare function filterAnalyticsSteps(steps: LockableRebaseable[]): LockableRebaseable[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-collab-edit",
-	"version": "3.7.2",
+	"version": "3.8.0",
 	"description": "Collab Edit plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -42,8 +42,8 @@
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/editor-shared-styles": "^3.4.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/prosemirror-collab": "^0.16.0",
-		"@atlaskit/tmp-editor-statsig": "^5.2.0",
+		"@atlaskit/prosemirror-collab": "^0.17.0",
+		"@atlaskit/tmp-editor-statsig": "^5.5.0",
 		"@babel/runtime": "^7.0.0",
 		"memoize-one": "^6.0.0"
 	},