Extract undo/redo as a separate package #54292
Merged
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
youknowriad
added
Framework
youknowriad
requested review from
mtias,
jsnajdr,
ellatrix,
dmsnell,
tyxla and
ntsekouras
youknowriad
requested review from
nerrad,
ajitbohra,
ryanwelcher,
juanmaguitar,
fabiankaegy and
ndiego
as code owners
|
Size Change: -3.35 kB (0%) Total Size: 1.52 MB
ℹ️ View Unchanged
|
jsnajdr
reviewed
Sep 8, 2023
|
Ok This should be ready now, I addressed all the edge cases that were causing some e2e test failures. |
ellatrix
reviewed
Sep 11, 2023
ellatrix
reviewed
Sep 11, 2023
ellatrix
reviewed
Sep 11, 2023
There was a problem hiding this comment.
I'm not sure if we should do this extraction now. With collaborative editing starting we need an undo solution that works well with multiple authors potentially changing multiple documents. So undo will probably use something like yjs-undo-manager or multi-document undo manager bellow. If we can use one of these solutions maybe we don't necessarily need to expose anything for now.
|
@jorgefilipecosta that is a good point and I've actually thought about it, that said, I think regardless of whether we need a different undo/redo manager once we have collaborative editing, I think this API is good for third-party editors and we may end up having two different undo/redo managers depending on the use-case. I'll probably make this package "bundled" to start with to avoid any WP public API. |
ellatrix
reviewed
Sep 11, 2023
ellatrix
reviewed
Sep 11, 2023
ellatrix
reviewed
Sep 11, 2023
Yes, I understand the block editor as a framework needs to have undo even in simple solutions where we don't have collaborative editing and things like that. My expectation would be that even in a simple case we can use one of the third-party undo solutions for consistency and maintainability. And in a simple case one non-sync document, one user, the third-party solutions would still work. But we don't know the future and if we can get away with just a single thrid-party undo manager our undo manager may become a wrapper of another solution in that case. |
ellatrix
reviewed
Sep 11, 2023
|
The goal here is to open some possibilities for third-party users. So we don't want new APIs for WordPress, I made this a "bundled" package now. cc @ellatrix @jorgefilipecosta |
ellatrix
reviewed
Sep 11, 2023
Right, but wouldn't it be better to start with exposing the wrapper then, and if they need a lower level API, expose this? |
@ellatrix For npm developers it's totally ok to have both APIs, I don't see any downsides. For WordPress less so, so I made the package private (bundled) for now. |
ellatrix
approved these changes
Sep 11, 2023
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.
Related #53874
One piece of feedback we've received regardless of third-party block editors is that they have to recreate undo/redo behavior on their own. This PR is the first step to help them do that without writing too much code. Basically here, I'm extracting the undo/redo manager from the reducer of "core-data" into a new dedicated package.
I think the best way to understand how to use this package is to check its unit tests. It's something like:
The next step for me is going to be to write a React hook around this undo/redo manager, something like that:
Testing instructions