feat: add proxy support for node-fetch

arika0093 · arika0093 · commit c850030b5927 · 2023-08-25T12:46:54.000Z
This process is expected to allow the CLI and SDK to work in environments where proxy is enabled.
diff --git a/.changeset/big-geese-dream.md b/.changeset/big-geese-dream.md
@@ -0,0 +1,6 @@
+---
+"@trigger.dev/sdk": patch
+"@trigger.dev/cli": patch
+---
+
+feat: add proxy support for node-fetch
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -76,6 +76,7 @@
     "ora": "^6.1.2",
     "path-to-regexp": "^6.2.1",
     "posthog-node": "^3.1.1",
+    "proxy-agent": "^6.3.0",
     "simple-git": "^3.19.0",
     "terminal-link": "^3.0.0",
     "tsconfck": "^2.1.2",
diff --git a/packages/cli/src/commands/dev.ts b/packages/cli/src/commands/dev.ts
@@ -2,7 +2,7 @@ import childProcess from "child_process";
 import chokidar from "chokidar";
 import fs from "fs/promises";
 import ngrok from "ngrok";
-import fetch from "node-fetch";
+import fetch from "../utils/fetchUseProxy";
 import ora, { Ora } from "ora";
 import pathModule from "path";
 import util from "util";
diff --git a/packages/cli/src/utils/addDependencies.ts b/packages/cli/src/utils/addDependencies.ts
@@ -4,7 +4,7 @@ import ora, { type Ora } from "ora";
 import pathModule from "path";
 import { getUserPackageManager, type PackageManager } from "./getUserPkgManager";
 import fs from "fs/promises";
-import fetch from "node-fetch";
+import fetch from "./fetchUseProxy";
 import { z } from "zod";
 
 export type InstallPackage = {
diff --git a/packages/cli/src/utils/fetchUseProxy.ts b/packages/cli/src/utils/fetchUseProxy.ts
@@ -0,0 +1,16 @@
+import node_fetch, {RequestInfo as _RequestInfo, RequestInit as _RequestInit} from "node-fetch";
+import {ProxyAgent} from "proxy-agent";
+
+export type RequestInfo = _RequestInfo;
+export type RequestInit = _RequestInit;
+
+export default function fetch(url: RequestInfo, init?: RequestInit) {
+	const fetchInit: RequestInit = { ...init };
+
+	// If agent is not specified, specify proxy-agent and use environment variables such as HTTPS_PROXY.
+	if (!fetchInit.agent){
+		fetchInit.agent = new ProxyAgent();
+	}
+
+	return node_fetch(url, fetchInit);
+}
diff --git a/packages/cli/src/utils/triggerApi.ts b/packages/cli/src/utils/triggerApi.ts
@@ -1,4 +1,4 @@
-import fetch from "node-fetch";
+import fetch from "./fetchUseProxy";
 import { z } from "zod";
 
 export type CreateEndpointOptions = {
diff --git a/packages/trigger-sdk/package.json b/packages/trigger-sdk/package.json
@@ -34,6 +34,7 @@
     "git-remote-origin-url": "^4.0.0",
     "git-repo-info": "^2.1.1",
     "node-fetch": "2.6.x",
+    "proxy-agent": "^6.3.0",
     "slug": "^6.0.0",
     "terminal-link": "^3.0.0",
     "ulid": "^2.3.0",
diff --git a/packages/trigger-sdk/src/apiClient.ts b/packages/trigger-sdk/src/apiClient.ts
@@ -26,7 +26,7 @@ import {
   urlWithSearchParams,
 } from "@trigger.dev/core";
 
-import fetch, { type RequestInit } from "node-fetch";
+import fetch, { type RequestInit } from "./fetch";
 import { z } from "zod";
 
 export type ApiClientOptions = {
diff --git a/packages/trigger-sdk/src/fetch.ts b/packages/trigger-sdk/src/fetch.ts
@@ -0,0 +1,16 @@
+import node_fetch, {RequestInfo as _RequestInfo, RequestInit as _RequestInit} from "node-fetch";
+import {ProxyAgent} from "proxy-agent";
+
+export type RequestInfo = _RequestInfo;
+export type RequestInit = _RequestInit;
+
+export default function fetch(url: RequestInfo, init?: RequestInit) {
+	const fetchInit: RequestInit = { ...init };
+
+	// If agent is not specified, specify proxy-agent and use environment variables such as HTTPS_PROXY.
+	if (!fetchInit.agent){
+		fetchInit.agent = new ProxyAgent();
+	}
+
+	return node_fetch(url, fetchInit);
+}

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import fetch from "node-fetch";`
	`1`	`+import fetch from "./fetchUseProxy";`
`2`	`2`	`import { z } from "zod";`
`3`	`3`
`4`	`4`	`export type CreateEndpointOptions = {`