feat: Add specific error types to request methods

- Added ConnectionRefusedError handling for ECONNREFUSED errors.
- Added RequestTimeoutError handling for UND_ERR_CONNECT_TIMEOUT, UND_ERR_HEADERS_TIMEOUT, and UND_ERR_BODY_TIMEOUT errors.

Author: schaable

v-next/hardhat-utils/src/errors/request.ts

@@ -20,3 +20,15 @@ export class DispatcherError extends CustomError {
     super(`Failed to create dispatcher: ${message}`, cause);
   }
 }
+
+export class RequestTimeoutError extends CustomError {
+  constructor(url: string, cause?: Error) {
+    super(`Request to ${sanitizeUrl(url)} timed out`, cause);
+  }
+}
+
+export class ConnectionRefusedError extends CustomError {
+  constructor(url: string, cause?: Error) {
+    super(`Connection to ${sanitizeUrl(url)} was refused`, cause);
+  }
+}

v-next/hardhat-utils/src/request.ts

@@ -11,6 +11,8 @@ import {
   DownloadError,
   RequestError,
   DispatcherError,
+  RequestTimeoutError,
+  ConnectionRefusedError,
 } from "./errors/request.js";
 import { move } from "./fs.js";
 import {
@@ -66,7 +68,9 @@ export interface RequestOptions {
  * @param requestOptions The options to configure the request. See {@link RequestOptions}.
  * @param dispatcherOrDispatcherOptions Either a dispatcher or dispatcher options. See {@link DispatcherOptions}.
  * @returns The response data object. See {@link https://undici.nodejs.org/#/docs/api/Dispatcher?id=parameter-responsedata}.
- * @throws RequestError If the request fails.
+ * @throws ConnectionRefusedError If the connection is refused by the server.
+ * @throws RequestTimeoutError If the request times out.
+ * @throws RequestError If the request fails for any other reason.
  */
 export async function getRequest(
   url: string,
@@ -86,7 +90,20 @@ export async function getRequest(
       ...baseRequestOptions,
     });
   } catch (e) {
-    ensureError(e);
+    ensureError<NodeJS.ErrnoException>(e);
+
+    if (e.code === "ECONNREFUSED") {
+      throw new ConnectionRefusedError(url, e);
+    }
+
+    if (
+      e.code === "UND_ERR_CONNECT_TIMEOUT" ||
+      e.code === "UND_ERR_HEADERS_TIMEOUT" ||
+      e.code === "UND_ERR_BODY_TIMEOUT"
+    ) {
+      throw new RequestTimeoutError(url, e);
+    }
+
     throw new RequestError(url, "GET", e);
   }
 }
@@ -99,7 +116,9 @@ export async function getRequest(
  * @param requestOptions The options to configure the request. See {@link RequestOptions}.
  * @param dispatcherOrDispatcherOptions Either a dispatcher or dispatcher options. See {@link DispatcherOptions}.
  * @returns The response data object. See {@link https://undici.nodejs.org/#/docs/api/Dispatcher?id=parameter-responsedata}.
- * @throws RequestError If the request fails.
+ * @throws ConnectionRefusedError If the connection is refused by the server.
+ * @throws RequestTimeoutError If the request times out.
+ * @throws RequestError If the request fails for any other reason.
  */
 export async function postJsonRequest(
   url: string,
@@ -125,7 +144,20 @@ export async function postJsonRequest(
       body: JSON.stringify(body),
     });
   } catch (e) {
-    ensureError(e);
+    ensureError<NodeJS.ErrnoException>(e);
+
+    if (e.code === "ECONNREFUSED") {
+      throw new ConnectionRefusedError(url, e);
+    }
+
+    if (
+      e.code === "UND_ERR_CONNECT_TIMEOUT" ||
+      e.code === "UND_ERR_HEADERS_TIMEOUT" ||
+      e.code === "UND_ERR_BODY_TIMEOUT"
+    ) {
+      throw new RequestTimeoutError(url, e);
+    }
+
     throw new RequestError(url, "POST", e);
   }
 }
@@ -138,7 +170,9 @@ export async function postJsonRequest(
  * @param requestOptions The options to configure the request. See {@link RequestOptions}.
  * @param dispatcherOrDispatcherOptions Either a dispatcher or dispatcher options. See {@link DispatcherOptions}.
  * @returns The response data object. See {@link https://undici.nodejs.org/#/docs/api/Dispatcher?id=parameter-responsedata}.
- * @throws RequestError If the request fails.
+ * @throws ConnectionRefusedError If the connection is refused by the server.
+ * @throws RequestTimeoutError If the request times out.
+ * @throws RequestError If the request fails for any other reason.
  */
 export async function postFormRequest(
   url: string,
@@ -165,7 +199,20 @@ export async function postFormRequest(
       body: querystring.stringify(body as ParsedUrlQueryInput),
     });
   } catch (e) {
-    ensureError(e);
+    ensureError<NodeJS.ErrnoException>(e);
+
+    if (e.code === "ECONNREFUSED") {
+      throw new ConnectionRefusedError(url, e);
+    }
+
+    if (
+      e.code === "UND_ERR_CONNECT_TIMEOUT" ||
+      e.code === "UND_ERR_HEADERS_TIMEOUT" ||
+      e.code === "UND_ERR_BODY_TIMEOUT"
+    ) {
+      throw new RequestTimeoutError(url, e);
+    }
+
     throw new RequestError(url, "POST", e);
   }
 }
@@ -177,7 +224,9 @@ export async function postFormRequest(
  * @param destination The absolute path to save the file to.
  * @param requestOptions The options to configure the request. See {@link RequestOptions}.
  * @param dispatcherOrDispatcherOptions Either a dispatcher or dispatcher options. See {@link DispatcherOptions}.
- * @throws DownloadFailedError If the download fails.
+ * @throws ConnectionRefusedError If the connection is refused by the server.
+ * @throws RequestTimeoutError If the request times out.
+ * @throws DownloadFailedError If the download fails for any other reason.
  */
 export async function download(
   url: string,
@@ -205,7 +254,20 @@ export async function download(
     await stream.pipeline(body, fileStream);
     await move(tempFilePath, destination);
   } catch (e) {
-    ensureError(e);
+    ensureError<NodeJS.ErrnoException>(e);
+
+    if (e.code === "ECONNREFUSED") {
+      throw new ConnectionRefusedError(url, e);
+    }
+
+    if (
+      e.code === "UND_ERR_CONNECT_TIMEOUT" ||
+      e.code === "UND_ERR_HEADERS_TIMEOUT" ||
+      e.code === "UND_ERR_BODY_TIMEOUT"
+    ) {
+      throw new RequestTimeoutError(url, e);
+    }
+
     throw new DownloadError(url, e);
   }
 }
@@ -301,4 +363,6 @@ export {
   DownloadError,
   RequestError,
   DispatcherError,
+  RequestTimeoutError,
+  ConnectionRefusedError,
 } from "./errors/request.js";