Merge pull request #5783 from BitGo/WP-4029/external

feat(express): add keepAliveTimeout, headersTimeout option

Author: zahin-mohammad

modules/express/.env.example

@@ -17,6 +17,8 @@ BITGO_EXTERNAL_SIGNER_URL=
 BITGO_SIGNER_MODE=
 BITGO_SIGNER_FILE_SYSTEM_PATH=
 BITGO_LIGHTNING_SIGNER_FILE_SYSTEM_PATH=
+BITGO_KEEP_ALIVE_TIMEOUT=
+BITGO_HEADERS_TIMEOUT=
 
 # SIGN TRANSACTION FOR A SPECIFIC WALLET (Replace <ID> with your wallet ID)
 # See clientRoutes.ts => getWalletPwFromEnv()

modules/express/README.md

@@ -206,6 +206,10 @@ This may be preferable for users who would like to apply their signature to thei
 
 For more information please see our [External Signing Mode Documentation](EXTERNAL_SIGNER.md).
 
+### KeepAliveTimeout/HeadersTimeout
+
+If the deployment destination is configured with a load balancer such as ELB, a 504 Gateway Timeout may occur. In such cases, it might be resolved by configuring the settings so that LB keepAliveTimeout < keepAliveTimeout < headersTimeout. This can be achieved by specifying the keepAliveTimeout and headersTimeout options.
+
 ## Configuration Values
 
 BitGo Express is able to take configuration options from either command line arguments, or via environment variables.
@@ -237,6 +241,9 @@ BitGo Express is able to take configuration options from either command line arg
 
 \[0]: BitGo will also check the additional environment variables for some options for backwards compatibility, but these environment variables should be considered deprecated:
 
+| N/A | --keepalivetimeout | `BITGO_KEEP_ALIVE_TIMEOUT` | N/A | BitGo Express server KeepAliveTimeout |
+| N/A | --headerstimeout | `BITGO_HEADERS_TIMEOUT` | N/A | BitGo Express server HeadersTimeout |
+
 - Disable SSL
   - `DISABLESSL`
   - `DISABLE_SSL`

modules/express/src/args.ts

