From ee7ad2ac7a59a74f5d91481ba34ff9294e7186e6 Mon Sep 17 00:00:00 2001
From: Nico Flaig <nflaig@protonmail.com>
Date: Fri, 28 Jul 2023 20:58:46 +0200
Subject: [PATCH] Move fetch to @lodestar/api package

---
 packages/api/src/index.ts                                 | 3 +++
 packages/{utils/src => api/src/utils/client}/fetch.ts     | 8 +++++++-
 packages/api/src/utils/client/httpClient.ts               | 5 +++--
 packages/api/src/utils/client/index.ts                    | 1 +
 .../test/unit => api/test/unit/client}/fetch.test.ts      | 3 +--
 packages/api/test/utils/fetchOpenApiSpec.ts               | 2 +-
 .../beacon-node/src/eth1/provider/jsonRpcHttpClient.ts    | 3 ++-
 packages/beacon-node/src/execution/engine/utils.ts        | 2 +-
 packages/beacon-node/src/monitoring/service.ts            | 3 ++-
 packages/beacon-node/test/e2e/api/impl/config.test.ts     | 2 +-
 .../beacon-node/test/e2e/eth1/jsonRpcHttpClient.test.ts   | 2 +-
 .../beacon-node/test/unit/metrics/server/http.test.ts     | 2 +-
 packages/utils/src/index.ts                               | 1 -
 packages/validator/src/util/externalSignerClient.ts       | 2 +-
 14 files changed, 25 insertions(+), 14 deletions(-)
 rename packages/{utils/src => api/src/utils/client}/fetch.ts (93%)
 rename packages/{utils/test/unit => api/test/unit/client}/fetch.test.ts (97%)

diff --git a/packages/api/src/index.ts b/packages/api/src/index.ts
index 5a8760f590a2..a0436611798e 100644
--- a/packages/api/src/index.ts
+++ b/packages/api/src/index.ts
@@ -10,6 +10,9 @@ export {
   HttpError,
   ApiError,
   Metrics,
+  FetchError,
+  isFetchError,
+  fetch,
 } from "./utils/client/index.js";
 export * from "./utils/routes.js";
 
diff --git a/packages/utils/src/fetch.ts b/packages/api/src/utils/client/fetch.ts
similarity index 93%
rename from packages/utils/src/fetch.ts
rename to packages/api/src/utils/client/fetch.ts
index 0e5c37e1e270..49df361ffa19 100644
--- a/packages/utils/src/fetch.ts
+++ b/packages/api/src/utils/client/fetch.ts
@@ -1,5 +1,7 @@
 /**
- * Wrapper around native fetch to improve error handling
+ * Native fetch with transparent and consistent error handling
+ *
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/fetch)
  */
 async function wrappedFetch(url: string | URL, init?: RequestInit): Promise<Response> {
   try {
@@ -11,6 +13,10 @@ async function wrappedFetch(url: string | URL, init?: RequestInit): Promise<Resp
 
 export {wrappedFetch as fetch};
 
+export function isFetchError(e: unknown): e is FetchError {
+  return e instanceof FetchError;
+}
+
 export type FetchErrorType = "failed" | "input" | "aborted" | "unknown";
 
 type FetchErrorCause = NativeFetchFailedError["cause"] | NativeFetchInputError["cause"];
diff --git a/packages/api/src/utils/client/httpClient.ts b/packages/api/src/utils/client/httpClient.ts
index 59c9658d3a18..6015d9b6715f 100644
--- a/packages/api/src/utils/client/httpClient.ts
+++ b/packages/api/src/utils/client/httpClient.ts
@@ -1,6 +1,7 @@
-import {ErrorAborted, Logger, TimeoutError, fetch, FetchError} from "@lodestar/utils";
+import {ErrorAborted, Logger, TimeoutError} from "@lodestar/utils";
 import {ReqGeneric, RouteDef} from "../index.js";
 import {ApiClientResponse, ApiClientSuccessResponse} from "../../interfaces.js";
+import {fetch, isFetchError} from "./fetch.js";
 import {stringifyQuery, urlJoin} from "./format.js";
 import {Metrics} from "./metrics.js";
 import {HttpStatusCode} from "./httpStatusCode.js";
@@ -322,7 +323,7 @@ export class HttpClient implements IHttpClient {
 }
 
 function isAbortedError(e: Error): boolean {
-  return e instanceof FetchError && e.type === "aborted";
+  return isFetchError(e) && e.type === "aborted";
 }
 
 function getErrorMessage(errBody: string): string {
diff --git a/packages/api/src/utils/client/index.ts b/packages/api/src/utils/client/index.ts
index 6c0adec01c6b..7198c22ab89b 100644
--- a/packages/api/src/utils/client/index.ts
+++ b/packages/api/src/utils/client/index.ts
@@ -1,2 +1,3 @@
 export * from "./client.js";
 export * from "./httpClient.js";
+export * from "./fetch.js";
diff --git a/packages/utils/test/unit/fetch.test.ts b/packages/api/test/unit/client/fetch.test.ts
similarity index 97%
rename from packages/utils/test/unit/fetch.test.ts
rename to packages/api/test/unit/client/fetch.test.ts
index 40c8467c895c..5f8beaaea5ba 100644
--- a/packages/utils/test/unit/fetch.test.ts
+++ b/packages/api/test/unit/client/fetch.test.ts
@@ -1,8 +1,7 @@
-import "../setup.js";
 import crypto from "node:crypto";
 import http from "node:http";
 import {expect} from "chai";
-import {FetchError, FetchErrorType, fetch} from "../../src/fetch.js";
+import {FetchError, FetchErrorType, fetch} from "../../../src/utils/client/fetch.js";
 
 describe("FetchError", function () {
   const port = 37421;
diff --git a/packages/api/test/utils/fetchOpenApiSpec.ts b/packages/api/test/utils/fetchOpenApiSpec.ts
index 6672849a2806..a4d7060fe55a 100644
--- a/packages/api/test/utils/fetchOpenApiSpec.ts
+++ b/packages/api/test/utils/fetchOpenApiSpec.ts
@@ -1,6 +1,6 @@
 import fs from "node:fs";
 import path from "node:path";
-import {fetch} from "@lodestar/utils";
+import {fetch} from "@lodestar/api";
 import {OpenApiFile, OpenApiJson} from "./parseOpenApiSpec.js";
 
 /* eslint-disable no-console */
diff --git a/packages/beacon-node/src/eth1/provider/jsonRpcHttpClient.ts b/packages/beacon-node/src/eth1/provider/jsonRpcHttpClient.ts
index 4371d3b7e3ec..694848c14cf9 100644
--- a/packages/beacon-node/src/eth1/provider/jsonRpcHttpClient.ts
+++ b/packages/beacon-node/src/eth1/provider/jsonRpcHttpClient.ts
@@ -1,4 +1,5 @@
-import {ErrorAborted, TimeoutError, retry, fetch} from "@lodestar/utils";
+import {fetch} from "@lodestar/api";
+import {ErrorAborted, TimeoutError, retry} from "@lodestar/utils";
 import {IGauge, IHistogram} from "../../metrics/interface.js";
 import {IJson, RpcPayload} from "../interface.js";
 import {encodeJwtToken} from "./jwt.js";
diff --git a/packages/beacon-node/src/execution/engine/utils.ts b/packages/beacon-node/src/execution/engine/utils.ts
index f722e6300f45..3218d403baa6 100644
--- a/packages/beacon-node/src/execution/engine/utils.ts
+++ b/packages/beacon-node/src/execution/engine/utils.ts
@@ -1,4 +1,4 @@
-import {isFetchError} from "@lodestar/utils";
+import {isFetchError} from "@lodestar/api";
 import {IJson, RpcPayload} from "../../eth1/interface.js";
 import {IJsonRpcHttpClient} from "../../eth1/provider/jsonRpcHttpClient.js";
 import {ExecutePayloadStatus, ExecutionEngineState} from "./interface.js";
diff --git a/packages/beacon-node/src/monitoring/service.ts b/packages/beacon-node/src/monitoring/service.ts
index 501efe54e199..a6142aeac957 100644
--- a/packages/beacon-node/src/monitoring/service.ts
+++ b/packages/beacon-node/src/monitoring/service.ts
@@ -1,5 +1,6 @@
 import {Registry} from "prom-client";
-import {ErrorAborted, Logger, TimeoutError, fetch} from "@lodestar/utils";
+import {fetch} from "@lodestar/api";
+import {ErrorAborted, Logger, TimeoutError} from "@lodestar/utils";
 import {RegistryMetricCreator} from "../metrics/index.js";
 import {HistogramExtra} from "../metrics/utils/histogram.js";
 import {defaultMonitoringOptions, MonitoringOptions} from "./options.js";
diff --git a/packages/beacon-node/test/e2e/api/impl/config.test.ts b/packages/beacon-node/test/e2e/api/impl/config.test.ts
index f1bc62ca0ada..e4fa5b29211e 100644
--- a/packages/beacon-node/test/e2e/api/impl/config.test.ts
+++ b/packages/beacon-node/test/e2e/api/impl/config.test.ts
@@ -1,4 +1,4 @@
-import {fetch} from "@lodestar/utils";
+import {fetch} from "@lodestar/api";
 import {ForkName, activePreset} from "@lodestar/params";
 import {chainConfig} from "@lodestar/config/default";
 import {ethereumConsensusSpecsTests} from "../../../spec/specTestVersioning.js";
diff --git a/packages/beacon-node/test/e2e/eth1/jsonRpcHttpClient.test.ts b/packages/beacon-node/test/e2e/eth1/jsonRpcHttpClient.test.ts
index 2524931e9a14..7e68dc899fe6 100644
--- a/packages/beacon-node/test/e2e/eth1/jsonRpcHttpClient.test.ts
+++ b/packages/beacon-node/test/e2e/eth1/jsonRpcHttpClient.test.ts
@@ -2,7 +2,7 @@ import "mocha";
 import crypto from "node:crypto";
 import http from "node:http";
 import {expect} from "chai";
-import {FetchError} from "@lodestar/utils";
+import {FetchError} from "@lodestar/api";
 import {JsonRpcHttpClient} from "../../../src/eth1/provider/jsonRpcHttpClient.js";
 import {getGoerliRpcUrl} from "../../testParams.js";
 import {RpcPayload} from "../../../src/eth1/interface.js";
diff --git a/packages/beacon-node/test/unit/metrics/server/http.test.ts b/packages/beacon-node/test/unit/metrics/server/http.test.ts
index 7b651bec7751..b147a283a960 100644
--- a/packages/beacon-node/test/unit/metrics/server/http.test.ts
+++ b/packages/beacon-node/test/unit/metrics/server/http.test.ts
@@ -1,4 +1,4 @@
-import {fetch} from "@lodestar/utils";
+import {fetch} from "@lodestar/api";
 import {getHttpMetricsServer, HttpMetricsServer} from "../../../../src/metrics/index.js";
 import {testLogger} from "../../../utils/logger.js";
 import {createMetricsTest} from "../utils.js";
diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
index 3f0f9cfcd4cc..a09c615fbf2b 100644
--- a/packages/utils/src/index.ts
+++ b/packages/utils/src/index.ts
@@ -3,7 +3,6 @@ export * from "./assert.js";
 export * from "./bytes.js";
 export * from "./err.js";
 export * from "./errors.js";
-export * from "./fetch.js";
 export * from "./format.js";
 export * from "./logger.js";
 export * from "./map.js";
diff --git a/packages/validator/src/util/externalSignerClient.ts b/packages/validator/src/util/externalSignerClient.ts
index 27a397ceb2d4..2716533e536f 100644
--- a/packages/validator/src/util/externalSignerClient.ts
+++ b/packages/validator/src/util/externalSignerClient.ts
@@ -1,7 +1,7 @@
 import {ContainerType, toHexString, ValueOf} from "@chainsafe/ssz";
+import {fetch} from "@lodestar/api";
 import {phase0, altair, capella} from "@lodestar/types";
 import {ForkSeq} from "@lodestar/params";
-import {fetch} from "@lodestar/utils";
 import {ValidatorRegistrationV1} from "@lodestar/types/bellatrix";
 import {BeaconConfig} from "@lodestar/config";
 import {computeEpochAtSlot, blindedOrFullBlockToHeader} from "@lodestar/state-transition";