#63 Restructure error messages as ErrorDetail (#79)

* Restructure error messages as ErrorDetail * Type response body of messages * Changeset * Typo
TBD54566975 · Nov 21, 2023 · d582385 · d582385
1 parent 6b2df5b
commit d582385
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 5 deletions.
diff --git a/.changeset/tiny-carrots-sort.md b/.changeset/tiny-carrots-sort.md
@@ -0,0 +1,5 @@
+---
+"@tbdex/http-server": patch
+---
+
+Restructure error messages as ErrorDetail type
diff --git a/packages/http-server/src/request-handlers/submit-rfq.ts b/packages/http-server/src/request-handlers/submit-rfq.ts
@@ -18,7 +18,7 @@ export function submitRfq(options: SubmitRfqOpts): RequestHandler {
     try {
       message = await Message.parse(req.body)
     } catch(e) {
-      const errorResponse: ErrorDetail = { detail: e.message }
+      const errorResponse: ErrorDetail = { detail: `Parsing of TBDex message failed: ${e.message}` }
       return res.status(400).json({ errors: [errorResponse] })
     }
 
@@ -31,12 +31,14 @@ export function submitRfq(options: SubmitRfqOpts): RequestHandler {
 
     const rfqExists = !! await exchangesApi.getRfq({ exchangeId: message.id })
     if (rfqExists) {
-      return res.status(409).json({ errors: [`rfq ${message.id} already exists`] })
+      const errorResponse: ErrorDetail = { detail: `rfq ${message.id} already exists`}
+      return res.status(409).json({ errors: [errorResponse] })
     }
 
     const offering = await offeringsApi.getOffering({ id: message.data.offeringId })
     if (!offering) {
-      return res.status(400).json({ errors: [`offering ${message.data.offeringId} does not exist`] })
+      const errorResponse: ErrorDetail = { detail: `offering ${message.data.offeringId} does not exist` }
+      return res.status(400).json({ errors: [errorResponse] })
     }
 
     try {
@@ -59,4 +61,4 @@ export function submitRfq(options: SubmitRfqOpts): RequestHandler {
 
     return res.sendStatus(202)
   }
-}
+}
diff --git a/packages/http-server/src/types.ts b/packages/http-server/src/types.ts
@@ -1,5 +1,6 @@
 import type { Request, Response } from 'express'
 import type { Close, MessageKindClass, MessageKindClasses, Offering, Order, OrderStatus, Quote, Rfq } from '@tbdex/protocol'
+import type { ErrorDetail } from '@tbdex/http-client'
 
 /**
  * Union type for get requests
@@ -89,7 +90,7 @@ export type RequestContext = {
  * Type alias for the request handler
  * @beta
  */
-export type RequestHandler = (request: Request, response: Response) => any
+export type RequestHandler = (request: Request, response: Response<{ errors?: ErrorDetail[], data?: any }>) => any
 
 /**
  * PFI Offerings API