A proxy wrapper for services to allow logging functionality for requests, responses, and errors.

LoggingWrapper.ts

import { file } from 'bun'
import { mkdirSync, existsSync } from 'node:fs'
import { join } from 'node:path'

const logFolder = 'LogFolder'
const logFilePath = join(process.cwd(), logFolder, 'proxy.log')

// Ensure the log folder exists
if (!existsSync(logFolder)) {
  mkdirSync(logFolder)
}

const logFile = file(logFilePath)
const writer = logFile.writer({ highWaterMark: 1024 * 1024 }) // 1MB buffer

async function logToFile(message: string) {
  writer.write(`${new Date().toISOString()} - ${message}\n`)
}

// Flush the writer when the process is about to exit
process.on('beforeExit', async () => {
  await writer.flush()
  writer.end()
})

export function wrapWithLogging<T extends object>(
  client: T,
  debugEnvVar = 'EnableClientDebugging'
): T {
  const debugEnabled = process.env[debugEnvVar] === 'true'

  if (!debugEnabled) {
    // Return client as-is if logging is not enabled
    return client
  }

  return new Proxy<T>(client, {
    get(target, property, receiver) {
      const original = Reflect.get(target, property, receiver)
      if (typeof original === 'function') {
        return async (...args: any[]) => {
          const requestLog = `TestRail Request: ${String(property)} - Args: ${JSON.stringify(args)}`
          console.debug(requestLog)
          await logToFile(requestLog)
          try {
            const result = await original.apply(target, args)
            const responseLog = `TestRail Response: ${String(property)} - Result: ${JSON.stringify(result)}`
            console.debug(responseLog)
            await logToFile(responseLog)
            return result
          } catch (error) {
            const errorLog = `TestRail Error: ${String(property)} - Args: ${JSON.stringify(args)} - Error: ${error}`
            console.error(errorLog)
            await logToFile(errorLog)
            throw error // Re-throw the error to maintain behavior
          }
        }
      }
      return original
    },
  })
}