Pretty-print JSON everywhere, to match httpbin and be generally readable

Author: pimterry

src/endpoints/http/basic-auth.ts

@@ -1,3 +1,4 @@
+import { serializeJson } from '../../util.js';
 import { HttpEndpoint, HttpHandler } from '../http-index.js';
 
 const matchPath = (path: string) =>
@@ -20,7 +21,7 @@ const handle: HttpHandler = (req, res, { path }) => {
         res.writeHead(200, {
             'content-type': 'application/json'
         });
-        res.end(JSON.stringify({
+        res.end(serializeJson({
             "authenticated": true,
             "user": username
         }));

src/endpoints/http/cookies.ts

@@ -1,13 +1,14 @@
 import * as Cookie from 'cookie';
 
 import { HttpEndpoint } from '../http-index.js';
+import { serializeJson } from '../../util.js';
 
 export const getCookies: HttpEndpoint = {
     matchPath: (path) => path === '/cookies',
     handle: (req, res) => {
         const cookies = Cookie.parse(req.headers.cookie || '');
         res.writeHead(200, { 'Content-Type': 'application/json' });
-        res.end(JSON.stringify({ cookies }, null, 2));
+        res.end(serializeJson({ cookies }));
     }
 }
 

src/endpoints/http/json.ts

@@ -1,3 +1,4 @@
+import { serializeJson } from '../../util.js';
 import { HttpEndpoint, HttpHandler } from '../http-index.js';
 
 const matchPath = (path: string) => path === '/json';
@@ -8,7 +9,7 @@ const handle: HttpHandler = (req, res) => {
     });
 
     // HTTPBin seems to just return this fixed example document:
-    res.end(JSON.stringify({
+    res.end(serializeJson({
         "slideshow": {
             "author": "Yours Truly",
             "date": "date of publication",
@@ -28,7 +29,7 @@ const handle: HttpHandler = (req, res) => {
             ],
             "title": "Sample Slide Show"
         }
-    }, null, 2));
+    }));
 }
 
 export const json: HttpEndpoint = {

src/endpoints/http/user-agent.ts

@@ -1,3 +1,4 @@
+import { serializeJson } from '../../util.js';
 import { HttpEndpoint, HttpHandler } from '../http-index.js';
 
 const matchPath = (path: string) => path === '/user-agent';
@@ -7,7 +8,9 @@ const handle: HttpHandler = (req, res) => {
     res.writeHead(200, {
         'content-type': 'application/json'
     });
-    res.end(JSON.stringify({ 'user-agent': userAgent }));
+    res.end(serializeJson({
+        'user-agent': userAgent
+    }));
 }
 
 export const userAgent: HttpEndpoint = {

src/httpbin-compat.ts

@@ -6,6 +6,7 @@ import * as querystring from 'querystring';
 import * as multipart from 'parse-multipart-data';
 
 import { TLSSocket } from 'tls';
+import { serializeJson } from './util.js';
 
 const utf8Decoder = new TextDecoder('utf8', { fatal: true });
 
@@ -99,5 +100,5 @@ export const buildHttpBinAnythingEndpoint = (options: {
     }
 
     res.writeHead(200, { 'Content-Type': 'application/json' });
-    res.end(JSON.stringify(result));
+    res.end(serializeJson(result));
 }

src/util.ts

@@ -1,4 +1,7 @@
 export const clearArray = (array: Array<unknown> | undefined) => {
     if (!array) return;
     array.length = 0;
-}
+}
+
+export const serializeJson = (json: any) =>
+    JSON.stringify(json, null, 2) + '\n';