feat: Accept contentType params for DID URL Resolution [DEV-4722]

services/helpers.go

@@ -2,6 +2,7 @@ package services
 
 import (
 	"net/url"
+	"strconv"
 	"strings"
 
 	"github.com/cheqd/did-resolver/types"
@@ -39,3 +40,48 @@ func PrepareQueries(c echo.Context) (rawQuery string, flag *string) {
 func GetDidParam(c echo.Context) (string, error) {
 	return url.QueryUnescape(c.Param("did"))
 }
+
+func GetHighestPriorityHeaderAndParams(acceptHeader string) (string, map[string]string) {
+	bestHeader := ""
+	bestParams := make(map[string]string)
+	highestQ := -1.0
+	position := 0
+
+	// Split by ',' to separate multiple headers
+	headers := strings.Split(acceptHeader, ",")
+	for index, entry := range headers {
+		entry = strings.TrimSpace(entry)
+		parts := strings.Split(entry, ";")
+
+		params := make(map[string]string)
+		q := 1.0
+
+		// Parse parameters
+		for _, param := range parts[1:] {
+			param = strings.TrimSpace(param)
+			keyValue := strings.SplitN(param, "=", 2)
+			if len(keyValue) == 2 {
+				key, value := keyValue[0], strings.Trim(keyValue[1], "\"")
+				params[key] = value
+			}
+		}
+
+		// Extract q value if present
+		if qStr, exists := params["q"]; exists {
+			if parsedQ, err := strconv.ParseFloat(qStr, 64); err == nil {
+				q = parsedQ
+			}
+		}
+
+		// Determine the highest priority header
+		if q > highestQ || (q == highestQ && position > index) {
+			highestQ = q
+			position = index
+			bestHeader = parts[0] // Only header
+			delete(params, "q")   // Remove q from params
+			bestParams = params   // Update best parameters
+		}
+	}
+
+	return bestHeader, bestParams
+}

services/resource/echo_handlers.go

@@ -2,6 +2,7 @@ package resources
 
 import (
 	"github.com/cheqd/did-resolver/services"
+	"github.com/cheqd/did-resolver/types"
 	"github.com/labstack/echo/v4"
 )
 
@@ -22,6 +23,13 @@ import (
 //	@Failure		501			{object}	types.IdentityError
 //	@Router			/{did}/resources/{resourceId} [get]
 func ResourceDataEchoHandler(c echo.Context) error {
+	// Get Accept header
+	header, params := services.GetHighestPriorityHeaderAndParams(c.Request().Header.Get(echo.HeaderAccept))
+
+	if header == string(types.JSONLD) && params["profile"] == types.W3IDDIDURL {
+		return services.EchoWrapHandler(&ResourceDataWithMetadataDereferencingService{})(c)
+	}
+
 	return services.EchoWrapHandler(&ResourceDataDereferencingService{})(c)
 }
 

services/resource/resource_data_with_metadata_dereferencing.go

@@ -0,0 +1,54 @@
+package resources
+
+import (
+	"net/http"
+
+	"github.com/cheqd/did-resolver/migrations"
+	"github.com/cheqd/did-resolver/services"
+	"github.com/cheqd/did-resolver/types"
+	"github.com/cheqd/did-resolver/utils"
+)
+
+type ResourceDataWithMetadataDereferencingService struct {
+	services.BaseRequestService
+	ResourceId string
+}
+
+func (dr *ResourceDataWithMetadataDereferencingService) Setup(c services.ResolverContext) error {
+	dr.IsDereferencing = true
+	return nil
+}
+
+func (dr *ResourceDataWithMetadataDereferencingService) SpecificPrepare(c services.ResolverContext) error {
+	dr.ResourceId = c.Param("resource")
+	return nil
+}
+
+func (dr ResourceDataWithMetadataDereferencingService) Redirect(c services.ResolverContext) error {
+	migratedDid := migrations.MigrateDID(dr.GetDid())
+
+	path := types.RESOLVER_PATH + migratedDid + types.RESOURCE_PATH + dr.ResourceId
+	return c.Redirect(http.StatusMovedPermanently, path)
+}
+
+func (dr *ResourceDataWithMetadataDereferencingService) SpecificValidation(c services.ResolverContext) error {
+	if !utils.IsValidUUID(dr.ResourceId) {
+		return types.NewInvalidDidUrlError(dr.ResourceId, dr.RequestedContentType, nil, dr.IsDereferencing)
+	}
+
+	// We not allow query here
+	if len(dr.Queries) != 0 {
+		return types.NewInvalidDidUrlError(dr.GetDid(), dr.RequestedContentType, nil, dr.IsDereferencing)
+	}
+	return nil
+}
+
+func (dr *ResourceDataWithMetadataDereferencingService) Query(c services.ResolverContext) error {
+	result, err := c.ResourceService.DereferenceResourceDataWithMetadata(dr.GetDid(), dr.ResourceId, dr.GetContentType())
+	if err != nil {
+		err.IsDereferencing = dr.IsDereferencing
+		return err
+	}
+
+	return dr.SetResponse(result)
+}

services/resource_dereference_service.go

@@ -6,7 +6,6 @@ import (
 
 	"strings"
 
-	resourceTypes "github.com/cheqd/cheqd-node/api/v2/cheqd/resource/v2"
 	"github.com/cheqd/did-resolver/types"
 )
 
@@ -36,9 +35,9 @@ func (rds ResourceService) DereferenceResourceMetadata(did string, resourceId st
 		context = types.ResolutionSchemaJSONLD
 	}
 
-	contentStream := types.NewDereferencedResourceListStruct(did, []*resourceTypes.Metadata{resource.Metadata})
+	metadata := types.NewDereferencedResource(did, resource.Metadata)
 
-	return &types.ResourceDereferencing{Context: context, ContentStream: contentStream, DereferencingMetadata: dereferenceMetadata}, nil
+	return &types.ResourceDereferencing{Context: context, Metadata: metadata, DereferencingMetadata: dereferenceMetadata}, nil
 }
 
 func (rds ResourceService) DereferenceCollectionResources(did string, contentType types.ContentType) (*types.ResourceDereferencing, *types.IdentityError) {
@@ -79,3 +78,31 @@ func (rds ResourceService) DereferenceResourceData(did string, resourceId string
 
 	return &types.ResourceDereferencing{ContentStream: &result, DereferencingMetadata: dereferenceMetadata}, nil
 }
+
+func (rds ResourceService) DereferenceResourceDataWithMetadata(did string, resourceId string, contentType types.ContentType) (*types.ResourceDereferencing, *types.IdentityError) {
+	dereferenceMetadata := types.NewDereferencingMetadata(did, contentType, "")
+
+	resource, err := rds.ledgerService.QueryResource(did, strings.ToLower(resourceId))
+	if err != nil {
+		err.ContentType = contentType
+		return nil, err
+	}
+
+	var context string
+	if contentType == types.DIDJSONLD || contentType == types.JSONLD {
+		context = types.ResolutionSchemaJSONLD
+	}
+
+	dereferenceMetadata.ContentType = types.ContentType(resource.Metadata.MediaType)
+
+	var result types.ContentStreamI
+	result = types.NewDereferencedResourceData(resource.Resource.Data)
+	metadata := types.NewDereferencedResource(did, resource.Metadata)
+	if dereferenceMetadata.ContentType == types.JSON || dereferenceMetadata.ContentType == types.TEXT {
+		if res, err := types.NewResourceData(resource.Resource.Data); err == nil {
+			result = res
+		}
+	}
+
+	return &types.ResourceDereferencing{Context: context, ContentStream: result, Metadata: metadata, DereferencingMetadata: dereferenceMetadata}, nil
+}

tests/integration/rest/resource/data/positive_test.go

@@ -155,4 +155,38 @@ var _ = DescribeTable("Positive: Get resource data", func(testCase utils.Positiv
 			ExpectedStatusCode: http.StatusOK,
 		},
 	),
+
+	Entry(
+		"can get resource with an existent DID, with multiple headers without q values",
+		utils.PositiveTestCase{
+			DidURL: fmt.Sprintf(
+				"http://%s/1.0/identifiers/%s/resources/%s",
+				testconstants.TestHostAddress,
+				testconstants.UUIDStyleTestnetDid,
+				testconstants.UUIDStyleTestnetDidResourceId,
+			),
+			ResolutionType:       "*/*," + string(types.JSONLD) + ";profile=" + string(types.W3IDDIDURL),
+			EncodingType:         testconstants.DefaultEncodingType,
+			ExpectedEncodingType: "gzip",
+			ExpectedJSONPath:     "../../testdata/resource_data/resource.json",
+			ExpectedStatusCode:   http.StatusOK,
+		},
+	),
+
+	Entry(
+		"can get resource with an existent DID, with multiple header and q values",
+		utils.PositiveTestCase{
+			DidURL: fmt.Sprintf(
+				"http://%s/1.0/identifiers/%s/resources/%s",
+				testconstants.TestHostAddress,
+				testconstants.UUIDStyleTestnetDid,
+				testconstants.UUIDStyleTestnetDidResourceId,
+			),
+			ResolutionType:       string(types.JSONLD) + ";profile=" + string(types.W3IDDIDURL) + ";q=0.5,application/json,text/plain;q=0.9,image/png;q=0.7",
+			EncodingType:         testconstants.DefaultEncodingType,
+			ExpectedEncodingType: "gzip",
+			ExpectedJSONPath:     "../../testdata/resource_data/resource.json",
+			ExpectedStatusCode:   http.StatusOK,
+		},
+	),
 )