serokell/xrefcheck
1
1
Fork 0
mirror of https://github.com/serokell/xrefcheck.git synced 2024-08-17 01:20:44 +03:00
Code Issues Projects Releases Wiki Activity

[#25] Handle 304 redirect

Browse Source 
Problem: After recent work on Xrefcheck redirect behavior, it remained
to discuss how to handle 304 redirects.

Solution: With the current default configuration, 304 redirects are
considered as valid, which seems appropriate taking into account that
304 responses usually mean that you previously received a successful
response for that same request and there is no need to retransmit the
resource again. We add a test case for this default config and update
the FAQ section.
This commit is contained in:
Adrián Enríquez 2023-01-10 16:32:51 +01:00
parent 20f3d052e0
commit eccb6d0068
No known key found for this signature in database
GPG Key ID: 1D2A049F5866F977
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -143,7 +143,7 @@ There are several ways to fix this:
1. How does `xrefcheck` handle redirects?
* The rules from the default configuration are as follows:
* Permanent redirects (i.e. 301 and 308) are reported as errors.
* Temporary redirects (i.e. 302, 303 and 307) are assumed to be valid.
* There are no rules for other redirects, except for a special GitLab case, so they are assumed to be valid.
* Redirect rules can be specified with the `externalRefRedirects` parameter within `networking`, which accepts an array of
rules with keys `from`, `to`, `on` and `outcome`. The rule applied is the first one that matches with
the `from`, `to` and `on` fields, if any, where

9
tests/Test/Xrefcheck/RedirectDefaultSpec.hs
View File

@ -23,8 +23,9 @@ import Xrefcheck.Verify
test_redirectRequests :: TestTree
test_redirectRequests = testGroup "Redirect response defaults"
[ testGroup "Temporary" $ temporaryRedirectTests <$> [302, 303, 307]
[ testGroup "Temporary" $ allowedRedirectTests <$> [302, 303, 307]
, testGroup "Permanent" $ permanentRedirectTests <$> [301, 308]
, testGroup "304 Not Modified" $ allowedRedirectTests <$> [304]
]
where
url :: Text
@ -33,11 +34,11 @@ test_redirectRequests = testGroup "Redirect response defaults"
location :: Maybe Text
location = Just "http://127.0.0.1:5000/other"
temporaryRedirectTests :: Int -> TestTree
temporaryRedirectTests statusCode =
allowedRedirectTests :: Int -> TestTree
allowedRedirectTests statusCode =
redirectTests
(show statusCode <> " passes by default")
(mkStatus statusCode "Temporary redirect")
(mkStatus statusCode "Allowed redirect")
(\case
Nothing -> Just $ RedirectMissingLocation $ fromList [url]
Just _ -> Nothing