Skip to content

test(docx-core): enable three pre-existing skipped tests#344

Merged
stevenobiajulu merged 1 commit into
mainfrom
tweak-enable-three-skipped-tests-20260608
Jun 8, 2026
Merged

test(docx-core): enable three pre-existing skipped tests#344
stevenobiajulu merged 1 commit into
mainfrom
tweak-enable-three-skipped-tests-20260608

Conversation

@stevenobiajulu
Copy link
Copy Markdown
Member

What

Turns three long-standing test.skips in docx-core into real, passing tests. After this change docx-core reports 0 skipped (1350 passing). None of these were genuine engine gaps — they were placeholders.

1 & 2 — field-fragmentation.test.ts edge cases

Two empty test.skip bodies deferred to a hypothetical "future classifier." The current engine already fragments both cases correctly, so they are now real scenarios with positive shape assertions (not just "nothing wrapped", which would also hold if the engine emitted no tracked changes):

  • Nested whole-field replacement (IF { PAGE } …IF { NUMPAGES } …): because the collapsed-field atom changes, the engine emits a whole-field delete + insert (renamed accordingly so readers don't infer surgical inner-only correlation). Asserts both nested fldChar pairs survive (12 markers), none inside <w:del>, old PAGE/first content is delInstrText/delText, and NUMPAGES/second land on the insertion side.
  • Separator-less field deletion (AUTONUM, no separate marker): asserts the field stays begin/end only (no synthesized separate), the instr is wrapped as delInstrText, and no fldChar lands inside <w:del>.

Both assert tracked changes are actually emitted (anti-vacuity) and that validateFieldStructure holds on combined/accept/reject.

3 — DocxArchive.test.ts round-trip

"loads and round-trips a real DOCX" was a hardcoded test.skip needing a fixture that was never committed. Rather than add a duplicate binary, it now loads the existing testing/fixtures/simple-word-change/original.docx, and the dead ENOENT skip-guard is removed.

Testing

  • npx vitest run on both files: 17 passed, 0 skipped
  • Full pre-submit gate green locally: build, lint:workspaces (0 errors), test:run (docx-core 1350 passed), check:spec-coverage, check:conformance-citations, check:conformance-doc
  • Peer-reviewed dynamically via Codex (ran the tests + inspected emitted XML to confirm real <w:del>/<w:ins>/<w:fldChar> teeth); its three findings (vacuity guards, nested-test naming, duplicate fixture) are all addressed here.

Ref: #217

The suite carried three skips that were placeholders, not genuine engine
gaps. Each is now a real, passing test so the coverage is exercised
rather than silently absent.

field-fragmentation.test.ts — the two edge-case `test.skip`s were empty
bodies deferred to a hypothetical future classifier. Probing the current
engine shows both cases already fragment correctly, so they are now real
scenarios with positive shape assertions (not just "nothing wrapped",
which would also hold if the engine emitted no tracked changes at all):
  - Nested IF { PAGE } field replaced by IF { NUMPAGES }: a whole-field
    delete+insert (the collapsed-field atom changes), so the test is named
    "nested whole-field replacement" and asserts both nested fldChar pairs
    survive (12 markers), none inside <w:del>, old PAGE/first content is
    delInstrText/delText, and NUMPAGES/second land on the insertion side.
  - Separator-less AUTONUM field deleted: asserts the field is begin/end
    only (no synthesized `separate`), the instr is wrapped as delInstrText,
    and no fldChar lands inside <w:del>.
Both assert tracked changes are actually emitted (anti-vacuity) and that
validateFieldStructure holds on combined/accept/reject. Helpers
(makeNestedField / makeSeparatorlessField / assertEmitsTrackedChanges)
live alongside the existing makeField helper with ECMA-376 17.16.5.1
citations.

DocxArchive.test.ts — "loads and round-trips a real DOCX" was a
hardcoded test.skip needing a word/document.xml-bearing fixture that was
never committed. Rather than add a duplicate binary, it now loads the
existing testing/fixtures/simple-word-change/original.docx, and the dead
ENOENT skip-guard is removed.

Ref: #217
@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 8, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
site Ready Ready Preview, Comment Jun 8, 2026 4:28pm

Request Review

@github-actions github-actions Bot added the test label Jun 8, 2026
@stevenobiajulu stevenobiajulu enabled auto-merge (squash) June 8, 2026 16:29
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 8, 2026

LLM-Based Quality Gate

Overall: ✅ PASS (3 pass · 0 warn · 11 skipped · 14 total)

Check Verdict
⏭️ SKIPPED read_file response metadata parity paths not touched by this PR
⏭️ SKIPPED Live DOM namespace-safe OOXML writes paths not touched by this PR
Deleted field markup keeps w:fldChar outside w:del The PR adds integration tests for nested and separatorless field deletions in packages/docx-core/src/integration/field-fragmentation.test.ts:400-498, verifying that w:fldChar remains unwrapped and deleted instructions use w:delInstrText inside w:del wrappers. The existing validation checks in packages/docx-core/src/baselines/atomizer/pipeline.ts:456-565 remain untouched and continue to safeguard field-structure invariants.
⏭️ SKIPPED Field validation per story, not global paths not touched by this PR
⏭️ SKIPPED Revision IDs seeded from all revision-bearing side parts paths not touched by this PR
Accept/reject sweep side parts and caches The PR only modifies test files in field-fragmentation.test.ts and DocxArchive.test.ts and does not touch DocxDocument.acceptChanges, DocxDocument.rejectChanges, or side-part revision markup.
⏭️ SKIPPED DocumentViewNode.heading stays canonical paths not touched by this PR
⏭️ SKIPPED AI-author parity across entry points paths not touched by this PR
⏭️ SKIPPED Property-change wrapper discipline paths not touched by this PR
⏭️ SKIPPED SUPPORT.md Table A drift vs. implementation paths not touched by this PR
⏭️ SKIPPED Table A / Table B boundary on side-part revisions paths not touched by this PR
⏭️ SKIPPED Canonical-emission surface completeness paths not touched by this PR
⏭️ SKIPPED Lean predicate drift against engine semantics (asymmetric) paths not touched by this PR
Unit-test quality (avoid tautological / change-detector tests) The integration tests added in field-fragmentation.test.ts construct inputs and expectations from first principles and perform concrete structural assertions, while DocxArchive.test.ts:178 activates a clean integration test verifying exact XML equality through a full round-trip.
Full checklist questions
  1. read_file response metadata parity: If this PR touches packages/docx-mcp/src/tools/read_file.ts, budgeted pagination returns, or additive response metadata like warnings / comment_load_error, do every successful return path (default budgeted early return, non-budget fallthrough, explicit limit/node_ids) preserve the same additive diagnostic fields? read_file has multiple success exits; diagnostics have already disappeared on one path before. Reference: fix(docx-core): declare xmlns:w14/w15 on comments root before writing prefixed attributes (#154) #180 surfaced comment_load_error, fix(docx-mcp): warn when read_file budget is exceeded by a single node (closes #184) #186 added an early budget return + warnings, fix(docx-mcp): surface comment_load_error on the default budgeted read path (closes #189) #191 fixed the missing comment_load_error on the default budgeted path.

  2. Live DOM namespace-safe OOXML writes: If this PR touches packages/docx-core/src/primitives/comments.ts or writes prefixed OOXML attributes/elements (w14:*, w15:*, xmlns:*, comments.xml, commentsExtended.xml, people.xml), are prefixed OOXML names written with namespace-aware APIs — root aliases bound with setAttributeNS(XMLNS_NS, ...), prefixed attributes with setAttributeNS(W14_NS/W15_NS, ...), and is there a test that proves the live DOM works before serialization/reparse? String-prefixed attributes can serialize plausibly while the live DOM still throws namespace errors. Reference: fix(docx-core): declare xmlns:w14/w15 on comments root before writing prefixed attributes (#154) #180 (xmlns:w14/w15 declared on comments root before writing prefixed attrs).

  3. Deleted field markup keeps w:fldChar outside w:del: If this PR touches field atomization, validateFieldStructure, hasFldCharInsideDel, w:fldChar, w:instrText, w:delInstrText, or collapsed field comparison logic, does deleted field output stay ECMA-376-conformant — w:fldChar sibling-level (never inside w:del), deleted instructions use w:delInstrText only inside valid delete wrappers, accept/reject safety checks still reject malformed combined output? Word treats deleted field-state markup in the wrong container as document-corrupting. References: fix(docx-core): validate w:delInstrText placement and reject w:fldChar inside <w:del> #211, fix(docx-core): partition field-closure validation by ECMA-376 story (#212) #225, fix(docx-core): fragment w:fldChar outside w:del per ECMA-376 Part 4 #228.

  4. Field validation per story, not global: If this PR touches packages/docx-core/src/baselines/atomizer/pipeline.ts, splitStories, validateFieldStructure, side-part merge logic, or footnote/endnote field handling, is field validation run independently per ECMA story (document.xml, each footnote, each endnote), with sidecars from both original and revised archives considered, and global counter balance not treated as sufficient? A document can be globally balanced but have an invalid field sequence inside one story. References: fix(docx-core): partition field-closure validation by ECMA-376 story (#212) #225, fix(docx-core): fragment w:fldChar outside w:del per ECMA-376 Part 4 #228, feat(docx-core): sweep side-part revisions on accept/reject #218.

  5. Revision IDs seeded from all revision-bearing side parts: If this PR touches packages/docx-mcp/src/session/manager.ts (especially getRevisionContextForSession or FIXED_REVISION_ID_SEED_PARTS), createRevisionContext, revision-ID allocation, or MCP tools that create tracked changes/comments/footnotes, does revision-ID allocation scan all relevant package parts before issuing new IDs — comments, footnotes, endnotes, glossary, headers, footers — ignore non-revision w:id values (comment IDs, bookmarks), and handle malformed optional parts gracefully? Revision IDs are package-wide; document-only seeding collides with existing side-part revisions. Reference: fix(docx-mcp): seed revision ids from side parts #216 (seed revision ids from side parts).

  6. Accept/reject sweep side parts and caches: If this PR touches DocxDocument.acceptChanges, DocxDocument.rejectChanges, REVISION_STORY_PART_PATHS, accept_changes, reject_changes, or side-part revision markup, does accept/reject process every revision-bearing story — updating document.xml + footnotes.xml + endnotes.xml + comments.xml, writing back only changed side parts while refreshing cached XML, and pruning orphan footnotes without deleting reserved separator entries? Accepting only in the main document leaves stale revisions and dangling references in the package. References: feat(docx-core): sweep side-part revisions on accept/reject #218, fix(docx-mcp): seed revision ids from side parts #216, fix(docx-core): partition field-closure validation by ECMA-376 story (#212) #225.

  7. DocumentViewNode.heading stays canonical: If this PR touches packages/docx-core/src/primitives/document_view.ts, HeadingValue, heading heuristics, ListMetadata.header_style, or Google Docs document-view heading normalization, does node.heading remain a structural heading signal — exact Word styles Heading1Heading6 win, heuristic sources suppressed inside table cells while real Word heading styles still pass, ordinary body paragraphs omit the heading key? Consumers use node.heading != null as a structural test; heuristic false positives break downstream navigation. References: fix(docx-core): harden heading detection (#157 Phase 1) #178, fix(docx-core): suppress non-sectional false-positive headings (closes #187) #188, feat(docx-core): add derived heading object to DocumentViewNode (closes #179) #190.

  8. AI-author parity across entry points: If this PR touches packages/docx-mcp/src/server.ts, packages/docx-mcp/src/cli/tool_runner.ts, packages/docx-mcp/src/cli/commands/**, or adds any new new SessionManager(...) call site in docx-mcp, does every entry point that constructs a SessionManager resolve SAFE_DOCX_AI_AUTHOR with the same three-way semantics (set → use it; empty string → opt out to untracked; unset → defaultAiAuthor), or has a new entry path silently bypassed tracked emission? Each entry path looks locally correct while diverging from another; tracked emission has gone dark in one path before anyone noticed. References: feat(docx-mcp): wire configurable AI author through MCP layer (#142) #172 (production MCP wiring would have kept tracked emission dark), fix(docx-mcp): honor SAFE_DOCX_AI_AUTHOR in CLI entry points (#181) #182 (CLI runners constructing bare SessionManager() silently produced untracked edits).

  9. Property-change wrapper discipline: If this PR touches packages/docx-core/src/primitives/layout.ts, packages/docx-core/src/primitives/text.ts, packages/docx-mcp/src/tools/clear_formatting.ts, or packages/docx-core/src/primitives/track-changes-emitter.ts, do tracked formatting/property edits emit exactly one correct *PrChange wrapper (pPrChange / rPrChange / trPrChange / tcPrChange) carrying a snapshot of the prior live properties — not stacking stale wrappers, not stripping valid historical children (cellIns/cellDel/cellMerge), and not omitting the snapshot when the operation is formatting-aware? Emitted OOXML is visually plausible but subtle snapshot mistakes only surface during later accept/reject or in Word's tracked-changes UI. References: feat(docx-core): emit pPrChange/trPrChange/tcPrChange from layout setters (#140) #167 (duplicate pPrChange/trPrChange/tcPrChange stacking + over-broad tcPr exclusion), feat(docx-mcp): emit rPrChange from clear_formatting MCP tool (#141) #170 (clear_formatting failing to strip stale rPrChange), feat(docx-core): emit rPrChange for formatted paragraph replacements #215 (rPrChange for formatted paragraph replacements + filtering nested stale records).

  10. SUPPORT.md Table A drift vs. implementation: If this PR modifies OOXML revision emission behavior (w:ins, w:del, w:rPrChange, etc.) in packages/docx-core/src/primitives/**, or touches packages/docx-core/SUPPORT.md, does the PR symmetrically update Table A in SUPPORT.md when the supported revision-emission surface in primitives changed — added, removed, or weakened — or is the documented contract now lying about what's supported? Reviewers focus on TS AST correctness and golden tests; Markdown contract tables get treated as an afterthought, so the documented surface drifts from the actual surface. Reference: [120.8] Regression suite for canonical revision emission across the surface #143 review caught replaceParagraphTextRange should emit w:rPrChange when run formatting changes #173 (formatting mismatch in Table A) and addCommentReply should emit body revision markup OR SUPPORT.md should be softened #174 (comment body revision omission forcing a Table A softening) late in peer review.

  11. Table A / Table B boundary on side-part revisions: If this PR touches packages/docx-core/src/primitives/comments.ts, packages/docx-core/src/primitives/footnotes.ts, or other side-part primitives, and adds/changes revision markup (w:ins, w:del), does tracked-change revision logic stay scoped to Table A (document-body content inside the side part) without leaking revision markup into Table B (the side-part package bootstrap — comments.xml/footnotes.xml element registration itself)? Body runs and side-part package elements share nearly identical XML namespace schemas; revisions emitted in the wrong table corrupt the package contract while looking plausible. References: [120.3] Emit w:ins/w:del for comment body anchors #138 (comment-body straddle constraints), [120.4] Emit w:ins/w:del for footnote reference and text #139 (footnote-reference straddle constraints).

  12. Canonical-emission surface completeness: If this PR adds or changes a tracked-edit surface in packages/docx-core/src/primitives/** or packages/docx-mcp/src/tools/**, are the paired artifacts updated together — packages/docx-core/src/integration/canonical-emission-regression.test.ts, packages/docx-mcp/src/integration/canonical-emission-mcp.test.ts, and the documented emitter surface (Table A) — or is the rollout only partially wired? The primitive change looks done before the MCP path, regression matrix, and documented contract are wired through; partial rollouts ship undocumented surface that drifts. References: feat(docx-mcp): wire configurable AI author through MCP layer (#142) #172 (RevisionContext threaded through every Table A MCP tool), test(docx-core,docx-mcp): final regression suite for canonical emission (#143) #175 (24-test regression suite + verified write-time emitter rows), feat(docx-core): emit rPrChange for formatted paragraph replacements #215 (re-enabled rPrChange regression + updated support surface for replaceParagraphTextRange).

  13. Lean predicate drift against engine semantics (asymmetric): If this PR changes field-wrapper semantics, the proof boundary, or atomizer behavior — packages/docx-core/src/baselines/atomizer/**, verification/lean/LeanSpike/Spec.lean, verification/lean/Tier2/**, or packages/docx-core/src/integration/lean-spec-bridge.test.ts — and if the TS engine semantics shifted, did the PR also update the Lean residual predicate and bridge tests, or is the proof now pinned to a stale stronger/weaker assumption? Asymmetric: a TS change without a corresponding Lean update is WARN; a Lean-only change without a TS update should not fire. The Lean side can still compile while the abstraction boundary is subtly wrong for the next engine refactor. References: feat(verification): close inv_field_001 with Tier 2 OoxmlDoc subset #208 (closed inv_field_001 using stronger recursivelyWellformed), refactor(verification): weaken inv_field_001 axiom to document-level preservationFriendly (rebased follow-up to #208) #220 (weakened the axiom to document-level preservationFriendly to avoid breakage when field fragmentation lands).

  14. Unit-test quality (avoid tautological / change-detector tests): If this PR adds or modifies any **/*.test.ts (or other test files), are the test assertions independent of the system under test — expected values constructed from first principles rather than re-derived from the function under test, mocks limited to external boundaries (filesystem, network, clocks) rather than mocking the SUT itself, assertions making concrete semantic claims rather than just snapshotting current behavior or asserting non-null, and any test added alongside a bug fix actually exercising the bug? Tests that re-implement the production code as the "expected" value, or mock out the system under test, pass green while providing no regression protection.

Estimated cost (this run): $0.0046 — 13,498 input + 224 output tokens (≈4 chars/token) on gemini-3.5-flash. Char-count estimate, not provider telemetry.

@stevenobiajulu stevenobiajulu merged commit 7e8e094 into main Jun 8, 2026
55 of 56 checks passed
@stevenobiajulu stevenobiajulu deleted the tweak-enable-three-skipped-tests-20260608 branch June 8, 2026 16:56
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@stevenobiajulu
Copy link
Copy Markdown
Member Author

✅ Post-merge smoke passed

Merged: 7e8e094171081656fb28f7d4913c3dd68bd9f0b3 (squash)
Built from: main @ 7e8e094
Smoke: clean npm run build + full npm run test:run + real-world DOCX driven through the two affected code paths

Steps

  • ✅ build (clean, 0 TS errors)
  • ✅ tests — full workspace green: docx-core 1350 passed / 0 skipped; all other packages pass (the 3 newly-enabled tests run green on clean main)
  • ✅ DocxArchive load + round-trip on a real document
  • ✅ inplace field-aware comparison on a real document

Real-world fixtures

  • bonterms-mutual-nda (local template at open-agreements/content/templates/bonterms-mutual-nda/template.docx, 24 KB, 130 atoms)
    • DocxArchive path: loaded the real DOCX, save()load() round-trip preserves document.xml, saved buffer is a valid ZIP (PK header).
    • Field-fragmentation path: edited a body text run, ran compareDocuments(..., { engine: 'atomizer', reconstructionMode: 'inplace' }) → stayed in inplace mode (no fallback), emitted <w:ins> with the inserted text, and no <w:fldChar> wrapped inside <w:del> (ECMA-376 field-structure integrity held on a real document).

Visual evidence: skipped — this is a test-only enablement PR; no rendered-output change.
Log: /tmp/automerge-smoke-344-20260608-125755.log (local). Combined-XML artifact: /tmp/automerge-smoke-344-20260608-125755/combined.xml.

Note: CI's first run hit a pre-existing, seed-unpinned flake in lean-spec-bridge.test.ts › INV-RT-001 (fast-check seed 1586860402, a comment-anchor + paragraph-insert scenario triggering an inplace→rebuild fallback). It is unrelated to this test-only change (zero engine code touched) and passes 3/3 locally with fresh seeds. The failed job was re-run and went green.

Cleanup

  • ✅ deleted remote branch tweak-enable-three-skipped-tests-20260608 (auto-delete was already enabled)
  • ⚠️ no worktree on this branch — nothing to remove
  • ✅ deleted local branch + pruned refs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant