Disable encoding on url segments

[rjimenezda]

I was trying to rewrite all urls that looked like a/b/:path+ to c/d/:path, so in practice:

a/b/file => c/d/file
a/b/dir/dir/dir/file => c/d/dir/dir/file

However, it didn't work. After some digging I found that path-to-regexp was encoding the slashes in the matched url segment.

However, you can pass a custom encoder, so I've added an option on rewrite objects to use an identity function (value => value), so no character gets encoded in the URL. I've named it raw but I'm open to suggestions.

There's a minor detail, you also have to provide the regex for the destintation, because by default they disallow certain characters there as well. I've added an example to the README mentioning this too. Also, a small test case.

[codecov]

Codecov Report

Merging #85 into master will not change coverage.
The diff coverage is 100%.

@@          Coverage Diff          @@
##           master    #85   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           2      2           
  Lines         324    324           
=====================================
  Hits          324    324

Impacted Files	Coverage Δ
src/index.js	100% <100%> (ø)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9101d15...1751eaf. Read the comment docs.

[a10nik]

I wonder what happened to this PR. Seems still valid to me.

[na-ji]

The downside of this PR is that it doesn't work with glob patterns. For instance:

{ source: 'folderA/**', destination: 'folderB/:0', raw: true }

Will throw this error:

 ⨯ TypeError: Expected "0" to match "[^\/]+?", but got "sub/folder/to/file.png"
    at /Users/user/www/myapp/node_modules/path-to-regexp/index.js:180:17
    at toTarget (/Users/user/www/myapp/node_modules/serve-handler/src/index.js:88:9)
    at applyRewrites (/Users/user/www/myapp/node_modules/serve-handler/src/index.js:105:18)
    at module.exports (/Users/user/www/myapp/node_modules/serve-handler/src/index.js:618:24)

In the meantime, I will use it as is with a regex, as in the test. Here is the patch-package I made for this. You just need to add this file patches/serve-handler+6.1.5.patch:

diff --git a/node_modules/serve-handler/src/index.js b/node_modules/serve-handler/src/index.js
index 05e3430..c29cb86 100644
--- a/node_modules/serve-handler/src/index.js
+++ b/node_modules/serve-handler/src/index.js
@@ -66,7 +66,7 @@ const sourceMatches = (source, requestPath, allowSegments) => {
 	return null;
 };
 
-const toTarget = (source, destination, previousPath) => {
+const toTarget = (source, destination, previousPath, raw) => {
 	const matches = sourceMatches(source, previousPath, true);
 
 	if (!matches) {
@@ -85,7 +85,7 @@ const toTarget = (source, destination, previousPath) => {
 		props[name] = results[index + 1];
 	}
 
-	return toPath(props);
+	return toPath(props, raw ? {encode: value => value} : {});
 };
 
 const applyRewrites = (requestPath, rewrites = [], repetitive) => {
@@ -101,8 +101,8 @@ const applyRewrites = (requestPath, rewrites = [], repetitive) => {
 	}
 
 	for (let index = 0; index < rewritesCopy.length; index++) {
-		const {source, destination} = rewrites[index];
-		const target = toTarget(source, destination, requestPath);
+		const {source, destination, raw} = rewrites[index];
+		const target = toTarget(source, destination, requestPath, raw);
 
 		if (target) {
 			// Remove rules that were already applied