agent_coder
3f7e1bdc7b
Page/space export (Markdown & HTML, both via jsonToHtml -> generateHTML) crashed with "Export failed:undefined" on any page carrying a `comment` mark. Root cause: comment.renderHTML returned a LIVE DOM node (document.createElement + a click listener) whenever a global `document` existed — and the in-process MCP module injects a jsdom global.window+global.document into the Node server, defeating the old `typeof document === "undefined"` guard. The server export runs happy-dom's DOMSerializer, which crashes appending the foreign jsdom node (NodeUtility.isInclusiveAncestor -> "Cannot read properties of undefined (reading 'length')"). comment is the only extension returning a live node. Fix: widen the guard with an isNodeRuntime check (process.versions.node) so on any Node runtime renderHTML returns the plain, serializable spec array — even when MCP injected jsdom globals. The browser branch (createElement + click -> ACTIVE_COMMENT_EVENT) is untouched, so in-editor comment interactivity is preserved (Vite defines only process.env as a member-expression substitution, no `process` object in the browser bundle, so isNodeRuntime is false there). The mcp schema mirror already returns a spec array and is not on the export path (tiptapExtensions imports Comment from @docmost/editor-ext), so no mirror change is needed. Also: export-modal now reads the real error text from the response Blob (responseType:'blob' made err.response.data.message always undefined) so a failed export shows the server's message instead of "undefined". Adds a regression test that runs the real jsonToHtml on a comment-marked doc with jsdom globals injected (reproduces the crash on the unpatched code, passes after). closes #298 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
83 lines
3.1 KiB
TypeScript
83 lines
3.1 KiB
TypeScript
import { JSDOM } from 'jsdom';
|
|
import { jsonToHtml } from '../../collaboration/collaboration.util';
|
|
|
|
/**
|
|
* Regression test for issue #298: page/space export (Markdown/HTML) crashes on
|
|
* pages that contain inline comments.
|
|
*
|
|
* The in-process MCP module injects a jsdom `global.window` + `global.document`
|
|
* into the Node server (see packages/mcp/src/lib/collaboration.ts). Before the
|
|
* fix, the comment mark's `renderHTML` guard was only
|
|
* `typeof window === "undefined" || typeof document === "undefined"`, so with
|
|
* BOTH jsdom globals present it took the interactive browser branch and returned
|
|
* a LIVE jsdom <span> node. The export path serializes via happy-dom's
|
|
* DOMSerializer, and appending a foreign jsdom node crashed happy-dom
|
|
* ("Cannot read properties of undefined (reading 'length')").
|
|
*
|
|
* We reproduce the MCP-loaded server by injecting jsdom globals, then export a
|
|
* doc containing a comment mark and assert the serialization SUCCEEDS and emits
|
|
* the expected serializable <span data-comment-id=... class="comment-mark">.
|
|
*
|
|
* Non-vacuity: this test only exercises the buggy branch because BOTH jsdom
|
|
* `window` AND `document` are set below. If the `isNodeRuntime` condition is
|
|
* removed from the guard in packages/editor-ext/src/lib/comment/comment.ts,
|
|
* `renderHTML` returns a live jsdom node and `jsonToHtml` throws — this test
|
|
* then fails. (In a plain node env without the injected globals the guard's
|
|
* `typeof window === "undefined"` clause already short-circuits, so it is the
|
|
* injected globals that make this assertion meaningful.)
|
|
*/
|
|
describe('export with inline comments (issue #298)', () => {
|
|
const originalWindow = (global as any).window;
|
|
const originalDocument = (global as any).document;
|
|
|
|
beforeAll(() => {
|
|
const dom = new JSDOM('<!DOCTYPE html><html><body></body></html>');
|
|
(global as any).window = dom.window;
|
|
(global as any).document = dom.window.document;
|
|
});
|
|
|
|
afterAll(() => {
|
|
(global as any).window = originalWindow;
|
|
(global as any).document = originalDocument;
|
|
});
|
|
|
|
const docWithComment = (resolved: boolean) => ({
|
|
type: 'doc',
|
|
content: [
|
|
{
|
|
type: 'paragraph',
|
|
content: [
|
|
{
|
|
type: 'text',
|
|
marks: [
|
|
{
|
|
type: 'comment',
|
|
attrs: { commentId: 'c-123', resolved },
|
|
},
|
|
],
|
|
text: 'commented text',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
});
|
|
|
|
it('exports a page with an unresolved comment mark without crashing', () => {
|
|
let html: string;
|
|
expect(() => {
|
|
html = jsonToHtml(docWithComment(false));
|
|
}).not.toThrow();
|
|
|
|
expect(html).toContain('data-comment-id="c-123"');
|
|
expect(html).toContain('class="comment-mark"');
|
|
expect(html).toContain('commented text');
|
|
});
|
|
|
|
it('exports a resolved comment mark with the resolved class/attr', () => {
|
|
const html = jsonToHtml(docWithComment(true));
|
|
expect(html).toContain('data-comment-id="c-123"');
|
|
expect(html).toContain('comment-mark resolved');
|
|
expect(html).toContain('data-resolved="true"');
|
|
});
|
|
});
|