Refactor Doc class to delegate mutations through DocStore by hackerwins · Pull Request #68 · wafflebase/wafflebase

hackerwins · 2026-03-22T12:34:16Z

Summary

Fix MemDocStore to use snapshot-only undo contract: only explicit snapshot() calls create undo entries, individual mutations no longer auto-push to undo stack
Add deleteBlockByIndex(index) to DocStore interface and MemDocStore
Refactor Doc class to take a DocStore in its constructor, delegate all mutations through store methods, and maintain a cached Document refreshed via refresh()
Replace direct blocks.splice() in TextEditor.deleteSelection() with doc.deleteBlockByIndex()
Remove syncToStore() from editor — Doc now writes through to the store directly

Context

This is the foundation for adding real-time collaborative editing via Yorkie's Tree CRDT (see docs/design/docs-collaboration.md). By routing all mutations through the DocStore interface, a future YorkieDocStore can be plugged in without changing Doc or TextEditor.

Test plan

All 125 docs package tests pass
pnpm verify:fast passes (1383+ tests across all packages)
TypeScript compilation clean for docs package (only pre-existing warnings in test fixtures)

🤖 Generated with Claude Code

Summary by CodeRabbit

Refactor
- Improved document management architecture with store-backed mutation model for better consistency and state control across the editor.
Tests
- Added block deletion coverage with bounds validation and updated undo/redo test expectations to reflect new operation sequencing.

Per docs-collaboration design, only explicit snapshot() calls create undo entries. Mutation methods no longer auto-push to undo stack. Co-Authored-By: Claude Opus 4.6 <[email protected]>

Needed by Doc.deleteSelection() which removes middle blocks by index during multi-block selection deletion.

Task 2 implementer reverted Task 1's snapshot-only undo changes. Restore them: mutation methods do not call pushUndo() or clear redoStack. Only snapshot() creates undo entries. Co-Authored-By: Claude Opus 4.6 <[email protected]>

Doc now takes a DocStore in its constructor and delegates all mutations (insert, delete, split, merge, style) through store methods. Maintains a cached Document for reads, refreshed after each mutation.

The design spec requires refresh() to be callable externally when remote changes arrive via YorkieDocStore.

TextEditor now uses doc.deleteBlockByIndex() instead of directly splicing doc.document.blocks, ensuring mutations go through DocStore.

Doc now receives the DocStore in its constructor so all mutations go through the store automatically. syncToStore() is no longer needed. Undo/redo uses doc.refresh() instead of directly assigning doc.document.

coderabbitai · 2026-03-22T12:34:50Z

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

The Doc class transitions from in-place mutation to a store-backed architecture. Doc now holds a DocStore with a cached _document, exposes the document via getter, and provides a refresh() method to reload from the store. All mutation operations now delegate through the store and refresh the cache. A new deleteBlockByIndex() method is added to the store interface.

Changes

Cohort / File(s)	Summary
Store-Backed Document Model `packages/docs/src/model/document.ts`, `packages/docs/src/store/store.ts`, `packages/docs/src/store/memory.ts`	Refactored `Doc` to hold a `DocStore` instead of directly storing the document; added caching via `_document` and `refresh()`; all mutation paths now delegate through store operations and refresh the cache afterward; introduced `deleteBlockByIndex(index)` to the store interface and implementation; removed automatic undo snapshotting from store mutations.
View Layer Integration `packages/docs/src/view/editor.ts`, `packages/docs/src/view/text-editor.ts`	Updated initialization to construct `Doc` from `docStore` directly; replaced direct document mutation with `doc.refresh()` for page margin and undo/redo operations; replaced array splice with `deleteBlockByIndex()` API call for block removal during multi-block selection deletion.
Store Test Coverage `packages/docs/test/store/memory.test.ts`	Added tests for `deleteBlockByIndex()` with valid/invalid indices; updated undo/redo tests to require explicit `snapshot()` calls before mutations; added test asserting mutations without preceding snapshots are not undoable.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

