fix(app): configure http with proxy url if present in environment (#762)

* chore(deps): install `https-proxy-agent` as dependency

* fix(app): configure http agent with proxy url if present in environment

Fixes ##714

Author: jontze

apps/generator-cli/src/app/app.module.ts

@@ -1,16 +1,33 @@
-import {Inject, Module, OnApplicationBootstrap} from '@nestjs/common';
-import {HttpModule} from '@nestjs/axios';
-import {Command} from 'commander';
+import { Inject, Module, OnApplicationBootstrap } from '@nestjs/common';
+import { HttpModule, HttpModuleOptions } from '@nestjs/axios';
+import { Command } from 'commander';
 
-import {COMMANDER_PROGRAM, LOGGER} from './constants';
-import {VersionManagerController} from './controllers/version-manager.controller';
-import {ConfigService, GeneratorService, PassThroughService, UIService, VersionManagerService} from './services';
+import { COMMANDER_PROGRAM, LOGGER } from './constants';
+import { VersionManagerController } from './controllers/version-manager.controller';
+import {
+  ConfigService,
+  GeneratorService,
+  PassThroughService,
+  UIService,
+  VersionManagerService,
+} from './services';
+import { HttpsProxyAgent } from 'https-proxy-agent';
+
+const proxyUrl = process.env.HTTP_PROXY || process.env.HTTPS_PROXY;
+const httpModuleConfig: HttpModuleOptions = {};
+
+if (proxyUrl) {
+  httpModuleConfig.proxy = false;
+  httpModuleConfig.httpsAgent = new HttpsProxyAgent(proxyUrl);
+}
 
 @Module({
-  imports: [HttpModule],
-  controllers: [
-    VersionManagerController
+  imports: [
+    HttpModule.register({
+      ...httpModuleConfig,
+    }),
   ],
+  controllers: [VersionManagerController],
   providers: [
     UIService,
     ConfigService,
@@ -19,34 +36,37 @@ import {ConfigService, GeneratorService, PassThroughService, UIService, VersionM
     VersionManagerService,
     {
       provide: COMMANDER_PROGRAM,
-      useValue: new Command('openapi-generator-cli').helpOption(false).usage('<command> [<args>]').option( '--openapitools <openapitools.json>', 'Use the specified openapi-generator-cli configuration file')
+      useValue: new Command('openapi-generator-cli')
+        .helpOption(false)
+        .usage('<command> [<args>]')
+        .option(
+          '--openapitools <openapitools.json>',
+          'Use the specified openapi-generator-cli configuration file',
+        ),
     },
-    {provide: LOGGER, useValue: console}
-  ]
+    { provide: LOGGER, useValue: console },
+  ],
 })
 export class AppModule implements OnApplicationBootstrap {
-
   constructor(
     @Inject(COMMANDER_PROGRAM) private readonly program: Command,
     private readonly versionManager: VersionManagerService,
-    private readonly passThroughService: PassThroughService
-  ) {
-  }
+    private readonly passThroughService: PassThroughService,
+  ) {}
 
   onApplicationBootstrap = async () => {
-
     let selectedVersion = this.versionManager.getSelectedVersion();
 
     if (!selectedVersion) {
-      const [{version}] = await this.versionManager.search(['latest']).toPromise();
+      const [{ version }] = await this.versionManager
+        .search(['latest'])
+        .toPromise();
       await this.versionManager.setSelectedVersion(version);
       selectedVersion = version;
     }
 
     await this.versionManager.downloadIfNeeded(selectedVersion);
     await this.passThroughService.init();
     this.program.parse(process.argv);
-
   };
-
 }

package.json

@@ -91,6 +91,7 @@
     "concurrently": "6.5.1",
     "console.table": "0.10.0",
     "fs-extra": "10.1.0",
+    "https-proxy-agent": "^7.0.4",
     "inquirer": "8.2.6",
     "jsonpath": "1.1.1",
     "lodash": "4.17.21",

yarn.lock

@@ -5938,6 +5938,14 @@ https-proxy-agent@^7.0.0, https-proxy-agent@^7.0.1:
     agent-base "^7.0.2"
     debug "4"
 
+https-proxy-agent@^7.0.4:
+  version "7.0.4"
+  resolved "https://registry.yarnpkg.com/https-proxy-agent/-/https-proxy-agent-7.0.4.tgz#8e97b841a029ad8ddc8731f26595bad868cb4168"
+  integrity sha512-wlwpilI7YdjSkWaQ/7omYBMTliDcmCN8OLihO6I9B86g06lMyAoqgoDpV0XqoaPOKj+0DIdAvnsWfyAAhmimcg==
+  dependencies:
+    agent-base "^7.0.2"
+    debug "4"
+
 human-signals@^2.1.0:
   version "2.1.0"
   resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-2.1.0.tgz#dc91fcba42e4d06e4abaed33b3e7a3c02f514ea0"