PavtchManager for all objects#6691
Open
IhorKaleniuk666 wants to merge 19 commits intoGrapesJS:devfrom
Open
Conversation
… into path-manager-any
… into path-manager-any
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In this MR, an opt-in infrastructure for editor state patch tracking is introduced (as a foundation for multiplayer/collaborative features) without altering the existing GrapesJS behavior when the option is disabled.
What’s included
A new patches.enable flag is added (default: false). When disabled, the system is fully no-op and does not affect the existing API or test suite.
PatchManager is integrated into EditorModel as editor.Patches, providing batched updates via update(cb), undo/redo history, and suppression of patch logging when applying changes with apply(..., { external: true }).
A ModelWithPatches base class is implemented on top of Immer patches, intercepting set(...) calls, generating patches / inversePatches, and normalizing patch paths into a single, consistent namespace.
A CollectionWithPatches base class is implemented with stable ordering based on fractional indexing, supporting add / remove / reset / reorder, correct undo/redo semantics for reordering operations, and deterministic sorting.
Key stateful models and collections (components, CSS rules, selectors, pages, devices, blocks, and assets) are migrated to the new base classes with explicit patchObjectType and collectionId.
Testing
New unit and integration tests are added for ModelWithPatches, CollectionWithPatches, and PatchManager, covering reordering, apply(external) without feedback loops, disabled mode, and order stability under concurrent operations.
The full existing test suite passes without any changes to expectations.