Refactor DID package #371
Merged
Refactor DID package #371
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
Codecov Report
@@ Coverage Diff @@
## main #371 +/- ##
==========================================
- Coverage 59.25% 56.83% -2.43%
==========================================
Files 55 65 +10
Lines 6840 6900 +60
==========================================
- Hits 4053 3921 -132
- Misses 2076 2283 +207
+ Partials 711 696 -15
|
andresuribe87
approved these changes
May 8, 2023
did/resolver/resolver.go
Outdated
| @@ -1,12 +1,15 @@ | |||
| package did | |||
| package resolver | |||
There was a problem hiding this comment.
To avoid stuttering, and seems like a better name for the package.
Suggested change
| package resolver | |
| package resolution |
did/resolver/resolver_test.go
Outdated
Comment on lines
10
to
21
| func TestDIDDocumentMetadata(t *testing.T) { | ||
| // good | ||
| var metadata DocumentMetadata | ||
| assert.True(t, metadata.IsValid()) | ||
|
|
||
| // bad | ||
| badMetadata := DocumentMetadata{ | ||
| Created: "bad", | ||
| Updated: time.Now().UTC().Format(time.RFC3339), | ||
| } | ||
| assert.False(t, badMetadata.IsValid()) | ||
| } |
There was a problem hiding this comment.
Can't tell if this was existing, but the tests could be separated
Suggested change
| func TestDIDDocumentMetadata(t *testing.T) { | |
| // good | |
| var metadata DocumentMetadata | |
| assert.True(t, metadata.IsValid()) | |
| // bad | |
| badMetadata := DocumentMetadata{ | |
| Created: "bad", | |
| Updated: time.Now().UTC().Format(time.RFC3339), | |
| } | |
| assert.False(t, badMetadata.IsValid()) | |
| } | |
| func TestDIDDocumentMetadata_IsValid(t *testing.T) { | |
| t.Run("returns true with empty", func(t *testing.T) { | |
| var metadata DocumentMetadata | |
| assert.True(t, metadata.IsValid()) | |
| }) | |
| t.Run("returns false when created field is not a timestamp", func(t *testing.T) { | |
| badMetadata := DocumentMetadata{ | |
| Created: "bad", | |
| Updated: time.Now().UTC().Format(time.RFC3339), | |
| } | |
| assert.False(t, badMetadata.IsValid()) | |
| }) | |
| } |
Comment on lines
+35
to
+41
| // The '=' at the end is an artifact of the encoding, and will mess up the decoding | ||
| // over the partials, so is removed. | ||
| // https://identity.foundation/peer-did-method-spec/index.html#generation-method | ||
| // ds := string(d) | ||
| // if ds[len(ds)-1] == '=' { | ||
| // d = DIDPeer(ds[:len(ds)-1]) | ||
| // } |
There was a problem hiding this comment.
I'm not familiar with the code so would prefer leaving it
did/peer/peer_test.go
Outdated
Comment on lines
14
to
22
| // unsupported type | ||
| _, err := encodePublicKeyWithKeyMultiCodecType(crypto.KeyType("unsupported"), nil) | ||
| assert.Error(t, err) | ||
| assert.Contains(t, err.Error(), "not a supported key type") | ||
|
|
||
| // bad public key | ||
| _, err = encodePublicKeyWithKeyMultiCodecType(crypto.Ed25519, nil) | ||
| assert.Error(t, err) | ||
| assert.Contains(t, err.Error(), "unknown public key type; could not convert to bytes") |
There was a problem hiding this comment.
Similar comment to the above. Though I see this was only moved. Up to you.
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.
no new code - just refactoring