chore: adds basic logger

Signed-off-by: Anthony D. Mays <[email protected]>

Author: anthonydmays

lib/javascript/fullstack_demo/package-lock.json

@@ -19,7 +19,9 @@
     "@upstash/redis": "^1.34.3",
     "lowdb": "^7.0.1",
     "lucide-react": "^0.468.0",
-    "next": "^14.2.22"
+    "next": "^14.2.22",
+    "uuid": "^11.0.5",
+    "winston": "^3.17.0"
   },
   "devDependencies": {
     "@testing-library/dom": "^10.4.0",
@@ -46,4 +48,4 @@
     "vitest": "^2.1.8",
     "vitest-fetch-mock": "^0.4.3"
   }
-}
+}

lib/javascript/fullstack_demo/package.json

@@ -0,0 +1,7 @@
+import { logger } from '@/util/server-logger';
+
+export async function POST(request: Request) {
+  const { level, message, vars } = await request.json();
+  logger.log(level, message, ...(vars || []));
+  return new Response(null, { status: 204 });
+}

lib/javascript/fullstack_demo/src/app/api/log/route.ts

@@ -0,0 +1,4 @@
+import { Logger } from '@/util/logger';
+import { WinstonLogger } from '@/util/winston-logger';
+
+export const logger: Logger = new WinstonLogger();

lib/javascript/fullstack_demo/src/logger.ts

@@ -1,9 +1,19 @@
 import { clerkMiddleware, createRouteMatcher } from '@clerk/nextjs/server';
+import { NextResponse } from 'next/server';
+import { v4 as uuidv4 } from 'uuid';
 
+const CORRELATION_ID_HEADER = 'x-correlation-id';
 const isProtectedRoute = createRouteMatcher(['/(.*)']);
 
 export default clerkMiddleware(async (auth, req) => {
+  const correlationId = uuidv4();
+  req.headers.set(CORRELATION_ID_HEADER, correlationId);
+
   if (isProtectedRoute(req)) await auth.protect();
+
+  const response = NextResponse.next();
+  response.headers.set(CORRELATION_ID_HEADER, correlationId);
+  return response;
 });
 
 export const config = {

lib/javascript/fullstack_demo/src/middleware.ts

@@ -0,0 +1,25 @@
+import { Logger, LogLevel } from './logger';
+
+class ClientLogger implements Logger {
+  log(level: LogLevel, message: string, ...vars: unknown[]): void {
+    fetch('/api/log', {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      body: JSON.stringify({ level, message, vars }),
+    });
+  }
+
+  debug(format: string, ...vars: unknown[]): void {
+    this.log('DEBUG', format, ...vars);
+  }
+  info(format: string, ...vars: unknown[]): void {
+    this.log('INFO', format, ...vars);
+  }
+  error(format: string, ...vars: unknown[]): void {
+    this.log('ERROR', format, ...vars);
+  }
+}
+
+export const logger = new ClientLogger();

lib/javascript/fullstack_demo/src/util/client-logger.ts

@@ -0,0 +1,8 @@
+export interface Logger {
+  log(level: LogLevel, message: string, ...vars: unknown[]): void;
+  debug(format: string, ...vars: unknown[]): void;
+  info(format: string, ...vars: unknown[]): void;
+  error(format: string, ...vars: unknown[]): void;
+}
+
+export type LogLevel = 'DEBUG' | 'INFO' | 'ERROR' | 'WARN';

lib/javascript/fullstack_demo/src/util/logger.ts

@@ -0,0 +1,50 @@
+import { auth } from '@clerk/nextjs/server';
+import { headers } from 'next/headers';
+import winston, { format } from 'winston';
+import { Logger, LogLevel } from './logger';
+const { combine, timestamp, json } = format;
+
+export class WinstonLogger implements Logger {
+  private readonly winstonLogger: winston.Logger;
+
+  constructor() {
+    this.winstonLogger = winston.createLogger({
+      level: 'info',
+      format: combine(
+        format((info) => {
+          const headerList = headers();
+          info.correlationId = headerList.get('x-correlation-id');
+          return info;
+        })(),
+        timestamp(),
+        json(),
+      ),
+      transports: [
+        new winston.transports.Console(),
+        new winston.transports.File({ filename: 'debug.log', level: 'debug' }),
+      ],
+    });
+  }
+
+  async log(level: LogLevel, message: string, ...vars: unknown[]) {
+    const { userId } = await auth();
+    this.winstonLogger.log(level.toLowerCase(), message, { ...vars, userId });
+  }
+
+  async debug(format: string, ...vars: unknown[]) {
+    const { userId } = await auth();
+    this.winstonLogger.debug(format, { ...vars, userId });
+  }
+
+  async info(format: string, ...vars: unknown[]) {
+    const { userId } = await auth();
+    this.winstonLogger.info(format, { ...vars, userId });
+  }
+
+  async error(format: string, ...vars: unknown[]) {
+    const { userId } = await auth();
+    this.winstonLogger.error(format, { ...vars, userId });
+  }
+}
+
+export const logger = new WinstonLogger();