generated from TBD54566975/tbd-project-template
-
Notifications
You must be signed in to change notification settings - Fork 10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add update for did #311
Closed
Closed
add update for did #311
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
75105db
test for adding it via manual way
michaelneale 80a35af
Add copy function for updating docs and dids
michaelneale 5dbfd5a
add some docs
michaelneale f8fc391
need to actually read and comprehend error messages
michaelneale 1a4cfa9
add an update helper
michaelneale 0ea72f3
line length
michaelneale 16b09ac
add more idiomatic
michaelneale ede0c01
don't append but replace
michaelneale b602da1
adding in the docs
michaelneale 82dff8e
use an updatedhtoptions type alias with clear docs
michaelneale 47bf20b
use update vs create type aliases correctly
michaelneale bd8d8b6
clarify docs that it isn't additive
michaelneale 616bd78
remove copy() and do it inline in update()
michaelneale File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you might have a bug here with how you're using the Elvis operator (👑 🎸) (
?:
). TheUpdateDidDhtOptions
has docs:As in, those values are additive, but the Elvis operator is a null coalescing operation, so imagine the
existingDidDocument.service
has service A, and thenoptions.services
has service B & C, then this would update the did:dht's DID Document to now have only services B & C (and not A), but the expected behavior according to the doc comments would be to have services A, B & C.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@KendallWeihe ah - that is a bug in the docs, it isn't adding now, but replacing (ie code is right, comments are not). will fix. thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, is the desired behavior to replace completely or add a new service to an existing list?
If it's the former, is this because you are prioritizing immutability?
I am not certain that going with former approach is a good dx. If I just want to add a service, shouldn't the update method do the work internally of:
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah desired is to entirely replace it (at least as it stands currently) which preserves immutability but keeps it relatively simple (but alternative means having add/remove etc things explicitly in there for things that are lists, perhaps add/remove for each thing you may want to change and separate methods?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with this approach, if only for the sake of pragmatism ("crawl before walk")