cds-plugin-ui5 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -3,9 +3,27 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# 0.1.0 (2023-05-26)
+## [0.1.2](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.1.1...cds-plugin-ui5@0.1.2) (2023-06-15)
+
+
+### Bug Fixes
+
+* update dependencies ([#754](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/754)) ([3893473](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/389347300795cfed881dc8be72eeb59d1bf45fff))
+
+
 
 
+
+## [0.1.1](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.1.0...cds-plugin-ui5@0.1.1) (2023-06-03)
+
+### Bug Fixes
+
+- **cds-plugin-ui5:** disable gzip encoding when livereload is used by CAP ([#750](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/750)) ([b131efa](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/b131efaa239b66d55350dab573d6a0a9ef978625))
+- **cds-plugin-ui5:** inject UI5 app pages ([#752](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/752)) ([0d7415d](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/0d7415d0630d33f851dd816015f3a2f394ce59d3))
+- update dependencies ([#749](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/749)) ([b1c8cfb](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/b1c8cfb4da1dcd0ae91bee181f539684d767d067))
+
+# 0.1.0 (2023-05-26)
+
 ### Features
 
-* **cds-plugin-ui5:** initial poc for UI5 cds-plugin ([#746](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/746)) ([70a7477](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/70a7477410ef8a75bc994f117cc0d7fcffef2fed))
+- **cds-plugin-ui5:** initial poc for UI5 cds-plugin ([#746](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/746)) ([70a7477](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/70a7477410ef8a75bc994f117cc0d7fcffef2fed))

package/cds-plugin.js

@@ -11,20 +11,41 @@ const applyUI5Middleware = require("./lib/applyUI5Middleware");
 // to disable the ui5-middleware-cap if used in apps
 process.env["cds-plugin-ui5"] = true;
 
-cds.on("bootstrap", async (app) => {
-	console.log("[cds-ui5-plugin] bootstrap");
+/**
+ * helper to log colorful messages
+ * @param {string} type the type of the message
+ * @param {string} message the message text
+ */
+function log(type, message) {
+	const colors = {
+		log: "\x1b[0m", // default
+		info: "\x1b[32m", // green
+		debug: "\x1b[34m", // blue
+		warn: "\x1b[33m", // yellow
+		error: "\x1b[31m", // red
+	};
+	if (!console[type]) {
+		type = "log";
+	}
+	console[type](`\x1b[36m[cds-ui5-plugin]\x1b[0m %s[%s]\x1b[0m %s`, colors[type], type, message);
+}
 
-	// prepare the _app_links to add links dynamically
-	const links = (app._app_links = app._app_links || []);
+cds.on("bootstrap", async function bootstrap(app) {
+	log("debug", "bootstrap");
 
-	// lookup the app folder
-	const appDirs = [];
-	appDirs.push(
-		...fs
-			.readdirSync(path.join(process.cwd(), "app"), { withFileTypes: true })
-			.filter((f) => f.isDirectory() && fs.existsSync(path.join(process.cwd(), "app", f.name, "ui5.yaml")))
-			.map((f) => path.join(process.cwd(), "app", f.name))
-	);
+	// lookup the app folder to determine local apps and ui5 app directories
+	const localApps = new Set(),
+		appDirs = [];
+	fs.readdirSync(path.join(process.cwd(), "app"), { withFileTypes: true })
+		.filter((f) => f.isDirectory())
+		.forEach((d) => localApps.add(d.name));
+	localApps.forEach((e) => {
+		const d = path.join(process.cwd(), "app", e);
+		if (fs.existsSync(path.join(d, "ui5.yaml"))) {
+			localApps.delete(e);
+			appDirs.push(d);
+		}
+	});
 
 	// lookup the UI5 dependencies
 	const pkgJson = require(path.join(process.cwd(), "package.json"));
@@ -49,6 +70,7 @@ cds.on("bootstrap", async (app) => {
 	// if apps are available, attach the middlewares of the UI5 apps
 	// to the express of the CAP server via a express router
 	if (appDirs) {
+		const links = [];
 		for await (const appDir of appDirs) {
 			// read the ui5.yaml file to extract the configuration
 			const ui5YamlPath = require.resolve(path.join(appDir, "ui5.yaml"), {
@@ -60,7 +82,7 @@ cds.on("bootstrap", async (app) => {
 				ui5Configs = yaml.loadAll(content);
 			} catch (err) {
 				if (err.name === "YAMLException") {
-					console.error(`Failed to read ${ui5YamlPath}!`);
+					log("error", `Failed to read ${ui5YamlPath}!`);
 				}
 				throw err;
 			}
@@ -74,12 +96,19 @@ cds.on("bootstrap", async (app) => {
 			}
 
 			// mounting the Router for the application to the CAP server
-			console.log(`Mounting ${mountPath} to UI5 app ${appDir}`);
+			log("info", `Mounting ${mountPath} to UI5 app ${appDir}`);
 			const modulePath = path.dirname(ui5YamlPath);
 
 			// create the router and get rid of the mount path
 			const router = new Router();
 			router.use(function (req, res, next) {
+				// disable the compression when livereload is used
+				// for loading html-related content (via accept header)
+				const accept = req.headers["accept"]?.indexOf("html");
+				if (accept && res._livereload) {
+					req.headers["accept-encoding"] = "identity";
+				}
+				// remove the mount path from the url
 				req.originalUrl = req.url;
 				req.baseUrl = "/";
 				next();
@@ -96,18 +125,65 @@ cds.on("bootstrap", async (app) => {
 			pages.forEach((page) => {
 				const prefix = mountPath !== "/" ? mountPath : "";
 				links.push(`${prefix}${page.getPath()}`);
-				console.log(`${prefix}${page.getPath()}`);
 			});
 
 			// mount the router to the determined mount path
 			app.use(`${mountPath}`, router);
 		}
+
+		// register the custom middleware (similar like in @sap/cds/server.js)
+		app.get("/", function appendLinksToIndex(req, res, next) {
+			var send = res.send;
+			res.send = function (content) {
+				// 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 HTMLParser = require("node-html-parser");
+				const doc = new HTMLParser.parse(content);
+				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.map((link) => `<li><a href="${link}">${link}</a></li>`));
+					ul.innerHTML = newLis.join("\n");
+					content = doc.toString();
+				} else {
+					log("warn", `Failed to inject application links into CAP index page!`);
+				}
+				send.apply(this, arguments);
+			};
+			//log("debug", req.url);
+			next();
+		});
+
+		// move our middleware before the CAP 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 CAP overview page middleware! You need to manually open the application pages!`);
+			}
+		} else {
+			log("error", `Failed to inject application pages to CAP overview page! You need to manually open the application pages!`);
+		}
 	}
 });
 
-// mount static resources and common middlewares...
+// return callback for plugin activation
 module.exports = {
 	activate: function activate(conf) {
-		console.log("[cds-ui5-plugin] activate", conf);
+		log("debug", "activate", conf);
 	},
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cds-plugin-ui5",
-  "version": "0.1.0",
+  "version": "0.1.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",
@@ -10,18 +10,19 @@
     "directory": "packages/cds-plugin-ui5"
   },
   "dependencies": {
-    "@ui5/fs": "^3.0.3",
-    "@ui5/project": "^3.3.0",
-    "@ui5/server": "^3.1.2",
-    "js-yaml": "^4.1.0"
+    "@ui5/fs": "^3.0.4",
+    "@ui5/project": "^3.3.2",
+    "@ui5/server": "^3.1.3",
+    "js-yaml": "^4.1.0",
+    "node-html-parser": "^6.1.5"
   },
   "devDependencies": {
-    "@sap/cds": "^6.8.1",
+    "@sap/cds": "^6.8.4",
     "express": "^4.18.2"
   },
   "peerDependencies": {
-    "@sap/cds": ">=6.8.1",
+    "@sap/cds": ">=6.8.2",
     "express": ">=4.18.2"
   },
-  "gitHead": "4284aeb6a796456dba9e0ef4f6a2a8d7fd064f3d"
+  "gitHead": "84c3a3e5f36915ecd2ba1325c74635a9b6fab09d"
 }