da-collab/test/cross-validation.test.js at c71bd781dd9ae032bf5274cbd02b75b9fde9fa89 · adobe/da-collab · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/*
 * Copyright 2025 Adobe. All rights reserved.
 * This file is licensed to you under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. You may obtain a copy
 * of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under
 * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
 * OF ANY KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */

/* eslint-disable max-len */

/**
 * Cross-Validation Tests
 *
 * These tests establish the "contract" for HTML conversion that both da-collab (doc2aem)
 * and da-live (prose2aem) should adhere to. Each test case defines:
 * - Input: AEM HTML
 * - Expected Output: The canonical HTML that should be produced after roundtrip conversion
 *
 * Corresponding tests should exist in da-live/test/unit/blocks/shared/cross-validation.test.js
 * to verify that prose2aem produces equivalent output.
 *
 * If these tests fail after changes, ensure both implementations are updated together.
 */

import assert from 'node:assert';
import * as Y from 'yjs';
import { aem2doc, doc2aem } from '../src/collab.js';

const collapseWhitespace = (str) => str.replace(/>\s+</g, '><').replace(/\s+/g, ' ').trim();

// Test cases that define the conversion contract
const CROSS_VALIDATION_CASES = [
  {
    name: 'Simple paragraph',
    input: '<body><header></header><main><div><p>Hello World</p></div></main><footer></footer></body>',
    expected: '<body><header></header><main><div><p>Hello World</p></div></main><footer></footer></body>',
  },
  {
    name: 'Multiple paragraphs',
    input: '<body><header></header><main><div><p>First</p><p>Second</p><p>Third</p></div></main><footer></footer></body>',
    expected: '<body><header></header><main><div><p>First</p><p>Second</p><p>Third</p></div></main><footer></footer></body>',
  },
  {
    name: 'Headings h1-h6',
    input: '<body><header></header><main><div><h1>H1</h1><h2>H2</h2><h3>H3</h3><h4>H4</h4><h5>H5</h5><h6>H6</h6></div></main><footer></footer></body>',
    expected: '<body><header></header><main><div><h1>H1</h1><h2>H2</h2><h3>H3</h3><h4>H4</h4><h5>H5</h5><h6>H6</h6></div></main><footer></footer></body>',
  },
  {
    name: 'Inline formatting - bold, italic, strikethrough, underline',
    input: '<body><header></header><main><div><p><strong>Bold</strong> <em>Italic</em> <s>Strike</s> <u>Under</u></p></div></main><footer></footer></body>',
    expected: '<body><header></header><main><div><p><strong>Bold</strong> <em>Italic</em> <s>Strike</s> <u>Under</u></p></div></main><footer></footer></body>',
  },
  {
    name: 'Links',
    input: '<body><header></header><main><div><p><a href="https://example.com">Example Link</a></p></div></main><footer></footer></body>',
    expected: '<body><header></header><main><div><p><a href="https://example.com">Example Link</a></p></div></main><footer></footer></body>',
  },
  {
    name: 'Unordered list',
    // doc2aem strips <p> from list items containing only text
    input: '<body><header></header><main><div><ul><li><p>Item 1</p></li><li><p>Item 2</p></li><li><p>Item 3</p></li></ul></div></main><footer></footer></body>',
    expected: '<body><header></header><main><div><ul><li>Item 1</li><li>Item 2</li><li>Item 3</li></ul></div></main><footer></footer></body>',
  },
  {
    name: 'Ordered list',
    // doc2aem strips <p> from list items containing only text
    input: '<body><header></header><main><div><ol><li><p>First</p></li><li><p>Second</p></li><li><p>Third</p></li></ol></div></main><footer></footer></body>',
    expected: '<body><header></header><main><div><ol><li>First</li><li>Second</li><li>Third</li></ol></div></main><footer></footer></body>',
  },
  {
    name: 'Simple block (marquee)',
    input: '<body><header></header><main><div><div class="marquee light"><div><div><p>Content here</p></div></div></div></div></main><footer></footer></body>',
    expected: '<body><header></header><main><div><div class="marquee light"><div><div><p>Content here</p></div></div></div></div></main><footer></footer></body>',
  },
  {
    name: 'Section break (hr)',
    input: '<body><header></header><main><div><p>Section 1</p></div><div><p>Section 2</p></div></main><footer></footer></body>',
    expected: '<body><header></header><main><div><p>Section 1</p></div><div><p>Section 2</p></div></main><footer></footer></body>',
  },
  {
    name: 'Image with picture wrapper',
    input: '<body><header></header><main><div><picture><source srcset="./media_123.png"><img src="./media_123.png" alt="Test image"></picture></div></main><footer></footer></body>',
    expected: '<body><header></header><main><div><picture><source srcset="./media_123.png"><source srcset="./media_123.png" media="(min-width: 600px)"><img src="./media_123.png" alt="Test image" loading="lazy"></picture></div></main><footer></footer></body>',
  },
  {
    name: 'Superscript and subscript',
    input: '<body><header></header><main><div><p>H<sub>2</sub>O and E=mc<sup>2</sup></p></div></main><footer></footer></body>',
    expected: '<body><header></header><main><div><p>H<sub>2</sub>O and E=mc<sup>2</sup></p></div></main><footer></footer></body>',
  },
  {
    name: 'Blockquote',
    input: '<body><header></header><main><div><blockquote><p>A wise quote</p></blockquote></div></main><footer></footer></body>',
    expected: '<body><header></header><main><div><blockquote><p>A wise quote</p></blockquote></div></main><footer></footer></body>',
  },
  {
    name: 'Code block',
    input: '<body><header></header><main><div><pre>const x = 1;</pre></div></main><footer></footer></body>',
    expected: '<body><header></header><main><div><pre><code>const x = 1;</code></pre></div></main><footer></footer></body>',
  },
  // Note: Nested formatting may have slight differences between prose2aem and doc2aem
  // due to how ProseMirror serializes nested marks. Skipping for now.
  // {
  //   name: 'Nested formatting',
  //   input: '<body><header></header><main><div><p><strong><em>Bold and italic</em></strong></p></div></main><footer></footer></body>',
  //   expected: '<body><header></header><main><div><p><strong><em>Bold and italic</em></strong></p></div></main><footer></footer></body>',
  // },
  {
    name: 'Link with formatting inside',
    input: '<body><header></header><main><div><p><a href="https://example.com"><strong>Bold link</strong></a></p></div></main><footer></footer></body>',
    expected: '<body><header></header><main><div><p><a href="https://example.com"><strong>Bold link</strong></a></p></div></main><footer></footer></body>',
  },
  {
    name: 'daMetadata block',
    input: '<body><header></header><main><div><p>Content</p></div></main><footer></footer><div class="da-metadata"><div><div>template</div><div>/templates/default</div></div></div></body>',
    expected: '<body><header></header><main><div><p>Content</p></div></main><footer></footer><div class="da-metadata"><div><div>template</div><div>/templates/default</div></div></div></body>',
  },
  {
    name: 'Regional edit - diff added',
    input: '<body><header></header><main><div><p da-diff-added="">New content</p></div></main><footer></footer></body>',
    expected: '<body><header></header><main><div><p da-diff-added="">New content</p></div></main><footer></footer></body>',
  },
  {
    name: 'Regional edit - diff deleted',
    input: '<body><header></header><main><div><da-diff-deleted data-mdast="ignore"><p>Deleted content</p></da-diff-deleted></div></main><footer></footer></body>',
    expected: '<body><header></header><main><div><da-diff-deleted data-mdast="ignore"><p>Deleted content</p></da-diff-deleted></div></main><footer></footer></body>',
  },
];

describe('Cross-Validation Test Suite (doc2aem contract)', () => {
  CROSS_VALIDATION_CASES.forEach(({ name, input, expected }) => {
    it(`${name}`, () => {
      const yDoc = new Y.Doc();
      aem2doc(input, yDoc);
      const result = doc2aem(yDoc);

      assert.equal(
        collapseWhitespace(result),
        collapseWhitespace(expected),
        `Roundtrip conversion failed for: ${name}`,
      );
    });
  });
});

// Export test cases for use in da-live tests
export { CROSS_VALIDATION_CASES, collapseWhitespace };