Improve error reporting to server consumers

Previously we emmitted error codes without any error data. Instead, actually transmit received errors to the Braekhus server consumer.
p0-security · Sep 20, 2024 · 883344b · 883344b
1 parent c9fb6d0
commit 883344b
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/client/index.ts b/client/index.ts
@@ -4,7 +4,7 @@ import {
   JSONRPCServer,
   JSONRPCServerAndClient,
 } from "json-rpc-2.0";
-import { isArray, omit } from "lodash";
+import { omit } from "lodash";
 import { Logger } from "pino";
 import WebSocket from "ws";
 

diff --git a/log/index.ts b/log/index.ts
@@ -13,6 +13,7 @@ export const createLogger = <T extends LoggerOptions>(
 ): Logger<T> => {
   const logger = pinoLogger({
     ...options,
+    name: `braekhus.${options.name}`,
     level: process.env.LOG_LEVEL || "info",
     serializers: {
       error: serializeError,

diff --git a/server/proxy.ts b/server/proxy.ts
@@ -40,7 +40,7 @@ export const httpProxyApp = (
     const matches = PATH_REGEXP.exec(req.path);
     logger.debug({ matches }, "path matches");
     if (matches === null || matches.length !== 3) {
-      res.sendStatus(400);
+      res.status(404).json({ error: "Invalid path format" });
     }
 
     const clientId = (matches as string[])[1];
@@ -78,7 +78,7 @@ export const httpProxyApp = (
         // See See https://nodejs.org/api/stream.html#readablepipedestination-options
         stream.pipe(res);
       } else {
-        res.status(response.status).send(response.data);
+        res.status(response.status).json(response.data);
       }
     } catch (error: any) {
       logger.error({ error, spammy: true }, "Error handling request");
@@ -89,9 +89,9 @@ export const httpProxyApp = (
         (error.message.startsWith("timeout") &&
           error.message.endsWith("exceeded"))
       ) {
-        res.sendStatus(504);
+        res.status(504).json({ error });
       } else {
-        res.sendStatus(502);
+        res.status(502).json({ error });
       }
     }
   });