cds-plugin-ui5 0.6.0 → 0.6.2

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.6.2](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.6.1...cds-plugin-ui5@0.6.2) (2023-09-08)
+
+
+### Bug Fixes
+
+* **cds-plugin-ui5:** allow relative config files in package.json ([#838](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/838)) ([735b24d](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/735b24d34cebee5463c97c3bb5a3d58e07dace24))
+
+
+
+
+
+## [0.6.1](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.6.0...cds-plugin-ui5@0.6.1) (2023-09-08)
+
+
+### Bug Fixes
+
+* **cds-plugin-ui5:** flexible mount path configuration ([#837](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/837)) ([dc31a9e](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/dc31a9e30f628c7236c93281909fafe19234bafe))
+
+
+
+
+
 # [0.6.0](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.5.2...cds-plugin-ui5@0.6.0) (2023-09-08)
 
 

package/README.md

@@ -23,7 +23,61 @@ That's it!
 
 ### Configuration
 
-The plugin can be configured using the `cds-plugin-ui5` section in the `package.json`. To define a custom configFile for any module you can add a configuration object for each module in the `modules` section:
+The plugin accepts configuration to control the mount path for the embedding into the CAP server and selected configuration options for the UI5 server middlewares which are embedded into the mount path of the CAP server.
+
+#### Mount Path
+
+The mount path of the UI5 application configures the nested Router for the UI5 server middlewares to run under this predefined path. It is by default derived from the `metadata/name` of the `ui5.yaml`:
+
+```yaml
+specVersion: "3.0"
+metadata:
+  name: ui5.bookshop
+type: application
+```
+
+This configuration can be overruled by adding a the `customConfiguration/cds-plugin-ui5/mountPath` option into the `ui5.yaml`:
+
+```yaml
+specVersion: "3.0"
+metadata:
+  name: ui5.bookshop
+type: application
+customConfiguration:
+  cds-plugin-ui5:
+    mountPath: /bookshop
+```
+
+In some cases it is necessary to overrule the UI5 application local configuration in the CAP server. Therefore, you can add custom configuration into the `package.json` of the CAP server into the section: `cds/cds-plugin-ui5/modules/%moduleId%/mountPath`
+
+```json
+{
+  "name": "cds-bookshop",
+  [...]
+  "cds": {
+    [...]
+    "cds-plugin-ui5": {
+      "modules": {
+        "ui5-bookshop": {
+          "mountPath": "/the-bookshop"
+        }
+      }
+    }
+  }
+}
+```
+
+The `moduleId` is either the directory name for local apps in the `app` directory of the CAP server or for dependencies the `name` from the `package.json`.
+
+The configuration can also be injected with the environment variable `CDS_PLUGIN_UI5_MODULES`. It contains the JSON string from the configuration above, e.g.:
+
+```sh
+CDS_PLUGIN_UI5_MODULES="{ \"ui5-bookshop\": { \"mountPath\": \"/the-bookshop\" } }" cds-serve
+```
+
+#### UI5 Server Middlewares
+
+If you require to configure the UI5 server middlewares, you can do so by adding some selected configuration options in the `package.json` of the CAP server in the section: `cds/cds-plugin-ui5/modules/%moduleId%`
 
 ```json
 {
@@ -45,14 +99,25 @@ The plugin can be configured using the `cds-plugin-ui5` section in the `package.
 }
 ```
 
-The key is the `moduleId` which is either the directory name for local apps in the `app` directory of the CAP server or for dependencies the `name` from the `package.json`. As value you can specify an alternative `configFile`, `workspaceConfigFile`, `workspaceName`, and/or `versionOverride`. The location of the config files are relative to the modules' base path.
+The `moduleId` is either the directory name for local apps in the `app` directory of the CAP server or for dependencies the `name` from the `package.json`.
 
-A second option to override this configuration is the usage of the environment variable `CDS_PLUGIN_UI5_MODULES`. It contains the JSON string from the configuration above, e.g.:
+The available configuration options are:
+
+* `configFile`: *`string`* - name of the config file (defaults to "ui5.yaml")
+* `workspaceConfigFile`: *`string`* - name of the workspace config file (defaults to "ui5-workspace.yaml")
+* `workspaceName`: *`string`* - name of the workspace (defaults to "default" when the file at workspaceConfigPath exists)
+* `versionOverride`: *`string`* - Framework version to use instead of the one defined in the root project
+
+If the `configFile` or `workspaceConfigFile` startes with `./` or `../` then the config file is considered to be relative to the `package.json`.
+
+The configuration can also be injected with the environment variable `CDS_PLUGIN_UI5_MODULES`. It contains the JSON string from the configuration above, e.g.:
 
 ```sh
 CDS_PLUGIN_UI5_MODULES="{ \"ui5-bookshop\": { \"configFile\": \"ui5-dist.yaml\" } }" cds-serve
 ```
 
+The configuration options from the UI5 server middlewares and the mount path can be mixed together as they both are in the same section of the `package.json`.
+
 ## Info for UI5 Tooling Extension Developers
 
 Custom middlewares may generate virtual app pages which should also be listed as web applications in the welcome page of the `@sap/cds` server. This is possible by assigning a static `getAppPages` function to the middleware function. The following snippet show-cases how this can be done:

package/cds-plugin.js

@@ -49,6 +49,7 @@ cds.on("bootstrap", async function bootstrap(app) {
 		// apply the UI5 middlewares to the router and
 		// retrieve the available HTML pages
 		const appInfo = await applyUI5Middleware(router, {
+			cwd,
 			basePath: modulePath,
 			...(config[moduleId] || {}),
 		});

package/lib/applyUI5Middleware.js

@@ -12,6 +12,7 @@ const log = require("./log");
 /**
  * @typedef applyUI5MiddlewareOptions
  * @type {object}
+ * @property {string} [cwd] cwd to resolve relative config files to, e.g. "./ui5.yaml" or "./ui5-workspace.yaml" (defaults to `process.cwd()`)
  * @property {string} [basePath] base path of the UI5 application (defaults to `process.cwd()`)
  * @property {string} [configFile] name of the config file (defaults to "ui5.yaml")
  * @property {string} [configPath] /!\ RESTRICTED /!\ - path to the ui5.yaml (defaults to "${basePath}/${configFile}")
@@ -30,23 +31,37 @@ const log = require("./log");
  * @param {applyUI5MiddlewareOptions} options configuration options
  * @returns {UI5AppInfo} UI5 application information object
  */
-module.exports = async function applyUI5Middleware(router, options = { basePath: process.cwd() }) {
+module.exports = async function applyUI5Middleware(router, options) {
 	const { graphFromPackageDependencies } = await import("@ui5/project/graph");
 	const { createReaderCollection } = await import("@ui5/fs/resourceFactory");
 
+	options.cwd = options.cwd || process.cwd();
+	options.basePath = options.basePath || process.cwd();
+
 	const configPath = options.configPath || options.basePath;
 	const configFile = options.configFile || "ui5.yaml";
 	const workspaceConfigPath = options.workspaceConfigPath || options.basePath;
 	const workpaceConfigFile = options.workpaceConfigFile || "ui5-workspace.yaml";
 
 	const determineConfigPath = function (configPath, configFile) {
+		// ensure that the config path is absolute
+		if (!path.isAbsolute(configPath)) {
+			configPath = path.resolve(options.basePath, configPath);
+		}
+		// if the config path is a file, then we assume that this is the
+		// configuration which should be used for the UI5 server middlewares
 		if (fs.existsSync(configPath) && fs.statSync(configPath).isFile()) {
 			return configPath;
 		}
-		configPath = path.resolve(configPath, configFile);
+		// if the configuration file is starting with ./ or ../ then we
+		// resolve the configuration relative to the current working dir
+		// otherwise we are resolving it relative to the config path
+		// which is typically the directory of the UI5 application
+		configPath = path.resolve(/^\.\.?\//.test(configFile) ? options.cwd : configPath, configFile);
 		if (fs.existsSync(configPath) && fs.statSync(configPath).isFile()) {
 			return configPath;
 		}
+		// nothing matched => no config
 		return undefined;
 	};
 

package/lib/findUI5Modules.js

@@ -116,22 +116,16 @@ module.exports = async function findUI5Modules({ cwd, skipLocalApps, skipDeps })
 				throw err;
 			}
 
-			// by default the mount path is derived from the metadata/name
-			// and can be overridden by customConfiguration/mountPath
+			// extract the configuration
 			const ui5Config = ui5Configs?.[0];
 			const isApplication = ui5Config?.type === "application";
 			if (isApplication) {
-				let mountPath = ui5Config?.customConfiguration?.mountPath || ui5Config?.metadata?.name;
-				if (!/^\//.test(mountPath)) {
-					mountPath = `/${mountPath}`; // always start with /
-				}
-
 				// determine the module path based on the location of the ui5.yaml
 				const modulePath = path.dirname(ui5YamlPath);
 
 				// manually get the module name as defined in package.json
-				// skipDeps is only true if we are looking for UI5 apps inside a CAP server project
-				// in all other cases the module name equals the appDir
+				// skipDeps is only true if we are looking for UI5 apps inside a CAP
+				// server project in all other cases the module name equals the appDir
 				let moduleName;
 				if (skipDeps) {
 					const packageJsonPath = require.resolve(path.join(appDir, "package.json"), {
@@ -142,6 +136,17 @@ module.exports = async function findUI5Modules({ cwd, skipLocalApps, skipDeps })
 				}
 				const moduleId = moduleName || path.basename(appDir);
 
+				// by default the mount path is derived from the "metadata/name"
+				// and can be overridden by "customConfiguration/mountPath" or
+				// by "customConfiguration/cds-plugin-ui5/mountPath" or by
+				// the following configuration entry in the package.json of CAP
+				// server: "cds/cds-plugin-ui5/modules/%moduleId%/mountPath"
+				let mountPath =
+					modulesConfig?.[moduleId]?.mountPath || ui5Config?.customConfiguration?.["cds-plugin-ui5"]?.mountPath || ui5Config?.customConfiguration?.mountPath || ui5Config?.metadata?.name;
+				if (!/^\//.test(mountPath)) {
+					mountPath = `/${mountPath}`; // always start with /
+				}
+
 				// store the custom config in the configuration map
 				if (modulesConfig?.[moduleId]) {
 					apps.config[moduleId] = modulesConfig[moduleId];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cds-plugin-ui5",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "description": "A CAP server cds-plugin to inject the middlewares of all related UI5 tooling based projects.",
   "author": "Peter Muessig",
   "license": "Apache-2.0",
@@ -24,5 +24,5 @@
     "@sap/cds": ">=6.8.2",
     "express": ">=4.18.2"
   },
-  "gitHead": "de3226373e571bb9bb9d9e71640815b96858b371"
+  "gitHead": "1f8272a1e1faa0559fd9e57b03da2ada256d23df"
 }