feat: test for filenames with percent-encoding

closes #115
ipfs · Sep 8, 2023 · 432c89a · 432c89a
1 parent f6d2dc7
commit 432c89a
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 0 deletions.
diff --git a/fixtures/path_gateway_unixfs/README.md b/fixtures/path_gateway_unixfs/README.md
@@ -39,3 +39,16 @@ ipfs files ls -l
 # Manually CID of "dir-with-files" and then...
 ipfs dag export $CID
 ```
+
+### [dir-with-percent-encoded-filename.car](./dir-with-percent-encoded-name-file.car)
+
+```sh
+ipfs version
+# ipfs version 0.22.0
+CID=$(echo "hello from a percent encoded filename" | ipfs add --cid-version=1 -q)
+ipfs files mkdir -p --cid-version 1 /dir-with-percent-encoded-filename
+ipfs files cp /ipfs/$CID "/dir-with-percent-encoded-filename/Portugal%2C+España=Peninsula Ibérica.txt"
+ipfs files ls -l
+# Manually CID of "dir-with-percent-encoded-filename" and then...
+ipfs dag export $CID
+```
diff --git a/fixtures/path_gateway_unixfs/dir-with-percent-encoded-filename.car b/fixtures/path_gateway_unixfs/dir-with-percent-encoded-filename.car
diff --git a/tests/path_gateway_unixfs_test.go b/tests/path_gateway_unixfs_test.go
@@ -564,3 +564,20 @@ func TestGatewayUnixFSFileRanges(t *testing.T) {
 
 	RunWithSpecs(t, tests, specs.PathGatewayUnixFS)
 }
+
+func TestPathGatewayMiscellaneous(t *testing.T) {
+	fixture := car.MustOpenUnixfsCar("path_gateway_unixfs/dir-with-percent-encoded-filename.car")
+	rootDirCID := fixture.MustGetCid()
+
+	tests := SugarTests{
+		{
+			Name: "GET for /ipfs/ file whose filename contains percentage-encoded characters works",
+			Request: Request().
+				Path("/ipfs/{{CID}}/Portugal%252C+España=Peninsula%20Ibérica.txt", rootDirCID),
+			Response: Expect().
+				Body(fixture.MustGetRawData("Portugal%2C+España=Peninsula Ibérica.txt")),
+		},
+	}
+
+	RunWithSpecs(t, tests, specs.PathGatewayUnixFS)
+}
diff --git a/tests/subdomain_gateway_ipfs_test.go b/tests/subdomain_gateway_ipfs_test.go
@@ -115,6 +115,9 @@ func TestGatewaySubdomains(t *testing.T) {
 	CIDv1_TOO_LONG := fixture.MustGetCid("hello-CIDv1_TOO_LONG")
 	CIDWikipedia := "QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco"
 
+	dirWithPercentEncodedFilename := car.MustOpenUnixfsCar("path_gateway_unixfs/dir-with-percent-encoded-filename.car")
+	dirWithPercentEncodedFilenameCID := dirWithPercentEncodedFilename.MustGetCid()
+
 	tests := SugarTests{}
 
 	// We're going to run the same test against multiple gateways (localhost, and a subdomain gateway)
@@ -145,6 +148,15 @@ func TestGatewaySubdomains(t *testing.T) {
 							Contains("{{scheme}}://{{cid}}.ipfs.{{host}}/", u.Scheme, CIDv1, u.Host),
 					),
 			},
+			{
+				Name:    "request for example.com/ipfs/{CIDv1}/{filename with percent encoding} redirects to subdomain",
+				Request: Request().URL("{{url}}/ipfs/{{cid}}/Portugal%252C+España=Peninsula%20Ibérica.txt", gatewayURL, dirWithPercentEncodedFilenameCID),
+				Response: Expect().
+					Status(301).
+					Headers(
+						Header("Location").Equals("{{scheme}}://{{cid}}.ipfs.{{host}}/Portugal%252C+España=Peninsula%20Ibérica.txt", u.Scheme, dirWithPercentEncodedFilenameCID, u.Host),
+					),
+			},
 			{
 				Name: "request for example.com/ipfs/{DirCID} redirects to subdomain",
 				Hint: `