feat: refactor event serialization to use static fromJson method #6614
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
feat/refactor-events
branch
from
0ca168c
to
b2fa980
Compare
NeilFraser
approved these changes
Nov 14, 2022
| @@ -32,7 +34,7 @@ export class BlockBase extends AbstractEvent { | |||
| */ | |||
| constructor(opt_block?: Block) { | |||
| super(); | |||
| this.isBlank = !!opt_block; | |||
| this.isBlank = !opt_block; | |||
There was a problem hiding this comment.
Can we have a comment about this property?
There was a problem hiding this comment.
Like what isBlank means?
There was a problem hiding this comment.
Yes. Like the comments below regarding the other properties.
There was a problem hiding this comment.
It has a docs comment here, do you think that's sufficient? I don't necessarily want to duplicate docs that might go out-of-date.
There was a problem hiding this comment.
Oh, cool. Agreed, don't want to duplicate comments.
That said, that comment looks like Copilot wrote it. X.isY -> "Whether or not X is Y" 🙄 I still have no idea what a 'blank' event means.
There was a problem hiding this comment.
Updated. How's that feel?
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
npm run formatandnpm run lintThe details
Resolves
Fixes #6607
Proposed Changes
Adds a new path to
Blockly.Events.fromJsonwhich uses a staticfromJsonmethod on the event classes to deserialize them.Also adds static
fromJsonmethods to all existing events.Reason for Changes
See #6607
Test Coverage
Adds round-trip serialization tests for all events, and updates change detectors in places where serialization was previously broken.
Documentation
N/A
Additional Information
I've marked the static
fromJsonmethods as@internalsince I'm not super hapy with the types, and external devs should be callingBlockly.Events.fromJsonanyway.