fix: disable HTTP keepAlive (Node 18 behavior) with a config toggle (#5519) * implement disable keepalive, handle request-proxy and config logic * Invert keep-alive boolean setting * fix: clean-up server.js diff * fix: boolean flag type * feat: disable keep-alive by default --------- Co-authored-by: Cohee <18619528+Cohee1207@users.noreply.github.com>

b1ef254f78b69bdf20d64421cc77d7ff68fff643

DeathStalker471 <thomasnealson85@gmail.com>

Signed

default/config.yaml+3 -0 Viewed

 # Interval in seconds to write a heartbeat file. Set to 0 to disable.
 # This is used primarily for Docker healthchecks.
 heartbeatInterval: 0
 +# Enable HTTP/HTTPS keep-alive globally.
 +# Disabling restores old Node 18 behavior, can help if ECONNRESET and other network errors occur.
 +enableKeepAlive: false
 # -- SSL options --
 ssl:
   # Enable SSL/TLS encryption

src/command-line.js+8 -0 Viewed

  * @property {string} keyPassphrase SSL private key passphrase
  * @property {boolean} whitelistMode If enable whitelist mode
  * @property {boolean} basicAuthMode If enable basic authentication
 + * @property {boolean} enableKeepAlive Enable HTTP/HTTPS keep-alive globally
  * @property {boolean} requestProxyEnabled If enable outgoing request proxy
  * @property {string} requestProxyUrl Request proxy URL
  * @property {string[]} requestProxyBypass Request proxy bypass list

             keyPassphrase: '',
             whitelistMode: true,
             basicAuthMode: false,
 +            enableKeepAlive: false,
             requestProxyEnabled: false,
             requestProxyUrl: '',
             requestProxyBypass: [],

                 default: null,
                 describe: 'Enables basic authentication',
             })
 +            .option('enableKeepAlive', {
 +                type: 'boolean',
 +                default: null,
 +                describe: 'Enable HTTP/HTTPS keep-alive globally',
 +            })
             .option('requestProxyEnabled', {
                 type: 'boolean',
                 default: null,

             keyPassphrase: cliArguments.keyPassphrase ?? getConfigValue('ssl.keyPassphrase', defaultConfig.keyPassphrase),
             whitelistMode: cliArguments.whitelist ?? getConfigValue('whitelistMode', defaultConfig.whitelistMode, 'boolean'),
             basicAuthMode: cliArguments.basicAuthMode ?? getConfigValue('basicAuthMode', defaultConfig.basicAuthMode, 'boolean'),
 +            enableKeepAlive: cliArguments.enableKeepAlive ?? getConfigValue('enableKeepAlive', defaultConfig.enableKeepAlive, 'boolean'),
             requestProxyEnabled: cliArguments.requestProxyEnabled ?? getConfigValue('requestProxy.enabled', defaultConfig.requestProxyEnabled, 'boolean'),
             requestProxyUrl: cliArguments.requestProxyUrl ?? getConfigValue('requestProxy.url', defaultConfig.requestProxyUrl),
             requestProxyBypass: cliArguments.requestProxyBypass ?? getConfigValue('requestProxy.bypass', defaultConfig.requestProxyBypass),

src/request-proxy.js+4 -2 Viewed

  * @property {boolean} enabled Whether proxy is enabled.
  * @property {string} url Proxy URL.
  * @property {string[]} bypass List of URLs to bypass proxy.
 + * @property {boolean} enableKeepAlive Enable HTTP/HTTPS keep-alive.
  */
 export default function initRequestProxy({ enabled, url, bypass, enableKeepAlive }) {
     try {
         // No proxy is enabled, so return
         if (!enabled) {

             process.env.no_proxy = bypass.join(',');
+        }
 -        const proxyAgent = new ProxyAgent();
 +        const proxyAgentOptions =  enableKeepAlive ? { keepAlive: true } : { keepAlive: false };
 +        const proxyAgent = new ProxyAgent(proxyAgentOptions);
         http.globalAgent = proxyAgent;
         https.globalAgent = proxyAgent;

src/server-main.js+7 -1 Viewed

 import net from 'node:net';
 import dns from 'node:dns';
 import process from 'node:process';
 +import http from 'node:http';
 +import https from 'node:https';
 import cors from 'cors';
 import { csrfSync } from 'csrf-sync';

     process.exit(1);
+}
 +// Set keep-alive preference for all HTTP/HTTPS requests.
 +http.globalAgent = new http.Agent({ keepAlive: cliArgs.enableKeepAlive });
 +https.globalAgent = new https.Agent({ keepAlive: cliArgs.enableKeepAlive });
++
 const app = express();
 app.use(helmet({
     contentSecurityPolicy: false,

     });
     // Add request proxy.
     initRequestProxy({ enabled: cliArgs.requestProxyEnabled, url: cliArgs.requestProxyUrl, bypass: cliArgs.requestProxyBypass, enableKeepAlive: cliArgs.enableKeepAlive });
     // Wait for frontend libs to compile
     await webpackMiddleware.runWebpackCompiler({ pruneCache: true });