chore(mbe): rename logFile to httpLogger

pranavjain97 · pranavjain97 · commit 29dfdbba64f8 · 2025-07-24T14:03:18.000-04:00
The logFile env var is only being used for HTTP logs. Update the name to reflect that. Ticket: WP-5364
diff --git a/README.md b/README.md
@@ -75,7 +75,7 @@ Both modes use the same TLS configuration variables:
 
 ### Logging and Debug
 
-- `LOGFILE` - Path to log file (optional)
+- `HTTP_LOGFILE` - Path to HTTP request log file (optional, used by Morgan for HTTP access logs)
 
 ## Quick Start
 
diff --git a/src/__tests__/api/enclaved/postIndependentKey.test.ts b/src/__tests__/api/enclaved/postIndependentKey.test.ts
@@ -33,7 +33,7 @@ describe('postIndependentKey', () => {
       port: 0, // Let OS assign a free port
       bind: 'localhost',
       timeout: 60000,
-      logFile: '',
+      httpLoggerFile: '',
       kmsUrl: kmsUrl,
       tlsMode: TlsMode.DISABLED,
       allowSelfSigned: true,
diff --git a/src/__tests__/api/enclaved/postMpcV2Key.test.ts b/src/__tests__/api/enclaved/postMpcV2Key.test.ts
@@ -35,7 +35,7 @@ describe('postMpcV2Key', () => {
       port: 0, // Let OS assign a free port
       bind: 'localhost',
       timeout: 60000,
-      logFile: '',
+      httpLoggerFile: '',
       kmsUrl: kmsUrl,
       tlsMode: TlsMode.DISABLED,
       allowSelfSigned: true,
diff --git a/src/__tests__/api/enclaved/recoveryMultisigTransaction.test.ts b/src/__tests__/api/enclaved/recoveryMultisigTransaction.test.ts
@@ -19,7 +19,7 @@ describe('UTXO recovery', () => {
     port: 0,
     bind: 'localhost',
     timeout: 60000,
-    logFile: '',
+    httpLoggerFile: '',
     tlsMode: TlsMode.DISABLED,
     allowSelfSigned: true,
     kmsUrl: 'kms.example.com',
diff --git a/src/__tests__/api/enclaved/recoveryMusigEth.test.ts b/src/__tests__/api/enclaved/recoveryMusigEth.test.ts
@@ -36,7 +36,7 @@ describe('recoveryMultisigTransaction', () => {
       port: 0, // Let OS assign a free port
       bind: 'localhost',
       timeout: 60000,
-      logFile: '',
+      httpLoggerFile: '',
       kmsUrl: kmsUrl,
       tlsMode: TlsMode.DISABLED,
       allowSelfSigned: true,
diff --git a/src/__tests__/api/enclaved/signMpcRecoveryTransaction.test.ts b/src/__tests__/api/enclaved/signMpcRecoveryTransaction.test.ts
@@ -10,11 +10,12 @@ import { AppMode, EnclavedConfig, TlsMode } from '../../../shared/types';
 describe('EdDSA Recovery Signing', () => {
   let agent: supertest.SuperTest<supertest.Test>;
   const config: EnclavedConfig = {
+    kmsUrl: 'http://localhost:3000',
     appMode: AppMode.ENCLAVED,
     port: 0,
     bind: 'localhost',
     timeout: 60000,
-    logFile: '',
+    httpLoggerFile: '',
     tlsMode: TlsMode.DISABLED,
     allowSelfSigned: true,
   };
diff --git a/src/__tests__/api/enclaved/signMpcTransaction.test.ts b/src/__tests__/api/enclaved/signMpcTransaction.test.ts
@@ -40,7 +40,7 @@ describe('signMpcTransaction', () => {
       port: 0, // Let OS assign a free port
       bind: 'localhost',
       timeout: 60000,
-      logFile: '',
+      httpLoggerFile: '',
       kmsUrl: kmsUrl,
       tlsMode: TlsMode.DISABLED,
       allowSelfSigned: true,
diff --git a/src/__tests__/api/enclaved/signMultisigTransaction.test.ts b/src/__tests__/api/enclaved/signMultisigTransaction.test.ts
@@ -33,7 +33,7 @@ describe('signMultisigTransaction', () => {
       port: 0, // Let OS assign a free port
       bind: 'localhost',
       timeout: 60000,
-      logFile: '',
+      httpLoggerFile: '',
       kmsUrl: kmsUrl,
       tlsMode: TlsMode.DISABLED,
       allowSelfSigned: true,
diff --git a/src/__tests__/api/master/accelerate.test.ts b/src/__tests__/api/master/accelerate.test.ts
@@ -23,7 +23,7 @@ describe('POST /api/:coin/wallet/:walletId/accelerate', () => {
       port: 0, // Let OS assign a free port
       bind: 'localhost',
       timeout: 30000,
-      logFile: '',
+      httpLoggerFile: '',
       env: 'test',
       disableEnvCheck: true,
       authVersion: 2,
diff --git a/src/__tests__/api/master/consolidate.test.ts b/src/__tests__/api/master/consolidate.test.ts
@@ -26,7 +26,7 @@ describe('POST /api/:coin/wallet/:walletId/consolidateunspents', () => {
       port: 0,
       bind: 'localhost',
       timeout: 30000,
-      logFile: '',
+      httpLoggerFile: '',
       env: 'test',
       disableEnvCheck: true,
       authVersion: 2,
diff --git a/src/__tests__/api/master/consolidateUnspents.test.ts b/src/__tests__/api/master/consolidateUnspents.test.ts
@@ -23,7 +23,7 @@ describe('POST /api/:coin/wallet/:walletId/consolidateunspents', () => {
       port: 0,
       bind: 'localhost',
       timeout: 30000,
-      logFile: '',
+      httpLoggerFile: '',
       env: 'test',
       disableEnvCheck: true,
       authVersion: 2,
diff --git a/src/__tests__/api/master/generateWallet.test.ts b/src/__tests__/api/master/generateWallet.test.ts
@@ -25,7 +25,7 @@ describe('POST /api/:coin/wallet/generate', () => {
       port: 0, // Let OS assign a free port
       bind: 'localhost',
       timeout: 60000,
-      logFile: '',
+      httpLoggerFile: '',
       env: 'test',
       disableEnvCheck: true,
       authVersion: 2,
@@ -727,7 +727,7 @@ describe('POST /api/:coin/wallet/generate', () => {
             to: 0,
             payload: {
               encryptedMessage: 'test-p2p-message-backup-to-user-2',
-              signature: 'test-signature-user-to-backup-2',
+              signature: 'test-signature-backup-to-user-2',
             },
             commitment: 'test-commitment-backup-2',
           },
@@ -873,7 +873,7 @@ describe('POST /api/:coin/wallet/generate', () => {
             to: 0,
             payload: {
               encryptedMessage: 'test-p2p-message-backup-to-user-3',
-              signature: 'test-signature-user-to-backup-3',
+              signature: 'test-signature-backup-to-user-3',
             },
             commitment: 'test-commitment-backup-3',
           },
@@ -1121,7 +1121,7 @@ describe('POST /api/:coin/wallet/generate', () => {
       port: 0,
       bind: 'localhost',
       timeout: 60000,
-      logFile: '',
+      httpLoggerFile: '',
       env: 'test',
       disableEnvCheck: true,
       authVersion: 2,
diff --git a/src/__tests__/api/master/musigRecovery.test.ts b/src/__tests__/api/master/musigRecovery.test.ts
@@ -23,7 +23,7 @@ describe('POST /api/:coin/wallet/recovery', () => {
       port: 0, // Let OS assign a free port
       bind: 'localhost',
       timeout: 60000,
-      logFile: '',
+      httpLoggerFile: '',
       env: 'test',
       disableEnvCheck: true,
       authVersion: 2,
diff --git a/src/__tests__/api/master/recoveryConsolidationsWallet.test.ts b/src/__tests__/api/master/recoveryConsolidationsWallet.test.ts
@@ -22,7 +22,7 @@ describe('POST /api/:coin/wallet/recoveryconsolidations', () => {
       port: 0,
       bind: 'localhost',
       timeout: 60000,
-      logFile: '',
+      httpLoggerFile: '',
       env: 'test',
       disableEnvCheck: true,
       authVersion: 2,
diff --git a/src/__tests__/api/master/recoveryWallet.test.ts b/src/__tests__/api/master/recoveryWallet.test.ts
@@ -22,7 +22,7 @@ describe('Recovery Tests', () => {
     port: 0,
     bind: 'localhost',
     timeout: 60000,
-    logFile: '',
+    httpLoggerFile: '',
     env: 'test',
     disableEnvCheck: true,
     authVersion: 2,
diff --git a/src/__tests__/api/master/sendMany.test.ts b/src/__tests__/api/master/sendMany.test.ts
@@ -26,7 +26,7 @@ describe('POST /api/:coin/wallet/:walletId/sendmany', () => {
       port: 0, // Let OS assign a free port
       bind: 'localhost',
       timeout: 60000,
-      logFile: '',
+      httpLoggerFile: '',
       env: 'test',
       disableEnvCheck: true,
       authVersion: 2,
@@ -579,7 +579,7 @@ describe('POST /api/:coin/wallet/:walletId/sendmany', () => {
       port: 0,
       bind: 'localhost',
       timeout: 60000,
-      logFile: '',
+      httpLoggerFile: '',
       env: 'test',
       disableEnvCheck: true,
       authVersion: 2,
diff --git a/src/__tests__/api/master/signAndSendTxRequest.test.ts b/src/__tests__/api/master/signAndSendTxRequest.test.ts
@@ -44,7 +44,7 @@ describe('POST /api/:coin/wallet/:walletId/txrequest/:txRequestId/signAndSend',
       port: 0, // Let OS assign a free port
       bind: 'localhost',
       timeout: 60000,
-      logFile: '',
+      httpLoggerFile: '',
       env: 'test',
       disableEnvCheck: true,
       authVersion: 2,
diff --git a/src/__tests__/api/secured/postIndependentKey.test.ts b/src/__tests__/api/secured/postIndependentKey.test.ts
diff --git a/src/__tests__/config.test.ts b/src/__tests__/config.test.ts
@@ -24,7 +24,7 @@ describe('Configuration', () => {
     delete process.env.MASTER_EXPRESS_PORT;
     delete process.env.BIND;
     delete process.env.IPC;
-    delete process.env.LOGFILE;
+    delete process.env.HTTP_LOGFILE;
     delete process.env.KEEP_ALIVE_TIMEOUT;
     delete process.env.HEADERS_TIMEOUT;
     delete process.env.BITGO_ENV;
@@ -183,6 +183,18 @@ describe('Configuration', () => {
       delete process.env.TLS_CERT;
       (() => initConfig()).should.throw();
     });
+
+    it('should read HTTP_LOGFILE into httpLoggerFile in Enclaved mode', () => {
+      process.env.KMS_URL = 'http://localhost:3000';
+      process.env.TLS_KEY = mockTlsKey;
+      process.env.TLS_CERT = mockTlsCert;
+      process.env.HTTP_LOGFILE = '/tmp/test-http-access.log';
+      const cfg = initConfig();
+      isEnclavedConfig(cfg).should.be.true();
+      if (isEnclavedConfig(cfg)) {
+        cfg.httpLoggerFile?.should.equal('/tmp/test-http-access.log');
+      }
+    });
   });
 
   describe('Master Express Mode', () => {
@@ -332,5 +344,14 @@ describe('Configuration', () => {
         cfg.customRootUri!.should.equal('https://bitgo.example.com');
       }
     });
+
+    it('should read HTTP_LOGFILE into httpLoggerFile in Master Express mode', () => {
+      process.env.HTTP_LOGFILE = '/tmp/test-http-access.log';
+      const cfg = initConfig();
+      isMasterExpressConfig(cfg).should.be.true();
+      if (isMasterExpressConfig(cfg)) {
+        cfg.httpLoggerFile?.should.equal('/tmp/test-http-access.log');
+      }
+    });
   });
 });
diff --git a/src/__tests__/routes.test.ts b/src/__tests__/routes.test.ts
@@ -12,7 +12,7 @@ describe('Routes', () => {
     app = express();
     setupRoutes(app, {
       appMode: AppMode.ENCLAVED,
-      logFile: '',
+      httpLoggerFile: '',
       allowSelfSigned: true,
       tlsMode: TlsMode.DISABLED,
       kmsUrl: 'http://localhost:3000/kms',
diff --git a/src/initConfig.ts b/src/initConfig.ts
@@ -49,7 +49,7 @@ const defaultEnclavedConfig: EnclavedConfig = {
   port: 3080,
   bind: 'localhost',
   timeout: 305 * 1000,
-  logFile: '',
+  httpLoggerFile: '',
   kmsUrl: '', // Will be overridden by environment variable
   tlsMode: TlsMode.MTLS,
   allowSelfSigned: false,
@@ -87,7 +87,7 @@ function enclavedEnvConfig(): Partial<EnclavedConfig> {
     port: Number(readEnvVar('ENCLAVED_EXPRESS_PORT')),
     bind: readEnvVar('BIND'),
     ipc: readEnvVar('IPC'),
-    logFile: readEnvVar('LOGFILE'),
+    httpLoggerFile: readEnvVar('HTTP_LOGFILE'),
     timeout: Number(readEnvVar('TIMEOUT')),
     keepAliveTimeout: Number(readEnvVar('KEEP_ALIVE_TIMEOUT')),
     headersTimeout: Number(readEnvVar('HEADERS_TIMEOUT')),
@@ -118,7 +118,7 @@ function mergeEnclavedConfigs(...configs: Partial<EnclavedConfig>[]): EnclavedCo
     port: get('port'),
     bind: get('bind'),
     ipc: get('ipc'),
-    logFile: get('logFile'),
+    httpLoggerFile: get('httpLoggerFile'),
     timeout: get('timeout'),
     keepAliveTimeout: get('keepAliveTimeout'),
     headersTimeout: get('headersTimeout'),
@@ -180,7 +180,7 @@ const defaultMasterExpressConfig: MasterExpressConfig = {
   port: 3081,
   bind: 'localhost',
   timeout: 305 * 1000,
-  logFile: '',
+  httpLoggerFile: '',
   env: 'test',
   disableEnvCheck: true,
   authVersion: 2,
@@ -221,7 +221,7 @@ function masterExpressEnvConfig(): Partial<MasterExpressConfig> {
     port: Number(readEnvVar('MASTER_EXPRESS_PORT')),
     bind: readEnvVar('BIND'),
     ipc: readEnvVar('IPC'),
-    logFile: readEnvVar('LOGFILE'),
+    httpLoggerFile: readEnvVar('HTTP_LOGFILE'),
     timeout: Number(readEnvVar('TIMEOUT')),
     keepAliveTimeout: Number(readEnvVar('KEEP_ALIVE_TIMEOUT')),
     headersTimeout: Number(readEnvVar('HEADERS_TIMEOUT')),
@@ -260,7 +260,7 @@ function mergeMasterExpressConfigs(
     port: get('port'),
     bind: get('bind'),
     ipc: get('ipc'),
-    logFile: get('logFile'),
+    httpLoggerFile: get('httpLoggerFile'),
     timeout: get('timeout'),
     keepAliveTimeout: get('keepAliveTimeout'),
     headersTimeout: get('headersTimeout'),
diff --git a/src/shared/appUtils.ts b/src/shared/appUtils.ts
@@ -17,9 +17,9 @@ import { Config, TlsMode, MasterExpressConfig } from '../shared/types';
 export function setupLogging(app: express.Application, config: Config): void {
   // Set up morgan for logging, with optional logging into a file
   let middleware;
-  if (config.logFile) {
+  if (config.httpLoggerFile) {
     // create a write stream (in append mode)
-    const accessLogPath = path.resolve(config.logFile);
+    const accessLogPath = path.resolve(config.httpLoggerFile);
     const accessLogStream = fs.createWriteStream(accessLogPath, { flags: 'a' });
     logger.info(`Log location: ${accessLogPath}`);
     // setup the logger
diff --git a/src/shared/types/index.ts b/src/shared/types/index.ts
@@ -10,50 +10,52 @@ export enum AppMode {
 
 export type EnvironmentName = 'prod' | 'test' | 'staging' | 'dev' | 'local';
 
-// Enclaved mode specific configuration
-export interface EnclavedConfig {
-  appMode: AppMode.ENCLAVED;
+// Common base configuration shared by both modes
+export interface BaseConfig {
+  appMode: AppMode;
   port: number;
   bind: string;
   ipc?: string;
-  logFile: string;
   timeout: number;
   keepAliveTimeout?: number;
   headersTimeout?: number;
+  httpLoggerFile?: string;
+}
+
+// Enclaved mode specific configuration
+export interface EnclavedConfig extends BaseConfig {
+  appMode: AppMode.ENCLAVED;
+  // KMS settings
   kmsUrl: string;
+  // mTLS settings
   keyPath?: string;
   crtPath?: string;
   tlsKey?: string;
   tlsCert?: string;
   tlsMode: TlsMode;
   mtlsAllowedClientFingerprints?: string[];
-  allowSelfSigned: boolean;
+  allowSelfSigned?: boolean;
 }
 
 // Master Express mode specific configuration
-export interface MasterExpressConfig {
+export interface MasterExpressConfig extends BaseConfig {
   appMode: AppMode.MASTER_EXPRESS;
-  port: number;
-  bind: string;
-  ipc?: string;
-  logFile: string;
-  timeout: number;
-  keepAliveTimeout?: number;
-  headersTimeout?: number;
+  // BitGo API settings
   env: EnvironmentName;
   customRootUri?: string;
-  disableEnvCheck: boolean;
-  authVersion: number;
+  disableEnvCheck?: boolean;
+  authVersion?: number;
   enclavedExpressUrl: string;
   enclavedExpressCert: string;
   customBitcoinNetwork?: string;
+  // mTLS settings
   keyPath?: string;
   crtPath?: string;
   tlsKey?: string;
   tlsCert?: string;
   tlsMode: TlsMode;
   mtlsAllowedClientFingerprints?: string[];
-  allowSelfSigned: boolean;
+  allowSelfSigned?: boolean;
 }
 
 // Union type for the configuration
diff --git a/test-results-ba298b51-18b9-4753-83c1-4c9b746bf912.xml b/test-results-ba298b51-18b9-4753-83c1-4c9b746bf912.xml
