feat: new component for data models - DIDs, signatures, JSON-LD #3565

Moopli · 2023-04-24T20:12:37Z

component/models/:

did: afgo's DID and DID Doc models.
ld: JSON-LD support - data models, context stores, LD-Proofs, canonicalization, etc.
signature: signing APIs used in DID Docs etc.
util: utility data models needed for other model implementations, but not specific to a given model.

codecov · 2023-04-24T20:21:37Z

Codecov Report

Merging #3565 (3d0f089) into main (a8b546e) will decrease coverage by 0.53%.
The diff coverage is 54.03%.

@@            Coverage Diff             @@
##             main    #3565      +/-   ##
==========================================
- Coverage   87.76%   87.24%   -0.53%     
==========================================
  Files         351      353       +2     
  Lines       48627    48671      +44     
==========================================
- Hits        42677    42461     -216     
- Misses       4402     4673     +271     
+ Partials     1548     1537      -11

Impacted Files	Coverage Δ
component/models/did/endpoint/endpoint.go	`91.50% <ø> (ø)`
component/models/did/helpers.go	`54.47% <ø> (ø)`
component/models/did/legacy.go	`92.94% <ø> (ø)`
component/models/did/serialize_default.go	`100.00% <ø> (ø)`
...ponent/models/ld/context/remote/remote_provider.go	`79.48% <ø> (ø)`
component/models/ld/proof/utils.go	`78.84% <ø> (ø)`
component/models/ld/store/context_store.go	`87.50% <ø> (ø)`
component/models/ld/store/remote_provider_store.go	`93.87% <ø> (ø)`
...e/suite/bbsblssignature2020/public_key_verifier.go	`100.00% <ø> (ø)`
...te/bbsblssignatureproof2020/public_key_verifier.go	`100.00% <ø> (ø)`
... and 39 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Moopli · 2023-04-24T23:16:30Z

Note: Since this PR introduces a new component that afgo depends on, it needs a followup that removes the go.mod replace directives (replace github.com/hyperledger/aries-framework-go/component/models => ./component/, etc) and updates imports of component/models to use this PR commit.

DRK3 · 2023-04-25T14:23:20Z

component/models/did/doc.go

@@ -1208,7 +1208,7 @@ func (doc *Doc) MarshalJSON() ([]byte, error) {
 }

 // VerifyProof verifies document proofs.
