diff --git a/lib/app-common.ts b/lib/app-common.ts index 36f1e5e5..baaa5b78 100644 --- a/lib/app-common.ts +++ b/lib/app-common.ts @@ -78,14 +78,9 @@ function checkNodeVersion() { } } -export interface GlobalTunnelNgConfig { - host: string; - port: number; - protocol: string; - proxyAuth?: string; - connect?: string; - sockets?: number; -} +export type GlobalTunnelNgConfig = import('global-tunnel-ng').Options; + +type ProxyConfig = string | GlobalTunnelNgConfig; /** * Global proxy setup. Originally, `global-tunnel-ng` was used, but it only @@ -110,12 +105,28 @@ export interface GlobalTunnelNgConfig { * default exclusion patterns are added for all private IPv4 address ranges. */ async function setupGlobalHttpProxy(settings: CliSettings) { - const semver = await import('semver'); - if (semver.lt(process.version, '10.16.0')) { - setupGlobalTunnelNgProxy(settings); - } else { - // use global-agent instead of global-tunnel-ng - await setupGlobalAgentProxy(settings); + // `global-tunnel-ng` accepts lowercase variables with higher precedence + // than uppercase variables, but `global-agent` does not accept lowercase. + // Set uppercase versions for backwards compatibility. + const { env } = process; + if (env.http_proxy) { + env.HTTP_PROXY = env.http_proxy; + } + if (env.https_proxy) { + env.HTTPS_PROXY = env.https_proxy; + } + delete env.http_proxy; + delete env.https_proxy; + + const proxy = settings.getCatch('proxy'); + if (proxy || env.HTTPS_PROXY || env.HTTP_PROXY) { + const semver = await import('semver'); + if (semver.lt(process.version, '10.16.0')) { + await setupGlobalTunnelNgProxy(proxy); + } else { + // use global-agent instead of global-tunnel-ng + await setupGlobalAgentProxy(settings, proxy); + } } } @@ -123,9 +134,8 @@ async function setupGlobalHttpProxy(settings: CliSettings) { * `global-tunnel-ng` proxy setup. * See docs for setupGlobalHttpProxy() above. */ -function setupGlobalTunnelNgProxy(settings: CliSettings) { - const proxy = settings.getCatch('proxy'); - const globalTunnel = require('global-tunnel-ng'); +async function setupGlobalTunnelNgProxy(proxy?: ProxyConfig) { + const globalTunnel = await import('global-tunnel-ng'); // Init the tunnel even if BALENARC_PROXY is not defined, because // other env vars may be defined. If no proxy configuration exists, // initialize() does nothing. @@ -137,9 +147,12 @@ function setupGlobalTunnelNgProxy(settings: CliSettings) { * `global-agent` proxy setup. * See docs for setupGlobalHttpProxy() above, and also the README file * (Proxy Support section). + * If `proxy` is undefined, HTTP(S)_PROXY env vars are expected to be set. */ -async function setupGlobalAgentProxy(settings: CliSettings) { - const proxy = settings.getCatch('proxy'); +async function setupGlobalAgentProxy( + settings: CliSettings, + proxy?: ProxyConfig, +) { const noProxy = settings.getCatch('noProxy'); // Always exclude localhost, even if NO_PROXY is set const requiredNoProxy = ['localhost', '127.0.0.1']; @@ -151,33 +164,19 @@ async function setupGlobalAgentProxy(settings: CliSettings) { const env = process.env; env.GLOBAL_AGENT_ENVIRONMENT_VARIABLE_NAMESPACE = ''; + env.NO_PROXY = [ + ...requiredNoProxy, + ...(noProxy ? noProxy.split(',').filter(v => v) : privateNoProxy), + ].join(','); if (proxy) { - const _ = await import('lodash'); const proxyUrl: string = typeof proxy === 'string' ? proxy : makeUrlFromTunnelNgConfig(proxy); env.HTTPS_PROXY = env.HTTP_PROXY = proxyUrl; - delete env.http_proxy; - delete env.https_proxy; - - env.NO_PROXY = [ - ...requiredNoProxy, - ...(noProxy ? _.filter((noProxy || '').split(',')) : privateNoProxy), - ].join(','); - } else { - // `global-tunnel-ng` accepts lowercase variables with higher precedence - // than uppercase variables, but `global-agent` does not accept lowercase. - // Set uppercase versions for backwards compatibility. - if (env.http_proxy) { - env.HTTP_PROXY = env.http_proxy; - } - if (env.https_proxy) { - env.HTTPS_PROXY = env.https_proxy; - } } - const { bootstrap } = require('global-agent'); + const { bootstrap } = await import('global-agent'); bootstrap(); } diff --git a/npm-shrinkwrap.json b/npm-shrinkwrap.json index 226ba9f9..af44595c 100644 --- a/npm-shrinkwrap.json +++ b/npm-shrinkwrap.json @@ -745,6 +745,18 @@ "@types/node": "*" } }, + "@types/global-agent": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/@types/global-agent/-/global-agent-2.1.0.tgz", + "integrity": "sha512-xBOerse4Agekl7VZJclA9bfuA9aa3u9T24TDkBiMQrZgu4qe5HMBPzVGzAt2k4dx/v3uIFI6CzG0Z9X894LHrg==", + "dev": true + }, + "@types/global-tunnel-ng": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/@types/global-tunnel-ng/-/global-tunnel-ng-2.1.0.tgz", + "integrity": "sha512-JPhCJHHu5/5HuQ78rmbrnCk+XlyxKuAopk+/8rP5MfAeL7KwiCH/gFFNtAqIr0/JFqWFk+jXWZjEWSP8dzGpMg==", + "dev": true + }, "@types/intercept-stdout": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/@types/intercept-stdout/-/intercept-stdout-0.1.0.tgz", diff --git a/package.json b/package.json index 0c0afdcc..27aab5b6 100644 --- a/package.json +++ b/package.json @@ -108,6 +108,8 @@ "@types/ejs": "^3.0.1", "@types/express": "^4.17.2", "@types/fs-extra": "^8.1.0", + "@types/global-agent": "^2.1.0", + "@types/global-tunnel-ng": "^2.1.0", "@types/intercept-stdout": "^0.1.0", "@types/is-root": "^2.1.2", "@types/lodash": "^4.14.149",