[SuperEditor] - Make all DocumentNodes immutable (Resolves #2166) #2384
Conversation
This file contains 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
… a blockquote use-case, and ToggleTextAttributionsCommand
…per_editor/supereditor_text_layout_test.dart
|
FYI @miguelcmedeiros @brian-superlist @jmatth @Jethro87 - This PR will likely break some things for you. The fixes should be pretty simple and straight forward, but some changes will likely be necessary for you. Changing document nodes to immutable brings us one step closer to capturing snapshots for undo/redo. |
angelosilvestre
approved these changes
Oct 23, 2024
| @@ -375,49 +418,31 @@ abstract class DocumentNode implements ChangeNotifier { | |||
| } | |||
|
|
|||
| /// Returns all metadata attached to this [DocumentNode]. | |||
| Map<String, dynamic> get metadata => _metadata; | |||
| Map<String, dynamic> get metadata => Map.from(_metadata); | |||
There was a problem hiding this comment.
Do we really need to create a new map that copies all items each time? If we just want to prevent modifications, could we use UnmodifiableMapView instead?
From the docs:
View of a Map that disallow modifying the map.
A wrapper around a Map that forwards all members to the map provided in the constructor, except for operations
that modify the map. Modifying operations throw instead.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
[SuperEditor] - Make all DocumentNodes immutable (Resolves #2166)
For undo/redo and edit transactions to be trustable, the document and its nodes need to be immutable from outside the
Editor. This PR makes that conversion.Replacing nodes
By making nodes immutable, each node can no longer be directly updated for things like changing text, indent, etc. Instead, every time a change is made to a node, the previous node must be replaced by the new node in the document. For that reason, a lot of the changes in this PR is focused on switching from direct node manipulation to document node replacement.
This also means that tests need to re-query nodes throughout the test. We should avoid storing nodes as intermediate values in tests, whenever we can, so that we don't accidentally try to look for changes on the same immutable node.
New copy methods
Moving from direct editing of a node to node replacement, we need the ability to
copyWith()changes. Unfortunately, there's not a clean solution to this because Dart doesn't support method overloading. As a result, to deal with subclasses, we have to declare things likecopyTextNodeWith(),copyParagraphWith(), andcopyTaskWith(). Moreover, each subclass needs to adjust the superclass copy method so that subclass instances don't lose some of their data when the parent class' copy method is called.