@sap-ux/backend-proxy-middleware 0.9.18 → 0.10.0

package/dist/base/proxy.d.ts

@@ -1,11 +1,14 @@
 import type { ServerOptions } from 'http-proxy';
 import type { RequestHandler, Options } from 'http-proxy-middleware';
 import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';
-import type { Logger } from '@sap-ux/logger';
-import { ToolsLogger } from '@sap-ux/logger';
+import { ToolsLogger, type Logger } from '@sap-ux/logger';
 import type { BackendConfig, DestinationBackendConfig } from './types';
 import type { BackendSystem } from '@sap-ux/store';
 import type { Url } from 'url';
+import type { Socket } from 'node:net';
+import type { Request } from 'express';
+import type connect from 'connect';
+export type EnhancedIncomingMessage = (IncomingMessage & Pick<Request, 'originalUrl'>) | connect.IncomingMessage;
 /**
  * Collection of custom event handler for the proxy.
  */
@@ -18,7 +21,7 @@ export declare const ProxyEventHandlers: {
      * @param _res (not used)
      * @param _options (not used)
      */
-    onProxyReq(proxyReq: ClientRequest, _req?: IncomingMessage, _res?: ServerResponse, _options?: ServerOptions): void;
+    proxyReq(proxyReq: ClientRequest, _req?: IncomingMessage, _res?: ServerResponse, _options?: ServerOptions): void;
     /**
      * Retrieve the set-cookie headers from the response and transform secure cookies to insecure ones.
      *
@@ -26,7 +29,7 @@ export declare const ProxyEventHandlers: {
      * @param _req (not used) original request
      * @param _res (not used)
      */
-    onProxyRes(proxyRes: IncomingMessage, _req?: IncomingMessage, _res?: ServerResponse): void;
+    proxyRes(proxyRes: IncomingMessage, _req?: IncomingMessage, _res?: ServerResponse): void;
 };
 /**
  * Specifically handling errors due to unsigned certificates and empty errors.
@@ -42,13 +45,13 @@ export declare function proxyErrorHandler(err: Error & {
 }, req: IncomingMessage & {
     next?: Function;
     originalUrl?: string;
-}, logger: ToolsLogger, _res?: ServerResponse, _target?: string | Partial<Url>): void;
+}, logger: ToolsLogger, _res?: ServerResponse | Socket, _target?: string | Partial<Url>): void;
 /**
  * Collection of path rewrite functions.
  */
 export declare const PathRewriters: {
     /**
-     * Generates a rewrite funtion that replace the match string with the prefix in the given string.
+     * Generates a rewrite function that replaces the matched string with the prefix in the given string.
      *
      * @param match part of the path that is to be replaced
      * @param prefix new path that is used as replacement
@@ -69,7 +72,7 @@ export declare const PathRewriters: {
      * @param log logger instance
      * @returns a path rewrite function
      */
-    getPathRewrite(config: BackendConfig, log: Logger): ((path: string) => string) | undefined;
+    getPathRewrite(config: BackendConfig, log: Logger): (path: string, req: IncomingMessage) => string;
 };
 /**
  * Initialize i18next with the translations for this module.

package/dist/base/proxy.js

@@ -33,7 +33,7 @@ exports.ProxyEventHandlers = {
      * @param _res (not used)
      * @param _options (not used)
      */
