feat: Add implementation for all DID URL dereferencing parameters [DEV-2351] (#132)

* Add handling for only did queries and small refactoring

* Makes linter happy

* Add unit tests

* Add basic implementation for resource queries

* Small refactoring

* Add resourceVersion and handler for it

* Makes Linter happy

* Makes linter happy

* Small refactoring

* Fix unit tests for queries

* MAkes linter happy and fix integration tests

* Add more integration tests for queries

* Fixed:
- added version support
- changed logic for allowing versionId and versionTime in the same query
- added more integration tests

* Changed did doc implementation due to the latest changes in doc

* Makes linter happy

* Small validation and refactorings

* Add checksum handling and small improvements

* Fix RequestURI parameter displaying

* Makes linter happy

* Makes linter happy

* Uncomment positive integration tests

* Makes linter happy

* fix swagger build

* Change expected diddoc jsons for integration tests

* Fix PR review comments

* Makes linter happy

* Change error code

* Fix unit tests

Author: Andrew Nikitin

Makefile

@@ -155,7 +155,7 @@ clean:
 
 swagger:
 	@echo "Generating Swagger files..."
-	@go install github.com/swaggo/swag/cmd/swag@latest
+	@go install github.com/swaggo/swag/cmd/swag@v1.8.11
 	@swag fmt
 	@swag init -g ./main.go
 .PHONY: swagger

docs/docs.go

@@ -621,6 +621,10 @@
                 "resourceURI": {
                     "type": "string",
                     "example": "did:cheqd:testnet:55dbc8bf-fba3-4117-855c-1e0dc1d3bb47/resources/398cee0a-efac-4643-9f4c-74c48c72a14b"
+                },
+                "resourceVersion": {
+                    "type": "string",
+                    "example": "1"
                 }
             }
         },

docs/swagger.json

@@ -51,6 +51,9 @@ definitions:
       resourceURI:
         example: did:cheqd:testnet:55dbc8bf-fba3-4117-855c-1e0dc1d3bb47/resources/398cee0a-efac-4643-9f4c-74c48c72a14b
         type: string
+      resourceVersion:
+        example: "1"
+        type: string
     type: object
   types.DereferencingMetadata:
     properties:

docs/swagger.yaml

@@ -18,9 +18,9 @@ import (
 
 func serve() {
 	// Get Config
-	config := utils.GetConfig()
+	config := types.GetConfig()
 	// Setup logger
-	utils.SetupLogger(config)
+	types.SetupLogger(config)
 	// Services
 	ledgerService := services.NewLedgerService()
 	didService := services.NewDIDDocService(types.DID_METHOD, ledgerService)
@@ -36,7 +36,7 @@ func serve() {
 
 	// Echo instance
 	e := echo.New()
-	e.HTTPErrorHandler = utils.CustomHTTPErrorHandler
+	e.HTTPErrorHandler = services.CustomHTTPErrorHandler
 
 	// Middleware
 	e.Use(func(next echo.HandlerFunc) echo.HandlerFunc {
@@ -86,7 +86,7 @@ func serve() {
 //	@schemes		https http
 
 func main() {
-	err := utils.PrintConfig()
+	err := types.PrintConfig()
 	if err != nil {
 		panic(err)
 	}

main.go

@@ -22,22 +22,25 @@ func (dd *DIDDocAllVersionMetadataRequestService) SpecificPrepare(c services.Res
 }
 
 func (dd DIDDocAllVersionMetadataRequestService) Redirect(c services.ResolverContext) error {
-	migratedDid := migrations.MigrateDID(dd.Did)
+	migratedDid := migrations.MigrateDID(dd.GetDid())
 
 	path := types.RESOLVER_PATH + migratedDid + types.DID_VERSIONS_PATH
 	return c.Redirect(http.StatusMovedPermanently, path)
 }
 
 func (dd *DIDDocAllVersionMetadataRequestService) SpecificValidation(c services.ResolverContext) error {
+	// We not allow query here
+	if len(dd.Queries) != 0 {
+		return types.NewInvalidDidUrlError(dd.GetDid(), dd.RequestedContentType, nil, dd.IsDereferencing)
+	}
 	return nil
 }
 
 func (dd *DIDDocAllVersionMetadataRequestService) Query(c services.ResolverContext) error {
-	result, err := c.DidDocService.GetAllDidDocVersionsMetadata(dd.Did, dd.RequestedContentType)
+	result, err := c.DidDocService.GetAllDidDocVersionsMetadata(dd.GetDid(), dd.GetContentType())
 	if err != nil {
 		err.IsDereferencing = dd.IsDereferencing
 		return err
 	}
-	dd.Result = result
-	return nil
+	return dd.SetResponse(result)
 }

services/diddoc/diddoc_all_version_metadata.go

@@ -4,6 +4,7 @@ import (
 	"strings"
 
 	"github.com/cheqd/did-resolver/services"
+	"github.com/cheqd/did-resolver/types"
 )
 
 type FragmentDIDDocRequestService struct {
@@ -16,6 +17,10 @@ func (dd *FragmentDIDDocRequestService) Setup(c services.ResolverContext) error
 }
 
 func (dd *FragmentDIDDocRequestService) SpecificValidation(c services.ResolverContext) error {
+	// We not allow query here
+	if len(dd.Queries) != 0 {
+		return types.NewInvalidDidUrlError(dd.GetDid(), dd.RequestedContentType, nil, dd.IsDereferencing)
+	}
 	return nil
 }
 
@@ -29,11 +34,10 @@ func (dd *FragmentDIDDocRequestService) SpecificPrepare(c services.ResolverConte
 }
 
 func (dd *FragmentDIDDocRequestService) Query(c services.ResolverContext) error {
-	result, err := c.DidDocService.DereferenceSecondary(dd.Did, dd.Version, dd.Fragment, dd.RequestedContentType)
+	result, err := c.DidDocService.DereferenceSecondary(dd.GetDid(), dd.Version, dd.Fragment, dd.GetContentType())
 	if err != nil {
 		err.IsDereferencing = dd.IsDereferencing
 		return err
 	}
-	dd.Result = result
-	return nil
+	return dd.SetResponse(result)
 }