cds-plugin-ui5 0.9.3 → 0.9.5

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.9.5](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.9.4...cds-plugin-ui5@0.9.5) (2024-07-22)
+
+
+### Bug Fixes
+
+* **cds-plugin-ui5:** report versions of the plugin and @sap/cds-dk, @sap/cds ([#1045](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/1045)) ([8db7560](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/8db7560da65d2d042a5e71887b885c8d102714db))
+
+
+
+
+
+## [0.9.4](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.9.3...cds-plugin-ui5@0.9.4) (2024-07-19)
+
+
+### Bug Fixes
+
+* **cds-plugin-ui5:** support @sap/cds-dk@8 build priorities ([#1037](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/1037)) ([c921a35](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/c921a35f97c0895b603f8b781a946ceaa1234275)), closes [#1033](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/1033)
+
+
+
+
+
 ## [0.9.3](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.9.2...cds-plugin-ui5@0.9.3) (2024-06-04)
 
 

package/README.md

@@ -2,7 +2,7 @@
 
 > :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 `cds-plugin-ui5` is a CDS server `cds-plugin` which enables the integration of UI5 tooling based (UI5 freestyle or Fiori elements) projects into the CDS server via the UI5 tooling express middlewares. The UI5 or Fiori elements projects just need to be located in the `app` folder of the CDS server, or via the `cds.env.folders.app` variable, or be a dependency of the CDS server.
+The `cds-plugin-ui5` is a CDS server `cds-plugin` for the node runtime of the [SAP Cloud Application Programming Model (CAP)](https://cap.cloud.sap/docs/about/) which enables the integration of UI5 tooling based (UI5 freestyle or Fiori elements) projects into the CDS server via the UI5 tooling express middlewares. The UI5 or Fiori elements projects just need to be located in the `app` folder of the CDS server, or via the `cds.env.folders.app` variable, or be a dependency of the CDS server.
 
 > :construction: **Note**
 > This cds-plugin is still work in progress and not final yet!

package/cds-plugin.js

@@ -48,6 +48,46 @@ if (!skip) {
 	// to disable the ui5-middleware-cap if used in apps
 	process.env["cds-plugin-ui5"] = true;
 
+	const { execSync } = require("child_process");
+	const { readFileSync } = require("fs");
+
+	const { version: cdsPluginUI5Version } = require(`${__dirname}/package.json`);
+
+	// function to resolve a module with the given paths without throwing an error
+	const resolveModule = function resolveModule(moduleName, paths) {
+		try {
+			return require.resolve(moduleName, { paths });
+		} catch (error) {
+			return null;
+		}
+	};
+
+	// find out the CDS-DK version to control the behavior of the plugin
+	const getCDSDKVersion = function getCDSDKVersion() {
+		const moduleName = "@sap/cds-dk";
+		let resolvedPath = resolveModule(`${moduleName}/package.json`);
+		if (!resolvedPath) {
+			const globalModulesPath = execSync("npm root -g").toString().trim();
+			resolvedPath = resolveModule(`${moduleName}/package.json`, [globalModulesPath]);
+		}
+		if (resolvedPath) {
+			const packageJson = JSON.parse(readFileSync(resolvedPath, { encoding: "utf-8" }));
+			return packageJson.version;
+		}
+	};
+
+	// get the CDS-DK version to control the behavior of the plugin
+	const cdsdkVersion = getCDSDKVersion();
+
+	// logging the version of the cds-plugin-ui5
+	log.info(`Running cds-plugin-ui5@${cdsPluginUI5Version} (@sap/cds-dk@${cdsdkVersion}, @sap/cds@${cds.version})`);
+	if (global.__cds_loaded_from?.size > 1) {
+		log.warn("  !! Multiple versions of @sap/cds loaded !!");
+		global.__cds_loaded_from.forEach((cdsPath) => {
+			log.warn(`    => ${cdsPath}`);
+		});
+	}
+
 	// promise to await the bootstrap and lock the
 	// served event to delay the startup a bit
 	let bootstrapped;
@@ -194,11 +234,11 @@ if (!skip) {
 	// check if the register function for build tasks is available at the cds object
 	// and if the Plugin class is available to register the cds build task to cover
 	// the tracks of the cds-plugin-ui5 workspace configuration and dependencies
+	const { minVersion, satisfies } = require("semver");
 	if (typeof cds.build?.register === "function" && typeof cds.build?.Plugin?.constructor === "function") {
 		const { readFile, writeFile } = require("fs").promises;
 		const { existsSync } = require("fs");
 		const { join } = require("path");
-		const { minVersion } = require("semver");
 		const util = require("util");
 		const exec = util.promisify(require("child_process").exec);
 
@@ -226,10 +266,16 @@ if (!skip) {
 				}
 				init() {}
 				clean() {
-					this._priority = -1; // hack to ensure that the task is executed last!
+					if (!satisfies(cdsdkVersion, ">=8")) {
+						this._priority = -1; // hack to ensure that the task is executed last!
+					}
 				}
 				get priority() {
-					return this._priority || 1;
+					if (!satisfies(cdsdkVersion, ">=8")) {
+						return this._priority || 1;
+					} else {
+						return -1;
+					}
 				}
 				async build() {
 					// determine the namespace from the model
@@ -277,8 +323,10 @@ if (!skip) {
 			}
 		);
 	} else {
-		// TODO: add error message to inform the user that the cds build task is not available
-		//       and that the @sap/cds-dk version is too old to support the cds build task
-		//log.info("The cds build task requires @sap/cds-dk version >= 7.6.0! Skipping execution as your @sap/cds-dk version is too old...");
+		if (!satisfies(cdsdkVersion, ">=7.5.0")) {
+			// TODO: add error message to inform the user that the cds build task is not available
+			//       and that the @sap/cds-dk version is too old to support the cds build task
+			log.warn("The cds build task requires @sap/cds-dk version >= 7.5.0! Skipping execution as your @sap/cds-dk version is too old...");
+		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cds-plugin-ui5",
-  "version": "0.9.3",
+  "version": "0.9.5",
   "description": "A CDS server plugin to inject the middlewares of all related UI5 tooling based projects.",
   "author": "Peter Muessig",
   "license": "Apache-2.0",
@@ -12,19 +12,19 @@
   },
   "dependencies": {
     "@ui5/fs": "^3.0.5",
-    "@ui5/project": "^3.9.1",
-    "@ui5/server": "^3.2.0",
+    "@ui5/project": "^3.9.2",
+    "@ui5/server": "^3.2.1",
     "js-yaml": "^4.1.0",
     "node-html-parser": "^6.1.13",
-    "semver": "^7.6.2"
+    "semver": "^7.6.3"
   },
   "devDependencies": {
-    "@sap/cds": "^6.8.4",
-    "express": "^4.19.2"
+    "@sap/cds": "*",
+    "express": "*"
   },
   "peerDependencies": {
     "@sap/cds": ">=6.8.2",
     "express": ">=4.18.2"
   },
-  "gitHead": "0665b24121e9f7584e19246c94cab86987e5f32e"
+  "gitHead": "0a4076873a7fbd2fc675b5f9c2ec2efa3cd0518a"
 }