chore: add pino debug logging for http requests

Author: dandelionn

.devcontainer/.env.production.local.example

@@ -12,7 +12,7 @@ GITHUB_CLIENT_ID=
 GITHUB_CLIENT_SECRET=
 GITHUB_CALLBACK_URL=http://localhost:3000/auth/github/callback
 
-NODE_ENV=production
+NODE_ENV=development
 
 REDIS_PORT=6379 
 REDIS_HOST=redis # using redis service name because the app will run in a container so localhost is not correct

.env.development

@@ -1,5 +1,7 @@
 PORT=3000
 FRONTEND_URL=http://localhost:3000
+
+DEBUG_LOG=true
 NODE_ENV=development
 REDIS_PORT=6379
 REDIS_HOST=localhost

manual-route-tests/login.http

@@ -1,5 +1,10 @@
+### Valid credentials
+GET http://localhost:3000/csrf/token
+content-type: application/json
+
 ### Valid credentials
 POST http://localhost:3000/auth/login
+x-csrf-token: 170691e9ce54052ddca950de19347c36006d47dd9ad66ba8f8e5504d896a336c159877eaa22b3296fada395791765f6225fc1b667125c85f1555a5f4509c2465760793bf49e194256f03738f426a861c27c7f060bd58378159de3df3454dbab6ffc38fe15e10b730c9439aef90ba1a1b5c5f68636d54488498301053f21ee8f2
 content-type: application/json
 
 {

package-lock.json

@@ -99,6 +99,7 @@
 		"passport-github2": "^0.1.12",
 		"passport-google-oauth20": "^2.0.0",
 		"pino": "^9.7.0",
+		"pino-http": "^10.5.0",
 		"pino-pretty": "^13.0.0",
 		"qrcode": "^1.5.4",
 		"react-email": "^4.0.7",

package.json

@@ -36,6 +36,7 @@ const GlobalConfig = {
 	EMAIL_BACKEND_BASE_URL: process.env.EMAIL_BACKEND_BASE_URL,
 	EMAIL_ASSETS_BASE_URL: process.env.EMAIL_ASSETS_BASE_URL,
 	FRONTEND_URL: process.env.FRONTEND_URL,
+	DEBUG_LOG: Boolean(process.env.DEBUG_LOG),
 };
 
 export default GlobalConfig;

src/config.ts

@@ -18,12 +18,18 @@ import cors from 'cors';
 import { setupSocialAuth } from './routes/social-auth/index.js';
 import { registerDevRoutes } from './routes/dev/dev-routes.js';
 import { configurePassport } from './routes/social-auth/passport-config.js';
+import { pinoHttp } from 'pino-http';
 
 console.log('env:', GlobalConfig.ENV);
 
 const app = express();
 const port = GlobalConfig.PORT;
 
+if (GlobalConfig.DEBUG_LOG === true) {
+	// Create Pino logger middleware
+	app.use(pinoHttp());
+}
+
 app.use(
 	cors({
 		origin: GlobalConfig.FRONTEND_URL, // your frontend URL & port here