@sap-ux/backend-proxy-middleware 0.6.11 → 0.6.14

package/dist/base/i18n.json

@@ -9,6 +9,7 @@
     "error": {
         "emptyUsername": "Username can not be empty.",
         "emptyPassword": "Password can not be empty.",
-        "sslProxy": "You are trying to connect to a server with a self signed certificate. Please check (https://help.sap.com/viewer/17d50220bcd848aa854c9c182d65b699/Latest/en-US/4b318bede7eb4021a8be385c46c74045.html) for guidance."
+        "sslProxy": "You are trying to connect to a server with a self signed certificate. Please check (https://help.sap.com/viewer/17d50220bcd848aa854c9c182d65b699/Latest/en-US/4b318bede7eb4021a8be385c46c74045.html) for guidance.",
+        "noCodeError": "Error {{-error}} thrown for request {{-request}}"
     }
 }

package/dist/base/proxy.d.ts

@@ -3,6 +3,7 @@ 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 type { BackendConfig, DestinationBackendConfig } from './types';
 import type { BackendSystem } from '@sap-ux/store';
 import type { Url } from 'url';
@@ -27,20 +28,22 @@ export declare const ProxyEventHandlers: {
      * @param _res (not used)
      */
     onProxyRes(proxyRes: IncomingMessage, _req?: IncomingMessage | undefined, _res?: ServerResponse | undefined): void;
-    /**
-     * Specifically handling errors due to unsigned certificates.
-     *
-     * @param err the error thrown when proxying the request or processing the response
-     * @param req request causing the error
-     * @param _res (not used)
-     * @param _target (not used)
-     */
-    onError(err: Error & {
-        code?: string;
-    }, req: IncomingMessage & {
-        next?: Function;
-    }, _res?: ServerResponse | undefined, _target?: string | Partial<Url> | undefined): void;
 };
+/**
+ * Specifically handling errors due to unsigned certificates and empty errors.
+ *
+ * @param err the error thrown when proxying the request or processing the response
+ * @param req request causing the error
+ * @param logger logger instance
+ * @param _res (not used)
+ * @param _target (not used)
+ */
+export declare function proxyErrorHandler(err: Error & {
+    code?: string;
+}, req: IncomingMessage & {
+    next?: Function;
+    originalUrl?: string;
+}, logger: ToolsLogger, _res?: ServerResponse, _target?: string | Partial<Url>): void;
 /**
  * Collection of path rewrite functions.
  */
@@ -101,7 +104,7 @@ export declare function enhanceConfigForSystem(proxyOptions: Options & {
  * @param logger optional logger instance
  * @returns options for the http-proxy-middleware
  */
-export declare function generateProxyMiddlewareOptions(backend: BackendConfig, options?: Options, logger?: Logger): Promise<Options>;
+export declare function generateProxyMiddlewareOptions(backend: BackendConfig, options?: Options, logger?: ToolsLogger): Promise<Options>;
 /**
  * Generate an instance of the proxy middleware based on the input.
  *
@@ -110,5 +113,5 @@ export declare function generateProxyMiddlewareOptions(backend: BackendConfig, o
  * @param logger optional logger instance
  * @returns an instance of http-proxy-middleware
  */
-export declare function createProxy(backend: BackendConfig, options?: Options, logger?: Logger): Promise<RequestHandler>;
+export declare function createProxy(backend: BackendConfig, options?: Options, logger?: ToolsLogger): Promise<RequestHandler>;
 //# sourceMappingURL=proxy.d.ts.map

package/dist/base/proxy.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createProxy = exports.generateProxyMiddlewareOptions = exports.enhanceConfigForSystem = exports.enhanceConfigsForDestination = exports.initI18n = exports.PathRewriters = exports.ProxyEventHandlers = void 0;
+exports.createProxy = exports.generateProxyMiddlewareOptions = exports.enhanceConfigForSystem = exports.enhanceConfigsForDestination = exports.initI18n = exports.PathRewriters = exports.proxyErrorHandler = exports.ProxyEventHandlers = void 0;
 const https_proxy_agent_1 = require("https-proxy-agent");
 const http_proxy_middleware_1 = require("http-proxy-middleware");
 const i18next_1 = __importDefault(require("i18next"));
@@ -56,33 +56,39 @@ exports.ProxyEventHandlers = {
                 header[i] = cookie;
             }
         }
-    },
-    /**
-     * Specifically handling errors due to unsigned certificates.
-     *
-     * @param err the error thrown when proxying the request or processing the response
-     * @param req request causing the error
-     * @param _res (not used)
-     * @param _target (not used)
-     */
-    onError(err, req, _res, _target) {
-        if (err) {
-            let error;
-            if (err.code === 'UNABLE_TO_GET_ISSUER_CERT_LOCALLY') {
-                error = new Error(i18next_1.default.t('error.sslProxy'));
-            }
-            else {
-                error = err;
-            }
-            if (typeof req.next === 'function') {
-                req.next(error);
-            }
-            else {
-                throw error;
-            }
-        }
     }
 };
