Merge pull request #7121 from NomicFoundation/dont-use-global-dispatcher

Don't use `undici`'s global dispatcher

Author: alcuadrado

.changeset/pink-schools-exercise.md

@@ -0,0 +1,6 @@
+---
+"hardhat": patch
+"@nomicfoundation/hardhat-verify": patch
+---
+
+Don't use `undici`'s global dispatcher, making Hardhat more stable across Node.js versions

packages/hardhat-core/src/internal/util/download.ts

@@ -24,13 +24,13 @@ export async function download(
   timeoutMillis = 10000,
   extraHeaders: { [name: string]: string } = {}
 ) {
-  const { getGlobalDispatcher, ProxyAgent, request } = await import("undici");
+  const { Agent, ProxyAgent, request } = await import("undici");
 
   let dispatcher: Dispatcher;
   if (process.env.http_proxy !== undefined && shouldUseProxy(url)) {
     dispatcher = new ProxyAgent(process.env.http_proxy);
   } else {
-    dispatcher = getGlobalDispatcher();
+    dispatcher = new Agent();
   }
 
   const hardhatVersion = getHardhatVersion();

packages/hardhat-verify/src/internal/undici.ts

@@ -28,14 +28,25 @@ export async function sendPostRequest(
   });
 }
 
+let mockDispatcher: Undici.Dispatcher | undefined;
+
 function getDispatcher(): Undici.Dispatcher {
-  const { ProxyAgent, getGlobalDispatcher } =
-    require("undici") as typeof Undici;
+  if (mockDispatcher !== undefined) {
+    return mockDispatcher;
+  }
+
+  const { ProxyAgent, Agent } = require("undici") as typeof Undici;
   if (process.env.http_proxy !== undefined) {
     return new ProxyAgent(process.env.http_proxy);
   }
 
-  return getGlobalDispatcher();
+  return new Agent();
+}
+
+export function setMockDispatcher(
+  dispatcher: Undici.Dispatcher | undefined
+): void {
+  mockDispatcher = dispatcher;
 }
 
 export function isSuccessStatusCode(statusCode: number): boolean {

packages/hardhat-verify/test/integration/mocks/etherscan.ts

@@ -1,9 +1,5 @@
-import {
-  Dispatcher,
-  getGlobalDispatcher,
-  MockAgent,
-  setGlobalDispatcher,
-} from "undici";
+import { MockAgent } from "undici";
+import { setMockDispatcher } from "../../../src/internal/undici";
 
 const mockAgent = new MockAgent({
   keepAliveTimeout: 10,
@@ -13,17 +9,15 @@ const mockAgent = new MockAgent({
 const client = mockAgent.get("https://api-hardhat.etherscan.io");
 
 export const mockEnvironment = () => {
-  let globalDispatcher: Dispatcher;
   // enable network connections for everything but etherscan API
   mockAgent.enableNetConnect(/^(?!https:\/\/api-hardhat\.etherscan\.io)/);
 
   before(() => {
-    globalDispatcher = getGlobalDispatcher();
-    setGlobalDispatcher(mockAgent);
+    setMockDispatcher(mockAgent);
   });
 
   after(() => {
-    setGlobalDispatcher(globalDispatcher);
+    setMockDispatcher(undefined);
   });
 };
 

packages/hardhat-verify/test/integration/mocks/sourcify.ts

@@ -1,9 +1,5 @@
-import {
-  Dispatcher,
-  getGlobalDispatcher,
-  MockAgent,
-  setGlobalDispatcher,
-} from "undici";
+import { MockAgent } from "undici";
+import { setMockDispatcher } from "../../../src/internal/undici";
 
 const mockAgent = new MockAgent({
   keepAliveTimeout: 10,
@@ -13,17 +9,15 @@ const mockAgent = new MockAgent({
 const client = mockAgent.get("https://sourcify.dev");
 
 export const mockEnvironmentSourcify = () => {
-  let globalDispatcher: Dispatcher;
   // enable network connections for everything but etherscan API
   mockAgent.enableNetConnect(/^(?!https:\/\/sourcify\.dev)/);
 
   before(() => {
-    globalDispatcher = getGlobalDispatcher();
-    setGlobalDispatcher(mockAgent);
+    setMockDispatcher(mockAgent);
   });
 
   after(() => {
-    setGlobalDispatcher(globalDispatcher);
+    setMockDispatcher(undefined);
   });
 };