-    onProxyReq(proxyReq, _req, _res, _options) {
+    proxyReq(proxyReq, _req, _res, _options) {
         if (proxyReq.path?.includes('Fiorilaunchpad.html') && !proxyReq.headersSent) {
             proxyReq.setHeader('accept-encoding', '*');
         }
@@ -45,7 +45,7 @@ exports.ProxyEventHandlers = {
      * @param _req (not used) original request
      * @param _res (not used)
      */
-    onProxyRes(proxyRes, _req, _res) {
+    proxyRes(proxyRes, _req, _res) {
         const header = proxyRes?.headers?.['set-cookie'];
         if (header?.length) {
             for (let i = header.length - 1; i >= 0; i--) {
@@ -108,7 +108,7 @@ async function getApiHubKey(logger) {
  */
 exports.PathRewriters = {
     /**
-     * Generates a rewrite funtion that replace the match string with the prefix in the given string.
+     * Generates a rewrite function that replaces the matched string with the prefix in the given string.
      *
      * @param match part of the path that is to be replaced
      * @param prefix new path that is used as replacement
@@ -143,6 +143,11 @@ exports.PathRewriters = {
      */
     getPathRewrite(config, log) {
         const functions = [];
+        functions.push((path, req) => {
+            // ensure that the path starts with the configured path
+            // it might get lost when you nest router instances
+            return req.originalUrl?.includes(path) ? req.originalUrl : path;
+        });
         if (config.pathReplace) {
             functions.push(exports.PathRewriters.replacePrefix(config.path, config.pathReplace));
         }
@@ -150,9 +155,11 @@ exports.PathRewriters = {
             functions.push(exports.PathRewriters.replaceClient(config.client));
         }
         if (functions.length > 0) {
-            return (path) => {
+            return (path, req) => {
                 let newPath = path;
-                functions.forEach((func) => (newPath = func(newPath)));
+                for (const func of functions) {
+                    newPath = func(newPath, req);
+                }
                 if (newPath !== path) {
                     log.info(`Rewrite path ${path} > ${newPath}`);
                 }
@@ -210,7 +217,7 @@ async function enhanceConfigsForDestination(proxyOptions, backend) {
             }
         }
         else {
-            throw new Error();
+            throw new Error('Destination not found. Please check your configuration or user role assignment.');
         }
     }
 }
@@ -262,20 +269,23 @@ async function enhanceConfigForSystem(proxyOptions, system, oAuthRequired, token
  * @param logger optional logger instance
  * @returns options for the http-proxy-middleware
  */
-async function generateProxyMiddlewareOptions(backend, options = {}, logger = new logger_1.ToolsLogger()) {
+async function generateProxyMiddlewareOptions(backend, options = {}, logger = new logger_1.ToolsLogger({
+    transports: [new logger_1.UI5ToolingTransport({ moduleName: 'backend-proxy-middleware' })]
+})) {
     // add required options
     const proxyOptions = {
         headers: {},
-        ...exports.ProxyEventHandlers,
-        onError: (err, req, res, target) => {
-            proxyErrorHandler(err, req, logger, res, target);
+        on: {
+            error: (err, req, res, target) => {
+                proxyErrorHandler(err, req, logger, res, target);
+            },
+            ...exports.ProxyEventHandlers
         },
-        ...options
+        ...options,
+        changeOrigin: true,
+        target: backend.url,
+        pathRewrite: exports.PathRewriters.getPathRewrite(backend, logger)
     };
-    proxyOptions.changeOrigin = true;
-    proxyOptions.logProvider = () => logger;
-    // always set the target to the url provided in yaml
-    proxyOptions.target = backend.url;
     // overwrite url if running in AppStudio
     if ((0, btp_utils_1.isAppStudio)()) {
         const destBackend = backend;
@@ -317,7 +327,6 @@ async function generateProxyMiddlewareOptions(backend, options = {}, logger = ne
     if (!proxyOptions.auth && process.env.FIORI_TOOLS_USER && process.env.FIORI_TOOLS_PASSWORD) {
         proxyOptions.auth = `${process.env.FIORI_TOOLS_USER}:${process.env.FIORI_TOOLS_PASSWORD}`;
     }
-    proxyOptions.pathRewrite = exports.PathRewriters.getPathRewrite(backend, logger);
     if (backend.bsp) {
         await (0, bsp_1.addOptionsForEmbeddedBSP)(backend.bsp, proxyOptions, logger);
     }
@@ -336,7 +345,7 @@ async function generateProxyMiddlewareOptions(backend, options = {}, logger = ne
     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 : ''}`);
+    logger.info(`Backend proxy created for ${proxyOptions.target}`);
     return proxyOptions;
 }
 /**

package/dist/base/types.d.ts

@@ -59,6 +59,7 @@ export type BackendConfig = LocalBackendConfig | DestinationBackendConfig;
 export interface BackendMiddlewareConfig {
     backend: BackendConfig;
     options?: Partial<Options>;
+    debug?: boolean;
 }
 export interface MiddlewareParameters<T> {
     resources: object;

package/dist/ext/bsp.js

@@ -28,13 +28,13 @@ function convertAppDescriptorToManifest(bsp) {
  */
 async function promptUserPass(log) {
     if ((0, btp_utils_1.isAppStudio)()) {
-        const { authNeeded } = await (0, prompts_1.default)([
+        const { authNeeded } = (await (0, prompts_1.default)([
             {
                 type: 'confirm',
                 name: 'authNeeded',
                 message: `${(0, chalk_1.cyan)(i18next_1.default.t('info.authNeeded'))}\n\n`
             }
-        ]);
+        ]));
         if (!authNeeded) {
             return undefined;
         }
@@ -42,7 +42,7 @@ async function promptUserPass(log) {
     else {
         log.info((0, chalk_1.yellow)(i18next_1.default.t('info.credentialsRequiredForFLP')));
     }
-    const { username, password } = await (0, prompts_1.default)([
+    const { username, password } = (await (0, prompts_1.default)([
         {
             type: 'text',
             name: 'username',
@@ -74,7 +74,7 @@ async function promptUserPass(log) {
             log.info((0, chalk_1.yellow)(i18next_1.default.t('info.operationAborted')));
             return process.exit(1);
         }
-    });
+    }));
     return `${username}:${password}`;
 }
 /**
@@ -88,8 +88,11 @@ async function addOptionsForEmbeddedBSP(bspPath, proxyOptions, logger) {
     const regex = new RegExp('(' + bspPath + '/manifest\\.appdescr\\b)', 'i');
     proxyOptions.router = (req) => {
         // redirects the request for manifest.appdescr to localhost
-        if (req.path.match(regex)) {
-            return req.protocol + '://' + req.headers.host;
+        if (req.url?.match(regex)) {
+            const protocol = 'protocol' in req
+                ? req.protocol
+                : req.headers.referer?.substring(0, req.headers.referer.indexOf(':')) ?? 'http';
+            return protocol + '://' + req.headers.host;
         }
         else {
             return undefined;

package/dist/middleware.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const dotenv_1 = __importDefault(require("dotenv"));
 const logger_1 = require("@sap-ux/logger");
+const express_1 = __importDefault(require("express"));
 const http_proxy_middleware_1 = require("http-proxy-middleware");
 const proxy_1 = require("./base/proxy");
 /**
@@ -21,10 +22,11 @@ function formatProxyForLogging(proxy) {
             proxy = proxy.replace(proxy.slice(forwardSlashIndex + 2, atIndex), '***:***');
         }
     }
+    // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
     return proxy || 'none';
 }
 /**
- * UI5 middleware allowing to to proxy backends.
+ * UI5 middleware allowing to proxy backends.
  *
  * @param params input parameters for UI5 middleware
  * @param params.options configuration options
@@ -32,28 +34,25 @@ function formatProxyForLogging(proxy) {
  */
 module.exports = async ({ options }) => {
     const logger = new logger_1.ToolsLogger({
+        logLevel: options.configuration?.debug ? logger_1.LogLevel.Debug : logger_1.LogLevel.Info,
         transports: [new logger_1.UI5ToolingTransport({ moduleName: 'backend-proxy-middleware' })]
     });
     await (0, proxy_1.initI18n)();
     dotenv_1.default.config();
+    const router = express_1.default.Router();
     const backend = options.configuration.backend;
     const configOptions = options.configuration.options ?? {};
     configOptions.secure = configOptions.secure !== undefined ? !!configOptions.secure : true;
+    configOptions.logger = options.configuration?.debug ? logger : undefined;
     try {
         const proxyOptions = await (0, proxy_1.generateProxyMiddlewareOptions)(options.configuration.backend, configOptions, logger);
         const proxyFn = (0, http_proxy_middleware_1.createProxyMiddleware)(proxyOptions);
         logger.info(`Starting backend-proxy-middleware using following configuration:\nbackend: ${JSON.stringify({
             ...backend,
             proxy: formatProxyForLogging(backend.proxy)
-        })}\noptions: ${JSON.stringify(configOptions)}'`);
-        return (req, res, next) => {
-            if (req.path.startsWith(backend.path)) {
-                proxyFn(req, res, next);
-            }
-            else {
-                next();
-            }
-        };
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        })}\noptions: ${JSON.stringify(({ logger, ...rest } = configOptions) => rest)}'\nlog: '${options.configuration?.debug ? 'debug' : 'info'}'`);
+        return router.use(backend.path, proxyFn);
     }
     catch (e) {
         const message = `Failed to register backend for ${backend.path}. Check configuration in yaml file. \n\t${e}`;

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.9.18",
+  "version": "0.10.0",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -23,13 +23,13 @@
   "dependencies": {
     "chalk": "4.1.2",
     "dotenv": "16.3.1",
-    "http-proxy-middleware": "2.0.9",
+    "http-proxy-middleware": "3.0.5",
     "https-proxy-agent": "5.0.1",
     "i18next": "25.3.0",
     "prompts": "2.4.2",
     "proxy-from-env": "1.1.0",
-    "@sap-ux/axios-extension": "1.22.8",
-    "@sap-ux/btp-utils": "1.1.2",
+    "@sap-ux/axios-extension": "1.22.9",
+    "@sap-ux/btp-utils": "1.1.3",
     "@sap-ux/logger": "0.7.0",
     "@sap-ux/store": "1.1.4"
   },
@@ -42,7 +42,9 @@
     "express": "4.21.2",
     "nock": "13.4.0",
     "supertest": "7.1.4",
-    "yaml": "2.2.2"
+    "yaml": "2.2.2",
+    "connect": "^3.7.0",
+    "@types/connect": "^3.4.38"
   },
   "ui5": {
     "dependencies": []