[FIX] Handle encoding in request paths correctly

Use new MiddlewareUtil to correctly parse the pathname of an incoming
request so that for example %20 becomes a whitespace.

Author: RandomByte

lib/middleware/serveIndex.js

@@ -93,10 +93,11 @@ function createResourceInfos(resources) {
  * @returns {Function} Returns a server middleware closure.
  */
 
-function createMiddleware({resources, simpleIndex = false, showHidden = true}) {
+function createMiddleware({resources, middlewareUtil, simpleIndex = false, showHidden = true}) {
 	return function(req, res, next) {
-		log.verbose("\n Listing index of " + req.path);
-		const glob = req.path + (req.path.endsWith("/") ? "*" : "/*");
+		const pathname = middlewareUtil.getPathname(req);
+		log.verbose("\n Listing index of " + pathname);
+		const glob = pathname + (pathname.endsWith("/") ? "*" : "/*");
 		resources.all.byGlob(glob, {nodir: false}).then((resources) => {
 			if (!resources || resources.length === 0) { // Not found
 				next();
@@ -110,7 +111,8 @@ function createMiddleware({resources, simpleIndex = false, showHidden = true}) {
 				next,
 				simpleIndex,
 				showHidden,
-				resourceInfos
+				resourceInfos,
+				pathname
 			});
 		}).catch((err) => {
 			next(err);

lib/middleware/serveIndex/serveIndex.js

@@ -374,7 +374,7 @@ const icons = {
 	".yaws": "page_white_code.png"
 };
 
-function handleRequest({req, res, next, showHidden, simpleIndex, resourceInfos}) {
+function handleRequest({req, res, next, showHidden, simpleIndex, resourceInfos, pathname}) {
 	const hidden = showHidden; // display hidden files
 	const view = simpleIndex ? "tiles" : "details";
 
@@ -395,7 +395,7 @@ function handleRequest({req, res, next, showHidden, simpleIndex, resourceInfos})
 
 		// create locals for rendering
 		const locals = {
-			directory: req.path,
+			directory: pathname,
 			fileList: resourceInfos,
 			path: path,
 			style: style,

lib/middleware/serveResources.js

@@ -1,9 +1,7 @@
 const log = require("@ui5/logger").getLogger("server:middleware:serveResources");
-const {getMimeInfo} = require("../mime-util");
 const replaceStream = require("replacestream");
 const etag = require("etag");
 const fresh = require("fresh");
-const parseurl = require("parseurl");
 
 const rProperties = /\.properties$/i;
 const rReplaceVersion = /\.(library|js|json)$/i;
@@ -24,10 +22,10 @@ function isFresh(req, res) {
  * @param {module:@ui5/fs.AbstractReader} parameters.resources.all Resource collection which contains the workspace and the project dependencies
  * @returns {Function} Returns a server middleware closure.
  */
-function createMiddleware({resources}) {
+function createMiddleware({resources, middlewareUtil}) {
 	return async function serveResources(req, res, next) {
 		try {
-			const pathname = parseurl(req).pathname;
+			const pathname = middlewareUtil.getPathname(req);
 			const resource = await resources.all.byPath(pathname);
 			if (!resource) { // Not found
 				next();
@@ -53,7 +51,7 @@ function createMiddleware({resources}) {
 				});
 			}
 
-			const {contentType, charset} = getMimeInfo(resourcePath);
+			const {contentType, charset} = middlewareUtil.getMimeInfo(resourcePath);
 			if (!res.getHeader("Content-Type")) {
 				res.setHeader("Content-Type", contentType);
 			}

lib/middleware/serveThemes.js

@@ -1,6 +1,5 @@
 const themeBuilder = require("@ui5/builder").processors.themeBuilder;
 const fsInterface = require("@ui5/fs").fsInterface;
-const {getMimeInfo} = require("../mime-util");
 const {basename, dirname} = require("path").posix;
 const etag = require("etag");
 const fresh = require("fresh");
@@ -39,7 +38,7 @@ const themeResources = [
  * @param {module:@ui5/fs.AbstractReader} parameters.resources.all Resource collection which contains the workspace and the project dependencies
  * @returns {Function} Returns a server middleware closure.
  */
-function createMiddleware({resources}) {
+function createMiddleware({resources, middlewareUtil}) {
 	const builder = new themeBuilder.ThemeBuilder({
 		fs: fsInterface(resources.all)
 	});
@@ -77,7 +76,7 @@ function createMiddleware({resources}) {
 			}
 
 			const resourcePath = resource.getPath();
-			const {contentType} = getMimeInfo(resourcePath);
+			const {contentType} = middlewareUtil.getMimeInfo(resourcePath);
 			res.setHeader("Content-Type", contentType);
 
 			const content = await resource.getBuffer();

test/lib/server/middleware/serveIndex.js

@@ -1,5 +1,6 @@
 const test = require("ava");
 const resourceFactory = require("@ui5/fs").resourceFactory;
+const MiddlewareUtil = require("../../../../lib/middleware/MiddlewareUtil");
 
 test.serial("serveIndex default", (t) => {
 	t.plan(4);
@@ -27,14 +28,15 @@ test.serial("serveIndex default", (t) => {
 		writeResource(readerWriter, "/.myFile4", 1024), // hidden 1 KB
 	]).then(() => {
 		const middleware = serveIndexMiddleware({
+			middlewareUtil: new MiddlewareUtil(),
 			resources: {
 				all: readerWriter
 			}
 		});
 
 		return new Promise((resolve, reject) => {
 			const req = {
-				path: "/"
+				url: "/"
 			};
 			const res = {
 				writeHead: function(status, contentType) {
@@ -81,6 +83,7 @@ test.serial("serveIndex no hidden", (t) => {
 		writeResource(readerWriter, "/.myFile4", 1024), // hidden 1 KB
 	]).then(() => {
 		const middleware = serveIndexMiddleware({
+			middlewareUtil: new MiddlewareUtil(),
 			resources: {
 				all: readerWriter
 			},
@@ -90,7 +93,7 @@ test.serial("serveIndex no hidden", (t) => {
 
 		return new Promise((resolve, reject) => {
 			const req = {
-				path: "/"
+				url: "/"
 			};
 			const res = {
 				writeHead: function(status, contentType) {
@@ -137,6 +140,7 @@ test.serial("serveIndex no details", (t) => {
 		writeResource(readerWriter, "/.myFile4", 1024), // hidden 1 KB
 	]).then(() => {
 		const middleware = serveIndexMiddleware({
+			middlewareUtil: new MiddlewareUtil(),
 			resources: {
 				all: readerWriter
 			},
@@ -146,7 +150,7 @@ test.serial("serveIndex no details", (t) => {
 
 		return new Promise((resolve, reject) => {
 			const req = {
-				path: "/"
+				url: "/"
 			};
 			const res = {
 				writeHead: function(status, contentType) {

test/lib/server/middleware/serveResources.js

@@ -3,6 +3,7 @@ const sinon = require("sinon");
 const {Readable, Writable} = require("stream");
 const resourceFactory = require("@ui5/fs").resourceFactory;
 const serveResourcesMiddleware = require("../../../../lib/middleware/serveResources");
+const MiddlewareUtil = require("../../../../lib/middleware/MiddlewareUtil");
 const writeResource = function(writer, path, size, stringContent, project) {
 	const statInfo = {
 		ino: 0,
@@ -54,6 +55,7 @@ test.serial("Check if properties file is served properly", (t) => {
 		.then((resource) => {
 			const setStringSpy = sinon.spy(resource, "setString");
 			const middleware = serveResourcesMiddleware({
+				middlewareUtil: new MiddlewareUtil(),
 				resources: {
 					all: readerWriter
 				}
@@ -97,6 +99,7 @@ test.serial("Check if properties file is served properly with UTF-8", (t) => {
 		.then((resource) => {
 			const setStringSpy = sinon.spy(resource, "setString");
 			const middleware = serveResourcesMiddleware({
+				middlewareUtil: new MiddlewareUtil(),
 				resources: {
 					all: readerWriter
 				}
@@ -132,6 +135,7 @@ test.serial("Check if properties file is served properly without property settin
 	return writeResource(readerWriter, "/myFile3.properties", 1024 * 1024, "key=titel\nfame=straße").then((resource) => {
 		const setStringSpy = sinon.spy(resource, "setString");
 		const middleware = serveResourcesMiddleware({
+			middlewareUtil: new MiddlewareUtil(),
 			resources: {
 				all: readerWriter
 			}
@@ -191,6 +195,7 @@ test.serial.cb("Check if version replacement is done", (t) => {
 		}
 	};
 	const middleware = serveResourcesMiddleware({
+		middlewareUtil: new MiddlewareUtil(),
 		resources
 	});
 
@@ -266,6 +271,7 @@ test.serial[
 		}
 	};
 	const middleware = serveResourcesMiddleware({
+		middlewareUtil: new MiddlewareUtil(),
 		resources
 	});
 

test/lib/server/middleware/serveThemes.js

@@ -3,6 +3,7 @@ const sinon = require("sinon");
 const mock = require("mock-require");
 
 const ThemeBuilder = require("@ui5/builder").processors.themeBuilder.ThemeBuilder;
+const MiddlewareUtil = require("../../../../lib/middleware/MiddlewareUtil");
 
 const failOnNext= function(t) {
 	return function(err) {
@@ -82,6 +83,7 @@ const createMiddleware = function() {
 	};
 	return {
 		middleware: require("../../../../lib/middleware/serveThemes")({
+			middlewareUtil: new MiddlewareUtil(),
 			resources
 		}),
 		byPath: resources.all.byPath