cds-plugin-ui5 0.7.5 → 0.8.1

package/CHANGELOG.md

@@ -3,6 +3,29 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.8.1](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.8.0...cds-plugin-ui5@0.8.1) (2024-02-18)
+
+
+### Bug Fixes
+
+* **cds-plugin-ui5:** only start when using "cds serve|watch" ([#951](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/951)) ([7b67bd9](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/7b67bd975b5a082e6a33855b12a058ad53d0a433)), closes [#950](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/950)
+* prefere cds.env._home over just current process.cwd ([#947](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/947)) ([ecb6e69](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/ecb6e69af178f93a3723c005609c7fefb50c8b41))
+
+
+
+
+
+# [0.8.0](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.7.5...cds-plugin-ui5@0.8.0) (2024-01-25)
+
+
+### Features
+
+* **ui5-middleware-ui5:** support nested scenarios in CDS servers ([#938](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/938)) ([5d61f18](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/5d61f18f04a624e8f61ec7fa1e8f32e81c43f6b0))
+
+
+
+
+
 ## [0.7.5](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.7.4...cds-plugin-ui5@0.7.5) (2024-01-17)
 
 

package/cds-plugin.js

@@ -68,119 +68,125 @@ if (!skip) {
 	cds.on("bootstrap", async function bootstrap(app) {
 		log.debug("bootstrap");
 
-		const cwd = process.cwd();
-		const ui5Modules = await findUI5Modules({ cwd, cds });
-		const { localApps, config } = ui5Modules;
-
-		const links = [];
-
-		// register the UI5 modules via their own router/middlewares
-		for await (const ui5Module of ui5Modules) {
-			const { moduleId, mountPath, modulePath } = ui5Module;
-
-			// mounting the Router for the UI5 application to the CDS server
-			log.info(`Mounting ${mountPath} to UI5 app ${modulePath} (id=${moduleId})${config[moduleId] ? ` using config=${JSON.stringify(config[moduleId])}` : ""}`);
-
-			// create a patched router
-			const router = await createPatchedRouter();
-
-			// apply the UI5 middlewares to the router and
-			// retrieve the available HTML pages
-			const appInfo = await applyUI5Middleware(router, {
-				cwd,
-				basePath: modulePath,
-				...(config[moduleId] || {}),
-			});
-
-			// register the router to the specified mount path
-			app.use(mountPath, router);
-
-			// append the HTML pages to the links
-			appInfo.pages.forEach((page) => {
-				const prefix = mountPath !== "/" ? mountPath : "";
-				links.push(`${prefix}${page}`);
-			});
-		}
+		// only for cds serve the cds-plugin-ui5 is active
+		if (cds.cli?.command === "serve") {
+			const cwd = cds.env?._home || process.cwd();
+			const ui5Modules = await findUI5Modules({ cwd, cds });
+			const { localApps, config } = ui5Modules;
+
+			const links = [];
+
+			// register the UI5 modules via their own router/middlewares
+			for await (const ui5Module of ui5Modules) {
+				const { moduleId, mountPath, modulePath } = ui5Module;
+
+				// mounting the Router for the UI5 application to the CDS server
+				log.info(`Mounting ${mountPath} to UI5 app ${modulePath} (id=${moduleId})${config[moduleId] ? ` using config=${JSON.stringify(config[moduleId])}` : ""}`);
+
+				// create a patched router
+				const router = await createPatchedRouter();
+
+				// apply the UI5 middlewares to the router and
+				// retrieve the available HTML pages
+				const appInfo = await applyUI5Middleware(router, {
+					cwd,
+					basePath: modulePath,
+					...(config[moduleId] || {}),
+				});
+
+				// register the router to the specified mount path
+				app.use(mountPath, router);
+
+				// append the HTML pages to the links
+				appInfo.pages.forEach((page) => {
+					const prefix = mountPath !== "/" ? mountPath : "";
+					links.push(`${prefix}${page}`);
+				});
+			}
 
-		// identify whether the welcome page should be rewritten
-		let rewrite = links.length > 0;
-
-		// rewrite the welcome page
-		if (rewrite) {
-			// register the custom middleware (similar like in @sap/cds/server.js)
-			app.get("/", function appendLinksToIndex(req, res, next) {
-				req._cds_plugin_ui5 = true; // marker for patched router to ignore
-				rewriteHTML(
-					req,
-					res,
-					() => true,
-					(doc) => {
-						// the first <ul> element contains the links to the
-						// application pages which is fully under control of
-						// our plugin now and we keep all links to static
-						// pages to ensure coop with classic apps
-						const head = doc.getElementsByTagName("head")?.[0];
-						head?.insertAdjacentHTML(
-							"beforeend",
-							`<style>
-						a.ui5:after {
-							content: "UI5";
-							font-weight: bold;
-							font-size: 0.5rem;
-							vertical-align: super;
-							margin: 0.25rem;
-							color: #1873B4;
-						}
-						@media (prefers-color-scheme: dark) {
+			// identify whether the welcome page should be rewritten
+			let rewrite = links.length > 0;
+
+			// rewrite the welcome page
+			if (rewrite) {
+				// register the custom middleware (similar like in @sap/cds/server.js)
+				app.get("/", function appendLinksToIndex(req, res, next) {
+					req._cds_plugin_ui5 = true; // marker for patched router to ignore
+					rewriteHTML(
+						req,
+						res,
+						() => true,
+						(doc) => {
+							// the first <ul> element contains the links to the
+							// application pages which is fully under control of
+							// our plugin now and we keep all links to static
+							// pages to ensure coop with classic apps
+							const head = doc.getElementsByTagName("head")?.[0];
+							head?.insertAdjacentHTML(
+								"beforeend",
+								`<style>
 							a.ui5:after {
-								color: #FF5A37;
+								content: "UI5";
+								font-weight: bold;
+								font-size: 0.5rem;
+								vertical-align: super;
+								margin: 0.25rem;
+								color: #1873B4;
 							}
-						}
-						</style>`
-						);
-						const ul = doc.getElementsByTagName("ul")?.[0];
-						if (ul) {
-							const newLis = [];
-							const lis = ul.getElementsByTagName("li");
-							lis?.forEach((li) => {
-								const appDir = li.firstChild?.text?.split("/")?.[1];
-								if (localApps.has(appDir)) {
-									newLis.push(li.toString());
+							@media (prefers-color-scheme: dark) {
+								a.ui5:after {
+									color: #FF5A37;
 								}
-							});
-							newLis.push(
-								...links.sort().map((link) => {
-									// we remove the query parameters from the link text
-									const linkText = link.indexOf("?") === -1 ? link : link.substr(0, link.indexOf("?"));
-									// renders a UI5 link ;-)
-									return `<li><a class="ui5" href="${link}">${linkText}</a></li>`;
-								})
+							}
+							</style>`
 							);
-							ul.innerHTML = newLis.join("\n");
-						} else {
-							log.warn(`Failed to inject application links into CDS index page!`);
+							const ul = doc.getElementsByTagName("ul")?.[0];
+							if (ul) {
+								const newLis = [];
+								const lis = ul.getElementsByTagName("li");
+								lis?.forEach((li) => {
+									const appDir = li.firstChild?.text?.split("/")?.[1];
+									if (localApps.has(appDir)) {
+										newLis.push(li.toString());
+									}
+								});
+								newLis.push(
+									...links.sort().map((link) => {
+										// we remove the query parameters from the link text
+										const linkText = link.indexOf("?") === -1 ? link : link.substr(0, link.indexOf("?"));
+										// renders a UI5 link ;-)
+										return `<li><a class="ui5" href="${link}">${linkText}</a></li>`;
+									})
+								);
+								ul.innerHTML = newLis.join("\n");
+							} else {
+								log.warn(`Failed to inject application links into CDS index page!`);
+							}
 						}
+					);
+					next();
+				});
+
+				// move our middleware before the CDS index serve middleware to
+				// allow that we can intercept the response and modify it to
+				// inject our application pages an remove the exitsing ones
+				const middlewareStack = app?._router?.stack;
+				if (Array.isArray(middlewareStack)) {
+					const cmw = middlewareStack.pop();
+					const idxOfServeStatic = middlewareStack.findIndex((layer) => layer.name === "serveStatic");
+					if (idxOfServeStatic !== -1) {
+						middlewareStack.splice(idxOfServeStatic, 0, cmw);
+					} else {
+						log.error(`Failed to determine welcome page middleware! The links of the application pages may not work properly!`);
 					}
-				);
-				next();
-			});
-
-			// move our middleware before the CDS index serve middleware to
-			// allow that we can intercept the response and modify it to
-			// inject our application pages an remove the exitsing ones
-			const middlewareStack = app?._router?.stack;
-			if (Array.isArray(middlewareStack)) {
-				const cmw = middlewareStack.pop();
-				const idxOfServeStatic = middlewareStack.findIndex((layer) => layer.name === "serveStatic");
-				if (idxOfServeStatic !== -1) {
-					middlewareStack.splice(idxOfServeStatic, 0, cmw);
 				} else {
-					log.error(`Failed to determine welcome page middleware! The links of the application pages may not work properly!`);
+					log.error(`Failed to inject application pages to welcome page! The links of the application pages may not work properly!`);
 				}
-			} else {
-				log.error(`Failed to inject application pages to welcome page! The links of the application pages may not work properly!`);
 			}
+		} else {
+			log.info("Skip execution of plugin! The plugin is only active for 'cds serve'!");
 		}
+
 		// bootstrap completed, unlock the "served" event
 		bootstrapped();
 	});

package/lib/findUI5Modules.js

@@ -16,6 +16,7 @@ const log = require("./log");
  * Returns all UI5 modules from local apps and the project dependencies.
  * @param {object} options configuration options
  * @param {string} options.cwd current working directory
+ * @param {string} options.cds reference to cds
  * @param {string} options.skipLocalApps skip local apps
  * @param {string} options.skipDeps skip dependencies
  * @returns {Array<UI5Module>} array of UI5 module
@@ -52,7 +53,7 @@ module.exports = async function findUI5Modules({ cwd, cds, skipLocalApps, skipDe
 	const localApps = new Set();
 	const appDirs = [];
 	if (!skipLocalApps) {
-		const appDir = path.join(cwd, cds?.env?.folders?.app || "app");
+		const appDir = path.join(cwd, cds.env?.folders?.app || "app");
 		if (fs.existsSync(appDir)) {
 			// is the UI5 app directly in the app directory?
 			if (!fs.existsSync(path.join(appDir, determineUI5Yaml(appDir)))) {

package/lib/rewriteHTML.js

@@ -61,15 +61,22 @@ module.exports = async function rewriteHTML(req, res, rewriteCondition, rewriteC
 		// store the last chunk in the content buffer
 		contentBuffer.push(content instanceof Buffer ? content.toString(encoding) : content);
 
-		// create the html content and parse it
+		// create the html content
 		let htmlContent = contentBuffer.join("");
-		const doc = HTMLParser.parse(htmlContent);
 
-		// now run the callback
-		rewriteContent(doc);
+		// ensure that the request is rewritten only once and not also by the cds-plugin-ui5
+		// therefore we add a marker to the request so that the middlewares can identify this
+		if (!req["ui5-rewriteHTML"]) {
+			// parse the html content
+			const doc = HTMLParser.parse(htmlContent);
 
-		// update the html content
-		htmlContent = doc.toString();
+			// now run the callback
+			rewriteContent(doc);
+
+			// update the html content
+			htmlContent = doc.toString();
+		}
+		req["ui5-rewriteHTML"] = true;
 
 		// the rest is on express
 		end.call(res, htmlContent, encoding);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cds-plugin-ui5",
-  "version": "0.7.5",
+  "version": "0.8.1",
   "description": "A CDS server plugin to inject the middlewares of all related UI5 tooling based projects.",
   "author": "Peter Muessig",
   "license": "Apache-2.0",
@@ -25,5 +25,5 @@
     "@sap/cds": ">=6.8.2",
     "express": ">=4.18.2"
   },
-  "gitHead": "1f9cb2f35ac5cfbfeab842150d710e7edafe9b2f"
+  "gitHead": "c982231d4c48e09b2694a1124f032bb62267cd7c"
 }