@sap-ux/backend-proxy-middleware 0.5.0

package/dist/middleware.js

@@ -0,0 +1,69 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const dotenv_1 = __importDefault(require("dotenv"));
+const logger_1 = require("@sap-ux/logger");
+const express_1 = require("express");
+const http_proxy_middleware_1 = require("http-proxy-middleware");
+const proxy_1 = require("./base/proxy");
+const bsp_1 = require("./ext/bsp");
+/**
+ * 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
+ */
+function formatProxyForLogging(proxy) {
+    if (proxy) {
+        const forwardSlashIndex = proxy.indexOf('//');
+        const atIndex = proxy.indexOf('@');
+        if (forwardSlashIndex !== -1 && atIndex !== -1) {
+            proxy = proxy.replace(proxy.slice(forwardSlashIndex + 2, atIndex), '***:***');
+        }
+    }
+    return proxy || 'none';
+}
+/**
+ * UI5 middleware allowing to to proxy backends.
+ *
+ * @param params input parameters for UI5 middleware
+ * @param params.options configuration options
+ */
+module.exports = ({ options }) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    const logger = new logger_1.ToolsLogger({
+        transports: [new logger_1.UI5ToolingTransport({ moduleName: 'backend-proxy-middleware' })]
+    });
+    yield proxy_1.initI18n();
+    dotenv_1.default.config();
+    const router = express_1.Router();
+    const backend = options.configuration.backend;
+    const configOptions = (_a = options.configuration.options) !== null && _a !== void 0 ? _a : {};
+    configOptions.secure = configOptions.secure !== undefined ? !!configOptions.secure : true;
+    try {
+        const proxyOptions = yield proxy_1.generateProxyMiddlewareOptions(options.configuration.backend, configOptions, logger);
+        if (backend.bsp) {
+            bsp_1.addOptionsForEmbeddedBSP(backend.bsp, proxyOptions, logger);
+        }
+        router.use(backend.path, http_proxy_middleware_1.createProxyMiddleware(proxyOptions));
+        logger.info(`Starting backend-proxy-middleware using following configuration:\nbackend: ${JSON.stringify(Object.assign(Object.assign({}, backend), { proxy: formatProxyForLogging(backend.proxy) }))}\noptions: ${JSON.stringify(configOptions)}'`);
+    }
+    catch (e) {
+        const message = `Failed to register backend for ${backend.path}. Check configuration in yaml file. \n\t${e}`;
+        logger.error(message);
+        throw new Error(message);
+    }
+    return router;
+});
+//# sourceMappingURL=middleware.js.map

