cds-plugin-ui5 0.13.2 → 0.13.4

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.13.4](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.13.3...cds-plugin-ui5@0.13.4) (2025-07-31)
+
+
+### Bug Fixes
+
+* **cds-plugin-ui5:** fixes minor condition error for custom webapp path determination ([#1245](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/1245)) ([c3b7355](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/c3b735588bd51a4632e4e94893b3205ca0f6aff4))
+
+
+
+
+
+## [0.13.3](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.13.2...cds-plugin-ui5@0.13.3) (2025-07-29)
+
+
+### Bug Fixes
+
+* **cds-plugin-ui5:** fixes issue in lazy loading feature ([#1224](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/1224)) ([a65b4bc](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/a65b4bc13489484d6b755f3c530bc825f5c50f24))
+
+
+
+
+
 ## [0.13.2](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.13.1...cds-plugin-ui5@0.13.2) (2025-07-06)
 
 

package/cds-plugin.js

@@ -188,25 +188,20 @@ if (!skip) {
 					const router = createPatchedRouter();
 
 					// determine the application info and apply the UI5 middlewares (maybe lazy)
-					const promiseApply = applyUI5Middleware(router, {
+					const { pages } = await applyUI5Middleware(router, {
 						cwd,
 						basePath: modulePath,
 						...(config[moduleId] || {}),
-						LOG,
+						log: LOG,
 						lazy: isLazyLoadingEnabled,
 						//logPerformance: true,
-					}).then(({ pages }) => {
-						// append the HTML pages to the links
-						pages.forEach((page) => {
-							const prefix = mountPath !== "/" ? mountPath : "";
-							links.push(`${prefix}${page}`);
-						});
 					});
 
-					// if lazy loading is not enabled, we wait for the middlewares to be applied
-					if (!isLazyLoadingEnabled) {
-						await promiseApply; // wait for the middlewares to be applied
-					}
+					// append the HTML pages to the links
+					pages.forEach((page) => {
+						const prefix = mountPath !== "/" ? mountPath : "";
+						links.push(`${prefix}${page}`);
+					});
 
 					// register the router to the specified mount path
 					app.use(mountPath, router);

package/lib/applyUI5Middleware.js

@@ -1,5 +1,9 @@
 const path = require("path");
 const fs = require("fs");
+const { glob } = require("glob");
+const yaml = require("js-yaml");
+
+const PAGE_GLOB_PATTERN = "**/!(*.fragment).{html,htm}";
 
 /**
  * @typedef UI5AppInfo
@@ -46,11 +50,7 @@ module.exports = async function applyUI5Middleware(router, options) {
 
 	const logPerformance = options.logPerformance || false;
 
-	const millisImport = logPerformance && Date.now();
-	const { graphFromPackageDependencies } = await import("@ui5/project/graph");
-	logPerformance && log.info(`[PERF] Import took ${Date.now() - millisImport}ms`);
-
-	const determineConfigPath = function (configPath, configFile) {
+	const determineConfigPath = (configPath, configFile) => {
 		// ensure that the config path is absolute
 		if (!path.isAbsolute(configPath)) {
 			configPath = path.resolve(options.basePath, configPath);
@@ -72,39 +72,50 @@ module.exports = async function applyUI5Middleware(router, options) {
 		return undefined;
 	};
 
-	// determine the project graph from the given options
-	const millisGraph = logPerformance && Date.now();
-	const graph = await graphFromPackageDependencies({
-		cwd: options.basePath,
-		rootConfigPath: determineConfigPath(configPath, configFile),
-		workspaceName: process.env["ui5-workspace"] || options.workspaceName || "default",
-		workspaceConfigPath: determineConfigPath(workspaceConfigPath, workspaceConfigFile),
-		versionOverride: options.versionOverride,
-		cacheMode: options.cacheMode,
-	});
-	logPerformance && log.info(`[PERF] Graph took ${Date.now() - millisGraph}ms`);
-
-	const millisRoot = logPerformance && Date.now();
-	// detect the root project
-	const rootProject = graph.getRoot();
-
-	// create a reader for the root project
-	const rootReader = rootProject.getReader({ style: "runtime" });
-	logPerformance && log.info(`[PERF] Root project took ${Date.now() - millisRoot}ms`);
-
-	// for Fiori elements based applications we need to invalidate the view cache
-	// so we need to append the query parameter to the HTML files (sap-ui-xx-viewCache=false)
-	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 millisPages = logPerformance && Date.now();
-	const pages = (await rootReader.byGlob("**/!(*.fragment).{html,htm}")).map((resource) => `${resource.getPath()}${isFioriElementsBased ? "?sap-ui-xx-viewCache=false" : ""}`);
-	logPerformance && log.info(`[PERF] Pages took ${Date.now() - millisPages}ms`);
+	const loadAppInfo = async () => {
+		const millisImport = logPerformance && Date.now();
+		const { graphFromPackageDependencies } = await import("@ui5/project/graph");
+		logPerformance && log.info(`[PERF] Import took ${Date.now() - millisImport}ms`);
+
+		// determine the project graph from the given options
+		const millisGraph = logPerformance && Date.now();
+		const graph = await graphFromPackageDependencies({
+			cwd: options.basePath,
+			rootConfigPath: determineConfigPath(configPath, configFile),
+			workspaceName: process.env["ui5-workspace"] || options.workspaceName || "default",
+			workspaceConfigPath: determineConfigPath(workspaceConfigPath, workspaceConfigFile),
+			versionOverride: options.versionOverride,
+			cacheMode: options.cacheMode,
+		});
+		logPerformance && log.info(`[PERF] Graph took ${Date.now() - millisGraph}ms`);
+
+		const millisRoot = logPerformance && Date.now();
+		// detect the root project
+		const rootProject = graph.getRoot();
+
+		// create a reader for the root project
+		const rootReader = rootProject.getReader({ style: "runtime" });
+		logPerformance && log.info(`[PERF] Root project took ${Date.now() - millisRoot}ms`);
+
+		return { rootProject, rootReader, graph };
+	};
+
+	const loadPages = async ({ rootProject, rootReader }) => {
+		// for Fiori elements based applications we need to invalidate the view cache
+		// so we need to append the query parameter to the HTML files (sap-ui-xx-viewCache=false)
+		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 millisPages = logPerformance && Date.now();
+		const pages = (await rootReader.byGlob(PAGE_GLOB_PATTERN)).map((resource) => `${resource.getPath()}${isFioriElementsBased ? "?sap-ui-xx-viewCache=false" : ""}`);
+		logPerformance && log.info(`[PERF] Pages took ${Date.now() - millisPages}ms`);
+		return pages;
+	};
 
 	// method to create the middleware manager and to apply the middlewares
 	// to the express router provided as a parameter to this function
-	const apply = async () => {
+	const apply = async ({ rootProject, rootReader, graph, pages }) => {
 		// find the relevant readers for the dependencies
 		const readers = [];
 		await graph.traverseBreadthFirst(async function ({ project: dep }) {
@@ -148,6 +159,10 @@ module.exports = async function applyUI5Middleware(router, options) {
 		});
 		await middlewareManager.applyMiddleware(router);
 
+		// custom pages are not collectible in lazy loading mode
+		if (!pages) {
+			return;
+		}
 		// collect app pages from middlewares implementing the getAppPages
 		// which will only work if the middleware is executed synchronously
 		middlewareManager.middlewareExecutionOrder?.map((name) => {
@@ -169,24 +184,55 @@ module.exports = async function applyUI5Middleware(router, options) {
 		});
 	};
 
+	const determineWebappPath = (ui5ConfigPath) => {
+		if (!ui5ConfigPath) {
+			log.warn("Path to config file could not be determined. Using default webapp path to lookup HTML pages");
+			return "webapp";
+		}
+
+		/** @type {{resources: {configuration: {paths: {webapp: string}}}}[]} */
+		let ui5Configs;
+		try {
+			// read the ui5.yaml file to extract the configuration
+			const content = fs.readFileSync(ui5ConfigPath, "utf-8");
+			ui5Configs = yaml.loadAll(content);
+		} catch (err) {
+			if (err.name === "YAMLException") {
+				log.error(`Failed to read ${ui5ConfigPath}!`);
+			}
+			throw err;
+		}
+
+		const webappPath = ui5Configs?.[0]?.resources?.configuration?.paths?.webapp;
+		if (webappPath) {
+			log.debug(`Determined custom "webapp" path "${webappPath}"`);
+		}
+		return webappPath ?? "webapp";
+	};
+
 	// install a callback in the router to apply the middlewares
 	if (options.lazy) {
 		let isApplied = false;
 		router.use(async (req, res, next) => {
 			if (!isApplied) {
-				await apply();
+				const { graph, rootProject, rootReader } = await loadAppInfo();
+				await apply({ graph, rootProject, rootReader });
 				isApplied = true;
 			}
 			next();
 		});
+		const webappPath = determineWebappPath(determineConfigPath(configPath, configFile));
+		// collect pages via glob pattern
+		return {
+			pages: (await glob(PAGE_GLOB_PATTERN, { cwd: path.join(configPath, webappPath) })).map((p) => (!p.startsWith("/") ? `/${p}` : p)),
+		};
 	} else {
-		await apply();
-	}
-
-	logPerformance && log.info(`[PERF] applyUI5Middleware took ${Date.now() - millis}ms`);
+		const { graph, rootProject, rootReader } = await loadAppInfo();
+		const pages = await loadPages({ rootProject, rootReader });
+		await apply({ graph, rootProject, rootReader, pages });
+		logPerformance && log.info(`[PERF] applyUI5Middleware took ${Date.now() - millis}ms`);
 
-	// return the UI5 application information
-	return {
-		pages,
-	};
+		// return the UI5 application information
+		return { pages };
+	}
 };

package/lib/findUI5Modules.js

@@ -18,7 +18,7 @@ const yaml = require("js-yaml");
  * @param {string} options.skipLocalApps skip local apps
  * @param {string} options.skipDeps skip dependencies
  * @param {string} options.log the logger (defaults to console)
- * @returns {Array<UI5Module>} array of UI5 module
+ * @returns {Promise<Array<UI5Module>>} array of UI5 module
  */
 module.exports = async function findUI5Modules({ cwd, cds, skipLocalApps, skipDeps, log = console }) {
 	// extract the modules configuration from the package.json

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cds-plugin-ui5",
-  "version": "0.13.2",
+  "version": "0.13.4",
   "description": "A CDS server plugin to inject the middlewares of all related UI5 tooling based projects.",
   "author": "Peter Muessig",
   "license": "Apache-2.0",
@@ -14,6 +14,7 @@
     "@ui5/fs": "^4",
     "@ui5/project": "^4",
     "@ui5/server": "^4",
+    "glob": "^11.0.2",
     "js-yaml": "^4.1.0",
     "node-html-parser": "^7.0.1",
     "semver": "^7.7.2"
@@ -26,5 +27,5 @@
     "@sap/cds": ">=6.8.2",
     "express": ">=4.18.2"
   },
-  "gitHead": "4564f2dc020ee4e2dcc5a7e0ebc982d488709350"
+  "gitHead": "5859e2f476004c8a9a7e3320f8948d5605986982"
 }