feat: allow usage behind a corporate proxy (#152)

* feat: allow usage behind a corporate proxy

* Update to Readme

---------

Co-authored-by: Piotr Karpala <[email protected]>

Author: Djiit

.env

@@ -23,4 +23,7 @@ NUXT_SESSION_PASSWORD=something_long_and_random_thats_at_least_32_characters
 
 # for Github OAuth
 NUXT_OAUTH_GITHUB_CLIENT_ID=
-NUXT_OAUTH_GITHUB_CLIENT_SECRET=
+NUXT_OAUTH_GITHUB_CLIENT_SECRET=
+
+# to use a corporate proxy
+# HTTP_PROXY=http://proxy.company.com:8080

README.md

@@ -174,6 +174,10 @@ Variables required for GitHub Auth are:
 >[!WARNING]
 > Only users with permissions (scopes listed in [NUXT_GITHUB_TOKEN](#NUXT_GITHUB_TOKEN)) can view copilot metrics, GitHub uses the authenticated users permissions to make API calls for data.
 
+#### Support for HTTP Proxy HTTP_PROXY
+
+Solution supports HTTP Proxy settings when running in corporate environment. Simple set `HTTP_PROXY` environment variable.
+
 ## Install Dependencies
 
 ```bash

nuxt.config.ts

@@ -69,7 +69,11 @@ export default defineNuxtConfig({
       scope: ''
     }
   },
-
+  nitro: {
+    plugins: [
+      'plugins/http-agent',
+    ],
+  },
   runtimeConfig: {
     githubToken: '',
     session: {

package-lock.json

@@ -23,6 +23,7 @@
     "nuxt": "^3.15.3",
     "nuxt-auth-utils": "^0.5.7",
     "roboto-fontface": "^0.10.0",
+    "undici": "^7.3.0",
     "vue": "latest",
     "vue-chartjs": "^5.3.2",
     "vuetify": "^3.7.3",

package.json

@@ -0,0 +1,13 @@
+import { ProxyAgent, setGlobalDispatcher } from "undici";
+import { ofetch } from "ofetch";
+
+export default defineNitroPlugin((nitro) => {
+  if (process.env.HTTP_PROXY) {
+    const proxyAgent = new ProxyAgent(process.env.HTTP_PROXY);
+    setGlobalDispatcher(proxyAgent);
+    const fetchWithProxy = ofetch.create({ dispatcher: proxyAgent });
+    nitro.hooks.hook("request", (context) => {
+      context.fetch = fetchWithProxy;
+    });
+  }
+});