@atlaskit/editor-plugin-show-diff 29.0.0 → 29.0.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-plugin-show-diff
 
+## 29.0.1
+
+### Patch Changes
+
+- [`90093ce337081`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/90093ce337081) -
+  Version history diff: treat documents that differ only in how adjacent same-mark text nodes are
+  split as equal, so changes to migrated legacy-editor content are highlighted (behind
+  platform_editor_show_diff_normalise_text_nodes)
+
 ## 29.0.0
 
 ### Major Changes

package/dist/cjs/pm-plugins/calculateDiff/calculateDiffDecorations.js

@@ -17,6 +17,7 @@ var _document = require("@atlaskit/editor-common/utils/document");
 var _transform = require("@atlaskit/editor-prosemirror/transform");
 var _view = require("@atlaskit/editor-prosemirror/view");
 var _tableMap = require("@atlaskit/editor-tables/table-map");
+var _isExperimentEnabled = require("@atlaskit/platform-feature-experiments/is-experiment-enabled");
 var _unsafeExpValNoExposure = require("@atlaskit/platform-feature-experiments/unsafe-exp-val-no-exposure");
 var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _attributions = require("../decorations/colorSchemes/attributions");
@@ -39,6 +40,7 @@ var _groupChangesByBlock = require("./groupChangesByBlock");
 var _groupDeletedColumnChanges = require("./groupDeletedColumnChanges");
 var _isMarkOnlyChange = require("./isMarkOnlyChange");
 var _isOpenTokenOnlyChange = require("./isOpenTokenOnlyChange");
+var _normalizeTextNodes = require("./normalizeTextNodes");
 var _optimizeChanges = require("./optimizeChanges");
 var _selectTokenEncoder2 = require("./selectTokenEncoder");
 var _simplifyChangesWithAttribution = require("./simplifyChangesWithAttribution");
