@capawesome/cli 3.5.0 → 3.6.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [3.6.0](https://github.com/capawesome-team/cli/compare/v3.5.0...v3.6.0) (2025-11-29)
+
+
+### Features
+
+* add proxy support for HTTP and HTTPS requests ([#99](https://github.com/capawesome-team/cli/issues/99)) ([5a6e627](https://github.com/capawesome-team/cli/commit/5a6e627a85634628ea9c365d4e7b25cc69fbe11d))
+
 ## [3.5.0](https://github.com/capawesome-team/cli/compare/v3.4.2...v3.5.0) (2025-11-24)
 
 

package/README.md

@@ -34,6 +34,8 @@ npx @capawesome/cli --help
 
 ## Development
 
+### Getting Started
+
 Run the following commands to get started with development:
 
 1. Clone the repository:
@@ -57,6 +59,26 @@ Run the following commands to get started with development:
 
     **Note:** The `--` is required to pass arguments to the script.
 
+### Testing Proxy Support
+
+To test HTTP/HTTPS proxy functionality locally:
+
+1. Start Squid proxy in a separate terminal:
+    ```bash
+    docker run --rm --name squid-proxy -p 3128:3128 -v $(pwd)/squid.conf:/etc/squid/squid.conf:ro sameersbn/squid:latest
+    ```
+
+2. Set proxy environment variables and run the CLI:
+    ```bash
+    export https_proxy=http://localhost:3128
+    npm run build && node ./dist/index.js login
+    ```
+
+3. To see debug output:
+    ```bash
+    DEBUG=https-proxy-agent node ./dist/index.js login
+    ```
+
 ## Changelog
 
 See [CHANGELOG](./CHANGELOG.md).

package/dist/utils/http-client.js

@@ -2,6 +2,8 @@ import { createRequire } from 'module';
 import configService from '../services/config.js';
 import axios from 'axios';
 import axiosRetry from 'axios-retry';
+import { HttpProxyAgent } from 'http-proxy-agent';
+import { HttpsProxyAgent } from 'https-proxy-agent';
 const require = createRequire(import.meta.url);
 const pkg = require('../../package.json');
 // Register middleware to retry failed requests
@@ -14,6 +16,22 @@ axiosRetry(axios, {
             (error.response?.status !== undefined && error.response.status >= 500));
     },
 });
+/**
+ * Gets the appropriate proxy agent based on the target URL protocol and environment variables.
+ * This ensures that HTTPS requests use HTTPS even when the proxy itself is accessed via HTTP.
+ */
+function getProxyAgent(targetUrl) {
+    const isHttps = targetUrl.startsWith('https://');
+    const proxyUrl = isHttps
+        ? process.env.HTTPS_PROXY || process.env.https_proxy
+        : process.env.HTTP_PROXY || process.env.http_proxy;
+    if (!proxyUrl) {
+        return undefined;
+    }
+    // Use the appropriate agent based on the TARGET protocol, not the proxy protocol
+    // This allows using an HTTP proxy for HTTPS requests
+    return isHttps ? new HttpsProxyAgent(proxyUrl) : new HttpProxyAgent(proxyUrl);
+}
 class HttpClientImpl {
     baseHeaders = {
         'User-Agent': `Capawesome CLI v${pkg.version}`,
@@ -21,27 +39,62 @@ class HttpClientImpl {
     async delete(url, config) {
         const baseUrl = await configService.getValueForKey('API_BASE_URL');
         const urlWithHost = url.startsWith('http') ? url : baseUrl + url;
-        return axios.delete(urlWithHost, { ...config, headers: { ...this.baseHeaders, ...config?.headers } });
+        const proxyAgent = getProxyAgent(urlWithHost);
+        const axiosConfig = {
+            ...config,
+            headers: { ...this.baseHeaders, ...config?.headers },
+            ...(proxyAgent && urlWithHost.startsWith('https://') ? { httpsAgent: proxyAgent, proxy: false } : {}),
+            ...(proxyAgent && urlWithHost.startsWith('http://') ? { httpAgent: proxyAgent, proxy: false } : {}),
+        };
+        return axios.delete(urlWithHost, axiosConfig);
     }
     async get(url, config) {
         const baseUrl = await configService.getValueForKey('API_BASE_URL');
         const urlWithHost = url.startsWith('http') ? url : baseUrl + url;
-        return axios.get(urlWithHost, { ...config, headers: { ...this.baseHeaders, ...config?.headers } });
+        const proxyAgent = getProxyAgent(urlWithHost);
+        const axiosConfig = {
+            ...config,
+            headers: { ...this.baseHeaders, ...config?.headers },
+            ...(proxyAgent && urlWithHost.startsWith('https://') ? { httpsAgent: proxyAgent, proxy: false } : {}),
+            ...(proxyAgent && urlWithHost.startsWith('http://') ? { httpAgent: proxyAgent, proxy: false } : {}),
+        };
+        return axios.get(urlWithHost, axiosConfig);
     }
     async patch(url, data, config) {
         const baseUrl = await configService.getValueForKey('API_BASE_URL');
         const urlWithHost = url.startsWith('http') ? url : baseUrl + url;
-        return axios.patch(urlWithHost, data, { ...config, headers: { ...this.baseHeaders, ...config?.headers } });
+        const proxyAgent = getProxyAgent(urlWithHost);
+        const axiosConfig = {
+            ...config,
+            headers: { ...this.baseHeaders, ...config?.headers },
+            ...(proxyAgent && urlWithHost.startsWith('https://') ? { httpsAgent: proxyAgent, proxy: false } : {}),
+            ...(proxyAgent && urlWithHost.startsWith('http://') ? { httpAgent: proxyAgent, proxy: false } : {}),
+        };
+        return axios.patch(urlWithHost, data, axiosConfig);
     }
     async post(url, data, config) {
         const baseUrl = await configService.getValueForKey('API_BASE_URL');
         const urlWithHost = url.startsWith('http') ? url : baseUrl + url;
-        return axios.post(urlWithHost, data, { ...config, headers: { ...this.baseHeaders, ...config?.headers } });
+        const proxyAgent = getProxyAgent(urlWithHost);
+        const axiosConfig = {
+            ...config,
+            headers: { ...this.baseHeaders, ...config?.headers },
+            ...(proxyAgent && urlWithHost.startsWith('https://') ? { httpsAgent: proxyAgent, proxy: false } : {}),
+            ...(proxyAgent && urlWithHost.startsWith('http://') ? { httpAgent: proxyAgent, proxy: false } : {}),
+        };
+        return axios.post(urlWithHost, data, axiosConfig);
     }
     async put(url, data, config) {
         const baseUrl = await configService.getValueForKey('API_BASE_URL');
         const urlWithHost = url.startsWith('http') ? url : baseUrl + url;
-        return axios.put(urlWithHost, data, { ...config, headers: { ...this.baseHeaders, ...config?.headers } });
+        const proxyAgent = getProxyAgent(urlWithHost);
+        const axiosConfig = {
+            ...config,
+            headers: { ...this.baseHeaders, ...config?.headers },
+            ...(proxyAgent && urlWithHost.startsWith('https://') ? { httpsAgent: proxyAgent, proxy: false } : {}),
+            ...(proxyAgent && urlWithHost.startsWith('http://') ? { httpAgent: proxyAgent, proxy: false } : {}),
+        };
+        return axios.put(urlWithHost, data, axiosConfig);
     }
 }
 let httpClient = new HttpClientImpl();

package/dist/utils/http-client.test.js

@@ -1,6 +1,6 @@
-import { beforeEach, describe, expect, it, vi } from 'vitest';
-import nock from 'nock';
 import configService from '../services/config.js';
+import nock from 'nock';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 // Mock the config service
 vi.mock('@/services/config.js', () => ({
     default: {
@@ -8,9 +8,21 @@ vi.mock('@/services/config.js', () => ({
     },
 }));
 describe('http-client', () => {
+    let originalEnv;
     beforeEach(() => {
+        // Save original environment variables
+        originalEnv = { ...process.env };
         nock.cleanAll();
         vi.clearAllMocks();
+        // Clear proxy environment variables
+        delete process.env.HTTP_PROXY;
+        delete process.env.http_proxy;
+        delete process.env.HTTPS_PROXY;
+        delete process.env.https_proxy;
+    });
+    afterEach(() => {
+        // Restore original environment variables
+        process.env = originalEnv;
     });
     it('should retry requests on 5xx status codes', async () => {
         // Mock the API_BASE_URL
@@ -69,4 +81,19 @@ describe('http-client', () => {
         expect(response.data).toEqual({ recovered: true });
         expect(nock.isDone()).toBe(true);
     });
+    it('should work without proxy when no environment variables are set', async () => {
+        vi.mocked(configService.getValueForKey).mockResolvedValue('https://api.example.com');
+        nock('https://api.example.com').get('/no-proxy').reply(200, { success: true });
+        const { default: httpClient } = await import('./http-client.js');
+        const response = await httpClient.get('/no-proxy');
+        expect(response.status).toBe(200);
+        expect(response.data).toEqual({ success: true });
+    });
+    // Note: Testing actual proxy behavior with nock is not reliable as nock intercepts
+    // requests at a different level than proxy agents. The proxy functionality is handled
+    // by the http-proxy-agent and https-proxy-agent libraries which are well-tested.
+    // The implementation ensures that:
+    // - HTTPS requests use HttpsProxyAgent when https_proxy/HTTPS_PROXY is set
+    // - HTTP requests use HttpProxyAgent when http_proxy/HTTP_PROXY is set
+    // - HTTP proxies (http://) work correctly for HTTPS targets (https://)
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capawesome/cli",
-  "version": "3.5.0",
+  "version": "3.6.0",
   "description": "The Capawesome Cloud Command Line Interface (CLI) to manage Live Updates and more.",
   "type": "module",
   "scripts": {
@@ -13,7 +13,7 @@
     "fmt": "npm run prettier -- --write",
     "prettier": "prettier \"**/*.{css,html,ts,js}\"",
     "sentry:releases:new": "sentry-cli releases new capawesome-team-cli@$npm_package_version --org genz-it-solutions-gmbh --project capawesome-team-cli",
-    "sentry:releases:set-commits": "sentry-cli releases set-commits capawesome-team-cli@$npm_package_version --auto --org genz-it-solutions-gmbh --project capawesome-team-cli",
+    "sentry:releases:set-commits": "sentry-cli releases set-commits capawesome-team-cli@$npm_package_version --auto --org genz-it-solutions-gmbh --project capawesome-team-cli --ignore-missing",
     "sentry:releases:finalize": "sentry-cli releases finalize capawesome-team-cli@$npm_package_version --org genz-it-solutions-gmbh --project capawesome-team-cli",
     "release": "commit-and-tag-version",
     "prepublishOnly": "npm run build && npm run sentry:releases:new && npm run sentry:releases:set-commits",
@@ -61,6 +61,8 @@
     "c12": "2.0.1",
     "consola": "3.3.0",
     "form-data": "4.0.4",
+    "http-proxy-agent": "7.0.2",
+    "https-proxy-agent": "7.0.6",
     "mime": "4.0.7",
     "open": "10.2.0",
     "rc9": "2.1.2",