fix: Migrate resource metadata from contentStream to contentMetadata …

…[DEV-4767] (#348) * fix: Fix resource & resource/metadata endpoints * gofumpt * Handle default browser header * feat: Migrate metadata list from contentStream to contentMetadata * Fix unit tests * Add unmarshaller for ResourceDereferencing && isBrowser * Remove IsBrowser fix --------- Co-authored-by: Ankur Banerjee <[email protected]>
cheqd · Feb 25, 2025 · 43c05d7 · 43c05d7
1 parent 7087e0b
commit 43c05d7
Show file tree

Hide file tree

Showing 25 changed files with 441 additions and 352 deletions.
diff --git a/services/diddoc/queries/resources/resource_query_metadata_handler.go b/services/diddoc/queries/resources/resource_query_metadata_handler.go
@@ -36,8 +36,8 @@ func (d *ResourceMetadataHandler) Handle(c services.ResolverContext, service ser
 	}
 
 	if resourceMetadata == "true" {
-		dereferencingResult := types.NewResourceDereferencingFromContent(
-			service.GetDid(), service.GetContentType(), &types.ResolutionDidDocMetadata{Resources: didResolution.Metadata.Resources},
+		dereferencingResult := types.NewResourceDereferencingFromResources(
+			service.GetDid(), service.GetContentType(), &didResolution.Metadata.Resources,
 		)
 		return d.Continue(c, service, dereferencingResult)
 	}

diff --git a/services/helpers.go b/services/helpers.go
@@ -18,9 +18,8 @@ func GetPriorityContentType(acceptHeader string, resource bool) (types.ContentTy
 	}
 	for _, at := range acceptedTypes {
 		mediaType := types.ContentType(at.Type + "/" + at.Subtype)
-
 		// If the Header contains any media type, return the default content type
-		if mediaType == "*/*" {
+		if mediaType == types.DEFAULT_RESOLUTION_TYPE {
 			if resource { // If request is from Resource Handlers
 				return types.JSONLD, ""
 			} else { // If request is from DIDDoc Handlers

diff --git a/services/request_service_base.go b/services/request_service_base.go
@@ -46,8 +46,9 @@ func (dd *BaseRequestService) BasicPrepare(c ResolverContext) error {
 	isDereferencingOrFragment := dd.IsDereferencing && dd.Fragment == ""
 	// Get Accept header
 	dd.RequestedContentType, _ = GetPriorityContentType(c.Request().Header.Get(echo.HeaderAccept), isDereferencingOrFragment)
-	if !dd.GetContentType().IsSupported() {
-		return types.NewRepresentationNotSupportedError(dd.GetDid(), dd.GetContentType(), nil, dd.IsDereferencing)
+	// Ignore supported type for dereferencing
+	if !isDereferencingOrFragment && !dd.GetContentType().IsSupported() {
+		return types.NewRepresentationNotSupportedError(dd.GetDid(), types.JSON, nil, dd.IsDereferencing)
 	}
 
 	// Get DID from request

diff --git a/services/resource/resource_metadata_dereferencing.go b/services/resource/resource_metadata_dereferencing.go
@@ -32,6 +32,11 @@ func (dr ResourceMetadataDereferencingService) Redirect(c services.ResolverConte
 }
 
 func (dr *ResourceMetadataDereferencingService) SpecificValidation(c services.ResolverContext) error {
+	// Metadata endpoint should be one of the supported types.
+	if !dr.RequestedContentType.IsSupported() {
+		return types.NewRepresentationNotSupportedError(dr.GetDid(), types.JSON, nil, dr.IsDereferencing)
+	}
+
 	if !utils.IsValidUUID(dr.ResourceId) {
 		return types.NewInvalidDidUrlError(dr.ResourceId, dr.RequestedContentType, nil, dr.IsDereferencing)
 	}

diff --git a/services/resource_dereference_service.go b/services/resource_dereference_service.go
@@ -36,7 +36,7 @@ func (rds ResourceService) DereferenceResourceMetadata(did string, resourceId st
 	}
 
 	metadata := types.NewDereferencedResource(did, resource.Metadata)
-	return &types.ResourceDereferencing{Context: context, Metadata: metadata, DereferencingMetadata: dereferenceMetadata}, nil
+	return &types.ResourceDereferencing{Context: context, Metadata: &types.ResolutionResourceMetadata{ContentMetadata: metadata}, DereferencingMetadata: dereferenceMetadata}, nil
 }
 
 func (rds ResourceService) ResolveMetadataResources(did string, contentType types.ContentType) (*types.DidResolution, *types.IdentityError) {
@@ -125,5 +125,5 @@ func (rds ResourceService) DereferenceResourceDataWithMetadata(did string, resou
 		}
 	}
 
-	return &types.ResourceDereferencing{Context: context, ContentStream: result, Metadata: metadata, DereferencingMetadata: dereferenceMetadata}, nil
+	return &types.ResourceDereferencing{Context: context, ContentStream: result, Metadata: &types.ResolutionResourceMetadata{ContentMetadata: metadata}, DereferencingMetadata: dereferenceMetadata}, nil
 }
diff --git a/tests/constants/constants.go b/tests/constants/constants.go
@@ -21,7 +21,8 @@ var (
 	IndyStyleTestnetDid = "did:cheqd:testnet:73wnEyHhkhXiH1Nq7w5Kgq"
 
 	UUIDStyleTestnetId       = "c1685ca0-1f5b-439c-8eb8-5c0e85ab7cd0"
-	UUIDStyleMainnetDid      = "did:cheqd:mainnet:c82f2b02-bdab-4dd7-b833-3e143745d612"
+	UUIDStyleMainnetId       = "c82f2b02-bdab-4dd7-b833-3e143745d612"
+	UUIDStyleMainnetDid      = "did:cheqd:mainnet:" + UUIDStyleMainnetId
 	UUIDStyleTestnetDid      = "did:cheqd:testnet:" + UUIDStyleTestnetId
 	UUIDTestnetDidIdForImage = "did:cheqd:testnet:55dbc8bf-fba3-4117-855c-1e0dc1d3bb47"
 

diff --git a/tests/integration/rest/diddoc/metadata/negative_test.go b/tests/integration/rest/diddoc/metadata/negative_test.go
@@ -44,7 +44,7 @@ var _ = DescribeTable("Negative: Get DIDDoc version metadata", func(testCase uti
 			ExpectedResult: types.DidResolution{
 				Context: "",
 				ResolutionMetadata: types.ResolutionMetadata{
-					ContentType:     types.TEXT,
+					ContentType:     types.JSON,
 					ResolutionError: "representationNotSupported",
 					DidProperties:   types.DidProperties{},
 				},
@@ -68,7 +68,7 @@ var _ = DescribeTable("Negative: Get DIDDoc version metadata", func(testCase uti
 			ExpectedResult: types.DidResolution{
 				Context: "",
 				ResolutionMetadata: types.ResolutionMetadata{
-					ContentType:     types.TEXT,
+					ContentType:     types.JSON,
 					ResolutionError: "representationNotSupported",
 					DidProperties:   types.DidProperties{},
 				},

diff --git a/tests/integration/rest/diddoc/version/negative_test.go b/tests/integration/rest/diddoc/version/negative_test.go
@@ -44,7 +44,7 @@ var _ = DescribeTable("Negative: Get DIDDoc version", func(testCase utils.Negati
 			ExpectedResult: types.DidResolution{
 				Context: "",
 				ResolutionMetadata: types.ResolutionMetadata{
-					ContentType:     types.TEXT,
+					ContentType:     types.JSON,
 					ResolutionError: "representationNotSupported",
 					DidProperties:   types.DidProperties{},
 				},
@@ -68,7 +68,7 @@ var _ = DescribeTable("Negative: Get DIDDoc version", func(testCase utils.Negati
 			ExpectedResult: types.DidResolution{
 				Context: "",
 				ResolutionMetadata: types.ResolutionMetadata{
-					ContentType:     types.TEXT,
+					ContentType:     types.JSON,
 					ResolutionError: "representationNotSupported",
 					DidProperties:   types.DidProperties{},
 				},

diff --git a/tests/integration/rest/diddoc/versions/negative_test.go b/tests/integration/rest/diddoc/versions/negative_test.go
@@ -43,7 +43,7 @@ var _ = DescribeTable("Negative: Get DIDDoc versions", func(testCase utils.Negat
 			ExpectedResult: types.DidResolution{
 				Context: "",
 				ResolutionMetadata: types.ResolutionMetadata{
-					ContentType:     types.TEXT,
+					ContentType:     types.JSON,
 					ResolutionError: "representationNotSupported",
 					DidProperties:   types.DidProperties{},
 				},
@@ -66,7 +66,7 @@ var _ = DescribeTable("Negative: Get DIDDoc versions", func(testCase utils.Negat
 			ExpectedResult: types.DidResolution{
 				Context: "",
 				ResolutionMetadata: types.ResolutionMetadata{
-					ContentType:     types.TEXT,
+					ContentType:     types.JSON,
 					ResolutionError: "representationNotSupported",
 					DidProperties:   types.DidProperties{},
 				},

diff --git a/tests/integration/rest/resource/data/negative_test.go b/tests/integration/rest/resource/data/negative_test.go
@@ -30,33 +30,8 @@ var _ = DescribeTable("Negative: Get resource data", func(testCase utils.Negativ
 	expectedDidDereferencing := testCase.ExpectedResult.(utils.DereferencingResult)
 	utils.AssertDidDereferencing(expectedDidDereferencing, receivedDidDereferencing)
 },
-
 	Entry(
-		"cannot get resource data with an existent DID, but not supported ResolutionType",
-		utils.NegativeTestCase{
-			DidURL: fmt.Sprintf(
-				"http://%s/1.0/identifiers/%s/resources/%s",
-				testconstants.TestHostAddress,
-				testconstants.UUIDStyleMainnetDid,
-				testconstants.ValidIdentifier,
-			),
-			ResolutionType: string(types.TEXT),
-			ExpectedResult: utils.DereferencingResult{
-				Context: "",
-				DereferencingMetadata: types.DereferencingMetadata{
-					ContentType:     types.TEXT,
-					ResolutionError: "representationNotSupported",
-					DidProperties:   types.DidProperties{},
-				},
-				ContentStream: nil,
-				Metadata:      types.ResolutionDidDocMetadata{},
-			},
-			ExpectedStatusCode: errors.RepresentationNotSupportedHttpCode,
-		},
-	),
-
-	Entry(
-		"cannot get resource data with not existent DID and not supported ResolutionType",
+		"cannot get resource data with not existent DID",
 		utils.NegativeTestCase{
 			DidURL: fmt.Sprintf(
 				"http://%s/1.0/identifiers/%s/resources/%s",
@@ -69,13 +44,17 @@ var _ = DescribeTable("Negative: Get resource data", func(testCase utils.Negativ
 				Context: "",
 				DereferencingMetadata: types.DereferencingMetadata{
 					ContentType:     types.TEXT,
-					ResolutionError: "representationNotSupported",
-					DidProperties:   types.DidProperties{},
+					ResolutionError: "notFound",
+					DidProperties: types.DidProperties{
+						DidString:        testconstants.NotExistentMainnetDid,
+						MethodSpecificId: testconstants.NotExistentIdentifier,
+						Method:           testconstants.ValidMethod,
+					},
 				},
 				ContentStream: nil,
 				Metadata:      types.ResolutionDidDocMetadata{},
 			},
-			ExpectedStatusCode: errors.RepresentationNotSupportedHttpCode,
+			ExpectedStatusCode: errors.NotFoundHttpCode,
 		},
 	),
 

diff --git a/tests/integration/rest/resource/metadata/negative_test.go b/tests/integration/rest/resource/metadata/negative_test.go
@@ -44,9 +44,13 @@ var _ = DescribeTable("Negative: get resource metadata", func(testCase utils.Neg
 			ExpectedResult: utils.ResourceDereferencingResult{
 				Context: "",
 				DereferencingMetadata: types.DereferencingMetadata{
-					ContentType:     types.TEXT,
+					ContentType:     types.JSON,
 					ResolutionError: "representationNotSupported",
-					DidProperties:   types.DidProperties{},
+					DidProperties: types.DidProperties{
+						DidString:        testconstants.UUIDStyleMainnetDid,
+						MethodSpecificId: testconstants.UUIDStyleMainnetId,
+						Method:           testconstants.ValidMethod,
+					},
 				},
 				ContentStream: nil,
 				Metadata:      &types.DereferencedResource{},
@@ -68,9 +72,13 @@ var _ = DescribeTable("Negative: get resource metadata", func(testCase utils.Neg
 			ExpectedResult: utils.ResourceDereferencingResult{
 				Context: "",
 				DereferencingMetadata: types.DereferencingMetadata{
-					ContentType:     types.TEXT,
+					ContentType:     types.JSON,
 					ResolutionError: "representationNotSupported",
-					DidProperties:   types.DidProperties{},
+					DidProperties: types.DidProperties{
+						DidString:        testconstants.NotExistentMainnetDid,
+						MethodSpecificId: testconstants.NotExistentIdentifier,
+						Method:           testconstants.ValidMethod,
+					},
 				},
 				ContentStream: nil,
 				Metadata:      &types.DereferencedResource{},

diff --git a/tests/integration/rest/testdata/query/resource_metadata/metadata_did_res.json b/tests/integration/rest/testdata/query/resource_metadata/metadata_did_res.json
@@ -9,7 +9,7 @@
             "method": "cheqd"
         }
     },
-    "contentStream": {
+    "contentMetadata": {
         "linkedResourceMetadata": [
             {
                 "resourceURI": "did:cheqd:testnet:c1685ca0-1f5b-439c-8eb8-5c0e85ab7cd0/resources/9ba3922e-d5f5-4f53-b265-fc0d4e988c77",
@@ -39,5 +39,5 @@
             }
         ]
     },
-    "contentMetadata": null
+    "contentStream": null
 }
diff --git a/tests/integration/rest/testdata/query/resource_version_time/resource.json b/tests/integration/rest/testdata/query/resource_version_time/resource.json
@@ -9,7 +9,7 @@
             "method": "cheqd"
         }
     },
-    "contentStream": {
+    "contentMetadata": {
         "linkedResourceMetadata": [
             {
                 "resourceURI": "did:cheqd:testnet:c1685ca0-1f5b-439c-8eb8-5c0e85ab7cd0/resources/9ba3922e-d5f5-4f53-b265-fc0d4e988c77",
@@ -39,5 +39,5 @@
             }
         ]
     },
-    "contentMetadata": {}
+    "contentStream": null
 }
diff --git a/tests/integration/rest/testdata/query/resource_version_time/resource_32_indy_did.json b/tests/integration/rest/testdata/query/resource_version_time/resource_32_indy_did.json
@@ -9,7 +9,7 @@
             "method": "cheqd"
         }
     },
-    "contentStream": {
+    "contentMetadata": {
         "linkedResourceMetadata": [
             {
                 "resourceURI": "did:cheqd:testnet:3KpiDD6Hxs4i2G7FtpiGhu/resources/f31c68e6-61b5-4926-a932-40a13b4c4507",
@@ -26,5 +26,5 @@
             }
         ]
     },
-    "contentMetadata": {}
+    "contentStream": null
 }