Add toJSON implementation and testing #4966
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
gagik
commented
Sep 30, 2022
| // Check that the serializable object is the same as the first related object. | ||
| // (this check only makes sense because of our structure) | ||
| expect(serializable).equals(serializable.related[0]); | ||
| const relatedObjects = serializable.related as Array<typeof serializable>; |
There was a problem hiding this comment.
not sure if using typeof serializable is okay here / in general, not too familiar with practices just yet.
gagik
changed the title
kraenhansen
reviewed
Oct 3, 2022
kraenhansen
reviewed
Oct 3, 2022
kraenhansen
reviewed
Oct 3, 2022
kraenhansen
reviewed
Oct 3, 2022
gagik
commented
Oct 4, 2022
gagik
commented
Oct 6, 2022
12 tasks
kraenhansen
reviewed
Oct 11, 2022
kraenhansen
reviewed
Oct 11, 2022
kraenhansen
approved these changes
Oct 11, 2022
kraenhansen
approved these changes
Oct 12, 2022
kraenhansen
pushed a commit
that referenced
this pull request
Oct 24, 2022
kraenhansen
pushed a commit
that referenced
this pull request
Oct 26, 2022
RedBeard0531
pushed a commit
that referenced
this pull request
Nov 15, 2022
RedBeard0531
pushed a commit
that referenced
this pull request
Nov 23, 2022
takameyer
pushed a commit
that referenced
this pull request
Dec 28, 2022
kraenhansen
pushed a commit
that referenced
this pull request
Mar 1, 2023
kraenhansen
pushed a commit
that referenced
this pull request
Mar 3, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What, How & Why?
This is a breaking change in sense that it reintroduces
toJSONfunctionality with the binding generator but removesJSONSerializerReplacer. Instead, users are advised to use external libraries such as flatted and @ungap/structured-clone if they need to deal with serialising objects with circular references into a JSON string.The expected functionality of
toJSONis therefore to generate valid, plain JavaScript objects with correct circular references so those can be used by the packages mentioned above. Current implementation supports Objects and Collections. It is nearly completely ported from pre-bindgen implementation, see this for objects and this for collections. Some changes were made to adapt both to the current state of the API and possibly improve performance by using a 2D map.This PR is not complete and still needs feedback regarding some approaches and testing, see my review for details.
This closes #4949
☑️ ToDos
Compatibilitylabel is updated or copied from previous entryCOMPATIBILITY.mdpackage.jsons (if updating internal packages)Breakinglabel has been applied or is not necessaryIf this PR adds or changes public API's: