feat: Create/Get Profile Endpoint and store the profile data #10

talwinder50 · 2020-01-15T23:09:23Z

closes #2

Signed-off-by: talwinder.kaur talwinder.kaur@securekey.com

todo · 2020-01-15T23:09:27Z

to be replaced by getting profile ID

https://github.com/trustbloc/edge-service/blob/bf9e2e781da4409842226d40ed2c828d2b54b155/pkg/restapi/vc/operation/operations.go#L217-L220

This comment was generated by todo based on a `TODO` comment in `bf9e2e7` in #10. cc @talwinder50.

codecov · 2020-01-15T23:15:57Z

Codecov Report

Merging #10 into master will decrease coverage by 4.93%.
The diff coverage is 87.77%.

@@            Coverage Diff             @@
##           master      #10      +/-   ##
==========================================
- Coverage   94.59%   89.65%   -4.94%     
==========================================
  Files           4        5       +1     
  Lines          74      145      +71     
==========================================
+ Hits           70      130      +60     
- Misses          2        8       +6     
- Partials        2        7       +5

Impacted Files	Coverage Δ
pkg/restapi/vc/controller.go	`77.77% <60%> (-22.23%)`	⬇️
pkg/restapi/vc/operation/profile.go	`77.77% <77.77%> (ø)`
pkg/restapi/vc/operation/operations.go	`92.92% <92.53%> (-2.91%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c05bf23...281b8e2. Read the comment docs.

sandrask · 2020-01-16T13:09:43Z

pkg/internal/mock/vc/mock_vc.go

+	"github.com/trustbloc/edge-service/pkg/storage"
+)
+
+// MockVC mock did exchange service


this mock is referencing exchange service and protocols, lets discuss this

sandrask · 2020-01-16T13:14:29Z

pkg/storage/memstore/memstore.go

@@ -0,0 +1,90 @@
+/*


Is this memory store reused from other projects?

Firas, Sandra and I just talked - I am going to ask @troyronda if we can make another repo for just storage, since it looks like we're going to be using the same storage in the edv repo and this one

When couchdb support is ready, it'll go into that new repo as well

Yes i reused it from aries-framework-go, agree it would make more sense to put that in separate project. I have pointed to edv for now.

sandrask · 2020-01-16T13:19:02Z

pkg/restapi/vc/operation/operations.go

@@ -111,11 +181,61 @@ func createCredential(data *CreateCrendential) (*verifiable.Credential, error) {
 	return validatedCred, nil
 }

+func (c *Operation) createProfile(pr *ProfileRequest) (*ProfileResponse, error) {
+	if pr.DID == "" || pr.URI == "" {
+		return nil, fmt.Errorf("profile request is bad")


error should be more informative: missing DID and/or URI information

sandrask · 2020-01-16T16:21:29Z

pkg/internal/mock/storage/mock_store.go

+)
+
+// MockStoreProvider mock store provider.
+type MockStoreProvider struct {


Are mocks from edv too?

sandrask · 2020-01-16T16:22:37Z

pkg/internal/mock/vc/mock_vc.go

+// Name return service name
+func (m *MockVC) Name() string {
+	if m.ProtocolName != "" {
+		return m.ProtocolName


What is protocol name?

cmd/vc-rest/go.mod

cmd/vc-rest/go.sum

cmd/vc-rest/startcmd/start.go

go.mod

DRK3 · 2020-01-17T17:47:48Z

pkg/restapi/vc/operation/operations.go

+		_, err = rw.Write([]byte(fmt.Sprintf("Received invalid request: %s", err.Error())))
+
+		if err != nil {
+			log.Errorf("Failed to write response for credential profile failure (unable to read request): %s", err.Error())


Change this log error to "Failed to write response for invalid request received" or something similar so it matches the pattern of the other log error messages in this file

It would be better to have common function for error response - it will make your unit-testing easier.
func (c *Operation) writeErrorResponse(rw http.ResponseWriter, status int, msg string) { rw.WriteHeader(status) if _, err := rw.Write([]byte(msg)); err != nil { log.Errorf("Unable to send error message, %s", err) } }

DRK3 · 2020-01-17T18:16:36Z

pkg/restapi/vc/operation/persistence.go

+//
+// Args:
+//
+//
+// Returns:
+//
+// error: error


don't need this part of the comment. Or perhaps expand on it so it provides some more useful info if you think it's needed

DRK3 · 2020-01-17T18:17:18Z

pkg/restapi/vc/operation/persistence.go

+//
+// Args:
+//
+// id: profile id
+//
+// Returns:
+//
+// profile found
+// error: error


Don't need this part of the comment. Or perhaps expand on it so it provides some more useful info if you think it's needed

pkg/restapi/vc/operation/persistence.go

sandrask · 2020-01-17T21:34:06Z

cmd/vc-rest/startcmd/start.go

@@ -89,7 +93,7 @@ func startEdgeService(parameters *vcRestParameters) error {
 		router.HandleFunc(handler.Path(), handler.Handle()).Methods(handler.Method())
 	}

-	err := parameters.srv.ListenAndServe(parameters.hostURL, router)
+	err = parameters.srv.ListenAndServe(parameters.hostURL, router)


you can return here

sandrask · 2020-01-17T21:38:45Z

pkg/restapi/vc/operation/operations.go

+		_, err = rw.Write([]byte(fmt.Sprintf("Received invalid request: %s", err.Error())))
+
+		if err != nil {
+			log.Errorf("Failed to write response for credential profile failure (unable to read request): %s", err.Error())


It would be better to have common function for error response - it will make your unit-testing easier.
func (c *Operation) writeErrorResponse(rw http.ResponseWriter, status int, msg string) { rw.WriteHeader(status) if _, err := rw.Write([]byte(msg)); err != nil { log.Errorf("Unable to send error message, %s", err) } }

pkg/restapi/vc/operation/operations.go

closes: trustbloc#1 Signed-off-by: talwinder.kaur <talwinder.kaur@securekey.com>

todo · 2020-01-20T17:02:58Z

to be replaced by getting profile ID issue-47

https://github.com/trustbloc/edge-service/blob/dbcf514ed3e67eb2056349d9b8a9c7b727fdf98f/pkg/restapi/vc/operation/operations.go#L147-L150

This comment was generated by todo based on a `TODO` comment in `dbcf514` in #10. cc @talwinder50.

sandrask · 2020-01-20T20:03:44Z

pkg/restapi/vc/operation/operations.go

 	if err != nil {
-		log.Errorf("Unable to send error response, %s", err)
+		if err == errProfileNotFound {
+			rw.WriteHeader(http.StatusNotFound)


header is also written in write error response, no need to write twice

sandrask · 2020-01-20T20:04:06Z

pkg/restapi/vc/operation/operations.go

+			return
+		}
+
+		rw.WriteHeader(http.StatusBadRequest)


no need to write header

sandrask · 2020-01-20T20:14:49Z

pkg/restapi/vc/operation/operations.go

+}
+
+func getIssueDate() time.Time {
+	issueDate := time.Date(time.Now().Year(), time.Now().Month(), time.Now().Day(),


no need to call time.Now() this many times
also, can you use time.Now().UTC()

i have tried time.Now().UTC() and it worked. I remember it didn't work before, so i have updated now.

DRK3 · 2020-01-20T22:17:29Z

pkg/restapi/vc/operation/operations.go

@@ -111,11 +158,65 @@ func createCredential(data *CreateCrendential) (*verifiable.Credential, error) {
 	return validatedCred, nil
 }

+func (c *Operation) createProfile(pr *ProfileRequest) (*ProfileResponse, error) {
+	if pr.DID == "" && pr.URI == "" {


if pr.DID is blank but pr.URI isn't, is any error thrown? If not, you'll probably want to catch that.

closes trustbloc#2 Signed-off-by: talwinder.kaur <talwinder.kaur@securekey.com>

cla-bot bot added the cla-signed label Jan 15, 2020

talwinder50 force-pushed the issue-2 branch from bf9e2e7 to ec498c6 Compare January 15, 2020 23:15

talwinder50 requested review from sandrask and DRK3 January 15, 2020 23:18

sandrask reviewed Jan 16, 2020

View reviewed changes

sandrask requested a review from fqutishat January 16, 2020 13:26

talwinder50 force-pushed the issue-2 branch 2 times, most recently from 25d05ba to 6e04d74 Compare January 16, 2020 16:14

talwinder50 requested a review from sandrask January 16, 2020 16:17

sandrask reviewed Jan 16, 2020

View reviewed changes

talwinder50 force-pushed the issue-2 branch from 6e04d74 to d87abf1 Compare January 17, 2020 14:23

talwinder50 requested a review from sandrask January 17, 2020 14:24

talwinder50 force-pushed the issue-2 branch 2 times, most recently from 00e321e to 4169a4f Compare January 17, 2020 15:40

DRK3 requested changes Jan 17, 2020

View reviewed changes

sandrask reviewed Jan 17, 2020

View reviewed changes

talwinder50 force-pushed the issue-2 branch from 4169a4f to f0d0633 Compare January 19, 2020 22:18

chore: project setup

945b820

closes: trustbloc#1 Signed-off-by: talwinder.kaur <talwinder.kaur@securekey.com>

talwinder50 force-pushed the issue-2 branch 3 times, most recently from 430e000 to dbcf514 Compare January 20, 2020 17:02

talwinder50 requested review from DRK3 and sandrask January 20, 2020 17:10

talwinder50 force-pushed the issue-2 branch from dbcf514 to 4c2c026 Compare January 20, 2020 17:15

sandrask reviewed Jan 20, 2020

View reviewed changes

talwinder50 force-pushed the issue-2 branch from 4c2c026 to 31439d6 Compare January 20, 2020 20:29

talwinder50 requested a review from sandrask January 20, 2020 20:31

sandrask approved these changes Jan 20, 2020

View reviewed changes

DRK3 reviewed Jan 20, 2020

View reviewed changes

feat: Create/Get Profile Endpoint and store the profile data

281b8e2

closes trustbloc#2 Signed-off-by: talwinder.kaur <talwinder.kaur@securekey.com>

talwinder50 force-pushed the issue-2 branch from 31439d6 to 281b8e2 Compare January 20, 2020 22:30

DRK3 approved these changes Jan 20, 2020

View reviewed changes

talwinder50 merged commit 8e96b30 into trustbloc:master Jan 20, 2020

todo bot mentioned this pull request Jan 20, 2020

to be replaced by getting profile ID issue-47 #17

Closed

talwinder50 mentioned this pull request Jan 21, 2020

Create Issuer profile endpoint api #7

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Create/Get Profile Endpoint and store the profile data #10

feat: Create/Get Profile Endpoint and store the profile data #10

talwinder50 commented Jan 15, 2020

todo bot commented Jan 15, 2020

codecov bot commented Jan 15, 2020 •

edited

sandrask Jan 16, 2020

sandrask Jan 16, 2020

DRK3 Jan 16, 2020 •

edited

talwinder50 Jan 16, 2020 •

edited

sandrask Jan 16, 2020

talwinder50 Jan 16, 2020

sandrask Jan 16, 2020

sandrask Jan 16, 2020

DRK3 Jan 17, 2020

sandrask Jan 17, 2020

talwinder50 Jan 20, 2020

DRK3 Jan 17, 2020

talwinder50 Jan 20, 2020

DRK3 Jan 17, 2020

talwinder50 Jan 20, 2020

sandrask Jan 17, 2020

talwinder50 Jan 20, 2020

sandrask Jan 17, 2020

todo bot commented Jan 20, 2020

sandrask Jan 20, 2020

talwinder50 Jan 20, 2020

sandrask Jan 20, 2020

talwinder50 Jan 20, 2020

sandrask Jan 20, 2020

talwinder50 Jan 20, 2020

DRK3 Jan 20, 2020

feat: Create/Get Profile Endpoint and store the profile data #10

feat: Create/Get Profile Endpoint and store the profile data #10

Conversation

talwinder50 commented Jan 15, 2020

todo bot commented Jan 15, 2020

to be replaced by getting profile ID

This comment was generated by todo based on a TODO comment in bf9e2e7 in #10. cc @talwinder50.

codecov bot commented Jan 15, 2020 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DRK3 Jan 16, 2020 • edited

Choose a reason for hiding this comment

talwinder50 Jan 16, 2020 • edited

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

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

todo bot commented Jan 20, 2020

to be replaced by getting profile ID issue-47

This comment was generated by todo based on a TODO comment in dbcf514 in #10. cc @talwinder50.

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

This comment was generated by todo based on a `TODO` comment in `bf9e2e7` in #10. cc @talwinder50.

codecov bot commented Jan 15, 2020 •

edited

DRK3 Jan 16, 2020 •

edited

talwinder50 Jan 16, 2020 •

edited

This comment was generated by todo based on a `TODO` comment in `dbcf514` in #10. cc @talwinder50.