🐰 A doc once mutated in place,
Now stores with grace and stored embrace,
Through cache and refresh, mutations flow,
To persistence below we go,
The rabbit hops through cleaner code!

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely summarizes the main architectural change: refactoring the Doc class to delegate mutations through DocStore instead of in-place mutation.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch refactor/docs-docstore-abstraction

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

github-actions · 2026-03-22T12:36:14Z

Verification: verify:self

Result: ✅ PASS in 95.8s

Lane	Status	Duration
sheets:build	✅ pass	13.0s
verify:fast	✅ pass	47.9s
frontend:build	✅ pass	13.5s
verify:frontend:chunks	✅ pass	0.3s
backend:build	✅ pass	4.3s
cli:build	✅ pass	1.8s
verify:entropy	✅ pass	14.9s

Verification: verify:integration

Result: ✅ PASS

hackerwins and others added 7 commits March 22, 2026 21:12

Fix MemDocStore to snapshot-only undo contract

948a2e5

Per docs-collaboration design, only explicit snapshot() calls create undo entries. Mutation methods no longer auto-push to undo stack. Co-Authored-By: Claude Opus 4.6 <[email protected]>

Add deleteBlockByIndex to DocStore interface

0fb1020

Needed by Doc.deleteSelection() which removes middle blocks by index during multi-block selection deletion.

Restore snapshot-only undo and fix deleteBlockByIndex

7213384

Task 2 implementer reverted Task 1's snapshot-only undo changes. Restore them: mutation methods do not call pushUndo() or clear redoStack. Only snapshot() creates undo entries. Co-Authored-By: Claude Opus 4.6 <[email protected]>

Refactor Doc class to delegate mutations through DocStore

9188587

Doc now takes a DocStore in its constructor and delegates all mutations (insert, delete, split, merge, style) through store methods. Maintains a cached Document for reads, refreshed after each mutation.

Make Doc.refresh() public for remote change handling

49c60f1

The design spec requires refresh() to be callable externally when remote changes arrive via YorkieDocStore.

Replace direct block splice in deleteSelection with Doc method

9071228

TextEditor now uses doc.deleteBlockByIndex() instead of directly splicing doc.document.blocks, ensuring mutations go through DocStore.

Remove syncToStore and wire Doc directly to DocStore

5e6df53

Doc now receives the DocStore in its constructor so all mutations go through the store automatically. syncToStore() is no longer needed. Undo/redo uses doc.refresh() instead of directly assigning doc.document.

hackerwins merged commit 999540b into main Mar 22, 2026
3 checks passed

hackerwins deleted the refactor/docs-docstore-abstraction branch March 22, 2026 12:44

This was referenced Mar 23, 2026

Integrate docs editor with frontend and add peer cursor labels #72

Merged

Add phase 2 inline extensions & clipboard #86

Merged

Add table support to Docs editor #92

Merged

Add granular table store updates and fix cross-block selection bugs #96

Merged

This was referenced Mar 31, 2026

Migrate docs undo/redo to Yorkie-native history #98

Closed

Add intent-preserving Yorkie edits for Docs editor (Phase 1-3) #103

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Refactor Doc class to delegate mutations through DocStore#68

Refactor Doc class to delegate mutations through DocStore#68
hackerwins merged 7 commits into
mainfrom
refactor/docs-docstore-abstraction

hackerwins commented Mar 22, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Mar 22, 2026 •

edited

Loading

Review failed

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

github-actions Bot commented Mar 22, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

hackerwins commented Mar 22, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Context

Test plan

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Mar 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

github-actions Bot commented Mar 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Verification: verify:self

Verification: verify:integration

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

hackerwins commented Mar 22, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Mar 22, 2026 •

edited

Loading

github-actions Bot commented Mar 22, 2026 •

edited

Loading