fix(metadata.test.ts): metadata validation handling and responses

Restores the metadata validation endpoint testing. Additionally the full
metadata controller is using try catches and we updated the response
types. The response types have been made more simple and flexible, for
one to support the cases of validation where the processing can be
successful but the data is invalid. Lastly, responses where data is set
as null were cleaned so simply not return data.

Author: bitbeckers

src/controllers/HyperboardController.ts

@@ -14,7 +14,7 @@ import {
 import type {
   ApiResponse,
   HyperboardCreateRequest,
-  HyperboardCreateResponse,
+  HyperboardResponse,
   HyperboardUpdateRequest,
 } from "../types/api.js";
 import { z } from "zod";
@@ -43,7 +43,7 @@ export class HyperboardController extends Controller {
   })
   public async createHyperboard(
     @Body() requestBody: HyperboardCreateRequest,
-  ): Promise<HyperboardCreateResponse> {
+  ): Promise<HyperboardResponse> {
     const inputSchema = z
       .object({
         chainIds: z
@@ -175,7 +175,6 @@ export class HyperboardController extends Controller {
       return {
         success: false,
         message: "Invalid input",
-        data: null,
         errors: JSON.parse(parsedBody.error.toString()),
       };
     }
@@ -228,7 +227,6 @@ export class HyperboardController extends Controller {
       return {
         success: false,
         message: "Invalid signature",
-        data: null,
       };
     }
 
@@ -262,7 +260,6 @@ export class HyperboardController extends Controller {
       return {
         success: false,
         message: "Error creating hyperboard",
-        data: null,
       };
     }
 
@@ -355,7 +352,6 @@ export class HyperboardController extends Controller {
         return {
           success: false,
           message: "Error updating collection",
-          data: null,
         };
       }
     }
@@ -430,7 +426,6 @@ export class HyperboardController extends Controller {
         return {
           success: false,
           message: "Error creating collection",
-          data: null,
         };
       }
     }
@@ -453,7 +448,7 @@ export class HyperboardController extends Controller {
   public async updateHyperboard(
     @Path() hyperboardId: string,
     @Body() requestBody: HyperboardUpdateRequest,
-  ): Promise<ApiResponse<{ id: string } | null>> {
+  ): Promise<HyperboardResponse> {
     const inputSchema = z
       .object({
         id: z.string().uuid(),
@@ -590,7 +585,6 @@ export class HyperboardController extends Controller {
       return {
         success: false,
         message: "Invalid input",
-        data: null,
         errors: JSON.parse(parsedBody.error.toString()),
       };
     }
@@ -603,7 +597,6 @@ export class HyperboardController extends Controller {
       return {
         success: false,
         message: "Hyperboard not found",
-        data: null,
       };
     }
 
@@ -657,7 +650,6 @@ export class HyperboardController extends Controller {
       return {
         success: false,
         message: "Invalid signature",
-        data: null,
       };
     }
 
@@ -671,7 +663,6 @@ export class HyperboardController extends Controller {
       return {
         success: false,
         message: "Not authorized to update hyperboard",
-        data: null,
       };
     }
 
@@ -692,7 +683,6 @@ export class HyperboardController extends Controller {
       return {
         success: false,
         message: "Error updating hyperboard",
-        data: null,
       };
     }
 
@@ -794,7 +784,6 @@ export class HyperboardController extends Controller {
         return {
           success: false,
           message: "Error updating collection",
-          data: null,
         };
       }
     }
@@ -867,7 +856,6 @@ export class HyperboardController extends Controller {
         return {
           success: false,
           message: "Error creating collection",
-          data: null,
         };
       }
     }

src/controllers/MetadataController.ts

@@ -116,57 +116,67 @@ export class MetadataController extends Controller {
     @Body() requestBody: StoreMetadataWithAllowlistRequest,
   ): Promise<StorageResponse> {
     const storage = await StorageService.init();
-    const metadataValidationResult = validateMetadataAndClaimdata(
-      requestBody.metadata,
-    );
+    const { metadata } = requestBody;
+    const { allowList, totalUnits } = requestBody;
 
-    if (!metadataValidationResult.valid) {
-      this.setStatus(422);
-      return {
-        success: false,
-        message: "Validation failed",
-        errors: metadataValidationResult.errors,
-      };
-    }
+    try {
+      const metadataValidationResult = validateMetadataAndClaimdata(metadata);
 
-    if (requestBody.metadata.allowList) {
-      this.setStatus(409);
-      return {
-        success: false,
-        message: "Allow list detected in metadata",
-        errors: { metadata: "Allowlist URI already present in metadata." },
-      };
-    }
+      if (!metadataValidationResult.valid) {
+        this.setStatus(422);
+        return {
+          success: false,
+          message: "Validation failed",
+          errors: metadataValidationResult.errors,
+        };
+      }
+
+      if (allowList) {
+        this.setStatus(409);
+        return {
+          success: false,
+          message: "Allow list detected in metadata",
+          errors: { metadata: "Allowlist URI already present in metadata." },
+        };
+      }
+
+      const allowlistValidationResult = parseAndValidateMerkleTree({
+        allowList,
+        totalUnits,
+      });
+
+      if (!allowlistValidationResult.valid) {
+        this.setStatus(422);
+        return {
+          success: false,
+          message: "Validation failed",
+          errors: allowlistValidationResult.errors,
+        };
+      }
 
-    const allowlistValidationResult = parseAndValidateMerkleTree({
-      allowList: requestBody.allowList,
-      totalUnits: requestBody?.totalUnits,
-    });
+      const uploadResult = await storage.uploadFile({
+        file: jsonToBlob(requestBody.allowList),
+      });
+      const cid = await storage.uploadFile({
+        file: jsonToBlob({
+          ...metadataValidationResult.data,
+          allowList: `ipfs://${uploadResult.cid}`,
+        }),
+      });
 
-    if (!allowlistValidationResult.valid) {
+      this.setStatus(201);
+      return {
+        success: true,
+        data: cid,
+      };
+    } catch (e) {
       this.setStatus(422);
       return {
         success: false,
-        message: "Validation failed",
-        errors: allowlistValidationResult.errors,
+        message: "Error while storing metadata",
+        errors: { metadata: (e as Error).message },
       };
     }
-
-    const uploadResult = await storage.uploadFile({
-      file: jsonToBlob(requestBody.allowList),
-    });
-    const cid = await storage.uploadFile({
-      file: jsonToBlob({
-        ...metadataValidationResult.data,
-        allowList: `ipfs://${uploadResult.cid}`,
-      }),
-    });
-
-    this.setStatus(201);
-    return {
-      success: true,
-      data: cid,
-    };
   }
 
   /**
@@ -185,39 +195,53 @@ export class MetadataController extends Controller {
   public async validateMetadata(
     @Body() requestBody: ValidateMetadataRequest,
   ): Promise<ValidationResponse> {
-    const metadataValidationResult = validateMetadataAndClaimdata(
-      requestBody.metadata,
-    );
-
-    if (!metadataValidationResult.valid) {
-      this.setStatus(422);
-      return {
-        success: false,
-        message: "Errors while validating metadata or allow list",
-        errors: metadataValidationResult.errors,
-      };
-    }
+    const { metadata } = requestBody;
 
-    if (requestBody.metadata.allowList) {
-      const allowListValidationResult = await validateRemoteAllowList(
-        requestBody.metadata.allowList,
-      );
+    try {
+      const metadataValidationResult = validateMetadataAndClaimdata(metadata);
 
-      if (!allowListValidationResult.valid) {
+      if (!metadataValidationResult.valid) {
         this.setStatus(422);
         return {
-          success: false,
-          message: "Errors while validating allow list reference in metadata",
-          errors: allowListValidationResult.errors,
+          success: true,
+          valid: false,
+          message: "Errors while validating metadata",
+          errors: metadataValidationResult.errors,
         };
       }
-    }
 
-    this.setStatus(200);
-    return {
-      success: true,
-      message: "Validation successful",
-    };
+      if (metadata.allowList) {
+        const allowListValidationResult = await validateRemoteAllowList(
+          metadata.allowList,
+        );
+
+        if (!allowListValidationResult.valid) {
+          this.setStatus(422);
+          return {
+            success: true,
+            valid: false,
+            message:
+              "Errors while validating allow list referenced in metadata",
+            errors: allowListValidationResult.errors,
+          };
+        }
+      }
+
+      this.setStatus(200);
+      return {
+        success: true,
+        valid: true,
+        message: "Metadata is valid hypercert metadata",
+      };
+    } catch (e) {
+      this.setStatus(422);
+      return {
+        success: false,
+        valid: false,
+        message: "Error while validating metadata",
+        errors: { metadata: (e as Error).message },
+      };
+    }
   }
 
   /**
@@ -236,37 +260,50 @@ export class MetadataController extends Controller {
   public async validateMetadataWithAllowlist(
     @Body() requestBody: StoreMetadataWithAllowlistRequest,
   ): Promise<ValidationResponse> {
-    const metadataValidationResult = validateMetadataAndClaimdata(
-      requestBody.metadata,
-    );
+    const { metadata, allowList, totalUnits } = requestBody;
 
-    if (!metadataValidationResult.valid) {
-      this.setStatus(422);
-      return {
-        success: false,
-        message: "Validation failed",
-        errors: metadataValidationResult.errors,
-      };
-    }
+    try {
+      const metadataValidationResult = validateMetadataAndClaimdata(metadata);
+
+      if (!metadataValidationResult.valid) {
+        this.setStatus(422);
+        return {
+          success: true,
+          valid: false,
+          message: "Validation failed",
+          errors: metadataValidationResult.errors,
+        };
+      }
+
+      const allowlistValidationResult = parseAndValidateMerkleTree({
+        allowList,
+        totalUnits,
+      });
 
-    const allowlistValidationResult = parseAndValidateMerkleTree({
-      allowList: requestBody.allowList,
-      totalUnits: requestBody?.totalUnits,
-    });
+      if (!allowlistValidationResult.valid) {
+        this.setStatus(422);
+        return {
+          success: true,
+          valid: false,
+          message: "Validation failed",
+          errors: allowlistValidationResult.errors,
+        };
+      }
 
-    if (!allowlistValidationResult.valid) {
+      this.setStatus(200);
+      return {
+        success: true,
+        valid: true,
+        message: "Metadata is valid hypercert metadata",
+      };
+    } catch (e) {
       this.setStatus(422);
       return {
         success: false,
-        message: "Validation failed",
-        errors: allowlistValidationResult.errors,
+        valid: false,
+        message: "Error while validating metadata",
+        errors: { metadata: (e as Error).message },
       };
     }
-
-    this.setStatus(200);
-    return {
-      success: true,
-      message: "Validation successful",
-    };
   }
 }