@ui5/server 3.1.5 → 3.2.0

package/.reuse/dep5

@@ -25,7 +25,7 @@ Disclaimer: The code in this project may include calls to APIs (“API Calls”)
  parties the right to use of access any SAP External Product, through API Calls.
 
 Files: *
-Copyright: 2018-2023 SAP SE or an SAP affiliate company and UI5 Tooling contributors
+Copyright: 2018-2024 SAP SE or an SAP affiliate company and UI5 Tooling contributors
 License: Apache-2.0
 
 Files: lib/middleware/serveIndex/*
@@ -36,5 +36,5 @@ Copyright: 2010 Sencha Inc.
 License: MIT
 
 Files: lib/middleware/testRunner/*
-Copyright: 2009-2023 SAP SE or an SAP affiliate company and OpenUI5 contributors
+Copyright: 2009-2024 SAP SE or an SAP affiliate company and OpenUI5 contributors
 License: Apache-2.0

package/CHANGELOG.md

@@ -2,7 +2,13 @@
 All notable changes to this project will be documented in this file.  
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-A list of unreleased changes can be found [here](https://github.com/SAP/ui5-server/compare/v3.1.5...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-server/compare/v3.2.0...HEAD).
+
+<a name="v3.2.0"></a>
+## [v3.2.0] - 2024-04-24
+### Features
+- **serveResources:** Dynamically generate missing library manifest.json [`d31f2c5`](https://github.com/SAP/ui5-server/commit/d31f2c57aa0b0c72fb033c41587ff257312838d1)
+
 
 <a name="v3.1.5"></a>
 ## [v3.1.5] - 2023-12-12
@@ -329,6 +335,7 @@ Only Node.js v10 or higher is supported.
 
 <a name="v0.0.1"></a>
 ## v0.0.1 - 2018-06-06
+[v3.2.0]: https://github.com/SAP/ui5-server/compare/v3.1.5...v3.2.0
 [v3.1.5]: https://github.com/SAP/ui5-server/compare/v3.1.4...v3.1.5
 [v3.1.4]: https://github.com/SAP/ui5-server/compare/v3.1.3...v3.1.4
 [v3.1.3]: https://github.com/SAP/ui5-server/compare/v3.1.2...v3.1.3

package/CONTRIBUTING.md

@@ -1,3 +1,3 @@
 # Contributing to the UI5 Tooling
 
-See CONTRIBUTING.md in the [SAP/ui5-tooling](https://github.com/SAP/ui5-tooling/blob/main/CONTRIBUTING.md) repository.
+See CONTRIBUTING.md in the [SAP/ui5-tooling](https://github.com/SAP/ui5-tooling/blob/v3/CONTRIBUTING.md) repository.

package/LICENSE.txt

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2018-2023 SAP SE or an SAP affiliate company and UI5 Tooling contributors
+   Copyright 2018-2024 SAP SE or an SAP affiliate company and UI5 Tooling contributors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -1,11 +1,11 @@
-![UI5 icon](https://raw.githubusercontent.com/SAP/ui5-tooling/main/docs/images/UI5_logo_wide.png)
+![UI5 icon](https://raw.githubusercontent.com/SAP/ui5-tooling/v3/docs/images/UI5_logo_wide.png)
 
 # ui5-server
 > Modules for running a UI5 development server  
 > Part of the [UI5 Tooling](https://github.com/SAP/ui5-tooling)
 
 [![REUSE status](https://api.reuse.software/badge/github.com/SAP/ui5-server)](https://api.reuse.software/info/github.com/SAP/ui5-server)
-[![Build Status](https://dev.azure.com/sap/opensource/_apis/build/status/SAP.ui5-server?branchName=main)](https://dev.azure.com/sap/opensource/_build/latest?definitionId=34&branchName=main)
+[![Build Status](https://dev.azure.com/sap/opensource/_apis/build/status/SAP.ui5-server?branchName=v3)](https://dev.azure.com/sap/opensource/_build/latest?definitionId=34&branchName=v3)
 [![npm Package Version](https://badge.fury.io/js/%40ui5%2Fserver.svg)](https://www.npmjs.com/package/@ui5/server)
 [![Coverage Status](https://coveralls.io/repos/github/SAP/ui5-server/badge.svg)](https://coveralls.io/github/SAP/ui5-server)
 
@@ -15,10 +15,10 @@ UI5 Server documentation can be found here: [sap.github.io/ui5-tooling](https://
 The UI5 Server API Reference can be found here: [`@ui5/server`](https://sap.github.io/ui5-tooling/v3/api/module-@ui5_server.html)
 
 ## Contributing
-Please check our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/main/CONTRIBUTING.md).
+Please check our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/v3/CONTRIBUTING.md).
 
 ## Support
-Please follow our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/main/CONTRIBUTING.md#report-an-issue) on how to report an issue.
+Please follow our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/v3/CONTRIBUTING.md#report-an-issue) on how to report an issue.
 
 Please report issues in the main [UI5 Tooling](https://github.com/SAP/ui5-tooling) repository.
 

package/lib/middleware/MiddlewareManager.js

@@ -220,16 +220,7 @@ class MiddlewareManager {
 		await this.addMiddleware("testRunner");
 		await this.addMiddleware("serveThemes");
 		await this.addMiddleware("versionInfo", {
-			mountPath: "/resources/sap-ui-version.json",
-			wrapperCallback: ({middleware: versionInfoModule}) => {
-				return ({resources, middlewareUtil}) => {
-					return versionInfoModule({
-						resources,
-						middlewareUtil,
-						graph: this.graph
-					});
-				};
-			}
+			mountPath: "/resources/sap-ui-version.json"
 		});
 		// Handle anything but read operations *before* the serveIndex middleware
 		//	as it will reject them with a 405 (Method not allowed) instead of 404 like our old tooling

package/lib/middleware/helper/generateLibraryManifest.js

@@ -0,0 +1,18 @@
+import createManifestProcessor from "@ui5/builder/processors/manifestCreator";
+
+export default async function generateLibraryManifest(middlewareUtil, dotLibResource) {
+	const project = dotLibResource.getProject();
+	const libResources = await project.getReader().byGlob(
+		`/resources/**/*.{js,json,library,less,css,theming,theme,properties}`);
+
+	const res = await createManifestProcessor({
+		libraryResource: dotLibResource,
+		namespace: project.getNamespace(),
+		resources: libResources,
+		getProjectVersion: (projectName) => {
+			return middlewareUtil.getProject(projectName)?.getVersion();
+		}
+	});
+	res.setProject(project);
+	return res;
+}

package/lib/middleware/serveResources.js

@@ -6,6 +6,8 @@ import fresh from "fresh";
 
 const rProperties = /\.properties$/i;
 const rReplaceVersion = /\.(library|js|json)$/i;
+const rManifest = /\/manifest.json$/i;
+const rResourcesPrefix = /^\/resources\//i;
 
 function isFresh(req, res) {
 	return fresh(req.headers, {
@@ -20,18 +22,33 @@ function isFresh(req, res) {
  * @module @ui5/server/middleware/serveResources
  * @param {object} parameters Parameters
  * @param {@ui5/server/internal/MiddlewareManager.middlewareResources} parameters.resources Parameters
- * @param {object} parameters.middlewareUtil Specification version dependent interface to a
- *                                        [MiddlewareUtil]{@link @ui5/server/middleware/MiddlewareUtil} instance
+ * @param {object} parameters.middlewareUtil [MiddlewareUtil]{@link @ui5/server/middleware/MiddlewareUtil} instance
  * @returns {Function} Returns a server middleware closure.
  */
 function createMiddleware({resources, middlewareUtil}) {
 	return async function serveResources(req, res, next) {
 		try {
 			const pathname = middlewareUtil.getPathname(req);
-			const resource = await resources.all.byPath(pathname);
+			let resource = await resources.all.byPath(pathname);
 			if (!resource) { // Not found
-				next();
-				return;
+				if (!rManifest.test(pathname) || !rResourcesPrefix.test(pathname)) {
+					next();
+					return;
+				}
+				log.verbose(`Could not find manifest.json for ${pathname}. ` +
+					`Checking for .library file to generate manifest.json from.`);
+				const {default: generateLibraryManifest} = await import("./helper/generateLibraryManifest.js");
+				// Attempt to find a .library file, which is required for generating a manifest.json
+				const dotLibraryPath = pathname.replace(rManifest, "/.library");
+				const dotLibraryResource = await resources.all.byPath(dotLibraryPath);
+				if (!dotLibraryResource) {
+					log.verbose(
+						`Could not find a .library to generate manifest.json from at ${dotLibraryPath}. ` +
+						`This might indicate that the project is not a library project.`);
+					next();
+					return;
+				}
+				resource = await generateLibraryManifest(middlewareUtil, dotLibraryResource);
 			}
 
 			const resourcePath = resource.getPath();
@@ -64,7 +81,13 @@ function createMiddleware({resources, middlewareUtil}) {
 			}
 
 			// Enable ETag caching
-			res.setHeader("ETag", etag(resource.getStatInfo()));
+			const statInfo = resource.getStatInfo();
+			if (statInfo?.size !== undefined) {
+				res.setHeader("ETag", etag(statInfo));
+			} else {
+				// Fallback to buffer if stats are not available or insufficient
+				res.setHeader("ETag", etag(await resource.getBuffer()));
+			}
 
 			if (isFresh(req, res)) {
 				// client has a fresh copy of the resource

package/lib/middleware/versionInfo.js

@@ -1,5 +1,5 @@
 import createVersionInfoProcessor from "@ui5/builder/processors/versionInfoGenerator";
-import createManifestProcessor from "@ui5/builder/processors/manifestCreator";
+import generateLibraryManifest from "./helper/generateLibraryManifest.js";
 
 const MANIFEST_JSON = "manifest.json";
 
@@ -9,10 +9,10 @@ const MANIFEST_JSON = "manifest.json";
  * @module @ui5/server/middleware/versionInfo
  * @param {object} parameters Parameters
  * @param {@ui5/server/internal/MiddlewareManager.middlewareResources} parameters.resources Parameters
- * @param {@ui5/project/graph/ProjectGraph} parameters.graph Project graph
+ * @param {object} parameters.middlewareUtil [MiddlewareUtil]{@link @ui5/server/middleware/MiddlewareUtil} instance
  * @returns {Function} Returns a server middleware closure.
  */
-function createMiddleware({resources, graph}) {
+function createMiddleware({resources, middlewareUtil}) {
 	return async function versionInfo(req, res, next) {
 		try {
 			const dependencies = resources.dependencies;
@@ -31,20 +31,7 @@ function createMiddleware({resources, graph}) {
 				const embeddedManifests =
 					manifestResources.filter((manifestResource) => manifestResource !== libraryManifest);
 				if (!libraryManifest) {
-					const extensions = "js,json,library,less,css,theming,theme,properties";
-					const libResources = await dependencies.byGlob(`/resources/${namespace}/**/*.{${extensions}}`);
-
-					libraryManifest = await createManifestProcessor({
-						libraryResource: dotLibResource,
-						namespace,
-						resources: libResources,
-						options: {
-							omitMinVersions: true
-						},
-						getProjectVersion: (projectName) => {
-							return graph.getProject(projectName)?.getVersion();
-						}
-					});
+					libraryManifest = await generateLibraryManifest(middlewareUtil, dotLibResource);
 				}
 				return {
 					libraryManifest,
@@ -53,7 +40,7 @@ function createMiddleware({resources, graph}) {
 					version: dotLibResource.getProject().getVersion()
 				};
 			});
-			const rootProject = graph.getRoot();
+			const rootProject = middlewareUtil.getProject();
 			const libraryInfos = await Promise.all(libraryInfosPromises);
 			const [versionInfoResource] = await createVersionInfoProcessor({
 				options: {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ui5/server",
-	"version": "3.1.5",
+	"version": "3.2.0",
 	"description": "UI5 Tooling - Server",
 	"author": {
 		"name": "SAP SE",
@@ -115,7 +115,7 @@
 		"url": "git@github.com:SAP/ui5-server.git"
 	},
 	"dependencies": {
-		"@ui5/builder": "^3.2.0",
+		"@ui5/builder": "^3.4.0",
 		"@ui5/fs": "^3.0.5",
 		"@ui5/logger": "^3.0.0",
 		"body-parser": "^1.20.2",
@@ -124,7 +124,7 @@
 		"devcert-sanscache": "^0.4.8",
 		"escape-html": "^1.0.3",
 		"etag": "^1.8.1",
-		"express": "^4.18.2",
+		"express": "^4.19.2",
 		"fresh": "^0.5.2",
 		"graceful-fs": "^4.2.11",
 		"mime-types": "^2.1.35",
@@ -137,23 +137,23 @@
 	},
 	"devDependencies": {
 		"@istanbuljs/esm-loader-hook": "^0.2.0",
-		"@ui5/project": "^3.8.0",
+		"@ui5/project": "^3.9.1",
 		"ava": "^5.3.1",
 		"chokidar-cli": "^3.0.0",
 		"cross-env": "^7.0.3",
 		"depcheck": "^1.4.7",
 		"docdash": "^2.0.2",
-		"eslint": "^8.55.0",
+		"eslint": "^8.57.0",
 		"eslint-config-google": "^0.14.0",
 		"eslint-plugin-ava": "^14.0.0",
-		"eslint-plugin-jsdoc": "^46.9.0",
-		"esmock": "^2.6.0",
+		"eslint-plugin-jsdoc": "^46.10.1",
+		"esmock": "^2.6.4",
 		"jsdoc": "^4.0.2",
 		"nyc": "^15.1.0",
 		"open-cli": "^7.2.0",
 		"rimraf": "^5.0.5",
 		"sinon": "^16.1.3",
-		"supertest": "^6.3.3",
+		"supertest": "^6.3.4",
 		"tap-xunit": "^2.4.1"
 	}
 }