@@ -482,6 +484,10 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref8
   // changes and ignores differences in attributes which don't affect decoration positions
   if (!(0, _document.areNodesEqualIgnoreAttrs)(steppedDoc, tr.doc)) {
     var _api$analytics;
+    // A document parsed from ADF can hold adjacent text nodes with identical marks, while the
+    // editor joins them whenever it rebuilds a node (for example when local ids are assigned on
+    // load). Positions are identical either way, so the decorations still apply.
+    var recoveredViaTextNodeNormalisation = (0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_show_diff_normalise_text_nodes') && (0, _document.areNodesEqualIgnoreAttrs)((0, _normalizeTextNodes.normalizeTextNodes)(steppedDoc), (0, _normalizeTextNodes.normalizeTextNodes)(tr.doc));
     var recoveredViaContentEquality = (0, _areDocsEqualByBlockStructureAndText.areDocsEqualByBlockStructureAndText)(steppedDoc, tr.doc);
     api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 || _api$analytics.actions.fireAnalyticsEvent({
       eventType: 'track',
@@ -490,10 +496,11 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref8
       attributes: {
         docSizeEqual: steppedDoc.nodeSize === tr.doc.nodeSize,
         colorScheme: colorScheme,
-        recoveredViaContentEquality: recoveredViaContentEquality
+        recoveredViaContentEquality: recoveredViaContentEquality,
+        recoveredViaTextNodeNormalisation: recoveredViaTextNodeNormalisation
       }
     });
-    if (!recoveredViaContentEquality) {
+    if (!recoveredViaTextNodeNormalisation && !recoveredViaContentEquality) {
       return {
         contributorTags: [],
         decorations: _view.DecorationSet.empty,

package/dist/cjs/pm-plugins/calculateDiff/normalizeTextNodes.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.normalizeTextNodes = void 0;
+var _model = require("@atlaskit/editor-prosemirror/model");
+/**
+ * Returns a copy of `node` in which adjacent text nodes with identical marks are joined, the same
+ * normalisation ProseMirror applies whenever it rebuilds a node's content. A document parsed straight
+ * from ADF keeps such split runs, so two documents with identical content and positions can still
+ * differ in child count.
+ */
+var _normalizeTextNodes = exports.normalizeTextNodes = function normalizeTextNodes(node) {
+  if (node.isText || node.childCount === 0) {
+    return node;
+  }
+  var children = [];
+  node.content.forEach(function (child) {
+    return children.push(_normalizeTextNodes(child));
+  });
+  return node.copy(_model.Fragment.fromArray(children));
+};

package/dist/es2019/pm-plugins/calculateDiff/calculateDiffDecorations.js

@@ -7,6 +7,7 @@ import { areNodesEqualIgnoreAttrs } from '@atlaskit/editor-common/utils/document
 import { Mapping } from '@atlaskit/editor-prosemirror/transform';
 import { Decoration, DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { TableMap } from '@atlaskit/editor-tables/table-map';
+import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
 import { UNSAFE_expValNoExposure } from '@atlaskit/platform-feature-experiments/unsafe-exp-val-no-exposure';
 import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { createAttributionColorMap, getAttributionKey, getAttributionKeyForChange, getColorSchemeForChange, isAttributionColoringEnabled, isContributorTagsEnabled } from '../decorations/colorSchemes/attributions';
@@ -29,6 +30,7 @@ import { groupChangesByBlock } from './groupChangesByBlock';
 import { CELL_CONTENT_OFFSET, groupDeletedColumnChanges } from './groupDeletedColumnChanges';
 import { isMarkOnlyChange } from './isMarkOnlyChange';
 import { isOpenTokenOnlyChange } from './isOpenTokenOnlyChange';
+import { normalizeTextNodes } from './normalizeTextNodes';
 import { optimizeChanges } from './optimizeChanges';
 import { selectTokenEncoder } from './selectTokenEncoder';
 import { collapseOverlappingChanges, simplifyChangesWithAttribution } from './simplifyChangesWithAttribution';
@@ -435,6 +437,10 @@ const calculateDiffDecorationsInner = ({
   // changes and ignores differences in attributes which don't affect decoration positions
   if (!areNodesEqualIgnoreAttrs(steppedDoc, tr.doc)) {
     var _api$analytics;
+    // A document parsed from ADF can hold adjacent text nodes with identical marks, while the
+    // editor joins them whenever it rebuilds a node (for example when local ids are assigned on
+    // load). Positions are identical either way, so the decorations still apply.
+    const recoveredViaTextNodeNormalisation = isExperimentEnabled('platform_editor_show_diff_normalise_text_nodes') && areNodesEqualIgnoreAttrs(normalizeTextNodes(steppedDoc), normalizeTextNodes(tr.doc));
     const recoveredViaContentEquality = areDocsEqualByBlockStructureAndText(steppedDoc, tr.doc);
     api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions.fireAnalyticsEvent({
       eventType: 'track',
@@ -443,10 +449,11 @@ const calculateDiffDecorationsInner = ({
       attributes: {
         docSizeEqual: steppedDoc.nodeSize === tr.doc.nodeSize,
         colorScheme,
-        recoveredViaContentEquality
+        recoveredViaContentEquality,
+        recoveredViaTextNodeNormalisation
       }
     });
-    if (!recoveredViaContentEquality) {
+    if (!recoveredViaTextNodeNormalisation && !recoveredViaContentEquality) {
       return {
         contributorTags: [],
         decorations: DecorationSet.empty,

package/dist/es2019/pm-plugins/calculateDiff/normalizeTextNodes.js

@@ -0,0 +1,16 @@
+import { Fragment } from '@atlaskit/editor-prosemirror/model';
+
+/**
+ * Returns a copy of `node` in which adjacent text nodes with identical marks are joined, the same
+ * normalisation ProseMirror applies whenever it rebuilds a node's content. A document parsed straight
+ * from ADF keeps such split runs, so two documents with identical content and positions can still
+ * differ in child count.
+ */
+export const normalizeTextNodes = node => {
+  if (node.isText || node.childCount === 0) {
+    return node;
+  }
+  const children = [];
+  node.content.forEach(child => children.push(normalizeTextNodes(child)));
+  return node.copy(Fragment.fromArray(children));
+};

package/dist/esm/pm-plugins/calculateDiff/calculateDiffDecorations.js

@@ -15,6 +15,7 @@ import { areNodesEqualIgnoreAttrs } from '@atlaskit/editor-common/utils/document
 import { Mapping } from '@atlaskit/editor-prosemirror/transform';
 import { Decoration, DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { TableMap } from '@atlaskit/editor-tables/table-map';
+import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
 import { UNSAFE_expValNoExposure } from '@atlaskit/platform-feature-experiments/unsafe-exp-val-no-exposure';
 import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { createAttributionColorMap, getAttributionKey, getAttributionKeyForChange, getColorSchemeForChange, isAttributionColoringEnabled, isContributorTagsEnabled } from '../decorations/colorSchemes/attributions';
@@ -37,6 +38,7 @@ import { groupChangesByBlock } from './groupChangesByBlock';
 import { CELL_CONTENT_OFFSET, groupDeletedColumnChanges } from './groupDeletedColumnChanges';
 import { isMarkOnlyChange } from './isMarkOnlyChange';
 import { isOpenTokenOnlyChange } from './isOpenTokenOnlyChange';
+import { normalizeTextNodes } from './normalizeTextNodes';
 import { optimizeChanges } from './optimizeChanges';
 import { selectTokenEncoder } from './selectTokenEncoder';
 import { collapseOverlappingChanges, simplifyChangesWithAttribution } from './simplifyChangesWithAttribution';
@@ -475,6 +477,10 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref8
   // changes and ignores differences in attributes which don't affect decoration positions
   if (!areNodesEqualIgnoreAttrs(steppedDoc, tr.doc)) {
     var _api$analytics;
+    // A document parsed from ADF can hold adjacent text nodes with identical marks, while the
+    // editor joins them whenever it rebuilds a node (for example when local ids are assigned on
+    // load). Positions are identical either way, so the decorations still apply.
+    var recoveredViaTextNodeNormalisation = isExperimentEnabled('platform_editor_show_diff_normalise_text_nodes') && areNodesEqualIgnoreAttrs(normalizeTextNodes(steppedDoc), normalizeTextNodes(tr.doc));
     var recoveredViaContentEquality = areDocsEqualByBlockStructureAndText(steppedDoc, tr.doc);
     api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 || _api$analytics.actions.fireAnalyticsEvent({
       eventType: 'track',
@@ -483,10 +489,11 @@ var calculateDiffDecorationsInner = function calculateDiffDecorationsInner(_ref8
       attributes: {
         docSizeEqual: steppedDoc.nodeSize === tr.doc.nodeSize,
         colorScheme: colorScheme,
-        recoveredViaContentEquality: recoveredViaContentEquality
+        recoveredViaContentEquality: recoveredViaContentEquality,
+        recoveredViaTextNodeNormalisation: recoveredViaTextNodeNormalisation
       }
     });
-    if (!recoveredViaContentEquality) {
+    if (!recoveredViaTextNodeNormalisation && !recoveredViaContentEquality) {
       return {
         contributorTags: [],
         decorations: DecorationSet.empty,

package/dist/esm/pm-plugins/calculateDiff/normalizeTextNodes.js

@@ -0,0 +1,19 @@
+import { Fragment } from '@atlaskit/editor-prosemirror/model';
+
+/**
+ * Returns a copy of `node` in which adjacent text nodes with identical marks are joined, the same
+ * normalisation ProseMirror applies whenever it rebuilds a node's content. A document parsed straight
+ * from ADF keeps such split runs, so two documents with identical content and positions can still
+ * differ in child count.
+ */
+var _normalizeTextNodes = function normalizeTextNodes(node) {
+  if (node.isText || node.childCount === 0) {
+    return node;
+  }
+  var children = [];
+  node.content.forEach(function (child) {
+    return children.push(_normalizeTextNodes(child));
+  });
+  return node.copy(Fragment.fromArray(children));
+};
+export { _normalizeTextNodes as normalizeTextNodes };

package/dist/types/pm-plugins/calculateDiff/normalizeTextNodes.d.ts

@@ -0,0 +1,8 @@
+import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+/**
+ * Returns a copy of `node` in which adjacent text nodes with identical marks are joined, the same
+ * normalisation ProseMirror applies whenever it rebuilds a node's content. A document parsed straight
+ * from ADF keeps such split runs, so two documents with identical content and positions can still
+ * differ in child count.
+ */
+export declare const normalizeTextNodes: (node: PMNode) => PMNode;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-show-diff",
-	"version": "29.0.0",
+	"version": "29.0.1",
 	"description": "ShowDiff plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -39,7 +39,7 @@
 		"@atlaskit/platform-feature-experiments": "^0.3.0",
 		"@atlaskit/platform-feature-flags": "^2.2.0",
 		"@atlaskit/primitives": "^22.6.0",
-		"@atlaskit/tmp-editor-statsig": "^248.0.0",
+		"@atlaskit/tmp-editor-statsig": "^248.1.0",
 		"@atlaskit/tokens": "^20.8.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^1.0.2",
@@ -53,17 +53,17 @@
 		"@atlaskit/button": "^25.6.0",
 		"@atlaskit/css": "^1.1.0",
 		"@atlaskit/dropdown-menu": "^21.0.0",
-		"@atlaskit/editor-core": "^241.1.0",
+		"@atlaskit/editor-core": "^242.0.0",
 		"@atlaskit/editor-json-transformer": "^10.0.0",
 		"@atlaskit/editor-plugins": "^16.2.0",
 		"@atlaskit/form": "^18.3.0",
 		"@atlaskit/section-message": "^10.2.0",
-		"@atlaskit/textarea": "^10.2.0",
+		"@atlaskit/textarea": "^10.3.0",
 		"@atlaskit/textfield": "^10.3.0",
 		"@atlaskit/util-data-test": "^19.1.0",
 		"@atlassian/confluence-presets": "workspace:^",
 		"@atlassian/content-reconciliation": "^0.1.3506",
-		"@atlassian/editor-ai-injected-editors": "^45.0.0",
+		"@atlassian/editor-ai-injected-editors": "^46.0.0",
 		"@atlassian/editor-plugin-ai": "^84.0.0",
 		"@atlassian/structured-docs-types": "workspace:^",
 		"react": "^19.2.0",