@sap-ux/ui5-proxy-middleware 1.1.9 → 1.1.10

package/dist/base/proxy.d.ts

@@ -1,4 +1,4 @@
-import type { Options } from 'http-proxy-middleware';
+import type { Filter, Options } from 'http-proxy-middleware';
 import type { ProxyConfig } from './types';
 /**
  * Function for proxying UI5 sources.
@@ -8,5 +8,5 @@ import type { ProxyConfig } from './types';
  * @param filter - custom filter function which will be applied to all requests
  * @returns Proxy function to use
  */
-export declare const ui5Proxy: (config: ProxyConfig, options?: Options | undefined, filter?: string | string[] | ((pathname: string, req: import("http-proxy-middleware/dist/types").Request) => boolean) | undefined) => import("http-proxy-middleware").RequestHandler;
+export declare const ui5Proxy: (config: ProxyConfig, options?: Options | undefined, filter?: Filter | undefined) => import("http-proxy-middleware").RequestHandler;
 //# sourceMappingURL=proxy.d.ts.map

package/dist/base/proxy.js

@@ -12,7 +12,7 @@ const logger_1 = require("@sap-ux/logger");
  * @param filter - custom filter function which will be applied to all requests
  * @returns Proxy function to use
  */
-exports.ui5Proxy = (config, options, filter) => {
+const ui5Proxy = (config, options, filter) => {
     const logger = new logger_1.ToolsLogger({
         transports: [new logger_1.UI5ToolingTransport({ moduleName: 'ui5-proxy-middleware' })]
     });
@@ -40,4 +40,5 @@ exports.ui5Proxy = (config, options, filter) => {
     }
     return http_proxy_middleware_1.createProxyMiddleware(proxyFilter, proxyConfig);
 };
+exports.ui5Proxy = ui5Proxy;
 //# sourceMappingURL=proxy.js.map

package/dist/base/utils.d.ts

@@ -41,11 +41,11 @@ export declare const hideProxyCredentials: (proxy: string | undefined) => string
 /**
  * Checks if a host is excluded from user's corporate proxy.
  *
- * @param noProxyConfig - user's no_proxy configuration
  * @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
  */
-export declare const isHostExcludedFromProxy: (noProxyConfig: string | undefined, url: string) => boolean;
+export declare const isHostExcludedFromProxy: (url: string, noProxyConfig?: string | undefined) => boolean;
 /**
  * Returns the name of html file, which is used to preview the application, from the URL.
  *

package/dist/base/utils.js

@@ -22,10 +22,11 @@ const i18n_1 = require("../i18n");
  * @param proxyRes - proxy response object
  * @param etag - ETag for the cached sources, normally the UI5 version
  */
-exports.proxyResponseHandler = (proxyRes, etag) => {
+const proxyResponseHandler = (proxyRes, etag) => {
     proxyRes.headers['Etag'] = etag;
     proxyRes.headers['cache-control'] = 'no-cache';
 };
+exports.proxyResponseHandler = proxyResponseHandler;
 /**
  * Handler for the proxy request event.
  * Re-validates the cached UI5 sources based on the ETag.
@@ -36,20 +37,21 @@ exports.proxyResponseHandler = (proxyRes, etag) => {
  * @param etag - Etag of the cached UI5 sources, normally the UI5 version
  * @param logger - Logger for loging the requests
  */
-exports.proxyRequestHandler = (proxyReq, res, etag, logger) => {
+const proxyRequestHandler = (proxyReq, res, etag, logger) => {
     logger.info(proxyReq.path);
     if (proxyReq.getHeader('if-none-match') === etag) {
         res.statusCode = 304;
         res.end();
     }
 };
+exports.proxyRequestHandler = proxyRequestHandler;
 /**
  * Get user's proxy configuration.
  *
  * @param yamlProxyServer - proxy server config from yaml file
  * @returns User's proxy configuration or undefined
  */
-exports.getCorporateProxyServer = (yamlProxyServer) => {
+const getCorporateProxyServer = (yamlProxyServer) => {
     return (yamlProxyServer ||
         process.env.FIORI_TOOLS_PROXY ||
         process.env.http_proxy ||
@@ -59,13 +61,14 @@ exports.getCorporateProxyServer = (yamlProxyServer) => {
         process.env.npm_config_proxy ||
         process.env.npm_config_https_proxy);
 };
+exports.getCorporateProxyServer = getCorporateProxyServer;
 /**
  * Hides the proxy credentials for displaying the proxy configuration in the console.
  *
  * @param proxy - user's proxy server
  * @returns proxy with hidden credentials for displaying in the console
  */
-exports.hideProxyCredentials = (proxy) => {
+const hideProxyCredentials = (proxy) => {
     if (proxy) {
         const forwardSlashIndex = proxy.indexOf('//');
         const atIndex = proxy.indexOf('@');
@@ -75,14 +78,15 @@ exports.hideProxyCredentials = (proxy) => {
     }
     return proxy;
 };
+exports.hideProxyCredentials = hideProxyCredentials;
 /**
  * Checks if a host is excluded from user's corporate proxy.
  *
- * @param noProxyConfig - user's no_proxy configuration
  * @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
  */
-exports.isHostExcludedFromProxy = (noProxyConfig, url) => {
+const isHostExcludedFromProxy = (url, noProxyConfig = process.env.no_proxy || process.env.npm_config_noproxy) => {
     if (noProxyConfig === '*') {
         return true;
     }
@@ -92,13 +96,14 @@ exports.isHostExcludedFromProxy = (noProxyConfig, url) => {
         return !!noProxyList.find((entry) => entry.startsWith('.') ? host.endsWith(entry) : host.endsWith(`.${entry}`));
     }
 };
+exports.isHostExcludedFromProxy = isHostExcludedFromProxy;
 /**
  * Returns the name of html file, which is used to preview the application, from the URL.
  *
  * @param url - html request url
  * @returns Name of the html file
  */
-exports.getHtmlFile = (url) => {
+const getHtmlFile = (url) => {
     let html = url;
     if (html.indexOf('?') !== -1) {
         html = html.split('?')[0].replace(/["']/g, '');
@@ -111,13 +116,14 @@ exports.getHtmlFile = (url) => {
     }
     return html;
 };
+exports.getHtmlFile = getHtmlFile;
 /**
  * Returns the name of the yaml file, which is used to for the server configuration, from the runtime arguments.
  *
  * @param args - runtime arguments
  * @returns Name of the YAML file
  */
-exports.getYamlFile = (args) => {
+const getYamlFile = (args) => {
     let yaml = 'ui5.yaml';
     const index = args.indexOf('--config') !== -1 ? args.indexOf('--config') : args.indexOf('-c');
     if (index !== -1) {
@@ -125,13 +131,14 @@ exports.getYamlFile = (args) => {
     }
     return yaml;
 };
+exports.getYamlFile = getYamlFile;
 /**
  * Gets the path to the webapp folder from the YAML file.
  *
  * @param ui5YamlPath - path to the yaml file
  * @returns Path to the webapp folder
  */
-exports.getWebAppFolderFromYaml = (ui5YamlPath) => __awaiter(void 0, void 0, void 0, function* () {
+const getWebAppFolderFromYaml = (ui5YamlPath) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b;
     if (fs_1.existsSync(ui5YamlPath)) {
         const ui5Config = yield ui5_config_1.UI5Config.newInstance(fs_1.readFileSync(ui5YamlPath, { encoding: 'utf8' }));
@@ -141,13 +148,14 @@ exports.getWebAppFolderFromYaml = (ui5YamlPath) => __awaiter(void 0, void 0, voi
         return 'webapp';
     }
 });
+exports.getWebAppFolderFromYaml = getWebAppFolderFromYaml;
 /**
  * Sends HTML content as a response.
  *
  * @param res - The http response object
  * @param html - The HTML content
  */
-exports.setHtmlResponse = (res, html) => {
+const setHtmlResponse = (res, html) => {
     if (res['_livereload']) {
         res.write(html);
         res.end();
@@ -156,13 +164,14 @@ exports.setHtmlResponse = (res, html) => {
         res.status(200).contentType('html').send(html);
     }
 };
+exports.setHtmlResponse = setHtmlResponse;
 /**
  * Gets the manifest.json for a given application.
  *
  * @param args list of runtime arguments
  * @returns The content of the manifest.json
  */
-exports.getManifest = (args) => __awaiter(void 0, void 0, void 0, function* () {
+const getManifest = (args) => __awaiter(void 0, void 0, void 0, function* () {
     const projectRoot = process.cwd();
     const yamlFileName = exports.getYamlFile(args);
     const ui5YamlPath = path_1.join(projectRoot, yamlFileName);
@@ -171,6 +180,7 @@ exports.getManifest = (args) => __awaiter(void 0, void 0, void 0, function* () {
     const manifest = JSON.parse(fs_1.readFileSync(manifestPath, { encoding: 'utf8' }));
     return manifest;
 });
+exports.getManifest = getManifest;
 /**
  * Gets the minUI5Version from the manifest.json.
  *
@@ -255,7 +265,7 @@ exports.injectUI5Url = injectUI5Url;
  * @param next - the next function, used to forward the request to the next available handler
  * @param ui5Configs - the UI5 configuration of the ui5-proxy-middleware
  */
-exports.injectScripts = (req, res, next, ui5Configs) => __awaiter(void 0, void 0, void 0, function* () {
+const injectScripts = (req, res, next, ui5Configs) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         const projectRoot = process.cwd();
         const args = process.argv;
@@ -276,6 +286,7 @@ exports.injectScripts = (req, res, next, ui5Configs) => __awaiter(void 0, void 0
         next(error);
     }
 });
+exports.injectScripts = injectScripts;
 /**
  * Filters comressed html files from UI5 CDN.
  * Avoid ERR_CONTENT_DECODING_FAILED on http request for gzip'd html files.
@@ -285,7 +296,7 @@ exports.injectScripts = (req, res, next, ui5Configs) => __awaiter(void 0, void 0
  * @param req - the http request object
  * @returns True, indicating that the request should be proxied
  */
-exports.filterCompressedHtmlFiles = (_pathname, req) => {
+const filterCompressedHtmlFiles = (_pathname, req) => {
     const acceptHeader = req.headers['accept'] || '';
     if (req.headers['accept-encoding'] &&
         (acceptHeader.includes('text/html') || acceptHeader.includes('application/xhtml+xml'))) {
@@ -293,6 +304,7 @@ exports.filterCompressedHtmlFiles = (_pathname, req) => {
     }
     return true;
 };
+exports.filterCompressedHtmlFiles = filterCompressedHtmlFiles;
 /**
  * Specifically handling errors due to undefined and empty errors.
  *

package/dist/ui5/middleware.js

@@ -12,35 +12,57 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const express_1 = __importDefault(require("express"));
 const https_proxy_agent_1 = require("https-proxy-agent");
 const logger_1 = require("@sap-ux/logger");
 const base_1 = require("../base");
 const dotenv_1 = __importDefault(require("dotenv"));
+/**
+ * Create proxy options based on the middleware config.
+ *
+ * @param logger logger to be used when running the middleware
+ * @param config middleware configuration
+ * @returns options object
+ */
+function createProxyOptions(logger, config) {
+    return {
+        secure: config.secure !== undefined ? !!config.secure : true,
+        logLevel: !!config.debug ? 'debug' : 'info',
+        logProvider: () => logger
+    };
+}
+/**
+ * Creates a function handling the routes the need to be rerouted to a UI5 provider.
+ *
+ * @param routes routes that need to be handled
+ * @returns handler function
+ */
+function createRequestHandler(routes) {
+    return (req, res, next) => {
+        for (const route of routes) {
+            if (req.path.startsWith(route.route)) {
+                return route.handler(req, res, next);
+            }
+        }
+        next();
+    };
+}
 module.exports = ({ options }) => __awaiter(void 0, void 0, void 0, function* () {
     const logger = new logger_1.ToolsLogger({
         transports: [new logger_1.UI5ToolingTransport({ moduleName: 'ui5-proxy-middleware' })]
     });
     dotenv_1.default.config();
-    const router = express_1.default.Router();
     const config = options.configuration;
     const ui5Version = yield base_1.resolveUI5Version(config.version, logger);
     const envUI5Url = process.env.FIORI_TOOLS_UI5_URI;
-    const secure = config.secure !== undefined ? !!config.secure : true;
-    const debug = !!config.debug;
     const directLoad = !!config.directLoad;
-    const noProxyVal = process.env.no_proxy || process.env.npm_config_noproxy;
     const corporateProxyServer = base_1.getCorporateProxyServer(config.proxy);
     // hide user and pass from proxy configuration for displaying it in the terminal
     const proxyInfo = base_1.hideProxyCredentials(corporateProxyServer);
-    const proxyOptions = {
-        secure,
-        logLevel: debug ? 'debug' : 'info',
-        logProvider: () => logger
-    };
-    logger.info(`Starting ui5-proxy-middleware using following configuration:\nproxy: '${proxyInfo}'\nsecure: '${secure}'\ndebug: '${debug}''\ndirectLoad: '${directLoad}'`);
+    const proxyOptions = createProxyOptions(logger, config);
+    logger.info(`Starting ui5-proxy-middleware using following configuration:\nproxy: '${proxyInfo}'\nsecure: '${proxyOptions.secure}'\nlog: '${proxyOptions.logLevel}''\ndirectLoad: '${directLoad}'`);
     const configs = Array.isArray(config.ui5) ? config.ui5 : [config.ui5];
     const ui5Configs = [];
+    const routes = [];
     for (const ui5 of configs) {
         const paths = Array.isArray(ui5.path) ? ui5.path : [ui5.path];
         for (const ui5Path of paths) {
@@ -49,18 +71,21 @@ module.exports = ({ options }) => __awaiter(void 0, void 0, void 0, function* ()
                 url: envUI5Url || ui5.url,
                 version: ui5Version
             };
-            if (corporateProxyServer && !base_1.isHostExcludedFromProxy(noProxyVal, ui5Config.url)) {
+            if (corporateProxyServer && !base_1.isHostExcludedFromProxy(ui5Config.url)) {
                 proxyOptions.agent = new https_proxy_agent_1.HttpsProxyAgent(corporateProxyServer);
             }
-            router.use(ui5Config.path, base_1.ui5Proxy(ui5Config, proxyOptions));
+            routes.push({ route: ui5Config.path, handler: base_1.ui5Proxy(ui5Config, proxyOptions) });
             ui5Configs.push(ui5Config);
         }
     }
     if (directLoad) {
-        router.use(base_1.HTML_MOUNT_PATHS, (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
+        const directLoadProxy = (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
             yield base_1.injectScripts(req, res, next, ui5Configs);
-        }));
+        });
+        base_1.HTML_MOUNT_PATHS.forEach((path) => {
+            routes.push({ route: path, handler: directLoadProxy });
+        });
     }
-    return router;
+    return createRequestHandler(routes);
 });
 //# sourceMappingURL=middleware.js.map

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.9",
+  "version": "1.1.10",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -24,13 +24,13 @@
     "@sap-ux/logger": "0.3.0",
     "@sap-ux/ui5-config": "0.15.0",
     "dotenv": "16.0.0",
-    "express": "4.17.2",
     "http-proxy-middleware": "2.0.1",
     "https-proxy-agent": "5.0.0",
     "i18next": "20.3.2"
   },
   "devDependencies": {
     "@types/express": "4.17.13",
+    "express": "4.17.2",
     "nock": "13.2.4",
     "supertest": "6.2.2",
     "@types/supertest": "2.0.12",