package/dist/middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware.js","sourceRoot":"","sources":["../src/middleware.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,oDAA4B;AAC5B,2CAAkE;AAElE,qCAAiD;AACjD,iEAA8D;AAE9D,wCAAwE;AACxE,mCAAqD;AAErD;;;;;GAKG;AACH,SAAS,qBAAqB,CAAC,KAAyB;IACpD,IAAI,KAAK,EAAE;QACP,MAAM,iBAAiB,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEnC,IAAI,iBAAiB,KAAK,CAAC,CAAC,IAAI,OAAO,KAAK,CAAC,CAAC,EAAE;YAC5C,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,iBAAiB,GAAG,CAAC,EAAE,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC;SACjF;KACJ;IACD,OAAO,KAAK,IAAI,MAAM,CAAC;AAC3B,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,GAAG,CAAO,EAAE,OAAO,EAAiD,EAA2B,EAAE;;IAC3G,MAAM,MAAM,GAAG,IAAI,oBAAW,CAAC;QAC3B,UAAU,EAAE,CAAC,IAAI,4BAAmB,CAAC,EAAE,UAAU,EAAE,0BAA0B,EAAE,CAAC,CAAC;KACpF,CAAC,CAAC;IAEH,MAAM,gBAAQ,EAAE,CAAC;IACjB,gBAAM,CAAC,MAAM,EAAE,CAAC;IAEhB,MAAM,MAAM,GAAG,gBAAY,EAAE,CAAC;IAC9B,MAAM,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC;IAC9C,MAAM,aAAa,SAAG,OAAO,CAAC,aAAa,CAAC,OAAO,mCAAI,EAAE,CAAC;IAC1D,aAAa,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;IAE1F,IAAI;QACA,MAAM,YAAY,GAAG,MAAM,sCAA8B,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;QAChH,IAAI,OAAO,CAAC,GAAG,EAAE;YACb,8BAAwB,CAAC,OAAO,CAAC,GAAG,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;SAC/D;QACD,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,6CAAqB,CAAC,YAAY,CAAC,CAAC,CAAC;QAC9D,MAAM,CAAC,IAAI,CACP,8EAA8E,IAAI,CAAC,SAAS,iCACrF,OAAO,KACV,KAAK,EAAE,qBAAqB,CAAC,OAAO,CAAC,KAAK,CAAC,IAC7C,cAAc,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,CACnD,CAAC;KACL;IAAC,OAAO,CAAC,EAAE;QACR,MAAM,OAAO,GAAG,kCAAkC,OAAO,CAAC,IAAI,2CAA2C,CAAC,EAAE,CAAC;QAC7G,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;KAC5B;IAED,OAAO,MAAM,CAAC;AAClB,CAAC,CAAA,CAAC"}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@sap-ux/backend-proxy-middleware",
+  "description": "SAP backend proxy middleware",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SAP/open-ux-tools.git",
+    "directory": "packages/backend-proxy-middleware"
+  },
+  "bugs": {
+    "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Abackend-proxy-middleware"
+  },
+  "version": "0.5.0",
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "files": [
+    "LICENSE",
+    "dist",
+    "ui5.yaml"
+  ],
+  "dependencies": {
+    "@sap-ux/axios-extension": "0.5.1",
+    "@sap-ux/btp-utils": "0.9.1",
+    "@sap-ux/logger": "0.1.5",
+    "@sap-ux/store": "0.1.4",
+    "chalk": "4.1.2",
+    "dotenv": "16.0.0",
+    "express": "4.17.2",
+    "http-proxy-middleware": "2.0.1",
+    "https-proxy-agent": "5.0.0",
+    "i18next": "20.3.2",
+    "prompts": "2.4.2"
+  },
+  "devDependencies": {
+    "@types/express": "4.17.13",
+    "@types/prompts": "2.0.14",
+    "nock": "13.2.4",
+    "supertest": "6.2.2",
+    "@types/supertest": "2.0.12",
+    "yaml": "2.0.0-10"
+  },
+  "ui5": {
+    "dependencies": []
+  },
+  "engines": {
+    "pnpm": ">=6.26.1",
+    "node": ">=12.22.5 < 13.0.0 || >= 14.16.0 < 15.0.0 || >=16.1.0 < 17.0.0"
+  },
+  "scripts": {
+    "build": "pnpm clean && tsc",
+    "clean": "rimraf dist",
+    "format": "prettier --write '**/*.{js,json,ts,yaml,yml}' --ignore-path ../../.prettierignore",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "test": "jest --ci --forceExit --detectOpenHandles --colors",
+    "watch": "tsc --watch"
+  },
+  "readme": "#  `@sap-ux/backend-proxy-middleware`\n\nThe `@sap-ux/backend-proxy-middleware` is a [Custom UI5 Server Middleware](https://sap.github.io/ui5-tooling/pages/extensibility/CustomServerMiddleware) for proxying requests to backend servers. The middleware is agnostic to running in local environments and SAP Business Application Studio. Additionally, if credentials are maintained with the SAP Fiori tools then these will be used.\n\nIt can be used either with the `ui5 serve` or the `fiori run` commands.\n\n## Configuration Options\n\n### `backend`\n| Option        | Type | Description |\n| ------------- | ------------- | ----------- |\n| `url`         | `string` mandatory (local)  | Mandatory URL pointing to the backend system. *Not required if destination is provided and the proxy is running SAP Business Application Studio |\n| `destination` | `string` mandatory (if no url) | Required if the backend system is available as destination in SAP Business Application Studio. |\n| `destinationInstance` | `string` optional | If a destination needs to be read by a specific instance of a destination service then you need to provide the id of the service as optional property `destinationInstance`.|\n| `path`        | `string` mandatory     | Path that is to be proxied |\n| `pathReplace`  | `string` optional      | If provided then the path will be replaced with this value before forwarding |\n| `client`      | `string` optional      | sap-client parameter |\n| `scp`         | `boolean` optional      | If set to true the proxy will execute the required OAuth routine for the ABAP environment on SAP BTP |\n| `apiHub`      | `boolean` optional      | If set to true then the proxy will connect to the SAP API Business Hub\n| `proxy`       | `string` optional      | If set then it will override the proxy settings from node.\n\nAdditional optional experimental property `bsp` (type `string`): The BSP property is only needed for the FLP Embedded Flow. The property refers to the BSP Application Name. In that case, we need to redirect the manifest.appdescr request to the local manifest.json in order to overwrite the deployed application with the local one.\n\n### `options`\nOptional object that can be used to directly set options of the used `http-proxy-middleware` modules (https://www.npmjs.com/package/http-proxy-middleware#http-proxy-middleware-options). Note: only declarative options (i.e. no functions) are supported.\n\n## Configuration Examples\n\n### [Connecting to a backend system](#connecting-to-a-backend-system)\n\nExecuting `ui5 serve` in your project with the configuration below in the `ui5.yaml` file would forward any request starting with the `path` parameter to the provided backend `url`.\n\n```\n- name: backend-proxy-middleware\n  afterMiddleware: compression\n  configuration:\n    backend:\n      path: /sap\n      url: https://my.backend.example:1234\n```\n\n### [Connecting to a backend system with destination](#connecting-to-a-backend-system-with-destination)\n\nIf working in SAP Business Application Studio and the backend is configured as destination then you can also provide the `destination` in the configuration. \nIf a destination needs to be read by a specific instance of a destination service then you need to provide the id of the service as optional property `destinationInstance`.\n\n```\n- name: backend-proxy-middleware\n  afterMiddleware: compression\n  configuration:\n    backend:\n      path: /sap\n      destination: my_example_destination\n```\n\n### [Connecting to a backend system with destination and principal propagation](#connecting-to-a-backend-system-with-destination-and-principal-propagation)\n\nIf the backend destination is configured to use principal propagation, then in some cases the requests might fail. If this occurs then you will need to set the optional property `xfwd` to `true`. This will add the x-forwared headers to the proxy requests.\n\n```\n- name: backend-proxy-middleware\n  afterMiddleware: compression\n  configuration:\n    backend:\n      path: /sap\n      destination: my_example_destination\n    options:\n      xfwd: true\n```\n\n### [Connecting to the SAP Business Technology Platform](#connecting-to-the-sap-business-technology-platform)\nIf you want to connect to an ABAP Environment on SAP Business Technology Platform then you will need to set the optional property `scp` to `true`. For any other target, remove this property or set it to `false`.\n\n```\n- name: backend-proxy-middleware\n  afterMiddleware: compression\n  configuration:\n    backend:\n      path: /sap\n      url: https://my.steampunk.example:1234\n      scp: true\n```\n\n### [Connecting to the SAP API Business Hub](#connecting-to-the-sap-api-business-hub)\nIf you want to connect to the SAP API Business Hub then you will need to set the optional property `apiHub` to `true`, and set the corresponding `path` and `url`, e.g.\n\n```\n- name: backend-proxy-middleware\n  afterMiddleware: compression\n  configuration:\n    backend:\n      path: /s4hanacloud\n      url: https://api.sap.com\n      apiHub: true\n```\n\n### [Proxying WebSockets](#proxying-websockets)\nIf you want the proxy to handle also WebSockets, then you need to set the optional property `ws` to `true`, e.g.\n\n```\n- name: backend-proxy-middleware\n  afterMiddleware: compression\n  configuration:\n    backend:\n      path: /sap\n      url: https://my.backend.example:1234\n    options:\n      ws: true\n```\n\n### [Changing the path to which a request is proxied](#changing-the-path-to-which-a-request-is-proxied)\nIf you want to configure the proxy to send requests from a certain path `/services/odata` to your backend (local url or destination) with a specified entry path `/my/entry/path`. Then you need to do the following:\n\n```\n- name: backend-proxy-middleware\n  afterMiddleware: compression\n  configuration:\n    backend:\n    - path: /services/odata\n      pathReplace: /my/entry/path\n      url: https://my.backend.example:1234\n      destination: my_example_destination\n```\n\n### [Providing Proxy Configuration](#providing-proxy-configuration)\nBy 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. \n**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\"`**.\n\n```\n- name: backend-proxy-middleware\n  afterMiddleware: compression\n  configuration:\n    proxy: https://myproxy.example:8443\n    backend:\n    - path: /sap\n      url: https://my.backend.example:1234\n\n```\n## Programmatic Usage\nAlternatively 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.\n\n```Typescript\nimport { createProxy } from '@sap-ux/backend-proxy-middleware';\nconst proxy = createProxy(backend, options);\n```\n- **config** - The backend configuration\n- **options** - Options of the [http-proxy-middleware](https://www.npmjs.com/package/http-proxy-middleware#options)\n\n## Keywords\n* Backend Proxy Middleware\n* Fiori tools\n* Fiori elements\n* SAP UI5"
+}

package/ui5.yaml

@@ -0,0 +1,7 @@
+specVersion: '2.6'
+metadata:
+    name: backend-proxy-middleware
+kind: extension
+type: server-middleware
+middleware:
+    path: dist/middleware.js