refactor: move fetchWithTimeout out of the openapi-core package (#2035)

Author: tatomyr

package-lock.json

@@ -20,7 +20,7 @@
     "prettier": "npx prettier --write \"**/*.{ts,js,yaml,yml,json,md}\"",
     "prettier:check": "npx prettier --check \"**/*.{ts,js,yaml,yml,json,md}\"",
     "eslint": "eslint packages/**",
-    "clean": "rm -rf packages/**/lib packages/**/node_modules packages/**/*.tsbuildinfo package-lock.json node_modules dist && git checkout package-lock.json",
+    "clear": "rm -rf packages/**/lib packages/**/node_modules packages/**/*.tsbuildinfo package-lock.json node_modules dist && git checkout package-lock.json",
     "typecheck": "tsc --noEmit --skipLibCheck",
     "compile": "tsc -b tsconfig.build.json && npm run respect:parser:generate && npm run build-docs:copy-assets",
     "prepare": "npm run compile",

package.json

@@ -53,6 +53,7 @@
     "form-data": "^4.0.0",
     "glob": "^11.0.1",
     "handlebars": "^4.7.6",
+    "https-proxy-agent": "^7.0.5",
     "mobx": "^6.0.4",
     "pluralize": "^8.0.0",
     "react": "^17.0.0 || ^18.2.0 || ^19.0.0",

packages/cli/package.json

@@ -1,7 +1,7 @@
 import AbortController from 'abort-controller';
-import fetchWithTimeout from '../utils/fetch-with-timeout.js';
-import { getProxyAgent } from '@redocly/openapi-core';
 import { HttpsProxyAgent } from 'https-proxy-agent';
+import fetchWithTimeout from '../utils/fetch-with-timeout.js';
+import * as proxyAgent from '../utils/proxy-agent.js';
 
 const signalInstance = new AbortController().signal;
 
@@ -31,6 +31,11 @@ const mockFetch = vi.fn(() =>
 const originalFetch = global.fetch;
 global.fetch = mockFetch;
 
+vi.mock('../utils/get-proxy-agent.js', async () => {
+  const actual = await vi.importActual('../utils/get-proxy-agent.js');
+  return { ...actual };
+});
+
 describe('fetchWithTimeout', () => {
   beforeAll(() => {
     global.setTimeout = vi.fn() as any;
@@ -60,12 +65,12 @@ describe('fetchWithTimeout', () => {
   });
 
   it('should call fetch with proxy agent', async () => {
-    const proxyAgent = new HttpsProxyAgent('http://localhost');
-    vi.mocked(getProxyAgent).mockReturnValueOnce(proxyAgent as any);
+    const dispatcher = new HttpsProxyAgent('http://localhost');
+    vi.spyOn(proxyAgent, 'getProxyAgent').mockReturnValueOnce(dispatcher);
 
     await fetchWithTimeout('url');
 
-    expect(global.fetch).toHaveBeenCalledWith('url', { dispatcher: proxyAgent });
+    expect(global.fetch).toHaveBeenCalledWith('url', { dispatcher });
   });
 
   it('should call fetch without signal when timeout is not passed', async () => {

packages/cli/src/__tests__/fetch-with-timeout.test.ts

@@ -1,4 +1,4 @@
-import { getProxyAgent } from '@redocly/openapi-core';
+import { getProxyAgent } from './proxy-agent.js';
 
 export const DEFAULT_FETCH_TIMEOUT = 3000;
 

packages/cli/src/utils/fetch-with-timeout.ts

@@ -0,0 +1,6 @@
+import { HttpsProxyAgent } from 'https-proxy-agent';
+
+export function getProxyAgent() {
+  const proxy = process.env.HTTPS_PROXY || process.env.HTTP_PROXY;
+  return proxy ? new HttpsProxyAgent(proxy) : undefined;
+}

packages/cli/src/utils/proxy-agent.ts

@@ -38,8 +38,9 @@
     "node:fs": false,
     "node:path": "path-browserify",
     "node:os": false,
-    "colorette": false,
-    "https-proxy-agent": false
+    "node:url": false,
+    "node:module": false,
+    "colorette": false
   },
   "homepage": "https://github.com/Redocly/redocly-cli",
   "keywords": [
@@ -59,7 +60,6 @@
     "@redocly/ajv": "^8.11.2",
     "@redocly/config": "^0.22.0",
     "colorette": "^1.2.0",
-    "https-proxy-agent": "^7.0.5",
     "js-levenshtein": "^1.1.6",
     "js-yaml": "^4.1.0",
     "minimatch": "^10.0.1",

packages/core/package.json

@@ -6,7 +6,6 @@ export {
   slash,
   doesYamlFileExist,
   isTruthy,
-  getProxyAgent,
   pause,
   isPlainObject,
   dequal,

packages/core/src/index.ts

@@ -4,7 +4,6 @@ import { minimatch } from 'minimatch';
 import { parseYaml } from './js-yaml/index.js';
 import { env } from './env.js';
 import { logger, colorize } from './logger.js';
-import { HttpsProxyAgent } from 'https-proxy-agent';
 import * as pluralize1 from 'pluralize'; // FIXME: use correct import after migration to ESM
 const pluralizeOne = (pluralize1 as any).default || pluralize1; // FIXME: use correct import after migration to ESM
 
@@ -309,11 +308,6 @@ function getUpdatedFieldName(updatedField: string, updatedObject?: string) {
   return `${typeof updatedObject !== 'undefined' ? `${updatedObject}.` : ''}${updatedField}`;
 }
 
-export function getProxyAgent() {
-  const proxy = process.env.HTTPS_PROXY || process.env.HTTP_PROXY;
-  return proxy ? new HttpsProxyAgent(proxy) : undefined;
-}
-
 /**
  * Checks if two objects are deeply equal.
  * Borrowed the source code from https://github.com/lukeed/dequal.