Add X-Request-Id in request to QGIS Server headers

[rldhont]

X-Request-Id correlates HTTP requests between a client and server. It will help to correlate logs between Lizmap Web client and QGIS Server. X-Request-Id is supported by Py-QGIS-Server.

[rldhont]

Wait for #5206

[Gustry]

Nice addition

[dmarteau]

Note: Py-qgis-server for now, does not take into account x-requesti-id but qjazz does. Nevertheless, this is a good idea to set it in all cases.

[3liz-bot]

The backport to release_3_7 failed:

The process '/usr/bin/git' failed with exit code 1

stderr

error: could not apply 2ada8d118... Response headers: use it in OGCRequest
hint: After resolving the conflicts, mark them with
hint: "git add/rm <pathspec>", then run
hint: "git cherry-pick --continue".
hint: You can instead skip this commit with "git cherry-pick --skip".
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".
hint: Disable this message with "git config advice.mergeConflict false"

stdout

Auto-merging lizmap/modules/lizmap/lib/Request/Proxy.php
[backport-5185-to-release_3_7 c8b7e8d2a] Add X-Request-Id in request to QGIS Server headers
 Author: rldhont <[email protected]>
 Date: Fri Jan 10 13:52:20 2025 +0100
 1 file changed, 1 insertion(+)
Auto-merging lizmap/modules/lizmap/lib/Request/Proxy.php
[backport-5185-to-release_3_7 d2b30e634] logRequestIfError: use X-Request-Id if available
 Author: rldhont <[email protected]>
 Date: Mon Jan 13 10:42:59 2025 +0100
 1 file changed, 18 insertions(+), 5 deletions(-)
Auto-merging lizmap/modules/lizmap/lib/Request/Proxy.php
[backport-5185-to-release_3_7 5c7e9bc82] Response headers : curl and file
 Author: rldhont <[email protected]>
 Date: Mon Jan 13 10:18:42 2025 +0100
 1 file changed, 47 insertions(+), 15 deletions(-)
Auto-merging lizmap/modules/lizmap/lib/Request/Proxy.php
[backport-5185-to-release_3_7 a6493fe81] Response headers from stream to log X-Request-Id
 Author: rldhont <[email protected]>
 Date: Mon Jan 13 12:23:37 2025 +0100
 1 file changed, 1 insertion(+), 1 deletion(-)
[backport-5185-to-release_3_7 bb0539839] Tests: Update Proxy test about buildHeaders
 Author: rldhont <[email protected]>
 Date: Mon Jan 13 15:32:42 2025 +0100
 1 file changed, 5 insertions(+), 1 deletion(-)
Auto-merging lizmap/modules/lizmap/lib/Request/Proxy.php
Auto-merging tests/end2end/cypress/integration/requests-wfs-ghaction.js
CONFLICT (content): Merge conflict in tests/end2end/cypress/integration/requests-wfs-ghaction.js

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-release_3_7 release_3_7
# Navigate to the new working tree
cd .worktrees/backport-release_3_7
# Create a new branch
git switch --create backport-5185-to-release_3_7
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick 650911ae4b2ce64d7019105b87d8d12ff4fa8444,7bf80e06715d822a0e24ef078988d5fba4f3e5a1,61871ce01832ff42a824a0fccaf61bbf97588037,eff786c0aba343ad5b175faa3461bec35e001111,148b8dc801b22e5fd042ba1c67dd5b7124a47817,2ada8d1185bc75348d2e8c12088df3b4a77c4d34
# Push it to GitHub
git push --set-upstream origin backport-5185-to-release_3_7
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-release_3_7

Then, create a pull request where the base branch is release_3_7 and the compare/head branch is backport-5185-to-release_3_7.