@sap-ux/ui5-proxy-middleware 1.1.12 → 1.1.14

package/README.md

@@ -92,7 +92,7 @@ server:
 ```
 
 ### Adding corporate proxy configuration
-If you are behind a corporate proxy then you can provide your corporate proxy configuration as follows.
+By default the `ui5-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.
 
 ```Yaml
 server:
@@ -107,6 +107,7 @@ server:
         url: https://ui5.sap.com
       proxy: https://my.corporate.proxy.example
 ```
+**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://ui5.sap.com` from the proxy you will need to set `noproxy` to `npm config set noproxy ".sap.com"`. Note the leading `.`, if you provide only `sap.com`, 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 incorporate the `ui5-proxy-middleware` functionality in your own middleware.

package/dist/base/utils.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';
 import type { ToolsLogger } from '@sap-ux/logger';
-import type { Manifest } from '@sap-ux/ui5-config';
+import type { Manifest } from '@sap-ux/project-access';
 import type { NextFunction, Request, Response } from 'express';
 import type { ProxyConfig } from './types';
 import type { Url } from 'url';
@@ -39,13 +39,12 @@ export declare const getCorporateProxyServer: (yamlProxyServer: string | undefin
  */
 export declare const hideProxyCredentials: (proxy: string | undefined) => string | undefined;
 /**
- * Checks if a host is excluded from user's corporate proxy.
+ * Checks if a host should be proxied through user's corporate proxy.
  *
  * @param url - url to be checked
- * @param noProxyConfig - user's no_proxy configuration
- * @returns true if host is excluded from user's corporate server, false otherwise
+ * @returns false if host is excluded from user's corporate server, true otherwise
  */
-export declare const isHostExcludedFromProxy: (url: string, noProxyConfig?: string | undefined) => boolean;
+export declare const isProxyRequired: (url: string) => boolean;
 /**
  * Returns the name of html file, which is used to preview the application, from the URL.
  *

package/dist/base/utils.js

@@ -9,12 +9,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.proxyErrorHandler = exports.filterCompressedHtmlFiles = exports.injectScripts = exports.injectUI5Url = exports.resolveUI5Version = exports.getUI5VersionFromManifest = exports.getManifest = exports.setHtmlResponse = exports.getWebAppFolderFromYaml = exports.getYamlFile = exports.getHtmlFile = exports.isHostExcludedFromProxy = exports.hideProxyCredentials = exports.getCorporateProxyServer = exports.proxyRequestHandler = exports.proxyResponseHandler = void 0;
+exports.proxyErrorHandler = exports.filterCompressedHtmlFiles = exports.injectScripts = exports.injectUI5Url = exports.resolveUI5Version = exports.getUI5VersionFromManifest = exports.getManifest = exports.setHtmlResponse = exports.getWebAppFolderFromYaml = exports.getYamlFile = exports.getHtmlFile = exports.isProxyRequired = exports.hideProxyCredentials = exports.getCorporateProxyServer = exports.proxyRequestHandler = exports.proxyResponseHandler = void 0;
 const ui5_config_1 = require("@sap-ux/ui5-config");
 const fs_1 = require("fs");
 const path_1 = require("path");
 const constants_1 = require("./constants");
 const i18n_1 = require("../i18n");
+const proxy_from_env_1 = require("proxy-from-env");
 /**
  * Handler for the proxy response event.
  * Sets an Etag which will be used for re-validation of the cached UI5 sources.
@@ -52,14 +53,27 @@ exports.proxyRequestHandler = proxyRequestHandler;
  * @returns User's proxy configuration or undefined
  */
 const getCorporateProxyServer = (yamlProxyServer) => {
-    return (yamlProxyServer ||
-        process.env.FIORI_TOOLS_PROXY ||
-        process.env.http_proxy ||
+    let proxyFromArgs;
+    process.argv.forEach((arg) => {
+        if (arg.match(/proxy=/g)) {
+            proxyFromArgs = arg.split('=')[1];
+        }
+    });
+    const proxyFromFioriToolsConfig = proxyFromArgs || yamlProxyServer || process.env.FIORI_TOOLS_PROXY;
+    const proxyFromOSEnvConfig = 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);
+        process.env.npm_config_https_proxy;
+    if (proxyFromFioriToolsConfig) {
+        process.env.npm_config_proxy = proxyFromFioriToolsConfig;
+        process.env.npm_config_https_proxy = proxyFromFioriToolsConfig;
+        return proxyFromFioriToolsConfig;
+    }
+    else {
+        return proxyFromOSEnvConfig;
+    }
 };
 exports.getCorporateProxyServer = getCorporateProxyServer;
 /**
@@ -80,23 +94,15 @@ const hideProxyCredentials = (proxy) => {
 };
 exports.hideProxyCredentials = hideProxyCredentials;
 /**
- * Checks if a host is excluded from user's corporate proxy.
+ * Checks if a host should be proxied through user's corporate proxy.
  *
  * @param url - url to be checked
- * @param noProxyConfig - user's no_proxy configuration
- * @returns true if host is excluded from user's corporate server, false otherwise
+ * @returns false if host is excluded from user's corporate server, true otherwise
  */
-const isHostExcludedFromProxy = (url, 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 isProxyRequired = (url) => {
+    return proxy_from_env_1.getProxyForUrl(url) ? true : false;
 };
-exports.isHostExcludedFromProxy = isHostExcludedFromProxy;
+exports.isProxyRequired = isProxyRequired;
 /**
  * Returns the name of html file, which is used to preview the application, from the URL.
  *

package/dist/ui5/middleware.js

@@ -72,7 +72,7 @@ module.exports = ({ options }) => __awaiter(void 0, void 0, void 0, function* ()
                 url: envUI5Url || ui5.url,
                 version: ui5Version
             };
-            if (corporateProxyServer && !base_1.isHostExcludedFromProxy(ui5Config.url)) {
+            if (corporateProxyServer && base_1.isProxyRequired(ui5Config.url)) {
                 proxyOptions.agent = new https_proxy_agent_1.HttpsProxyAgent(corporateProxyServer);
             }
             routes.push({ route: ui5Config.path, handler: base_1.ui5Proxy(ui5Config, proxyOptions) });

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%3Aui5-proxy-middleware"
   },
-  "version": "1.1.12",
+  "version": "1.1.14",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -22,18 +22,21 @@
   ],
   "dependencies": {
     "@sap-ux/logger": "0.3.1",
-    "@sap-ux/ui5-config": "0.15.2",
+    "@sap-ux/ui5-config": "0.15.3",
     "dotenv": "16.0.0",
     "http-proxy-middleware": "2.0.1",
     "https-proxy-agent": "5.0.0",
-    "i18next": "20.3.2"
+    "i18next": "20.3.2",
+    "proxy-from-env": "1.1.0"
   },
   "devDependencies": {
+    "@sap-ux/project-access": "1.0.0",
     "@types/express": "4.17.13",
+    "@types/supertest": "2.0.12",
+    "@types/proxy-from-env": "1.0.1",
     "express": "4.17.2",
     "nock": "13.2.4",
     "supertest": "6.2.2",
-    "@types/supertest": "2.0.12",
     "yaml": "2.0.0-10"
   },
   "ui5": {