feat: look for original url when formatting (PL-000) (#61)

Author: trs

.circleci/config.yml

@@ -1,15 +1,16 @@
 version: 2.1
 
 orbs:
-  vfcommon: voiceflow/common@0.15.1
+  vfcommon: voiceflow/common@0.48.0
   sonarcloud: sonarsource/[email protected]
 
 jobs:
   test:
-    executor: vfcommon/default-executor
+    executor: vfcommon/code-test-executor-node-20
     steps:
       - checkout
-      - vfcommon/install_node_modules
+      - vfcommon/install_node_modules:
+          cache_prefix: v1
       - attach_workspace:
           at: ~/voiceflow
       - vfcommon/lint_report:

.depcheckrc

@@ -20,6 +20,7 @@
     "husky",
     "istanbul",
     "lint-staged",
-    "pino-pretty"
+    "pino-pretty",
+    "rimraf"
   ]
 }

.gitignore

@@ -69,4 +69,13 @@ build/
 
 #Sonar report
 sonar/
-nyc_coverage*
+nyc_coverage*
+
+# Yarn
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

.lintstagedrc.js

@@ -1,4 +1,4 @@
 module.exports = {
   'package.json': ['fixpack'],
-  '**/*.{js,ts}': ['eslint --fix', 'prettier-eslint --write'],
+  '**/*.{js,ts}': ['eslint --fix'],
 };

.yarn/releases/yarn-3.2.1.cjs

@@ -0,0 +1,3 @@
+yarnPath: .yarn/releases/yarn-3.2.1.cjs
+enableTelemetry: false
+nodeLinker: node-modules

.yarnrc.yml

@@ -44,10 +44,14 @@
     "mocha": "10.0.0",
     "nyc": "^15.1.0",
     "prettier": "2.7.1",
+    "rimraf": "5.0.0",
     "ts-mocha": "10.0.0",
     "tsc-alias": "1.7.0",
     "typescript": "4.8.3"
   },
+  "engines": {
+    "node": "20"
+  },
   "files": [
     "build/"
   ],
@@ -57,11 +61,12 @@
   ],
   "license": "ISC",
   "main": "build/main.js",
+  "packageManager": "[email protected]",
   "prettier": "@voiceflow/prettier-config",
   "repository": "[email protected]:voiceflow/logger.git",
   "scripts": {
     "build": "yarn clean && tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",
-    "clean": "rimraf build",
+    "clean": "yarn rimraf build",
     "commit": "cz",
     "eslint-output": "eslint-output",
     "lint": "eslint '**/*.{js,ts}'",
@@ -75,5 +80,9 @@
     "test:single": "NODE_ENV=test ts-mocha --paths --config ./config/test/.mocharc.yml",
     "test:unit": "NODE_ENV=test nyc --report-dir=nyc_coverage_unit ts-mocha --paths --config ./config/test/.mocharc.yml 'test/**/*.unit.ts'"
   },
-  "types": "build/main.d.ts"
+  "types": "build/main.d.ts",
+  "volta": {
+    "node": "20.10.0",
+    "yarn": "3.2.1"
+  }
 }

package.json

@@ -1,4 +1,6 @@
 /* eslint-disable sonarjs/no-nested-template-literals */
+import type { IncomingMessage } from 'node:http';
+
 import { gray, white } from 'colorette';
 import pinoHttp, { Options } from 'pino-http';
 import { match } from 'ts-pattern';
@@ -19,16 +21,16 @@ export const createHTTPConfig = ({ format, level }: LoggerOptions): Options => (
   },
   wrapSerializers: true,
 
-  ...match<LogFormat, Options>(format)
+  ...match<LogFormat, Options<IncomingMessage & { originalUrl?: string }>>(format)
     .with(LogFormat.INLINE, () => ({
       customSuccessMessage: (req, res) =>
-        `${getColorizer(res)(`(${res.statusCode})`)} ${white(`${req.method} ${req.url}`)} ${gray(
+        `${getColorizer(res)(`(${res.statusCode})`)} ${white(`${req.method} ${req.originalUrl ?? req.url}`)} ${gray(
           `(${req.socket.remoteAddress}:${req.socket.remotePort})`
         )}`,
       customErrorMessage: (req, res) =>
-        `${getColorizer(res)(`(${res.statusCode})`)} ${white(`${req.method} ${req.url} -`)} ${gray(
+        `${getColorizer(res)(`(${res.statusCode})`)} ${white(`${req.method} ${req.originalUrl ?? req.url}`)} ${gray(
           `(${req.socket.remoteAddress}:${req.socket.remotePort})`
-        )} ${res.err?.message}`,
+        )} - ${res.err?.message}`,
       ...createInlineConfig(level),
     }))
     .with(LogFormat.DETAILED, () => createDetailedConfig(level))

src/http.logger.ts

@@ -1,23 +1,14 @@
-import { SerializedError, SerializedRequest, SerializedResponse } from 'pino';
+import { MinimalSerializer } from './minimal';
+import type { Serializer } from './serializer.interface';
 
-export const MaximalSerializer = {
-  req: (req: SerializedRequest) => ({
-    id: req.id,
-    method: req.method,
-    url: req.url,
-    query: req.query,
-    params: req.params,
+export const MaximalSerializer: Serializer = {
+  req: (req) => ({
+    ...MinimalSerializer.req(req),
     headers: Object.fromEntries(Object.entries(req.headers).filter(([key]) => key === 'authorization')),
-    remoteAddress: req.remoteAddress,
-    remotePort: req.remotePort,
   }),
-  res: (res: SerializedResponse) => ({
-    statusCode: res.statusCode,
+  res: (res) => ({
+    ...MinimalSerializer.res(res),
     headers: res.headers,
   }),
-  err: (err: SerializedError) => ({
-    type: err.type,
-    message: err.message,
-    stack: err.stack,
-  }),
+  err: (err) => MinimalSerializer.err(err),
 };

src/serializers/maximal.ts

@@ -1,18 +1,18 @@
-import { SerializedError, SerializedRequest, SerializedResponse } from 'pino';
+import type { Serializer } from './serializer.interface';
 
-export const MinimalSerializer = {
-  req: (req: SerializedRequest) => ({
+export const MinimalSerializer: Serializer = {
+  req: (req) => ({
     method: req.method,
-    url: req.url,
+    url: req.raw.originalUrl ?? req.url,
     query: req.query,
     params: req.params,
     remoteAddress: req.remoteAddress,
     remotePort: req.remotePort,
   }),
-  res: (res: SerializedResponse) => ({
+  res: (res) => ({
     statusCode: res.statusCode,
   }),
-  err: (err: SerializedError) => ({
+  err: (err) => ({
     type: err.type,
     message: err.message,
     stack: err.stack,