fix: comment have XML save and load new workspace comments classes #7931
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
BeksOmega
force-pushed
the
fix/comment-xml
branch
5 times, most recently
from
f7ee13b
to
07a22ec
Compare
BeksOmega
force-pushed
the
fix/comment-xml
branch
from
07a22ec
to
8be694a
Compare
maribethb
approved these changes
Mar 20, 2024
| @@ -478,6 +491,34 @@ export function domToWorkspace(xml: Element, workspace: Workspace): string[] { | |||
| return newBlockIds; | |||
| } | |||
|
|
|||
| /** Deserializes the given comment state into the given workspace. */ | |||
| function loadWorkspaceComment( | |||
There was a problem hiding this comment.
I am curious why not have this implemented as a function on the class itself, like it used to be? It seems like that would make it easier on people who are implementing custom subclasses, and it would make more sense organizationally IMO. And we do have a pattern of a fromXml method on fields, events, etc.
There was a problem hiding this comment.
No one is allowed to implement custom subclasses atm. We discussed that and decided YAGNI.
maribethb
approved these changes
Mar 20, 2024
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.
The basics
The details
Resolves
Fixes N/A
Proposed Changes + reasons
Updates the XML system to save and load new workspace comment classes for a ✨ seamless transition ✨
Test Coverage
Added round-trip tests for comments. This also covers the logic for all the headless setters and getters (as promised in a previous PR)
Documentation
N/A
Additional Information
Sorry about the derpy format for the serialization tests. But rewriting them to be mocha style isn't worth it.
When writing this I realized that JSON isn't handling RTL correctly. I used the same (bad) implementation here, then I'm going to fix it in my next PR.