Fix error_page for versioned doc subdirectory URLs (#640)

StanFromIreland · web-flow · commit 321da6c746a5 · 2026-04-04T13:09:00.000-05:00
diff --git a/salt/docs/config/nginx.docs-redirects.conf b/salt/docs/config/nginx.docs-redirects.conf
@@ -182,6 +182,7 @@ location ~ ^/((2|3)(\.[0-9]+)?|dev)/\w+/[\d\w\.]+(?!\.html)$ {
     if (-f "${request_filename}.html") {
         return 301 https://$host:$request_uri.html;
     }
+    error_page 404 /$1/404.html;
     add_header Surrogate-Key en/$1 always;
 }
 
diff --git a/tests/docs-redirects/docroot/3.14/404.html b/tests/docs-redirects/docroot/3.14/404.html
@@ -0,0 +1 @@
+3.14 404
diff --git a/tests/docs-redirects/docroot/3/404.html b/tests/docs-redirects/docroot/3/404.html
@@ -0,0 +1 @@
+3 404
diff --git a/tests/docs-redirects/docroot/dev/404.html b/tests/docs-redirects/docroot/dev/404.html
@@ -0,0 +1 @@
+dev 404
diff --git a/tests/docs-redirects/docroot/fr/3.14/404.html b/tests/docs-redirects/docroot/fr/3.14/404.html
@@ -0,0 +1 @@
+fr/3.14 404
diff --git a/tests/docs-redirects/docroot/pl/3/404.html b/tests/docs-redirects/docroot/pl/3/404.html
@@ -0,0 +1 @@
+pl/3 404
diff --git a/tests/docs-redirects/docroot/zh-cn/dev/404.html b/tests/docs-redirects/docroot/zh-cn/dev/404.html
@@ -0,0 +1 @@
+zh-cn/dev 404
diff --git a/tests/docs-redirects/nginx.conf b/tests/docs-redirects/nginx.conf
@@ -1,4 +1,6 @@
 server {
     listen 10000;
+    root /srv/docroot;
+    autoindex on;
     include docs-redirects.conf;
 }
diff --git a/tests/docs-redirects/specs/error-page.hurl b/tests/docs-redirects/specs/error-page.hurl
@@ -0,0 +1,54 @@
+GET {{host}}/3.14/not-a-file
+HTTP 404
+[Asserts]
+body contains "3.14 404"
+
+GET {{host}}/3/not-a-file.html
+HTTP 404
+[Asserts]
+body contains "3 404"
+
+GET {{host}}/3.14/whatsnew/3.1t4
+HTTP 404
+[Asserts]
+body contains "3.14 404"
+
+GET {{host}}/3.14/library/not-a-file
+HTTP 404
+[Asserts]
+body contains "3.14 404"
+
+GET {{host}}/3.14/library/notafile.html
+HTTP 404
+[Asserts]
+body contains "3.14 404"
+
+GET {{host}}/3/whatsnew/not-a-file
+HTTP 404
+[Asserts]
+body contains "3 404"
+
+GET {{host}}/fr/3.14/not-a-file
+HTTP 404
+[Asserts]
+body contains "fr/3.14 404"
+
+GET {{host}}/fr/3.14/not-a-dir/not-a-file
+HTTP 404
+[Asserts]
+body contains "fr/3.14 404"
+
+GET {{host}}/pl/3/not-a-dir/not-a-file.html
+HTTP 404
+[Asserts]
+body contains "pl/3 404"
+
+GET {{host}}/pl/3/not-a-dir/not-a-dir/not-a-file.html
+HTTP 404
+[Asserts]
+body contains "pl/3 404"
+
+GET {{host}}/pl/3/library/notafile.html
+HTTP 404
+[Asserts]
+body contains "pl/3 404"
diff --git a/tests/docs-redirects/specs/surrogate-key.hurl b/tests/docs-redirects/specs/surrogate-key.hurl
@@ -3,7 +3,7 @@
 ## Basic cases
 
 GET {{host}}/3/
-HTTP 404
+HTTP 200
 [Asserts]
 header "Surrogate-Key" == "en/3"
 
@@ -30,7 +30,7 @@ HTTP 404
 header "Surrogate-Key" == "en/2"
 
 GET {{host}}/dev/
-HTTP 404
+HTTP 200
 [Asserts]
 header "Surrogate-Key" == "en/dev"
 
@@ -284,7 +284,7 @@ HTTP 404
 header "Surrogate-Key" == "en/3.13"
 
 GET {{host}}/3.14/
-HTTP 404
+HTTP 200
 [Asserts]
 header "Surrogate-Key" == "en/3.14"
 
@@ -396,7 +396,7 @@ HTTP 404
 header "Surrogate-Key" == "fr/3"
 
 GET {{host}}/fr/3.14/
-HTTP 404
+HTTP 200
 [Asserts]
 header "Surrogate-Key" == "fr/3.14"
 
@@ -536,7 +536,7 @@ HTTP 404
 header "Surrogate-Key" == "ko/dev"
 
 GET {{host}}/pl/3/
-HTTP 404
+HTTP 200
 [Asserts]
 header "Surrogate-Key" == "pl/3"
 
@@ -736,7 +736,7 @@ HTTP 404
 header "Surrogate-Key" == "zh-cn/3.14"
 
 GET {{host}}/zh-cn/dev/
-HTTP 404
+HTTP 200
 [Asserts]
 header "Surrogate-Key" == "zh-cn/dev"
 
diff --git a/tests/docs-redirects/test.sh b/tests/docs-redirects/test.sh
@@ -8,6 +8,7 @@ docker stop docs-redirects-nginx || true
 docker run --name docs-redirects-nginx --detach --quiet --rm --tty \
   --mount type=bind,source=./tests/docs-redirects/nginx.conf,target=/etc/nginx/conf.d/docs.conf,readonly \
   --mount type=bind,source=./salt/docs/config/nginx.docs-redirects.conf,target=/etc/nginx/docs-redirects.conf,readonly \
+  --mount type=bind,source=./tests/docs-redirects/docroot,target=/srv/docroot,readonly \
   -p 10000:10000 \
   nginx:1.26.1-alpine
 

Original file line number	Diff line number	Diff line change
`@@ -182,6 +182,7 @@ location ~ ^/((2\|3)(\.[0-9]+)?\|dev)/\w+/[\d\w\.]+(?!\.html)$ {`
`182`	`182`	`if (-f "${request_filename}.html") {`
`183`	`183`	`return 301 https://$host:$request_uri.html;`
`184`	`184`	`}`
	`185`	`+ error_page 404 /$1/404.html;`
`185`	`186`	`add_header Surrogate-Key en/$1 always;`
`186`	`187`	`}`
`187`	`188`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,6 @@`
`1`	`1`	`server {`
`2`	`2`	`listen 10000;`
	`3`	`+ root /srv/docroot;`
	`4`	`+ autoindex on;`
`3`	`5`	`include docs-redirects.conf;`
`4`	`6`	`}`