refactor(server): Remove obsolete code from serveResources middleware

Author: matz3

packages/server/lib/middleware/MiddlewareManager.js

@@ -218,6 +218,7 @@ class MiddlewareManager {
 		});
 		await this.addMiddleware("serveResources");
 		await this.addMiddleware("testRunner");
+		// TODO: Allow to still reference 'serveThemes' middleware in custom middleware
 		// await this.addMiddleware("serveThemes");
 		await this.addMiddleware("versionInfo", {
 			mountPath: "/resources/sap-ui-version.json"

packages/server/lib/middleware/serveResources.js

@@ -1,15 +1,5 @@
-import {getLogger} from "@ui5/logger";
-const log = getLogger("server:middleware:serveResources");
-import replaceStream from "replacestream";
 import etag from "etag";
 import fresh from "fresh";
-import fsInterface from "@ui5/fs/fsInterface";
-
-const rProperties = /\.properties$/i;
-const rReplaceVersion = /\.(library|js|json)$/i;
-const rManifest = /\/manifest\.json$/i;
-const rResourcesPrefix = /^\/resources\//i;
-const rTestResourcesPrefix = /^\/test-resources\//i;
 
 function isFresh(req, res) {
 	return fresh(req.headers, {
@@ -18,7 +8,7 @@ function isFresh(req, res) {
 }
 
 /**
- * Creates and returns the middleware to serve application resources.
+ * Creates and returns the middleware to serve project resources.
  *
  * @module @ui5/server/middleware/serveResources
  * @param {object} parameters Parameters
@@ -30,90 +20,23 @@ function createMiddleware({resources, middlewareUtil}) {
 	return async function serveResources(req, res, next) {
 		try {
 			const pathname = middlewareUtil.getPathname(req);
-			let resource = await resources.all.byPath(pathname);
-			if (!resource) { // Not found
-				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 && dotLibraryResource.getProject()?.getType() === "library") {
-					resource = await generateLibraryManifest(middlewareUtil, dotLibraryResource);
-				}
-				if (!resource) {
-					// Not a library project, missing .library file or other reason for failed manifest.json generation
-					next();
-					return;
-				}
-			} else if (
-				rManifest.test(pathname) && !rTestResourcesPrefix.test(pathname) &&
-				resource.getProject()?.getNamespace()
-			) {
-				// Special handling for manifest.json file by adding additional content to the served manifest.json
-				// NOTE: This should only be done for manifest.json files that exist in the sources,
-				// not in test-resources.
-				// Files created by generateLibraryManifest (see above) should not be handled in here.
-				// Only manifest.json files in library / application projects should be handled.
-				// resource.getProject.getNamespace() returns null for all other kind of projects.
-				const {default: manifestEnhancer} = await import("@ui5/builder/processors/manifestEnhancer");
-				await manifestEnhancer({
-					resources: [resource],
-					// Ensure that only files within the manifest's project are accessible
-					// Using the "runtime" style to match the style used by the UI5 server
-					fs: fsInterface(resource.getProject().getReader({style: "runtime"}))
-				});
+			const resource = await resources.all.byPath(pathname);
+			if (!resource) {
+				// Not found
+				next();
+				return;
 			}
 
 			const resourcePath = resource.getPath();
-			if (rProperties.test(resourcePath)) {
-				// Special handling for *.properties files escape non ascii characters.
-				const {default: nonAsciiEscaper} = await import("@ui5/builder/processors/nonAsciiEscaper");
-				const project = resource.getProject();
-				let propertiesFileSourceEncoding = project?.getPropertiesFileSourceEncoding?.();
-
-				if (!propertiesFileSourceEncoding) {
-					if (project && project.getSpecVersion().lte("1.1")) {
-						// default encoding to "ISO-8859-1" for old specVersions
-						propertiesFileSourceEncoding = "ISO-8859-1";
-					} else {
-						// default encoding to "UTF-8" for all projects starting with specVersion 2.0
-						propertiesFileSourceEncoding = "UTF-8";
-					}
-				}
-				const encoding = nonAsciiEscaper.getEncodingFromAlias(propertiesFileSourceEncoding);
-				await nonAsciiEscaper({
-					resources: [resource], options: {
-						encoding
-					}
-				});
-			}
 
-			const {contentType, charset} = middlewareUtil.getMimeInfo(resourcePath);
+			const {contentType} = middlewareUtil.getMimeInfo(resourcePath);
 			if (!res.getHeader("Content-Type")) {
 				res.setHeader("Content-Type", contentType);
 			}
 
 			// Enable ETag caching
-			const statInfo = resource.getStatInfo();
-			if (statInfo?.size !== undefined && !resource.isModified()) {
-				let etagHeader = etag(statInfo);
-				if (resource.getProject()) {
-					// Add project version to ETag to invalidate cache when project version changes.
-					// This is necessary to invalidate files with ${version} placeholders.
-					etagHeader = etagHeader.slice(0, -1) + `-${resource.getProject().getVersion()}"`;
-				}
-				res.setHeader("ETag", etagHeader);
-			} else {
-				// Fallback to buffer if stats are not available or insufficient or resource is modified.
-				// Modified resources must use the buffer for cache invalidation so that UI5 CLI changes
-				// invalidate the cache even when the original resource is not modified.
-				res.setHeader("ETag", etag(await resource.getBuffer()));
-			}
+			const resourceIntegrity = await resource.getIntegrity();
+			res.setHeader("ETag", etag(resourceIntegrity));
 
 			if (isFresh(req, res)) {
 				// client has a fresh copy of the resource
@@ -122,22 +45,9 @@ function createMiddleware({resources, middlewareUtil}) {
 				return;
 			}
 
-			let stream = resource.getStream();
-
-			// Only execute version replacement for UTF-8 encoded resources because replaceStream will always output
-			//	UTF-8 anyways.
-			// Also, only process .library, *.js and *.json files. Just like it's done in Application-
-			//	and LibraryBuilder
-			if ((!charset || charset === "UTF-8") && rReplaceVersion.test(resourcePath)) {
-				if (resource.getProject()) {
-					stream.setEncoding("utf8");
-					stream = stream.pipe(replaceStream("${version}", resource.getProject().getVersion()));
-				} else {
-					log.verbose(`Project missing from resource ${pathname}"`);
-				}
-			}
-
-			stream.pipe(res);
+			// Pipe resource stream to response
+			// TODO: Check whether we can optimize this for small or even all resources by using getBuffer()
+			resource.getStream().pipe(res);
 		} catch (err) {
 			next(err);
 		}