First step of docs/git-sync-plan.md. New workspace package @docmost/git-sync vendoring the PURE parts from docmost-sync (HEAD b03eb35): - lib: markdown-converter, markdown-document, canonicalize, docmost-schema, node-ops, diff, and an extracted markdown-to-prosemirror (only the pure marked->HTML->generateJSON path from upstream collaboration.ts; no websocket). - engine (pure, no IO): reconcile, layout, sanitize, stabilize, loop-guard. Ported the upstream pure-module + round-trip corpus tests (vitest): 314 pass, 3 expected upstream known-limitation fails. tsc clean. No server wiring yet. docmost-schema inlines getStyleProperty (as packages/mcp does — @tiptap/core 3.20.4 doesn't export it). IO engine (pull/push/git/settings) deferred to later Phase A/B steps; the editor-ext idempotency gate (plan §13.1) is the next step. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
91 lines
4.0 KiB
TypeScript
91 lines
4.0 KiB
TypeScript
import { describe, expect, it } from 'vitest';
|
|
import { stabilizePageFile, type PageMeta } from '../src/engine/stabilize.js';
|
|
// markdownToProseMirror lives in collaboration.ts; importing it mutates the
|
|
// global DOM via jsdom at module load time (required for @tiptap/html under Node).
|
|
import { markdownToProseMirror } from '../src/lib/markdown-to-prosemirror.js';
|
|
import { parseDocmostMarkdown } from '../src/lib/markdown-document.js';
|
|
|
|
// stabilize.ts (SPEC §11 normalize-on-write) was 0% covered (only the gated e2e
|
|
// touched it). stabilizePageFile is import-testable: build a small ProseMirror
|
|
// content + meta and assert (1) the normalize-on-write pass reaches a fixpoint
|
|
// (a SECOND pass over the written body is byte-identical), and (2) the meta is
|
|
// serialized verbatim, including a null parentPageId.
|
|
|
|
const meta: PageMeta = {
|
|
version: 1,
|
|
pageId: 'pg-1',
|
|
slugId: 'sl-1',
|
|
title: 'My Title',
|
|
spaceId: 'sp-1',
|
|
parentPageId: null,
|
|
};
|
|
|
|
describe('stabilizePageFile — normalize-on-write fixpoint (SPEC §11)', () => {
|
|
it('reaches a byte-identical fixpoint after one extra export/import/export pass', async () => {
|
|
// A diagram is the canonical one-pass asymmetry: drawio's `align` default of
|
|
// "center" materializes on import, so a NAIVE export differs on the second
|
|
// export. stabilizePageFile runs the convergence pass at write time, so the
|
|
// written body must already be at the fixpoint: re-importing its body and
|
|
// re-stabilizing yields the exact same bytes.
|
|
const content = {
|
|
type: 'doc',
|
|
content: [
|
|
{ type: 'paragraph', content: [{ type: 'text', text: 'intro' }] },
|
|
{ type: 'drawio', attrs: { src: '/d.drawio' } },
|
|
{ type: 'paragraph', content: [{ type: 'text', text: 'outro' }] },
|
|
],
|
|
};
|
|
|
|
const file1 = await stabilizePageFile(content, meta);
|
|
// Re-import the written body and stabilize again — the second pass must be
|
|
// byte-identical to the first (the fixpoint property git relies on).
|
|
const body1 = parseDocmostMarkdown(file1).body;
|
|
const doc2 = await markdownToProseMirror(body1);
|
|
const file2 = await stabilizePageFile(doc2, meta);
|
|
expect(file2).toBe(file1);
|
|
|
|
// The materialized diagram default is present in the stabilized body (proof
|
|
// that the convergence pass actually ran, not just that two naive exports
|
|
// happened to match).
|
|
expect(body1).toContain('data-align="center"');
|
|
});
|
|
|
|
it('already-stable content is unchanged by the pass (idempotent)', async () => {
|
|
// Plain prose is already a fixpoint; stabilizing it once and twice agree.
|
|
const content = {
|
|
type: 'doc',
|
|
content: [{ type: 'paragraph', content: [{ type: 'text', text: 'just plain text' }] }],
|
|
};
|
|
const file1 = await stabilizePageFile(content, meta);
|
|
const body1 = parseDocmostMarkdown(file1).body;
|
|
const doc2 = await markdownToProseMirror(body1);
|
|
const file2 = await stabilizePageFile(doc2, meta);
|
|
expect(file2).toBe(file1);
|
|
expect(body1).toBe('just plain text');
|
|
});
|
|
});
|
|
|
|
describe('stabilizePageFile — meta serialization', () => {
|
|
it('preserves a null parentPageId verbatim in the meta block', async () => {
|
|
const file = await stabilizePageFile(
|
|
{ type: 'doc', content: [{ type: 'paragraph', content: [{ type: 'text', text: 'x' }] }] },
|
|
meta,
|
|
);
|
|
const parsed = parseDocmostMarkdown(file);
|
|
// The whole meta round-trips, and parentPageId is exactly null (root page).
|
|
expect(parsed.meta).toEqual(meta);
|
|
expect(parsed.meta!.parentPageId).toBeNull();
|
|
// No trailing docmost:comments block — the sync body serializer omits it.
|
|
expect(file).not.toContain('docmost:comments');
|
|
});
|
|
|
|
it('keeps a non-null parentPageId as-is', async () => {
|
|
const childMeta: PageMeta = { ...meta, parentPageId: 'parent-99' };
|
|
const file = await stabilizePageFile(
|
|
{ type: 'doc', content: [{ type: 'paragraph', content: [{ type: 'text', text: 'x' }] }] },
|
|
childMeta,
|
|
);
|
|
expect(parseDocmostMarkdown(file).meta).toEqual(childMeta);
|
|
});
|
|
});
|