Merge pull request #398 from ut-code/task/#397/logging-with-morgan

#397 Enable to export logging of API requests/responses using morgan

Author: bvv-1

backend/package-lock.json

@@ -19,8 +19,10 @@
     "@elastic/elasticsearch": "^8.13.0",
     "@prisma/client": "^5.11.0",
     "@supabase/supabase-js": "^2.39.0",
+    "@types/morgan": "^1.9.9",
     "csv-parse": "^5.5.6",
     "express": "^4.18.2",
+    "morgan": "^1.10.0",
     "swagger-ui-express": "^5.0.0",
     "typescript": "^5.3.2"
   },

backend/package.json

@@ -1,5 +1,6 @@
 import express from "express"
 import cors from "cors"
+import morgan from "morgan"
 import swaggerUi from "swagger-ui-express"
 import swaggerDocument from "../../openapi.json"
 import UserController from "./controllers/UserController"
@@ -19,6 +20,35 @@ app.use(cors())
 app.use(express.json())
 app.use(express.urlencoded({ extended: true }))
 
+// morgan でリクエストボディとレスポンスボディをログ出力する
+// Ref: https://www.npmjs.com/package/morgan-body
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function logBodyGen(prependStr: string, getBodyFunc: (req: any, res: any) => string) {
+  const bodyFormatName = "bodyFmt_" + prependStr
+  morgan.format(bodyFormatName, function logBody(_, req, res) {
+    const url = req.url
+    const method = req.method
+    const status = res.statusCode
+    const body = getBodyFunc(req, res)
+    const timeStamp = new Date().toISOString()
+    return `[${timeStamp}] ${method} ${url} ${status} ${prependStr}: ${JSON.stringify(body)}`
+  })
+  return bodyFormatName
+}
+
+const appResponsePrototype = Object.getPrototypeOf(app.response)
+const originalSend = appResponsePrototype.send
+const morganBodyResponseSymbol = Symbol()
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+appResponsePrototype.send = function sendOverWrite(body: any) {
+  originalSend.call(this, body)
+  this[morganBodyResponseSymbol] = body
+}
+
+app.use(morgan("[:date[iso]] :method :url :status ResponseTime :response-time ms"))
+app.use(morgan(logBodyGen("RequestBody", (req) => req.body)))
+app.use(morgan(logBodyGen("ResponseBody", (_req, res) => res[morganBodyResponseSymbol])))
+
 app.get("/", (_req, res) => {
   res.status(200).send("Hello, world!")
 })

backend/src/app.ts

@@ -78,7 +78,6 @@ class SearchController {
       })
 
       const hits = result.hits.hits
-      console.log(hits)
       if (hits.length === 0) {
         res.status(404).json({ error: "Not found" })
         return