Adding DID Document Builder #284

andorsk · 2023-02-15T11:35:23Z

In reference to #283

…cumentbuilder

codecov-commenter · 2023-02-16T09:11:15Z

Codecov Report

Merging #284 (51be561) into main (0d4c525) will increase coverage by 0.11%.
The diff coverage is 65.62%.

@@            Coverage Diff             @@
##             main     #284      +/-   ##
==========================================
+ Coverage   60.43%   60.54%   +0.11%     
==========================================
  Files          40       41       +1     
  Lines        4458     4554      +96     
==========================================
+ Hits         2694     2757      +63     
- Misses       1330     1352      +22     
- Partials      434      445      +11

Impacted Files	Coverage Δ
did/builder.go	`65.62% <65.62%> (ø)`

andorsk · 2023-02-16T10:00:00Z

@decentralgabe can you take a look and merge if this is ok?

nitro-neal · 2023-02-16T15:52:21Z

did/builder.go

+		return errors.Wrap(err, "malformed context")
+	}
+	uniqueContexts := util.MergeUniqueValues(builder.contexts, res)
+	builder.contexts = uniqueContexts


Why doe we have an outer layer with contexts as well?

great question. I used https://github.com/TBD54566975/ssi-sdk/blob/main/credential/builder.go as a reference. The reason it was suggested was the following:

On : https://github.com/TBD54566975/ssi-sdk/blob/main/credential/builder.go#L25
// contexts and types are kept to avoid having cast to/from interface{} values

I made an assumption here since the context is also the same data type, this is a reasonable implementation to rely upon for did document builder. The reason I would give is similar to the above. I can put in comments if helpful

did/builder_test.go

decentralgabe

supportive of this!

Co-authored-by: Gabe <7622243+decentralgabe@users.noreply.github.com>

andorsk · 2023-02-16T16:38:21Z

Thanks for the review @decentralgabe . addressed the comments. Realized you might be busy. No rush here. @nitro-neal lmk if your concerns are addressed as well.

Thanks guys!

andorsk · 2023-02-22T10:39:15Z

bonk. @decentralgabe or @nitro-neal can you get back and possible merge if you're good with this?

andresuribe87

I understand that this is following the same pattern that existed, but it is strange to me that every setter method returns an error, which can only be the BuilderEmptyError. I think it would be cleaner for only Build to return an error. The rest should simply accumulate changes.

andresuribe87 · 2023-02-22T13:59:21Z

did/builder.go

