dev-approuter 0.1.16 → 0.1.18

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.1.18](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/dev-approuter@0.1.17...dev-approuter@0.1.18) (2023-09-15)
+
+
+### Bug Fixes
+
+* prevent side-effects for combined scenarios ([#842](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/842)) ([36aaa5f](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/36aaa5f8d8b8404725250664704a560229055943))
+
+
+
+
+
+## [0.1.17](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/dev-approuter@0.1.16...dev-approuter@0.1.17) (2023-09-14)
+
+**Note:** Version bump only for package dev-approuter
+
+
+
+
+
 ## [0.1.16](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/dev-approuter@0.1.15...dev-approuter@0.1.16) (2023-09-13)
 
 **Note:** Version bump only for package dev-approuter

package/README.md

@@ -2,9 +2,9 @@
 
 > :wave: This is a **community project** and there is no official support for this package! Feel free to use it, open issues, contribute, and help answering questions.
 
-The `dev-approuter` is a dev time wrapper for the [SAP Application Router](https://www.npmjs.com/package/@sap/approuter) that can serve [UI5](https://ui5.sap.com/) and [SAP CAP](https://cap.cloud.sap/docs/) apps that are added as (dev)dependencies to the approuter's `package.json`. A few key notes to begin with:
+The `dev-approuter` is a dev time wrapper for the [SAP Application Router](https://www.npmjs.com/package/@sap/approuter) that can serve [UI5](https://ui5.sap.com/) and [SAP Cloud Application Programming Model (CAP)](https://cap.cloud.sap/docs/) apps that are added as (dev)dependencies to the approuter's `package.json`. A few key notes to begin with:
 - The `dev-approuter` utilizes the [SAP Application Router's extension API](https://help.sap.com/docs/btp/sap-business-technology-platform/extension-api-of-application-router) by adding UI5 servers as extensions - providing the full [UI5 Tooling](https://sap.github.io/ui5-tooling/v3/) experience.
-- A linked SAP CAP app is started on a different port - this is to mimic a deployed architecture. The corresponding destination is automatically created for you.
+- A linked SAP CDS app is started on a different port - this is to mimic a deployed architecture. The corresponding destination is automatically created for you.
 - In order to safely separate development configuration from productive code, the `dev-approuter` introduces the concept of the `xs-dev.json` - think of it as an extension to the [`xs-app.json`](https://help.sap.com/docs/btp/sap-business-technology-platform/routing-configuration-file).
 - As the name suggests, the `dev-approuter` is for development only and not meant to be used in production.
 
@@ -14,7 +14,7 @@ The `dev-approuter` is a dev time wrapper for the [SAP Application Router](https
 2. [Starting the `dev-approuter`](#starting-the-dev-approuter)
 3. [Adding and serving apps](#adding-and-serving-apps)
     - [UI5 apps](#ui5-apps)
-    - [SAP CAP apps](#sap-cap-apps)
+    - [SAP CDS server](#sap-cds-server)
 4. [The `xs-dev.json` file](#the-xs-devjson-file)
 5. [Using the `dev-approuter` and SAP Application Router simultaneously](#using-the-dev-approuter-and-sap-approuter-simultaneously)
 6. [Extending the `dev-approuter`](#extending-the-dev-approuter)
@@ -58,7 +58,7 @@ The `dev-approuter` is a wrapper for the SAP Application Router, meaning your cu
 
 ## Adding and serving apps
 
-To add a UI5 or SAP CAP app to the `dev-approuter`, add it to the `devDependencies` section of your approuter's `package.json` file:
+To add a UI5 or SAP CDS app to the `dev-approuter`, add it to the `devDependencies` section of your approuter's `package.json` file:
 
 ```json
 {
@@ -66,7 +66,7 @@ To add a UI5 or SAP CAP app to the `dev-approuter`, add it to the `devDependenci
     "devDependencies": {
         ...
         "my-ui5-app": "path/to/ui5-app",
-        "my-cap-app": "path/to/cap-app"
+        "my-cds-app": "path/to/cds-app"
     }
 }
 ```
@@ -81,23 +81,24 @@ metadata:
   name: ui5-app  # default mount path would be /ui5-app 
 type: application
 customConfiguration:
-  mountPath: /my-custom-mount-path # overwrites the default mount path
+  cds-plugin-ui5:
+    mountPath: /my-custom-mount-path # overwrites the default mount path
 ```
 
 The above configuration result in the UI5 app being available at `http://localhost:5000/my-custom-mount-path`.
 
-### SAP CAP apps
+### SAP CDS server
 
-SAP CAP apps are started on a separate port (4004 by default, can be overwritten via `CAP_PORT`). The `dev-approuter` automatically creates a route and destination behind the scenes, so that you (and your UI5 apps) can reach your SAP CAP services directly at their service path, but through the `dev-approuter`, e.g. `http://localhost:5000/my-cap-service`.
+SAP CDS server is started on a separate port (4004 by default, can be overwritten via `CDS_PORT`). The `dev-approuter` automatically creates a route and destination behind the scenes, so that you (and your UI5 apps) can reach your SAP CDS services directly at their service path, but through the `dev-approuter`, e.g. `http://localhost:5000/my-cds-service`.
 
-There is no need manually create a destination for you SAP CAP app, unless you want to overwrite the [default destination configuration](./lib/helpers.js#L81-L85). In this case, create a new destination in a `default-env.json`. The destination's name has to match the module name as declared in the approuter's `devDependencies`:
+There is no need manually create a destination for you SAP CDS app, unless you want to overwrite the [default destination configuration](./lib/helpers.js#L81-L85). In this case, create a new destination in a `default-env.json`. The destination's name has to match the module name as declared in the approuter's `devDependencies`:
 
 ```json
 {
-    "CAP_PORT": 4005,
+    "CDS_PORT": 4005,
     "destinations": [
         {
-            "Name": "my-cap-app",
+            "Name": "my-cds-app",
             "Authentication": "NoAuthentication",
             "ProxyType": "Internet",
             "Type": "HTTP",
@@ -113,7 +114,7 @@ There is no need manually create a destination for you SAP CAP app, unless you w
 
 The `dev-approuter` introduces the concept of an `xs-dev.json` file, which works like a regular [`xs-app.json`](https://help.sap.com/docs/btp/sap-business-technology-platform/routing-configuration-file) file, but is used by the `dev-approuter` exclusively (meaning it's ignored by the SAP Application Router). The idea behind this concept is to safely separate dev time configuration from productive code.
 
-The `xs-dev.json` follows the same logic and syntax as the [`xs-app.json`](https://help.sap.com/docs/btp/sap-business-technology-platform/routing-configuration-file) file, but has one additional key feature: You can add a `dependency` to a `route`, which links it to a UI5 or SAP CAP app.
+The `xs-dev.json` follows the same logic and syntax as the [`xs-app.json`](https://help.sap.com/docs/btp/sap-business-technology-platform/routing-configuration-file) file, but has one additional key feature: You can add a `dependency` to a `route`, which links it to a UI5 or SAP CDS app.
 
 Look at the following example `xs-dev.json` that defines different `authenticationType`s for different UI5 apps:
 
@@ -134,11 +135,11 @@ Look at the following example `xs-dev.json` that defines different `authenticati
 }
 ```
 
-Behind the scenes, the `dev-approuter` will resolve these "dependency routes" by adding the `source`, `target`, and `destination` properties to them. Be aware that exactly these properties get overwritten by the `dev-approuter` in case you use them together with `dependency`. The only exception are SAP CAP dependencies, for which only the `destination` property gets overwritten by the `dev-approuter`.
+Behind the scenes, the `dev-approuter` will resolve these "dependency routes" by adding the `source`, `target`, and `destination` properties to them. Be aware that exactly these properties get overwritten by the `dev-approuter` in case you use them together with `dependency`. The only exception are SAP CDS dependencies, for which only the `destination` property gets overwritten by the `dev-approuter`.
 
 ## Using the `dev-approuter` and SAP Application Router simultaneously
 
-If you choose to place your `dev-approuter` in the same directory as an SAP Application Router, which you will eventually deploy, you will have to remove the `devDependencies` section of the `package.json` before deployment. This is required because the SAP Application Router will not be able to install local dev dependencies (your UI5 and SAP CAP apps) in the cloud. To achieve this, you could introduce a build step for the approuter, moving required files to a `dist/` folder and removing dev dependencies:
+If you choose to place your `dev-approuter` in the same directory as an SAP Application Router, which you will eventually deploy, you will have to remove the `devDependencies` section of the `package.json` before deployment. This is required because the SAP Application Router will not be able to install local dev dependencies (your UI5 and SAP CDS apps) in the cloud. To achieve this, you could introduce a build step for the approuter, moving required files to a `dist/` folder and removing dev dependencies:
 
 ```json
 "build": "mkdir -p dist && jq 'del(.devDependencies)' package.json > dist/package.json && cp xs-app.json dist/xs-app.json"
@@ -176,4 +177,4 @@ Any type of contribution (code contributions, pull requests, issues) to this set
 
 ## License
 
-This work is [dual-licensed](../../LICENSE) under Apache 2.0 and the Derived Beer-ware License. The official license will be Apache 2.0 but finally you can choose between one of them if you use this work.
+This work is [dual-licensed](../../LICENSE) under Apache 2.0 and the Derived Beer-ware License. The official license will be Apache 2.0 but finally you can choose between one of them if you use this work.

package/lib/devApprouter.js

@@ -6,10 +6,13 @@ const findUI5Modules = require("cds-plugin-ui5/lib/findUI5Modules");
 const createPatchedRouter = require("cds-plugin-ui5/lib/createPatchedRouter");
 const applyUI5Middleware = require("cds-plugin-ui5/lib/applyUI5Middleware");
 
-const findCAPModules = require("ui5-middleware-cap/lib/findCAPModules");
-const applyCAPMiddleware = require("ui5-middleware-cap/lib/applyCAPMiddleware");
+const findCDSModules = require("ui5-middleware-cap/lib/findCDSModules");
+const applyCDSMiddleware = require("ui5-middleware-cap/lib/applyCDSMiddleware");
 
-const { parseConfig, applyDependencyConfig, addDestination, configureCAPRoute, configureUI5Route } = require("./helpers");
+const { parseConfig, applyDependencyConfig, addDestination, configureCDSRoute, configureUI5Route } = require("./helpers");
+
+// marker that the dev-approuter is running
+process.env["dev-approuter"] = true;
 
 class DevApprouter {
 	constructor() {}
@@ -21,7 +24,7 @@ class DevApprouter {
 	 * Here is a shorter summary:
 	 * UI5 modules declared as (dev)dependencies are added as extensions
 	 * using the extension API of the SAP Approuter.
-	 * CAP modules declared as (dev)dependencies are started on a different port.
+	 * CDS modules declared as (dev)dependencies are started on a different port.
 	 * Corresponding routes and destinations are automatically created.
 	 * A custom `xs-dev.json` can be used to configure the dev approuter,
 	 * so the productive configuration can be kept in the `xs-app.json`.
@@ -45,19 +48,19 @@ class DevApprouter {
 		const config = parseConfig();
 		const cwd = process.cwd();
 
-		// lookup the CAP server root
-		let capServerConfig;
-		const capModules = await findCAPModules({ cwd });
-		if (capModules.length > 1) {
-			throw new Error(`Multiple CAP modules found. The package dev-approuter can only handle one CAP module as dependency.`);
-		} else if (capModules.length === 1) {
-			capServerConfig = capModules[0];
+		// lookup the CDS server root
+		let cdsServerConfig;
+		const cdsModules = await findCDSModules({ cwd });
+		if (cdsModules.length > 1) {
+			throw new Error(`Multiple CDS modules found. The package dev-approuter can only handle one CDS module as dependency.`);
+		} else if (cdsModules.length === 1) {
+			cdsServerConfig = cdsModules[0];
 		}
 
-		// find all UI5 modules from the CAP server root and dependencies from the approuter
+		// find all UI5 modules from the CDS server root and dependencies from the approuter
 		const ui5Modules = [...(await findUI5Modules({ cwd, skipLocalApps: true }))];
-		if (capServerConfig) {
-			ui5Modules.push(...(await findUI5Modules({ cwd: capServerConfig.modulePath, skipDeps: true })));
+		if (cdsServerConfig) {
+			ui5Modules.push(...(await findUI5Modules({ cwd: cdsServerConfig.modulePath, skipDeps: true })));
 		}
 
 		// collect UI5 middlewares
@@ -74,7 +77,7 @@ class DevApprouter {
 				basePath: modulePath,
 			});
 
-			// mounting the router for the UI5 application to the CAP server
+			// mounting the router for the UI5 application to the CDS server
 			console.log(`Mounting ${mountPath} to UI5 app ${modulePath}`);
 
 			let middlewareMountPath;
@@ -98,31 +101,31 @@ class DevApprouter {
 			});
 		}
 
-		// start CAP server on different port
-		if (capServerConfig) {
-			const { modulePath, moduleId } = capServerConfig;
+		// start CDS server on different port
+		if (cdsServerConfig) {
+			const { modulePath, moduleId } = cdsServerConfig;
 
-			// start CAP server on different port
+			// start CDS server on different port
 			const app = express();
-			const { servicesPaths } = await applyCAPMiddleware(app, { root: modulePath, cwd });
-			app.listen(process.env.CAP_PORT || 4004, () => {
-				console.log(`CAP server started at: http://localhost:${process.env.CAP_PORT || 4004}`);
+			const { servicesPaths } = await applyCDSMiddleware(app, { root: modulePath, cwd });
+			app.listen(process.env.CDS_PORT || 4004, () => {
+				console.log(`CDS server started at: http://localhost:${process.env.CDS_PORT || 4004}`);
 			});
 
-			// create route if CAP module is not referenced in xs-dev.json/xs-app.json
+			// create route if CDS module is not referenced in xs-dev.json/xs-app.json
 			if (!config.dependencyRoutes[moduleId]) {
 				const route = {
 					dependency: moduleId,
 					authenticationType: "none",
 				};
 				config.routes.unshift(Object.assign({}, route));
-				config.dependencyRoutes[moduleId] = configureCAPRoute(moduleId, servicesPaths, route);
+				config.dependencyRoutes[moduleId] = configureCDSRoute(moduleId, servicesPaths, route);
 			} else {
-				config.dependencyRoutes[moduleId] = configureCAPRoute(moduleId, servicesPaths, config.dependencyRoutes[moduleId]);
+				config.dependencyRoutes[moduleId] = configureCDSRoute(moduleId, servicesPaths, config.dependencyRoutes[moduleId]);
 			}
 
 			// add destination for newly configured route
-			addDestination(moduleId, process.env.CAP_PORT || 4004);
+			addDestination(moduleId, process.env.CDS_PORT || 4004);
 		}
 
 		// create and start the SAP Approuter

package/lib/helpers.js

@@ -90,13 +90,13 @@ const addDestination = (moduleId, port, mountPath) => {
 };
 
 /**
- * Configures the route for a given CAP module.
+ * Configures the route for a given CDS module.
  * @param {String} moduleId - the id of the module that the route should be configured for.
- * @param {String[]} servicePaths - an array of service paths that the CAP module serves.
+ * @param {String[]} servicesPaths - an array of service paths that the CDS module serves.
  * @param {Object} route - the route that is to be configured.
  * @returns {Object} the configured route.
  */
-const configureCAPRoute = (moduleId, servicesPaths, route) => {
+const configureCDSRoute = (moduleId, servicesPaths, route) => {
 	if (!route.source) {
 		route.source = servicesPaths
 			.map((path) => {
@@ -135,6 +135,6 @@ module.exports = {
 	parseConfig,
 	applyDependencyConfig,
 	addDestination,
-	configureCAPRoute,
+	configureCDSRoute,
 	configureUI5Route,
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "dev-approuter",
-  "version": "0.1.16",
-  "description": "A dev time wrapper for the SAP Application Router that can serve UI5 and CAP modules added as dependencies.",
+  "version": "0.1.18",
+  "description": "A dev time wrapper for the SAP Application Router that can serve UI5 and CDS modules added as dependencies.",
   "author": "Nico Schoenteich <nicolai.schoenteich@sap.com> (https://github.com/nicoschoenteich)",
   "license": "Apache-2.0",
   "repository": {
@@ -12,9 +12,9 @@
   "dependencies": {
     "@sap/approuter": ">=14.3.1",
     "@sap/xsenv": "4.0.0",
-    "cds-plugin-ui5": "^0.6.8",
+    "cds-plugin-ui5": "^0.6.9",
     "express": "^4.18.2",
-    "ui5-middleware-cap": "^3.1.2"
+    "ui5-middleware-cap": "^3.1.4"
   },
-  "gitHead": "b53f5050d013dd0a8a94478ceabb7dc235234461"
+  "gitHead": "7ff4fbf9fa7501c5e2691bb2b92c1ea59a403edf"
 }