feat: Principal class serializes to JSON #766
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
size-limit report 📦
|
ericswanson-dfinity
approved these changes
Sep 20, 2023
| * @returns {string} string | ||
| */ | ||
| public toJSON(): string { | ||
| return this.toText(); |
There was a problem hiding this comment.
Isn't this a bit weak? It means that any string is either a principal or a string which can be quite error prone if you stringify and parse an object that contains string and principals.
In @dfinity/utils we prefix principal to make their encoding and decoding more safe by using JSON reviver and replacer.
https://github.com/dfinity/ic-js/blob/main/packages/utils/src/utils/json.utils.ts
There was a problem hiding this comment.
We could serialize into { "__principal__": principal.toText() } instead. The main case I wanted to cover was just ensuring that JSON.stringify() on objects containing principals handles the case gracefully
4 tasks
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.
Description
JSON.stringify(principal)currently usesUint8Arrayencoding instead oftoString. Adding thetoJSONmethod resolves thisHow Has This Been Tested?
new unit tests
Checklist: