[FIX] serveResources: Correctly encode non UTF-8 resources

RandomByte · RandomByte · commit 1ee6723b5e5d · 2019-06-24T19:14:06.000+02:00
The replaceStream module converts all string it processes to UTF-8. Therefore, stop using it for strings that are not UTF-8 encoded. Resolves https://github.com/SAP/ui5-server/issues/196
diff --git a/lib/middleware/serveResources.js b/lib/middleware/serveResources.js
@@ -63,7 +63,7 @@ function createMiddleware({resourceCollections}) {
 
 			let stream = resource.getStream();
 
-			if ((type.startsWith("text/") || type === "application/javascript")) {
+			if (charset === "UTF-8" && (type.startsWith("text/") || type === "application/javascript")) {
 				if (resource._project) {
 					stream = stream.pipe(replaceStream("${version}", resource._project.version));
 				} else {
diff --git a/test/fixtures/application.a/webapp/i18n/i18n_de.properties b/test/fixtures/application.a/webapp/i18n/i18n_de.properties
@@ -0,0 +1 @@
+showHelloButtonText=Say �!
diff --git a/test/fixtures/application.a/webapp/index.html b/test/fixtures/application.a/webapp/index.html
@@ -1,9 +1,9 @@
 <!DOCTYPE html>
 <html>
 <head>
-	<title>Application A</title>
+	<title>Application A - Version ${version}</title>
 </head>
 <body>
 
 </body>
-</html>
+</html>
diff --git a/test/lib/server/acceptRemoteConnections.js b/test/lib/server/acceptRemoteConnections.js
@@ -41,6 +41,6 @@ test("Get resource from application.a (/index.html) with enabled remote connecti
 		}
 		t.deepEqual(res.statusCode, 200, "Correct HTTP status code");
 		t.regex(res.headers["content-type"], /html/, "Correct content type");
-		t.regex(res.text, /<title>Application A<\/title>/, "Correct response");
+		t.regex(res.text, /<title>Application A - Version 1.0.0<\/title>/, "Correct response");
 	});
 });
diff --git a/test/lib/server/h2.js b/test/lib/server/h2.js
@@ -54,6 +54,6 @@ test("Get resource from application.a (/index.html)", (t) => {
 		}
 		t.deepEqual(res.statusCode, 200, "Correct HTTP status code");
 		t.regex(res.headers["content-type"], /html/, "Correct content type");
-		t.regex(res.text, /<title>Application A<\/title>/, "Correct response");
+		t.regex(res.text, /<title>Application A - Version 1.0.0<\/title>/, "Correct response");
 	});
 });
diff --git a/test/lib/server/main.js b/test/lib/server/main.js
@@ -21,7 +21,7 @@ test.before((t) => {
 	});
 });
 
-test.after(() => {
+test.after.always(() => {
 	return new Promise((resolve, reject) => {
 		serve.close((error) => {
 			if (error) {
@@ -40,7 +40,7 @@ test("Get resource from application.a (/index.html)", (t) => {
 		}
 		t.deepEqual(res.statusCode, 200, "Correct HTTP status code");
 		t.regex(res.headers["content-type"], /html/, "Correct content type");
-		t.regex(res.text, /<title>Application A<\/title>/, "Correct response");
+		t.regex(res.text, /<title>Application A - Version 1.0.0<\/title>/, "Correct response");
 	});
 });
 
@@ -51,10 +51,27 @@ test("Get resource from application.a (/i18n/i18n.properties) with correct chars
 		}
 		t.deepEqual(res.statusCode, 200, "Correct HTTP status code");
 		t.deepEqual(res.headers["content-type"], "text/plain; charset=ISO-8859-1", "Correct content type and charset");
-		t.deepEqual(res.text, "showHelloButtonText=Say Hello!", "Correct response");
+		t.deepEqual(Buffer.from(res.text, "latin1").toString(), "showHelloButtonText=Say Hello!", "Correct response");
 	});
 });
 
+test("Get resource from application.a (/i18n/i18n_de.properties) with correct encoding 'ISO-8859-1'", (t) => {
+	return request.get("/i18n/i18n_de.properties")
+		.responseType("arraybuffer")
+		.then((res) => {
+			if (res.error) {
+				t.fail(res.error.text);
+			}
+			t.deepEqual(res.statusCode, 200, "Correct HTTP status code");
+			t.deepEqual(res.headers["content-type"], "text/plain; charset=ISO-8859-1",
+				"Correct content type and charset");
+
+			t.deepEqual(res.body.toString("latin1"), "showHelloButtonText=Say ä!", "Correct response");
+			// Because it took so long to figure this out I keep the below line. It is equivalent to the deepEqual above
+			// t.deepEqual(res.body.toString("latin1"), Buffer.from("showHelloButtonText=Say \u00e4!", "latin1").toString("latin1"),
+			// 	"Correct response");
+		});
+});
 
 test("Get resource from library.a (/resources/library/a/.library)", (t) => {
 	return request.get("/resources/library/a/.library").then((res) => {

Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,6 @@ test("Get resource from application.a (/index.html) with enabled remote connecti`
`41`	`41`	`}`
`42`	`42`	`t.deepEqual(res.statusCode, 200, "Correct HTTP status code");`
`43`	`43`	`t.regex(res.headers["content-type"], /html/, "Correct content type");`
`44`		`- t.regex(res.text, /<title>Application A<\/title>/, "Correct response");`
	`44`	`+ t.regex(res.text, /<title>Application A - Version 1.0.0<\/title>/, "Correct response");`
`45`	`45`	`});`
`46`	`46`	`});`
Original file line number	Diff line number	Diff line change
`@@ -54,6 +54,6 @@ test("Get resource from application.a (/index.html)", (t) => {`
`54`	`54`	`}`
`55`	`55`	`t.deepEqual(res.statusCode, 200, "Correct HTTP status code");`
`56`	`56`	`t.regex(res.headers["content-type"], /html/, "Correct content type");`
`57`		`- t.regex(res.text, /<title>Application A<\/title>/, "Correct response");`
	`57`	`+ t.regex(res.text, /<title>Application A - Version 1.0.0<\/title>/, "Correct response");`
`58`	`58`	`});`
`59`	`59`	`});`