@ui5/server 3.0.0-beta.3 → 3.0.0-rc.0

package/CHANGELOG.md

@@ -2,7 +2,32 @@
 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.0.0-beta.3...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-server/compare/v3.0.0-rc.0...HEAD).
+
+<a name="v3.0.0-rc.0"></a>
+## [v3.0.0-rc.0] - 2022-12-23
+### Breaking Changes
+- Remove "/proxy" endpoint ([#550](https://github.com/SAP/ui5-server/issues/550)) [`4bdf839`](https://github.com/SAP/ui5-server/commit/4bdf839e96f67ddbc4cb2a18216921d54df4006e)
+
+### BREAKING CHANGE
+
+This removes the "/proxy" endpoint and the corresponding
+"connectUi5Proxy" middleware from the standard ui5-server.
+Internally, this middleware made use of the connect-openui5 proxy
+implementation (https://github.com/SAP/connect-openui5#proxy).
+
+More sophisticated proxy solutions for ui5-server are already available
+in the form of custom middleware extensions from the UI5-community.
+
+The UI5 Team might provide a dedicated custom middleware extension,
+with similar functionality, in the future.
+
+
+<a name="v3.0.0-beta.4"></a>
+## [v3.0.0-beta.4] - 2022-12-01
+### Dependency Updates
+- Bump connect-openui5 from 0.10.2 to 0.10.3 [`90871f8`](https://github.com/SAP/ui5-server/commit/90871f89815501860616ffbdf8927824412ec909)
+
 
 <a name="v3.0.0-beta.3"></a>
 ## [v3.0.0-beta.3] - 2022-11-30
@@ -302,6 +327,8 @@ Only Node.js v10 or higher is supported.
 <a name="v0.0.1"></a>
 ## v0.0.1 - 2018-06-06
 
+[v3.0.0-rc.0]: https://github.com/SAP/ui5-server/compare/v3.0.0-beta.4...v3.0.0-rc.0
+[v3.0.0-beta.4]: https://github.com/SAP/ui5-server/compare/v3.0.0-beta.3...v3.0.0-beta.4
 [v3.0.0-beta.3]: https://github.com/SAP/ui5-server/compare/v3.0.0-beta.2...v3.0.0-beta.3
 [v3.0.0-beta.2]: https://github.com/SAP/ui5-server/compare/v3.0.0-beta.1...v3.0.0-beta.2
 [v3.0.0-beta.1]: https://github.com/SAP/ui5-server/compare/v3.0.0-alpha.4...v3.0.0-beta.1

package/jsdoc.json

@@ -27,7 +27,7 @@
 	"openGraph": {
 		"title": "UI5 Tooling - API Reference",
 		"type": "website",
-		"image": "https://sap.github.io/ui5-tooling/docs/images/UI5_logo_wide.png",
+		"image": "https://sap.github.io/ui5-tooling/v3/images/UI5_logo_wide.png",
 		"site_name": "UI5 Tooling - API Reference",
 		"url": "https://sap.github.io/ui5-tooling/"
 	},

package/lib/middleware/MiddlewareManager.js

@@ -61,7 +61,7 @@ class MiddlewareManager {
 	 * Adds the given middleware configuration
 	 *
 	 * @private
-	 * @param {string} configuredMiddlewareName The name of the middleware
+	 * @param {string} middlewareName The name of the middleware
 	 * @param {object} [options] The Options of the middleware
 	 * @param {object} [options.customMiddleware] The custom middleware
 	 * @param {Function} [options.wrapperCallback] Callback called when middleware is called
@@ -69,15 +69,19 @@ class MiddlewareManager {
 	 * @param {string} [options.beforeMiddleware] The name of the middleware called before the added middleware
 	 * @param {string} [options.afterMiddleware] The name of the middleware called after the added middleware
 	 */
-	async addMiddleware(configuredMiddlewareName, {
+	async addMiddleware(middlewareName, {
 		customMiddleware, wrapperCallback, mountPath = "/",
 		beforeMiddleware, afterMiddleware
 	} = {}) {
+		if (this.middleware[middlewareName]) {
+			throw new Error(`A middleware with the name ${middlewareName} has already been added`);
+		}
+
 		let middlewareCallback;
 		if (customMiddleware) {
 			middlewareCallback = customMiddleware;
 		} else {
-			const middlewareInfo = await middlewareRepository.getMiddleware(configuredMiddlewareName);
+			const middlewareInfo = await middlewareRepository.getMiddleware(middlewareName);
 			if (wrapperCallback) {
 				middlewareCallback = wrapperCallback(middlewareInfo);
 			} else {
@@ -85,16 +89,6 @@ class MiddlewareManager {
 			}
 		}
 
-		let middlewareName = configuredMiddlewareName;
-		if (this.middleware[middlewareName]) {
-			// Middleware is already known
-			// => add a suffix to allow for multiple configurations of the same middleware
-			let suffixCounter = 0;
-			while (this.middleware[middlewareName]) {
-				suffixCounter++; // Start at 1
-				middlewareName = `${configuredMiddlewareName}--${suffixCounter}`;
-			}
-		}
 		if (this.middlewareExecutionOrder.includes(middlewareName)) {
 			throw new Error(`Middleware ${middlewareName} already added to execution order. This should not happen.`);
 		}
@@ -102,6 +96,14 @@ class MiddlewareManager {
 		if (beforeMiddleware || afterMiddleware) {
 			const refMiddlewareName = beforeMiddleware || afterMiddleware;
 			let refMiddlewareIdx = this.middlewareExecutionOrder.indexOf(refMiddlewareName);
+
+			if (refMiddlewareName === "connectUi5Proxy") {
+				throw new Error(
+					`Standard middleware "connectUi5Proxy", referenced by middleware "${middlewareName}" ` +
+					`in project ${this.middlewareUtil.getProject()}, ` +
+					`has been removed in this version of UI5 Tooling and can't be referenced anymore. ` +
+					`Please see the migration guide at https://sap.github.io/ui5-tooling/updates/migrate-v3/`);
+			}
 			if (refMiddlewareIdx === -1) {
 				throw new Error(`Could not find middleware ${refMiddlewareName}, referenced by custom ` +
 					`middleware ${middlewareName}`);
@@ -229,9 +231,6 @@ class MiddlewareManager {
 				};
 			}
 		});
-		await this.addMiddleware("connectUi5Proxy", {
-			mountPath: "/proxy"
-		});
 		// 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
 		await this.addMiddleware("nonReadRequests");
@@ -275,7 +274,19 @@ class MiddlewareManager {
 					`Custom middleware definition ${middlewareDef.name} of project ${project.getName()} ` +
 					`defines neither a "beforeMiddleware" nor an "afterMiddleware" parameter. One must be defined.`);
 			}
-			await this.addMiddleware(middlewareDef.name, {
+
+			let middlewareName = middlewareDef.name;
+			if (this.middleware[middlewareName]) {
+				// Middleware is already known
+				// => add a suffix to allow for multiple configurations of the same middleware
+				let suffixCounter = 0;
+				while (this.middleware[middlewareName]) {
+					suffixCounter++; // Start at 1
+					middlewareName = `${middlewareDef.name}--${suffixCounter}`;
+				}
+			}
+
+			await this.addMiddleware(middlewareName, {
 				customMiddleware: async ({resources, middlewareUtil}) => {
 					const customMiddleware = this.graph.getExtension(middlewareDef.name);
 
@@ -288,8 +299,8 @@ class MiddlewareManager {
 
 					const specVersion = customMiddleware.getSpecVersion();
 					if (specVersion.gte("3.0")) {
-						params.options.middlewareName = middlewareDef.name;
-						params.log = logger.getGroupLogger(`server:custom-middleware:${middlewareDef.name}`);
+						params.options.middlewareName = middlewareName;
+						params.log = logger.getLogger(`server:custom-middleware:${middlewareDef.name}`);
 					}
 					const middlewareUtilInterface = middlewareUtil.getInterface(specVersion);
 					if (middlewareUtilInterface) {

package/lib/middleware/MiddlewareUtil.js

@@ -119,15 +119,25 @@ class MiddlewareUtil {
 	 * This method is only available to custom server middleware extensions defining
 	 * <b>Specification Version 3.0 and above</b>.
 	 *
-	 * @param {string} [projectName] Name of the project to retrieve. Defaults to the project currently being built
+	 * @param {string|@ui5/fs/Resource} [projectNameOrResource]
+	 * Name of the project to retrieve or a Resource instance to retrieve the associated project for.
+	 * Defaults to the name of the current root project
 	 * @returns {@ui5/project/build/helpers/MiddlewareUtill~ProjectInterface|undefined}
-	 * project instance or undefined if the project is unknown to the graph
+	 * Specification Version-dependent interface to the Project instance or <code>undefined</code>
+	 * if the project name is unknown or the provided resource is not associated with any project.
 	 * @public
 	 */
-	getProject(projectName) {
-		if (projectName) {
-			return this._graph.getProject(projectName);
+	getProject(projectNameOrResource) {
+		if (projectNameOrResource) {
+			if (typeof projectNameOrResource === "string" || projectNameOrResource instanceof String) {
+				// A project name has been provided
+				return this._graph.getProject(projectNameOrResource);
+			} else {
+				// A Resource instance has been provided
+				return projectNameOrResource.getProject();
+			}
 		}
+		// No parameter has been provided, default to the root project
 		return this._project;
 	}
 
@@ -139,7 +149,8 @@ class MiddlewareUtil {
 	 * This method is only available to custom server middleware extensions defining
 	 * <b>Specification Version 3.0 and above</b>.
 	 *
-	 * @param {string} [projectName] Name of the project to retrieve. Defaults to the project currently being built
+	 * @param {string} [projectName] Name of the project to retrieve.
+	 * Defaults to the name of the current root project
 	 * @returns {string[]} Names of all direct dependencies
 	 * @throws {Error} If the requested project is unknown to the graph
 	 * @public

package/lib/middleware/middlewareRepository.js

@@ -6,7 +6,6 @@ const middlewareInfos = {
 	serveIndex: {path: "./serveIndex.js"},
 	discovery: {path: "./discovery.js"},
 	versionInfo: {path: "./versionInfo.js"},
-	connectUi5Proxy: {path: "./connectUi5Proxy.js"},
 	serveThemes: {path: "./serveThemes.js"},
 	testRunner: {path: "./testRunner.js"},
 	nonReadRequests: {path: "./nonReadRequests.js"}

package/lib/middleware/serveResources.js

@@ -84,7 +84,7 @@ function createMiddleware({resources, middlewareUtil}) {
 					stream.setEncoding("utf8");
 					stream = stream.pipe(replaceStream("${version}", resource.getProject().getVersion()));
 				} else {
-					log.verbose("Project missing from resource %s", pathname);
+					log.verbose(`Project missing from resource ${pathname}"`);
 				}
 			}
 

package/lib/sslUtil.js

@@ -1,15 +1,9 @@
 import os from "node:os";
-import fs from "node:fs";
-import logger from "@ui5/logger";
-const log = logger.getLogger("server:sslUtil");
-import {promisify} from "node:util";
-
-const stat = promisify(fs.stat);
+import {stat, readFile, writeFile, mkdir} from "node:fs/promises";
 import path from "node:path";
+import logger from "@ui5/logger";
 
-const readFile = promisify(fs.readFile);
-const writeFile = promisify(fs.writeFile);
-
+const log = logger.getLogger("server:sslUtil");
 
 /**
  * @private
@@ -87,13 +81,11 @@ async function createAndInstallCertificate(keyPath, certPath) {
 
 	const {key, cert} = await devCert("UI5Tooling");
 
-	const {default: makeDir} = await import("make-dir");
-
 	await Promise.all([
 		// Write certificates to the ui5 certificate folder
 		// such that they are used by default upon next startup
-		makeDir(path.dirname(keyPath)).then(() => writeFile(keyPath, key)),
-		makeDir(path.dirname(certPath)).then(() => writeFile(certPath, cert))
+		mkdir(path.dirname(keyPath), {recursive: true}).then(() => writeFile(keyPath, key)),
+		mkdir(path.dirname(certPath), {recursive: true}).then(() => writeFile(certPath, cert))
 	]);
 	return {key, cert};
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ui5/server",
-	"version": "3.0.0-beta.3",
+	"version": "3.0.0-rc.0",
 	"description": "UI5 Tooling - Server",
 	"author": {
 		"name": "SAP SE",
@@ -115,12 +115,11 @@
 		"url": "git@github.com:SAP/ui5-server.git"
 	},
 	"dependencies": {
-		"@ui5/builder": "^3.0.0-beta.3",
-		"@ui5/fs": "^3.0.0-beta.3",
-		"@ui5/logger": "^3.0.1-beta.1",
+		"@ui5/builder": "^3.0.0-rc.0",
+		"@ui5/fs": "^3.0.0-rc.0",
+		"@ui5/logger": "^3.0.1-rc.0",
 		"body-parser": "^1.20.1",
 		"compression": "^1.7.4",
-		"connect-openui5": "^0.10.2",
 		"cors": "^2.8.5",
 		"devcert-sanscache": "^0.4.8",
 		"escape-html": "^1.0.3",
@@ -128,34 +127,33 @@
 		"express": "^4.18.2",
 		"fresh": "^0.5.2",
 		"graceful-fs": "^4.2.10",
-		"make-dir": "^3.1.0",
 		"mime-types": "^2.1.35",
 		"parseurl": "^1.3.3",
 		"portscanner": "^2.2.0",
 		"replacestream": "^4.0.3",
 		"router": "^1.3.7",
 		"spdy": "^4.0.2",
-		"yesno": "^0.3.1"
+		"yesno": "^0.4.0"
 	},
 	"devDependencies": {
 		"@istanbuljs/esm-loader-hook": "^0.2.0",
-		"@ui5/project": "^3.0.0-beta.3",
+		"@ui5/project": "^3.0.0-beta.5",
 		"ava": "^5.1.0",
 		"chokidar-cli": "^3.0.0",
 		"cross-env": "^7.0.3",
 		"depcheck": "^1.4.3",
 		"docdash": "^2.0.0",
-		"eslint": "^8.28.0",
+		"eslint": "^8.30.0",
 		"eslint-config-google": "^0.14.0",
 		"eslint-plugin-ava": "^13.2.0",
 		"eslint-plugin-jsdoc": "^39.6.4",
-		"esmock": "^2.0.9",
+		"esmock": "^2.1.0",
 		"jsdoc": "^3.6.11",
 		"nyc": "^15.1.0",
 		"open-cli": "^7.1.0",
 		"rimraf": "^3.0.2",
-		"sinon": "^14.0.2",
-		"supertest": "^6.3.1",
+		"sinon": "^15.0.1",
+		"supertest": "^6.3.3",
 		"tap-nyan": "^1.1.0",
 		"tap-xunit": "^2.4.1"
 	}

package/lib/middleware/connectUi5Proxy.js

@@ -1,9 +0,0 @@
-import ui5connect from "connect-openui5";
-
-function createMiddleware() {
-	return ui5connect.proxy({
-		secure: false
-	});
-}
-
-export default createMiddleware;