Always preserve query string on redirects

[urdh]

Description

Adds a new preserve-query option to redirects which causes SWS to append any query string received verbatim to the Location header when redirecting. This setting is optional, defaulting to false, which retains existing behavior for backward-compatibility.

Related Issue

#700

Motivation and Context

How Has This Been Tested?

Unit and integration tests have been written and pass (on Arch Linux, amd64, rustc 1.91.1).

Screenshots (if appropriate):

[semanticdiff-com]

Review changes with  

Changed Files

File	Status
src/redirects.rs	1% smaller
tests/fixtures/toml/redirects.toml	Unsupported file format
tests/redirects.rs	0% smaller

[joseluisq]

Preserving the query string for redirect is a good idea.
As I wrote in #700 (comment), we should add the query string if available by default to work out of the box.

IMO, this does not represent a "breaking change" per se, but it will enhance what users already have instead.

Here are some adjustments to make:

• Change the master branch target to 2.x. As the master now points to the upcoming v3 (in development). Unless you really wanted your changes to be included in a future v3 release?
• Let's include the query string in the redirect by default if present.
• Let's adjust the tests so we assert this behaviour.
• Revert the new option for redirect query support as we want it built-in.

[joseluisq]

The docs have been moved to another repo. You can revert those changes here and make another PR mentioning this change in the new repo. You can find it at https://github.com/static-web-server/docs/tree/master/src/v2.

[urdh]

Here's the PR for documentation changes: static-web-server/docs#6.

[urdh]

Sounds reasonable!

One thing I hadn't quite thought of when implementing this which might be more important to deal with if this changes default behavior rather than being opt-in is what do to when the destination already has a query string, e.g.:

[[advanced.redirects]]
source = "/index.html"
destination = "https://static-web-server.net/?src=some-value"
kind = 302

Apache has a QSA option for merging the query strings (the default is to always use the one from destination). There's also QSD for the case where destination doesn't have a query string, causing Apache to drop any source query strings (what SWS does now).

I'd lean toward a QSA-like behavior by default, what do you think?

[joseluisq]

Sounds reasonable!

One thing I hadn't quite thought of when implementing this which might be more important to deal with if this changes default behavior rather than being opt-in is what do to when the destination already has a query string, e.g.:

[[advanced.redirects]]
source = "/index.html"
destination = "https://static-web-server.net/?src=some-value"
kind = 302

Apache has a QSA option for merging the query strings (the default is to always use the one from destination). There's also QSD for the case where destination doesn't have a query string, causing Apache to drop any source query strings (what SWS does now).

I'd lean toward a QSA-like behavior by default, what do you think?

I believe QSA-like behavior by default is fine too if the query string is present, of course. Let's go with that then.

[urdh]

Great! I've updated the PR and re-targeted it to 2.x. Will try to send a documentation PR later this evening.

[joseluisq]

A minor improvement to make.

[joseluisq]

Looks ok to me.
Thanks!