+// Builds the DID Document
+func (builder *DIDDocumentBuilder) Build() (*DIDDocument, error) {
+	if builder.IsEmpty() {
+		return nil, errors.New(BuilderEmptyError)


Good practice for the error to be the constant, so callers can compare against it. You can also reuse.

@andresuribe87 understand. Following existing implementation here https://github.com/TBD54566975/ssi-sdk/blob/main/credential/builder.go#L70 to stay consistent. If we want to revisit how errors are handle in the builders I'm OK with that, but I think they should be consistent across the VC builder and the DIDDocument builder.

did/builder.go

andresuribe87 · 2023-02-22T14:00:42Z

did/builder.go

+	return reflect.DeepEqual(builder, &DIDDocumentBuilder{})
+}
+
+func (builder *DIDDocumentBuilder) AddContext(context interface{}) error {


Suggested change

func (builder *DIDDocumentBuilder) AddContext(context interface{}) error {

func (builder *DIDDocumentBuilder) AddContext(context any) error {

@andresuribe87 as long as this works, I'm fine moving to any, but note https://github.com/TBD54566975/ssi-sdk/blob/main/credential/builder.go#L68 uses the interface{} type.

Either works, filed #289

andresuribe87 · 2023-02-22T16:24:24Z

did/builder_test.go

+)
+
+// Exercise all builder methods
+func TestDIDDocumentBuilder(t *testing.T) {


Would it make sense to split this test into multiple smaller ones, that exercise a single behavior?

Reasonable suggestion if we want to update that. I can put a note in for a future PR to move this into smaller tests.

Why not do it in this PR?

From a maintainability perspective, it's easier to have smaller, self contained tests.

FWIW, I want to add coding guidelines into the contribution doc. See #290

@andresuribe87 again, this was all using the reference of the VC Builder code, which does tests in a similar way. https://github.com/TBD54566975/ssi-sdk/blob/main/credential/builder_test.go#L254. I was being consistent with the existing codebase. I think if we want to break things out, we should also address the VC Builder as well.

There are good reasons to have smaller tests, but IMO this shouldn't block the PR.

andresuribe87 · 2023-02-22T16:32:59Z

did/builder.go

+type DIDDocumentBuilder struct {
+	contexts []string
+	types    []string
+	*DIDDocument


Why have this be exposed to users of the DIDDocumentBuilder class?

@andresuribe87 I was following precedence from previous code implemented in the ssi-sdk: https://github.com/TBD54566975/ssi-sdk/blob/main/credential/builder.go#L24.

Co-authored-by: Andres Uribe <andresuribe87@gmail.com>

decentralgabe · 2023-02-22T18:59:29Z

thanks @andorsk !

andorsk · 2023-02-22T19:06:56Z

Thanks @andresuribe87 @nitro-neal @decentralgabe for the review!

andorsk added 3 commits February 15, 2023 17:05

added builder

ce27b9f

added other builder methods

ae8c244

start of builder tests

8cd0fae

andorsk changed the title ~~Adding Document Builder~~ Adding DID Document Builder Feb 15, 2023

andorsk added 4 commits February 15, 2023 17:17

Merge branch 'main' into documentbuilder

17dce44

tests are passing

f4352e9

Merge branch 'documentbuilder' of github.com:benri-io/ssi-sdk into do…

a5eccd5

…cumentbuilder

Merge branch 'main' into documentbuilder

a75b9ff

andorsk self-assigned this Feb 16, 2023

andorsk added the enhancement New feature or request label Feb 16, 2023

andorsk marked this pull request as ready for review February 16, 2023 08:55

andorsk requested review from decentralgabe, nitro-neal and andresuribe87 as code owners February 16, 2023 08:55

andorsk added 3 commits February 16, 2023 14:34

fix jwk call

db9bf6a

Merge branch 'documentbuilder' of github.com:benri-io/ssi-sdk into do…

ed7f352

…cumentbuilder

formatting updates

0ccc4df

andorsk added 2 commits February 16, 2023 14:46

fix linter error

ebe6e46

added an additional test to improve coverage

51be561

nitro-neal reviewed Feb 16, 2023

View reviewed changes

andorsk requested a review from nitro-neal February 16, 2023 16:20

decentralgabe reviewed Feb 16, 2023

View reviewed changes

did/builder_test.go Outdated Show resolved Hide resolved

decentralgabe reviewed Feb 16, 2023

View reviewed changes

did/builder_test.go Outdated Show resolved Hide resolved

decentralgabe approved these changes Feb 16, 2023

View reviewed changes

andorsk and others added 2 commits February 16, 2023 22:04

Update did/builder_test.go

af402ab

Co-authored-by: Gabe <7622243+decentralgabe@users.noreply.github.com>

addressed comments

74938b5

andorsk requested a review from decentralgabe February 22, 2023 10:38

andresuribe87 reviewed Feb 22, 2023

View reviewed changes

Update did/builder.go

d05570a

Co-authored-by: Andres Uribe <andresuribe87@gmail.com>

andresuribe87 approved these changes Feb 22, 2023

View reviewed changes

decentralgabe merged commit fe6a40d into TBD54566975:main Feb 22, 2023

andorsk deleted the documentbuilder branch February 22, 2023 19:06

decentralgabe mentioned this pull request Mar 24, 2023

[Idea] DID Document Builder #283

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding DID Document Builder #284

Adding DID Document Builder #284

andorsk commented Feb 15, 2023 •

edited

Loading

codecov-commenter commented Feb 16, 2023 •

edited

Loading

andorsk commented Feb 16, 2023

nitro-neal Feb 16, 2023

andorsk Feb 16, 2023 •

edited

Loading

decentralgabe left a comment

andorsk commented Feb 16, 2023

andorsk commented Feb 22, 2023

andresuribe87 left a comment •

edited

Loading

andresuribe87 Feb 22, 2023

andorsk Feb 22, 2023

andresuribe87 Feb 22, 2023

andorsk Feb 22, 2023

andresuribe87 Feb 22, 2023

andresuribe87 Feb 22, 2023

andorsk Feb 22, 2023

andresuribe87 Feb 22, 2023

andorsk Feb 22, 2023 •

edited

Loading

andresuribe87 Feb 22, 2023

andorsk Feb 22, 2023

decentralgabe commented Feb 22, 2023

andorsk commented Feb 22, 2023

	func (builder *DIDDocumentBuilder) AddContext(context interface{}) error {
	func (builder *DIDDocumentBuilder) AddContext(context any) error {

Adding DID Document Builder #284

Adding DID Document Builder #284

Conversation

andorsk commented Feb 15, 2023 • edited Loading

codecov-commenter commented Feb 16, 2023 • edited Loading

Codecov Report

andorsk commented Feb 16, 2023

Choose a reason for hiding this comment

andorsk Feb 16, 2023 • edited Loading

Choose a reason for hiding this comment

decentralgabe left a comment

Choose a reason for hiding this comment

andorsk commented Feb 16, 2023

andorsk commented Feb 22, 2023

andresuribe87 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andorsk Feb 22, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

decentralgabe commented Feb 22, 2023

andorsk commented Feb 22, 2023

andorsk commented Feb 15, 2023 •

edited

Loading

codecov-commenter commented Feb 16, 2023 •

edited

Loading

andorsk Feb 16, 2023 •

edited

Loading

andresuribe87 left a comment •

edited

Loading

andorsk Feb 22, 2023 •

edited

Loading