feat: support for HTTP_PROXY and HTTPS_PROXY

Author: christian-bromann

README.md

@@ -31,6 +31,10 @@ $ EDGEDRIVER_VERSION=105.0.1343.33 npx edgedriver --version
 Microsoft Edge WebDriver 105.0.1343.33 (4122bb4646b33f33bca5d269490b9caadfc452b2)
 ```
 
+# Setting a PROXY URL
+
+Use `HTTPS_PROXY` or `HTTP_PROXY` to set your proxy URL.
+
 # Programmatic Interface
 
 You can import this package with Node.js and start the driver as part of your script and use it e.g. with [WebdriverIO](https://webdriver.io).

package-lock.json

@@ -59,6 +59,7 @@
     "eslint-plugin-unicorn": "^56.0.0",
     "globals": "^15.11.0",
     "husky": "^9.1.6",
+    "node-fetch": "^3.3.2",
     "npm-run-all2": "^7.0.1",
     "release-it": "^17.10.0",
     "ts-node": "^10.9.2",
@@ -73,6 +74,8 @@
     "decamelize": "^6.0.0",
     "edge-paths": "^3.0.5",
     "fast-xml-parser": "^4.5.0",
+    "http-proxy-agent": "^7.0.2",
+    "https-proxy-agent": "^7.0.5",
     "which": "^5.0.0"
   }
 }

package.json

@@ -4,8 +4,11 @@ import os from 'node:os'
 import cp from 'node:child_process'
 import { format } from 'node:util'
 
+import fetch, { type RequestInit } from 'node-fetch'
 import { XMLParser } from 'fast-xml-parser'
 import { BlobReader, BlobWriter, ZipReader } from '@zip.js/zip.js'
+import { HttpsProxyAgent } from 'https-proxy-agent'
+import { HttpProxyAgent } from 'http-proxy-agent'
 
 import findEdgePath from './finder.js'
 import { TAGGED_VERSIONS, EDGE_PRODUCTS_API, EDGEDRIVER_BUCKET, TAGGED_VERSION_URL, LATEST_RELEASE_URL, DOWNLOAD_URL, BINARY_FILE, log } from './constants.js'
@@ -20,6 +23,13 @@ interface ProductAPIResponse {
   }[]
 }
 
+const fetchOpts: RequestInit = {}
+if (process.env.HTTPS_PROXY) {
+  fetchOpts.agent = new HttpsProxyAgent(process.env.HTTPS_PROXY)
+} else if (process.env.HTTP_PROXY) {
+  fetchOpts.agent = new HttpProxyAgent(process.env.HTTP_PROXY)
+}
+
 export async function download (
   edgeVersion: string = process.env.EDGEDRIVER_VERSION,
   cacheDir: string = process.env.EDGEDRIVER_CACHE_DIR || os.tmpdir()
@@ -55,7 +65,7 @@ async function downloadDriver(version: string) {
   try {
     const downloadUrl = format(DOWNLOAD_URL, version, getNameByArchitecture())
     log.info(`Downloading Edgedriver from ${downloadUrl}`)
-    const res = await fetch(downloadUrl)
+    const res = await fetch(downloadUrl, fetchOpts)
 
     if (!res.body || !res.ok || res.status !== 200) {
       throw new Error(`Failed to download binary from ${downloadUrl} (statusCode ${res.status})`)
@@ -75,6 +85,7 @@ async function downloadDriver(version: string) {
         : 'linux'
     log.info(`Attempt to fetch latest v${majorVersion} for ${platform} from ${EDGEDRIVER_BUCKET}`)
     const versions = await fetch(EDGEDRIVER_BUCKET, {
+      ...fetchOpts,
       headers: {
         accept: '*/*',
         'accept-language': 'en-US,en;q=0.9',
@@ -95,11 +106,11 @@ async function downloadDriver(version: string) {
     }
 
     log.info(`Downloading alternative Edgedriver version from ${alternativeDownloadUrl}`)
-    const versionResponse = await fetch(alternativeDownloadUrl)
+    const versionResponse = await fetch(alternativeDownloadUrl, fetchOpts)
     const alternativeVersion = sanitizeVersion(await versionResponse.text())
     const downloadUrl = format(DOWNLOAD_URL, alternativeVersion, getNameByArchitecture())
     log.info(`Downloading Edgedriver from ${downloadUrl}`)
-    const res = await fetch(downloadUrl)
+    const res = await fetch(downloadUrl, fetchOpts)
     if (!res.body || !res.ok || res.status !== 200) {
       throw new Error(`Failed to download binary from ${downloadUrl} (statusCode ${res.status})`)
     }
@@ -168,7 +179,7 @@ export async function fetchVersion (edgeVersion: string) {
    * if browser version is a tagged version, e.g. stable, beta, dev, canary
    */
   if (TAGGED_VERSIONS.includes(edgeVersion.toLowerCase())) {
-    const apiResponse = await fetch(EDGE_PRODUCTS_API).catch((err) => {
+    const apiResponse = await fetch(EDGE_PRODUCTS_API, fetchOpts).catch((err) => {
       log.error(`Couldn't fetch version from ${EDGE_PRODUCTS_API}: ${err.stack}`)
       return { json: async () => [] as ProductAPIResponse[] }
     })
