feat: add custom response header for easy debug

godwokenrises · Dec 9, 2022 · a7a3f9b · a7a3f9b
1 parent 9161b7c
commit a7a3f9b
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/packages/api-server/src/middlewares/header.ts b/packages/api-server/src/middlewares/header.ts
@@ -0,0 +1,10 @@
+import { Response } from "express";
+
+export interface ResponseHeader {
+  instantFinality: boolean;
+  // add more below if needed
+}
+
+export function setResponseHeader(res: Response, header: ResponseHeader) {
+  res.setHeader("X-Instant-Finality", header.instantFinality.toString());
+}
diff --git a/packages/api-server/src/middlewares/jayson.ts b/packages/api-server/src/middlewares/jayson.ts
@@ -3,6 +3,7 @@ import { instantFinalityHackMethods, methods } from "../methods/index";
 import { Request, Response, NextFunction } from "express";
 import createServer from "connect";
 import { isInstantFinalityHackMode } from "../util";
+import { ResponseHeader, setResponseHeader } from "./header";
 
 const server = new jayson.Server(methods);
 const instantFinalityHackServer = new jayson.Server(instantFinalityHackMethods);
@@ -18,8 +19,16 @@ export const jaysonMiddleware = (
     req.body.params = [] as any[];
   }
 
+  const enableInstantFinality = isInstantFinalityHackMode(req);
+
+  // manage response header here
+  const header: ResponseHeader = {
+    instantFinality: enableInstantFinality,
+  };
+  setResponseHeader(res, header);
+
   // enable additional feature for special URL
-  if (isInstantFinalityHackMode(req)) {
+  if (enableInstantFinality) {
     const middleware =
       instantFinalityHackServer.middleware() as createServer.NextHandleFunction;
     return middleware(req, res, next);