@@ -109,4 +109,12 @@ parser.addArgument(['--signerFileSystemPath'], {
 parser.addArgument(['--lightningSignerFileSystemPath'], {
   help: 'Local path specifying where an Express machine keeps lightning signer urls.',
 });
+
+parser.addArgument(['--keepalivetimeout'], {
+  help: 'keep alive timeout in milliseconds',
+});
+
+parser.addArgument(['--headerstimeout'], {
+  help: 'headers timeout in milliseconds',
+});
 export const args = () => parser.parseArgs();

modules/express/src/config.ts

@@ -41,6 +41,8 @@ export interface Config {
   signerMode?: boolean;
   signerFileSystemPath?: string;
   lightningSignerFileSystemPath?: string;
+  keepAliveTimeout?: number;
+  headersTimeout?: number;
 }
 
 export const ArgConfig = (args): Partial<Config> => ({
@@ -65,6 +67,8 @@ export const ArgConfig = (args): Partial<Config> => ({
   signerMode: args.signerMode,
   signerFileSystemPath: args.signerFileSystemPath,
   lightningSignerFileSystemPath: args.lightningSignerFileSystemPath,
+  keepAliveTimeout: args.keepalivetimeout,
+  headersTimeout: args.headerstimeout,
 });
 
 export const EnvConfig = (): Partial<Config> => ({
@@ -89,6 +93,8 @@ export const EnvConfig = (): Partial<Config> => ({
   signerMode: readEnvVar('BITGO_SIGNER_MODE') ? true : undefined,
   signerFileSystemPath: readEnvVar('BITGO_SIGNER_FILE_SYSTEM_PATH'),
   lightningSignerFileSystemPath: readEnvVar('BITGO_LIGHTNING_SIGNER_FILE_SYSTEM_PATH'),
+  keepAliveTimeout: Number(readEnvVar('BITGO_KEEP_ALIVE_TIMEOUT')),
+  headersTimeout: Number(readEnvVar('BITGO_HEADERS_TIMEOUT')),
 });
 
 export const DefaultConfig: Config = {
@@ -173,6 +179,8 @@ function mergeConfigs(...configs: Partial<Config>[]): Config {
     signerMode: get('signerMode'),
     signerFileSystemPath: get('signerFileSystemPath'),
     lightningSignerFileSystemPath: get('lightningSignerFileSystemPath'),
+    keepAliveTimeout: get('keepAliveTimeout'),
+    headersTimeout: get('headersTimeout'),
   };
 }
 

modules/express/src/expressApp.ts

@@ -153,7 +153,16 @@ function isTLS(config: Config): config is Config & { keyPath: string; crtPath: s
  * Create either a HTTP or HTTPS server
  */
 export async function createServer(config: Config, app: express.Application): Promise<https.Server | http.Server> {
-  return isTLS(config) ? await createHttpsServer(app, config) : createHttpServer(app);
+  const server = isTLS(config) ? await createHttpsServer(app, config) : createHttpServer(app);
+
+  // Set keepAliveTimeout and headersTimeout if specified in config
+  if (config.keepAliveTimeout !== undefined) {
+    server.keepAliveTimeout = config.keepAliveTimeout;
+  }
+  if (config.headersTimeout !== undefined) {
+    server.headersTimeout = config.headersTimeout;
+  }
+  return server;
 }
 
 /**

modules/express/test/unit/bitgoExpress.ts

@@ -559,5 +559,87 @@ describe('Bitgo Express', function () {
       (() => expressApp(args)).should.not.throw();
       readValidStub.restore();
     });
+
+    it('should set keepAliveTimeout and headersTimeout if specified in config for HTTP server', async function () {
+      const createServerStub = sinon.stub(http, 'createServer').callsFake(() => {
+        return { listen: sinon.stub(), setTimeout: sinon.stub() } as unknown as http.Server;
+      });
+
+      const args: any = {
+        env: 'test',
+        bind: 'localhost',
+        keepAliveTimeout: 5000,
+        headersTimeout: 10000,
+      };
+
+      const server = await createServer(args, null as any);
+
+      server.keepAliveTimeout.should.equal(args.keepAliveTimeout);
+      server.headersTimeout.should.equal(args.headersTimeout);
+
+      createServerStub.restore();
+    });
+
+    it('should set keepAliveTimeout and headersTimeout if specified in config for HTTPS server', async function () {
+      const createServerStub = sinon.stub(https, 'createServer').callsFake(() => {
+        return { listen: sinon.stub(), setTimeout: sinon.stub() } as unknown as https.Server;
+      });
+
+      const args: any = {
+        env: 'test',
+        bind: 'localhost',
+        sslKey: 'ssl-key',
+        sslCert: 'ssl-cert',
+        keepAliveTimeout: 5000,
+        headersTimeout: 10000,
+      };
+
+      const server = await createServer(args, null as any);
+
+      server.keepAliveTimeout.should.equal(args.keepAliveTimeout);
+      server.headersTimeout.should.equal(args.headersTimeout);
+
+      createServerStub.restore();
+    });
+
+    it('should not set keepAliveTimeout and headersTimeout if not specified in config for HTTP server', async function () {
+      const createServerStub = sinon.stub(http, 'createServer').callsFake(() => {
+        return { listen: sinon.stub(), setTimeout: sinon.stub() } as unknown as http.Server;
+      });
+
+      const args: any = {
+        env: 'test',
+        bind: 'localhost',
+        // keepAliveTimeout and headersTimeout are not specified
+      };
+
+      const server = await createServer(args, null as any);
+
+      should(server.keepAliveTimeout).be.undefined();
+      should(server.headersTimeout).be.undefined();
+
+      createServerStub.restore();
+    });
+
+    it('should not set keepAliveTimeout and headersTimeout if not specified in config for HTTPS server', async function () {
+      const createServerStub = sinon.stub(https, 'createServer').callsFake(() => {
+        return { listen: sinon.stub(), setTimeout: sinon.stub() } as unknown as https.Server;
+      });
+
+      const args: any = {
+        env: 'test',
+        bind: 'localhost',
+        sslKey: 'ssl-key',
+        sslCert: 'ssl-cert',
+        // keepAliveTimeout and headersTimeout are not specified
+      };
+
+      const server = await createServer(args, null as any);
+
+      should(server.keepAliveTimeout).be.undefined();
+      should(server.headersTimeout).be.undefined();
+
+      createServerStub.restore();
+    });
   });
 });

modules/express/test/unit/config.ts

@@ -86,6 +86,8 @@ describe('Config:', () => {
       signerMode: 'argsignerMode',
       signerFileSystemPath: 'argsignerFileSystemPath',
       lightningSignerFileSystemPath: 'arglightningSignerFileSystemPath',
+      keepalivetimeout: 'argkeepalivetimeout',
+      headerstimeout: 'argheaderstimeout',
     });
     const envStub = sinon.stub(process, 'env').value({
       BITGO_PORT: 'env12345',
@@ -108,6 +110,8 @@ describe('Config:', () => {
       BITGO_SIGNER_MODE: 'envsignerMode',
       BITGO_SIGNER_FILE_SYSTEM_PATH: 'envsignerFileSystemPath',
       BITGO_LIGHTNING_SIGNER_FILE_SYSTEM_PATH: 'envlightningSignerFileSystemPath',
+      BITGO_KEEP_ALIVE_TIMETOUT: 'envkeepalivetimeout',
+      BITGO_HEADERS_TIMETOUT: 'envheaderstimeout',
     });
     config().should.eql({
       port: 23456,
@@ -131,6 +135,8 @@ describe('Config:', () => {
       signerMode: 'argsignerMode',
       signerFileSystemPath: 'argsignerFileSystemPath',
       lightningSignerFileSystemPath: 'arglightningSignerFileSystemPath',
+      keepAliveTimeout: 'argkeepalivetimeout',
+      headersTimeout: 'argheaderstimeout',
     });
     argStub.restore();
     envStub.restore();