@@ -193,7 +204,7 @@ export async function fetchVersion (edgeVersion: string) {
       return productVersion
     }
 
-    const res = await fetch(format(TAGGED_VERSION_URL, edgeVersion.toUpperCase()))
+    const res = await fetch(format(TAGGED_VERSION_URL, edgeVersion.toUpperCase()), fetchOpts)
     return sanitizeVersion(await res.text())
   }
 
@@ -205,7 +216,7 @@ export async function fetchVersion (edgeVersion: string) {
     const [major] = edgeVersion.match(MATCH_VERSION)
     const url = format(LATEST_RELEASE_URL, major.toString().toUpperCase(), platform.toUpperCase())
     log.info(`Fetching latest version from ${url}`)
-    const res = await fetch(url)
+    const res = await fetch(url, fetchOpts)
     if (!res.ok || res.status !== 200) {
       throw new Error(`Couldn't detect version for ${edgeVersion}`)
     }

src/install.ts

@@ -1,33 +1,37 @@
 import os from 'node:os'
 import { vi, test, expect } from 'vitest'
+import fetch from 'node-fetch'
 
 import * as pkgExports from '../src/index.js'
 import { fetchVersion } from '../src/install.js'
 import { getNameByArchitecture, parseParams } from '../src/utils.js'
 import { EDGE_PRODUCTS_API } from '../src/constants.js'
 
-import apiResponse from './__fixtures__/api.json' assert { type: 'json' }
-
 vi.mock('node:os', () => ({
   default: {
     arch: vi.fn(),
     platform: vi.fn()
   }
 }))
 
-const origFetch = globalThis.fetch
-vi.stubGlobal('fetch', async (url) => {
-  if (url === EDGE_PRODUCTS_API) {
-    return {
-      json: vi.fn().mockResolvedValue(apiResponse)
-    }
-  } else if (!url.includes('LATEST_RELEASE')) {
-    return {
-      text: vi.fn().mockResolvedValue('��123.456.789.0')
-    }
-  }
+vi.mock('node-fetch', async (orig) => {
+  const origFetch: any = await orig()
+  const apiResponse = await import('./__fixtures__/api.json', { assert: { type: 'json' } })
+  return {
+    default: vi.fn(async (url) => {
+      if (url === EDGE_PRODUCTS_API) {
+        return {
+          json: vi.fn().mockResolvedValue(apiResponse.default)
+        }
+      } else if (!url.includes('LATEST_RELEASE')) {
+        return {
+          text: vi.fn().mockResolvedValue('��123.456.789.0')
+        }
+      }
 
-  return origFetch(url)
+      return origFetch.default(url)
+    })
+  }
 })
 
 test('fetchVersion', async () => {
@@ -53,7 +57,19 @@ test('fetchVersion', async () => {
   vi.mocked(os.arch).mockReturnValue('arm64')
   vi.mocked(os.platform).mockReturnValue('darwin')
   expect(await fetchVersion('stable')).toBe('121.0.2277.112')
+})
 
+test('fetchVersion with proxy support', async () => {
+  vi.resetModules()
+  process.env.HTTPS_PROXY = 'https://proxy.com'
+  const { fetchVersion } = await import('../src/install.js')
+  expect(await fetchVersion('stable')).toBe('121.0.2277.112')
+  expect(fetch).toBeCalledWith(
+    expect.any(String),
+    expect.objectContaining({
+      agent: expect.any(Object)
+    })
+  )
 })
 
 test('getNameByArchitecture', () => {