-func (doc *Doc) VerifyProof(suites []verifier.SignatureSuite, jsonldOpts ...jsonld.ProcessorOpts) error {
+func (doc *Doc) VerifyProof(suites []verifier.SignatureSuite, jsonldOpts ...processor.ProcessorOpts) error {


I would suggest renaming ProcessorOpts to just Opts to avoid the repetition

DRK3 · 2023-04-25T14:25:46Z

component/models/ld/mock/mock_context_store.go

 	"github.com/hyperledger/aries-framework-go/spi/storage"
 )

 // MockContextStore is a mock JSON-LD context store.
-type MockContextStore struct {
+type MockContextStore struct { // nolint:golint


Reason for the nolint?

This is for the name stuttering, but I've now fixed the stuttering instead.

DRK3 · 2023-04-25T14:28:43Z

component/models/ld/processor/processor_test.go

-	"github.com/hyperledger/aries-framework-go/pkg/doc/signature/jsonld"
-	"github.com/hyperledger/aries-framework-go/pkg/internal/ldtestutil"
+	ldcontext "github.com/hyperledger/aries-framework-go/component/models/ld/context"
+	"github.com/hyperledger/aries-framework-go/component/models/ld/ldtestutil"


since ldtestutil is under ld, you can change ldtestutil to simply testutil

DRK3 · 2023-04-25T14:32:55Z

component/models/ld/processor/processor.go

The package name is still jsonld - it should be changed to processor

DRK3

See my comments

DRK3 · 2023-04-25T14:34:01Z

component/models/ld/documentloader/document_loader.go

Package name needs to be updated to avoid weirdness when importing

DRK3 · 2023-04-25T14:43:02Z

Something else I'm wondering: do we really need individual packages for all the various pieces under component/models/ld? If they're all related, is there a reason to require a caller to import multiple packages? Will anyone need to import one of them but not the other? etc

DRK3 · 2023-04-25T14:46:03Z

component/models/ld/store/context_store.go

Package name should be store instead of ld now. Also, with that in mind - ContextStore should then be simplified to avoid repetition. But as I'm writing this, I'm seeing some weirdness with trying to come up with an appropriate name - should this just be merged in along with the other ld stuff into a single ld package? Then you could have things like ld.ContextStore, ld.DocumentLoader instead of store.ContextStore, documentloader.Loader, etc

Moopli · 2023-04-25T17:26:45Z

If they're all related, is there a reason to require a caller to import multiple packages? Will anyone need to import one of them but not the other?

Hmm so, testutil definitely needs to be separate, and usually only context is imported together with other ld/ packages, so I'm not sure what it gains, while at least right now there's a clear separation of functionality.

* perf: remove extra parsing * fix: lint * perf: avoid one more perse

…ledger-archives#3565)" This reverts commit bc29a59.

This reverts commit bc29a59.

Moopli force-pushed the did-module branch from fc91db4 to e90c9c6 Compare April 24, 2023 21:41

Moopli marked this pull request as ready for review April 24, 2023 23:13

Moopli force-pushed the did-module branch 2 times, most recently from 6be9993 to ece95a7 Compare April 24, 2023 23:54

rolsonquadras requested review from rolsonquadras, DRK3, sandrask, sudeshrshetty and vkubiv April 25, 2023 14:00

sudeshrshetty approved these changes Apr 25, 2023

View reviewed changes

sandrask approved these changes Apr 25, 2023

View reviewed changes

rolsonquadras approved these changes Apr 25, 2023

View reviewed changes

DRK3 reviewed Apr 25, 2023

View reviewed changes

vkubiv approved these changes Apr 25, 2023

View reviewed changes

DRK3 reviewed Apr 25, 2023

View reviewed changes

DRK3 suggested changes Apr 25, 2023

View reviewed changes

DRK3 reviewed Apr 25, 2023

View reviewed changes

Moopli force-pushed the did-module branch 3 times, most recently from 3543558 to 7248c9a Compare April 25, 2023 16:45

rolsonquadras requested a review from DRK3 April 25, 2023 16:55

Moopli force-pushed the did-module branch 2 times, most recently from 6b37f93 to d5b1156 Compare April 25, 2023 18:19

Moopli force-pushed the did-module branch 3 times, most recently from 6b98ea7 to fd1f3cc Compare April 25, 2023 18:59

perf: remove extra parsing (hyperledger-archives#3566)

3d0f089

* perf: remove extra parsing * fix: lint * perf: avoid one more perse

Moopli force-pushed the did-module branch from fd1f3cc to 3d0f089 Compare April 25, 2023 19:09

DRK3 approved these changes Apr 25, 2023

View reviewed changes

sudeshrshetty merged commit bc29a59 into hyperledger-archives:main Apr 25, 2023

Moopli added a commit to Moopli/aries-framework-go that referenced this pull request Apr 25, 2023

Revert "perf: remove extra parsing (hyperledger-archives#3566) (hyper…

fc66426

…ledger-archives#3565)" This reverts commit bc29a59.

Moopli mentioned this pull request Apr 25, 2023

Revert "feat: new component for data models - DIDs, signatures, JSON-LD" #3567

Merged

sudeshrshetty added a commit that referenced this pull request Apr 25, 2023

Revert "perf: remove extra parsing (#3566) (#3565)"

1b1ca6e

This reverts commit bc29a59.

sudeshrshetty mentioned this pull request Apr 25, 2023

Revert "feat: new component for data models - DIDs, signatures, JSON-LD" #3569

Closed

Moopli mentioned this pull request Apr 25, 2023

feat: new component for data models - DIDs, signatures, JSON-LD #3568

Merged

sudeshrshetty pushed a commit that referenced this pull request Apr 26, 2023

Revert "perf: remove extra parsing (#3566) (#3565)" (#3567)

3fd663d

This reverts commit bc29a59.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: new component for data models - DIDs, signatures, JSON-LD #3565

feat: new component for data models - DIDs, signatures, JSON-LD #3565

Moopli commented Apr 24, 2023

codecov bot commented Apr 24, 2023 •

edited

Loading

Moopli commented Apr 24, 2023

DRK3 Apr 25, 2023 •

edited

Loading

Moopli Apr 25, 2023

DRK3 Apr 25, 2023

Moopli Apr 25, 2023

DRK3 Apr 25, 2023

Moopli Apr 25, 2023

DRK3 Apr 25, 2023

Moopli Apr 25, 2023

DRK3 left a comment

DRK3 Apr 25, 2023

Moopli Apr 25, 2023

DRK3 commented Apr 25, 2023

DRK3 Apr 25, 2023 •

edited

Loading

Moopli Apr 25, 2023

Moopli commented Apr 25, 2023

feat: new component for data models - DIDs, signatures, JSON-LD #3565

feat: new component for data models - DIDs, signatures, JSON-LD #3565

Conversation

Moopli commented Apr 24, 2023

codecov bot commented Apr 24, 2023 • edited Loading

Codecov Report

Moopli commented Apr 24, 2023

DRK3 Apr 25, 2023 • 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

DRK3 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DRK3 commented Apr 25, 2023

DRK3 Apr 25, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Moopli commented Apr 25, 2023

codecov bot commented Apr 24, 2023 •

edited

Loading

DRK3 Apr 25, 2023 •

edited

Loading

DRK3 Apr 25, 2023 •

edited

Loading