+/**
+ * Specifically handling errors due to unsigned certificates and empty errors.
+ *
+ * @param err the error thrown when proxying the request or processing the response
+ * @param req request causing the error
+ * @param logger logger instance
+ * @param _res (not used)
+ * @param _target (not used)
+ */
+function proxyErrorHandler(err, req, logger, _res, _target) {
+    var _a;
+    if (err && ((_a = err.stack) === null || _a === void 0 ? void 0 : _a.toLowerCase()) !== 'error') {
+        let error;
+        if (err.code === 'UNABLE_TO_GET_ISSUER_CERT_LOCALLY') {
+            error = new Error(i18next_1.default.t('error.sslProxy'));
+        }
+        else {
+            error = err;
+        }
+        if (typeof req.next === 'function') {
+            req.next(error);
+        }
+        else {
+            throw error;
+        }
+    }
+    else {
+        logger.debug(i18next_1.default.t('error.noCodeError', { error: JSON.stringify(err, null, 2), request: req.originalUrl }));
+    }
+}
+exports.proxyErrorHandler = proxyErrorHandler;
 /**
  * Return the SAP API Hub key either provided as environment variable (including .env file) or from the secure store when not running in AppStudio.
  * not found or error while extracting the key.
@@ -163,7 +169,11 @@ exports.PathRewriters = {
             };
         }
         else {
-            return undefined;
+            // Display request path even if it was not rewritten
+            return (path) => {
+                log.info(path);
+                return path;
+            };
         }
     }
 };
@@ -194,6 +204,7 @@ exports.initI18n = initI18n;
  * @param backend reference to the backend configuration that the the function may enhance
  */
 function enhanceConfigsForDestination(proxyOptions, backend) {
+    var _a;
     return __awaiter(this, void 0, void 0, function* () {
         proxyOptions.target = btp_utils_1.getDestinationUrlForAppStudio(backend.destination);
         if (backend.destinationInstance) {
@@ -205,10 +216,8 @@ function enhanceConfigsForDestination(proxyOptions, backend) {
             if (destination) {
                 // in case of a full url destination remove the path defined in the destination from the forwarded call
                 if (btp_utils_1.isFullUrlDestination(destination)) {
-                    const destPath = new URL(destination.Host).pathname.replace(/\/$/, '');
-                    if (backend.path.startsWith(destPath) && !backend.pathReplace) {
-                        backend.pathReplace = backend.path.replace(destPath, '');
-                    }
+                    backend.path = new URL(destination.Host).pathname.replace(/\/$/, '');
+                    backend.pathReplace = (_a = backend.pathReplace) !== null && _a !== void 0 ? _a : '/';
                 }
             }
             else {
@@ -271,7 +280,9 @@ function generateProxyMiddlewareOptions(backend, options = {}, logger = new logg
     var _a;
     return __awaiter(this, void 0, void 0, function* () {
         // add required options
-        const proxyOptions = Object.assign(Object.assign({ headers: {} }, exports.ProxyEventHandlers), options);
+        const proxyOptions = Object.assign(Object.assign(Object.assign({ headers: {} }, exports.ProxyEventHandlers), { onError: (err, req, res, target) => {
+                proxyErrorHandler(err, req, logger, res, target);
+            } }), options);
         proxyOptions.changeOrigin = true;
         proxyOptions.logProvider = () => logger;
         // always set the target to the url provided in yaml

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.11",
+  "version": "0.6.14",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -21,8 +21,8 @@
     "!dist/**/*.map"
   ],
   "dependencies": {
-    "@sap-ux/axios-extension": "0.9.0",
-    "@sap-ux/btp-utils": "0.10.3",
+    "@sap-ux/axios-extension": "0.9.2",
+    "@sap-ux/btp-utils": "0.10.4",
     "@sap-ux/logger": "0.2.2",
     "@sap-ux/store": "0.3.2",
     "chalk": "4.1.2",