@sap-ux/backend-proxy-middleware 0.6.26 → 0.6.28

package/README.md

@@ -123,8 +123,7 @@ If you want to configure the proxy to send requests from a certain path `/servic
 ```
 
 ### [Providing Proxy Configuration](#providing-proxy-configuration)
-By default the `backend-proxy-middleware` will read the proxy configuration from the Node.js environment variables `proxy`, `https-proxy` and `noproxy`. If those variables are not set, then you can also provide the proxy configuration in the `ui5.yaml` file. 
-**Please note: if you want to exclude any domains from the proxy then you will need to set the `noproxy` variable, e.g. `npm config set noproxy "sap.com"`**.
+By default the `backend-proxy-middleware` will read the proxy configuration from the OS environment variables `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` or from the Node.js environment variables `proxy`, `https-proxy` and `noproxy`. If those variables are not set, then you can also provide the proxy configuration in the `ui5.yaml` file.
 
 ```
 - name: backend-proxy-middleware
@@ -136,6 +135,7 @@ By default the `backend-proxy-middleware` will read the proxy configuration from
       url: https://my.backend.example:1234
 
 ```
+**Please note:** if you want to exclude any domains from the proxy then you will need to set the `noproxy` variable. E.g. if you want to exclude the `https://my.backend.example:1234` from the proxy you will need to set `noproxy` to `npm config set noproxy ".backend.example"`. Note the leading `.`, if you provide only `backend.example`, then it will not work.
 ## Programmatic Usage
 Alternatively you can only use the underlying proxy function, e.g. for the case when you want to use the `backend-proxy-middleware` functionality in your `express` server.
 

package/dist/base/config.d.ts

@@ -1,15 +1,7 @@
 /**
- * Get the effective proxy string from runtime args (highest priority), given config value or environment variables.
+ * Updates the proxy configuration with values from runtime args (highest priority), given config value or environment variables.
  *
  * @param proxyFromConfig - optional proxy string from configuration
- * @returns proxy server if required, otherwise undefined
  */
-export declare function getCorporateProxyServer(proxyFromConfig?: string): string | undefined;
-/**
- * Checks if a host is excluded from user's corporate proxy.
- *
- * @param url - url to be checked
- * @returns true if host is excluded from user's corporate server, false otherwise
- */
-export declare const isHostExcludedFromProxy: (url: string) => boolean;
+export declare function updateProxyEnv(proxyFromConfig?: string): void;
 //# sourceMappingURL=config.d.ts.map

package/dist/base/config.js

@@ -1,46 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isHostExcludedFromProxy = exports.getCorporateProxyServer = void 0;
+exports.updateProxyEnv = void 0;
 /**
- * Get the effective proxy string from runtime args (highest priority), given config value or environment variables.
+ * Updates the proxy configuration with values from runtime args (highest priority), given config value or environment variables.
  *
  * @param proxyFromConfig - optional proxy string from configuration
- * @returns proxy server if required, otherwise undefined
  */
-function getCorporateProxyServer(proxyFromConfig) {
+function updateProxyEnv(proxyFromConfig) {
     let proxyFromArgs;
     process.argv.forEach((arg) => {
         if (arg.match(/proxy=/g)) {
             proxyFromArgs = arg.split('=')[1];
         }
     });
-    return (proxyFromArgs ||
-        proxyFromConfig ||
-        process.env.FIORI_TOOLS_PROXY ||
-        process.env.http_proxy ||
-        process.env.HTTP_PROXY ||
-        process.env.https_proxy ||
-        process.env.HTTPS_PROXY ||
-        process.env.npm_config_proxy ||
-        process.env.npm_config_https_proxy);
-}
-exports.getCorporateProxyServer = getCorporateProxyServer;
-/**
- * Checks if a host is excluded from user's corporate proxy.
- *
- * @param url - url to be checked
- * @returns true if host is excluded from user's corporate server, false otherwise
- */
-const isHostExcludedFromProxy = (url) => {
-    const noProxyConfig = process.env.no_proxy || process.env.npm_config_noproxy;
-    if (noProxyConfig === '*') {
-        return true;
-    }
-    else {
-        const host = new URL(url).host;
-        const noProxyList = noProxyConfig ? noProxyConfig.split(',') : [];
-        return !!noProxyList.find((entry) => entry.startsWith('.') ? host.endsWith(entry) : host.endsWith(`.${entry}`));
+    const proxyFromFioriToolsConfig = proxyFromArgs || proxyFromConfig || process.env.FIORI_TOOLS_PROXY;
+    if (proxyFromFioriToolsConfig) {
+        process.env.npm_config_proxy = proxyFromFioriToolsConfig;
+        process.env.npm_config_https_proxy = proxyFromFioriToolsConfig;
     }
-};
-exports.isHostExcludedFromProxy = isHostExcludedFromProxy;
+}
+exports.updateProxyEnv = updateProxyEnv;
 //# sourceMappingURL=config.js.map

package/dist/base/proxy.js

@@ -23,6 +23,7 @@ const i18n_json_1 = __importDefault(require("./i18n.json"));
 const store_1 = require("@sap-ux/store");
 const config_1 = require("./config");
 const bsp_1 = require("../ext/bsp");
+const proxy_from_env_1 = require("proxy-from-env");
 /**
  * Collection of custom event handler for the proxy.
  */
@@ -333,8 +334,10 @@ function generateProxyMiddlewareOptions(backend, options = {}, logger = new logg
         if (!proxyOptions.target) {
             throw new Error(`Unable to determine target from configuration:\n${JSON.stringify(backend, null, 2)}`);
         }
-        backend.proxy = config_1.getCorporateProxyServer(backend.proxy);
-        if (backend.proxy && !config_1.isHostExcludedFromProxy(proxyOptions.target)) {
+        // update proxy config with values coming from args or ui5.yaml
+        config_1.updateProxyEnv(backend.proxy);
+        backend.proxy = proxy_from_env_1.getProxyForUrl(proxyOptions.target);
+        if (backend.proxy) {
             proxyOptions.agent = new https_proxy_agent_1.HttpsProxyAgent(backend.proxy);
         }
         logger.info(`Backend proxy created for ${proxyOptions.target} ${backend.path ? backend.path : ''}`);

package/package.json

@@ -9,7 +9,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Abackend-proxy-middleware"
   },
-  "version": "0.6.26",
+  "version": "0.6.28",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -21,7 +21,7 @@
     "!dist/**/*.map"
   ],
   "dependencies": {
-    "@sap-ux/axios-extension": "0.10.2",
+    "@sap-ux/axios-extension": "0.10.3",
     "@sap-ux/btp-utils": "0.11.2",
     "@sap-ux/logger": "0.3.1",
     "@sap-ux/store": "0.3.5",
@@ -30,12 +30,14 @@
     "http-proxy-middleware": "2.0.1",
     "https-proxy-agent": "5.0.0",
     "i18next": "20.3.2",
-    "prompts": "2.4.2"
+    "prompts": "2.4.2",
+    "proxy-from-env": "1.1.0"
   },
   "devDependencies": {
     "@types/express": "4.17.13",
     "@types/http-proxy": "^1.17.5",
     "@types/prompts": "2.0.14",
+    "@types/proxy-from-env": "1.0.1",
     "@types/supertest": "2.0.12",
     "express": "4.17.2",
     "nock": "13.2.4",