cds-plugin-ui5 0.6.10 → 0.6.12

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.6.12](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.6.11...cds-plugin-ui5@0.6.12) (2023-10-01)
+
+
+### Bug Fixes
+
+* **cds-plugin-ui5:** handle dirs without trailing slash ([#856](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/856)) ([ee0df6b](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/ee0df6b1cd2242c3a0d49bda4737838f17daef33))
+* **cds-plugin-ui5:** rework collision detection ([#853](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/853)) ([b25fd5c](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/b25fd5c10600c15e0bd4977e3792c78fea7f366e))
+
+
+
+
+
+## [0.6.11](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.6.10...cds-plugin-ui5@0.6.11) (2023-09-25)
+
+
+### Bug Fixes
+
+* **cds-plugin-ui5:** disable view cache for Fiori elements based apps ([#847](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/847)) ([81f6a80](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/81f6a803cff4f0c7323e7dcf5b2a28dc081d3123))
+
+
+
+
+
 ## [0.6.10](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.6.9...cds-plugin-ui5@0.6.10) (2023-09-15)
 
 

package/cds-plugin.js

@@ -7,10 +7,6 @@ const createPatchedRouter = require("./lib/createPatchedRouter");
 const applyUI5Middleware = require("./lib/applyUI5Middleware");
 const rewriteHTML = require("./lib/rewriteHTML");
 
-// marker that the cds-plugin-ui5 plugin is running
-// to disable the ui5-middleware-cap if used in apps
-process.env["cds-plugin-ui5"] = true;
-
 // identify whether the execution should be skipped
 let skip = false;
 if (process.env["ui5-middleware-cap"]) {
@@ -23,6 +19,10 @@ if (process.env["ui5-middleware-cap"]) {
 
 // only hook into lifecycle if the plugin should not be skipped
 if (!skip) {
+	// marker that the cds-plugin-ui5 plugin is running
+	// to disable the ui5-middleware-cap if used in apps
+	process.env["cds-plugin-ui5"] = true;
+
 	// promise to await the bootstrap and lock the
 	// served event to delay the startup a bit
 	let bootstrapped;
@@ -123,7 +123,14 @@ if (!skip) {
 									newLis.push(li.toString());
 								}
 							});
-							newLis.push(...links.sort().map((link) => `<li><a class="ui5" href="${link}">${link}</a></li>`));
+							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!`);
@@ -157,6 +164,8 @@ if (!skip) {
 // return callback for plugin activation
 module.exports = {
 	activate: function activate(conf) {
-		log.debug("activate", conf);
+		if (!skip) {
+			log.debug("activate", conf);
+		}
 	},
 };

package/lib/applyUI5Middleware.js

@@ -117,9 +117,12 @@ module.exports = async function applyUI5Middleware(router, options) {
 	});
 	await middlewareManager.applyMiddleware(router);
 
+	// for Fiori elements based applications we need to invalidate the view cache
+	const isFioriElementsBased = rootProject.getFrameworkDependencies().find((lib) => lib.name.startsWith("sap.fe"));
+
 	// collect app pages from workspace (glob testing: https://globster.xyz/ and https://codepen.io/mrmlnc/pen/OXQjMe)
 	//   -> but exclude the HTML fragments from the list of app pages!
-	const pages = (await rootReader.byGlob("**/!(*.fragment).{html,htm}")).map((resource) => resource.getPath());
+	const pages = (await rootReader.byGlob("**/!(*.fragment).{html,htm}")).map((resource) => `${resource.getPath()}${isFioriElementsBased ? "?sap-ui-xx-viewCache=false" : ""}`);
 
 	// collect app pages from middlewares implementing the getAppPages
 	middlewareManager.middlewareExecutionOrder?.map((name) => {

package/lib/createPatchedRouter.js

@@ -12,7 +12,7 @@ module.exports = async function createPatchedRouter() {
 	router.use(function (req, res, next) {
 		// store the original request information
 		const { url, originalUrl, baseUrl } = req;
-		req["cds-plugin-ui5"] = {
+		req["ui5-patched-router"] = req["ui5-patched-router"] || {
 			url,
 			originalUrl,
 			baseUrl,
@@ -20,26 +20,25 @@ module.exports = async function createPatchedRouter() {
 		// rewite the path to simulate requests on the root level
 		req.originalUrl = req.url;
 		req.baseUrl = "/";
+		// only accept requests for html-related content (via accept header)
+		const accept = req.headers["accept"]?.indexOf("html") !== -1;
 		// disable the compression when livereload is used
 		// for loading html-related content (via accept header)
 		// otherwise we run into compression issue with CDS livereload
-		const accept = req.headers["accept"]?.indexOf("html") !== -1;
 		if (accept && res._livereload) {
 			req.headers["accept-encoding"] = "identity";
 		}
-		// override UI5 server directory listing if:
-		//   1.) not handled by the CDS Plugin UI5 already
-		//   2.) only if it ends with a slash
-		//   3.) not forwarded to a welcome page
-		if (!req._cds_plugin_ui5 && req.url?.endsWith("/") && req.url === (req?.["ui5-middleware-index"]?.url || req.url)) {
+		// override UI5 server directory listing if not forwarded to a welcome page
+		// and not already handled by the HTML rewriter of the CDS welcome page
+		if (accept && !req._cds_plugin_ui5 && req.url === (req["ui5-middleware-index"]?.url || req.url)) {
 			// determine context path (approuter contains x-forwarded-path header)
 			let contextPath = baseUrl;
-			if (req.headers["x-forwarded-path"]) {
+			if (req.headers["x-forwarded-path"]?.endsWith(url)) {
 				// determine the context path by removing the subpath from the forwarded path
 				contextPath = req.headers["x-forwarded-path"].slice(0, -1 * url.length);
-			} else if (req["cds-plugin-ui5"].originalUrl) {
+			} else if (req["ui5-patched-router"].originalUrl?.endsWith(url)) {
 				// determine the context path by removing the subpath from the originalUrl
-				contextPath = req["cds-plugin-ui5"].originalUrl.slice(0, -1 * url.length);
+				contextPath = req["ui5-patched-router"].originalUrl.slice(0, -1 * url.length);
 			}
 			rewriteHTML(
 				req,
@@ -50,21 +49,21 @@ module.exports = async function createPatchedRouter() {
 				},
 				(doc) => {
 					const title = doc.getElementsByTagName("title")?.[0];
-					if (title) {
+					if (title && title.innerHTML.startsWith(`Index of ${req.url}`)) {
 						title.innerHTML = `Index of ${contextPath}/`;
+						const files = doc.getElementById("files");
+						const filesas = files?.getElementsByTagName("a");
+						filesas?.forEach((a) => {
+							a.setAttribute("href", `${contextPath}${a.getAttribute("href")}`);
+						});
+						const h1 = doc.getElementsByTagName("h1")?.[0];
+						const h1as = h1?.getElementsByTagName("a");
+						h1as?.forEach((a) => {
+							const path = a.getAttribute("href") === "/" ? "/" : a.getAttribute("href") + "/";
+							a.setAttribute("href", `${contextPath}${path}`);
+						});
+						h1?.insertAdjacentHTML("afterbegin", `<a href="/">🏡</a> / `);
 					}
-					const files = doc.getElementById("files");
-					const filesas = files?.getElementsByTagName("a");
-					filesas?.forEach((a) => {
-						a.setAttribute("href", `${contextPath}${a.getAttribute("href")}`);
-					});
-					const h1 = doc.getElementsByTagName("h1")?.[0];
-					const h1as = h1?.getElementsByTagName("a");
-					h1as?.forEach((a) => {
-						const path = a.getAttribute("href") === "/" ? "/" : a.getAttribute("href") + "/";
-						a.setAttribute("href", `${contextPath}${path}`);
-					});
-					h1?.insertAdjacentHTML("afterbegin", `<a href="/">🏡</a> / `);
 				}
 			);
 		}

package/lib/findUI5Modules.js

@@ -7,6 +7,7 @@ const log = require("./log");
 /**
  * @typedef UI5Module
  * @type {object}
+ * @property {string} moduleId package name of the module
  * @property {string} modulePath root path of the module
  * @property {string} mountPath path to mount the module to
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cds-plugin-ui5",
-  "version": "0.6.10",
+  "version": "0.6.12",
   "description": "A CDS server 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": "4e614b76248207ceeaf36bcedd22abfee7f4c226"
+  "gitHead": "fb2d781edbff18febc11b79d686281cddc2532d6"
 }