Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Backend URL redirection logic #1058

Merged
merged 3 commits into from
Aug 5, 2024
Merged

Conversation

adamantike
Copy link
Collaborator

Fix FastAPI and nginx configuration, to make the application correctly redirect URLs. This is specially useful when URLs ended with forward slash are redirected to their stripped version.

Included changes:

  • Stop removing the /api prefix in nginx rewrite rules, so FastAPI knows what's the original URL path being requested.
  • Use $http_host in nginx, so FastAPI receives both the original host and port, to build the redirect URL (as $host does not include the port, if present).
  • Make all FastAPI included routers know their prefix, to correctly route incoming requests.

This fix was found based on a report that redirects from URLs ended with forward slash were not working [1].

[1] #1051 (comment)

Fix FastAPI and nginx configuration, to make the application correctly
redirect URLs. This is specially useful when URLs ended with forward
slash are redirected to their stripped version.

Included changes:
* Stop removing the `/api` prefix in nginx rewrite rules, so FastAPI
  knows what's the original URL path being requested.
* Use `$http_host` in nginx, so FastAPI receives both the original host
  and port, to build the redirect URL (as `$host` does not include the
  port, if present).
* Make all FastAPI included routers know their prefix, to correctly
  route incoming requests.

This fix was found based on a report that redirects from URLs ended with
forward slash were not working [1].

[1] #1051 (comment)
Copy link

github-actions bot commented Aug 5, 2024

Test Results

72 tests   72 ✅  20s ⏱️
 1 suites   0 💤
 1 files     0 ❌

Results for commit a53c091.

♻️ This comment has been updated with latest results.

@adamantike adamantike merged commit cbab9f6 into master Aug 5, 2024
9 checks passed
@adamantike adamantike deleted the fix/fastapi-redirections branch August 5, 2024 17:27
@zurdi15 zurdi15 mentioned this pull request Aug 7, 2024
spiceratops referenced this pull request in spiceratops/k8s-gitops Aug 20, 2024
This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [rommapp/romm](https://github.com/rommapp/romm) | minor | `3.3.0` ->
`3.4.0` |

---

> [!WARNING]
> Some dependencies could not be looked up. Check the Dependency
Dashboard for more information.

---

### Release Notes

<details>
<summary>rommapp/romm (rommapp/romm)</summary>

### [`v3.4.0`](https://github.com/rommapp/romm/releases/tag/3.4.0)

[Compare
Source](https://github.com/rommapp/romm/compare/3.3.0...3.4.0)

#### What's Changed

- feat: Added link to home button by
[@&#8203;zurdi15](https://github.com/zurdi15) in
[https://github.com/rommapp/romm/pull/1054](https://github.com/rommapp/romm/pull/1054)
- feat: Public collections by
[@&#8203;gantoine](https://github.com/gantoine) in
[https://github.com/rommapp/romm/pull/1028](https://github.com/rommapp/romm/pull/1028)
- feat: Added aditional platform icons by
[@&#8203;Casuallynoted](https://github.com/Casuallynoted) in
[https://github.com/rommapp/romm/pull/1038](https://github.com/rommapp/romm/pull/1038)
- feat: Store and re-use last saved bios/save/state/core by
[@&#8203;gantoine](https://github.com/gantoine) in
[https://github.com/rommapp/romm/pull/1037](https://github.com/rommapp/romm/pull/1037)
- feat: Clickable filter buttons on details view by
[@&#8203;gantoine](https://github.com/gantoine) in
[https://github.com/rommapp/romm/pull/1040](https://github.com/rommapp/romm/pull/1040)
- feat: Add button to show duplicates by
[@&#8203;gantoine](https://github.com/gantoine) in
[https://github.com/rommapp/romm/pull/1043](https://github.com/rommapp/romm/pull/1043)
- fix: Scanning selected roms by
[@&#8203;gantoine](https://github.com/gantoine) in
[https://github.com/rommapp/romm/pull/1042](https://github.com/rommapp/romm/pull/1042)
- fix: Use namespaced cookie for session by
[@&#8203;adamantike](https://github.com/adamantike) in
[https://github.com/rommapp/romm/pull/1009](https://github.com/rommapp/romm/pull/1009)
- fix: Replace game-and-watch with g-and-w by
[@&#8203;gantoine](https://github.com/gantoine) in
[https://github.com/rommapp/romm/pull/1026](https://github.com/rommapp/romm/pull/1026)
- fix: Backend URL redirection logic by
[@&#8203;adamantike](https://github.com/adamantike) in
[https://github.com/rommapp/romm/pull/1058](https://github.com/rommapp/romm/pull/1058)
- fix: Enable flake8-async rules in ruff and fix warnings by
[@&#8203;adamantike](https://github.com/adamantike) in
[https://github.com/rommapp/romm/pull/1030](https://github.com/rommapp/romm/pull/1030)
- fix: Initialize context on scheduled task by
[@&#8203;adamantike](https://github.com/adamantike) in
[https://github.com/rommapp/romm/pull/1033](https://github.com/rommapp/romm/pull/1033)
- fix: Return early if IGDB finds an exact match by
[@&#8203;adamantike](https://github.com/adamantike) in
[https://github.com/rommapp/romm/pull/1032](https://github.com/rommapp/romm/pull/1032)
- fix: CSRF token issues by
[@&#8203;zurdi15](https://github.com/zurdi15) in
[https://github.com/rommapp/romm/pull/1057](https://github.com/rommapp/romm/pull/1057)
- fix: Link from related games by
[@&#8203;gantoine](https://github.com/gantoine) in
[https://github.com/rommapp/romm/pull/1045](https://github.com/rommapp/romm/pull/1045)
- fix: Typos in frontend by
[@&#8203;HellLord77](https://github.com/HellLord77) in
[https://github.com/rommapp/romm/pull/1048](https://github.com/rommapp/romm/pull/1048)
- fix: Firmware pagination by
[@&#8203;gantoine](https://github.com/gantoine) in
[https://github.com/rommapp/romm/pull/1041](https://github.com/rommapp/romm/pull/1041)
- fix: Multi-file download in gallery view by
[@&#8203;gantoine](https://github.com/gantoine) in
[https://github.com/rommapp/romm/pull/1044](https://github.com/rommapp/romm/pull/1044)
- fix: Remove persistent overlay prevents back navigation by
[@&#8203;gantoine](https://github.com/gantoine) in
[https://github.com/rommapp/romm/pull/1036](https://github.com/rommapp/romm/pull/1036)
- misc: Add Redis async cache by
[@&#8203;adamantike](https://github.com/adamantike) in
[https://github.com/rommapp/romm/pull/1010](https://github.com/rommapp/romm/pull/1010)
- misc: Create config.batocera-retrobat.yml by
[@&#8203;TyroneSlothrop](https://github.com/TyroneSlothrop) in
[https://github.com/rommapp/romm/pull/1013](https://github.com/rommapp/romm/pull/1013)
- misc: Migrate MobyGamesHandler to async by
[@&#8203;adamantike](https://github.com/adamantike) in
[https://github.com/rommapp/romm/pull/1011](https://github.com/rommapp/romm/pull/1011)
- misc: Migrate filesystem resource handler to async by
[@&#8203;adamantike](https://github.com/adamantike) in
[https://github.com/rommapp/romm/pull/1017](https://github.com/rommapp/romm/pull/1017)
- misc: Replace pytest-vcr dependency with pytest-recording by
[@&#8203;adamantike](https://github.com/adamantike) in
[https://github.com/rommapp/romm/pull/1021](https://github.com/rommapp/romm/pull/1021)
- misc: Refactor scan process by splitting single function by
[@&#8203;adamantike](https://github.com/adamantike) in
[https://github.com/rommapp/romm/pull/1024](https://github.com/rommapp/romm/pull/1024)
- misc: Migrate IGDBBaseHandler to async by
[@&#8203;adamantike](https://github.com/adamantike) in
[https://github.com/rommapp/romm/pull/1023](https://github.com/rommapp/romm/pull/1023)
- misc: Use PYTEST_VERSION variable to detect Pytest runs by
[@&#8203;adamantike](https://github.com/adamantike) in
[https://github.com/rommapp/romm/pull/1034](https://github.com/rommapp/romm/pull/1034)
- misc: Use async interface for stream-zip by
[@&#8203;adamantike](https://github.com/adamantike) in
[https://github.com/rommapp/romm/pull/1035](https://github.com/rommapp/romm/pull/1035)
- misc: Add workflow that runs typecheck on PRs by
[@&#8203;gantoine](https://github.com/gantoine) in
[https://github.com/rommapp/romm/pull/1055](https://github.com/rommapp/romm/pull/1055)
- misc: Make backend handle URLs with trailing slash by
[@&#8203;adamantike](https://github.com/adamantike) in
[https://github.com/rommapp/romm/pull/1059](https://github.com/rommapp/romm/pull/1059)
- misc: Drop ROMM_AUTH_USERNAME and ROMM_AUTH_PASSWORD env variables by
[@&#8203;gantoine](https://github.com/gantoine) in
[https://github.com/rommapp/romm/pull/1060](https://github.com/rommapp/romm/pull/1060)

#### New Contributors

- [@&#8203;TyroneSlothrop](https://github.com/TyroneSlothrop) made
their first contribution in
[https://github.com/rommapp/romm/pull/1013](https://github.com/rommapp/romm/pull/1013)

**Full Changelog**:
rommapp/romm@3.3.0...3.4.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Renovate
Bot](https://github.com/renovatebot/renovate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC4yMS4zIiwidXBkYXRlZEluVmVyIjoiMzguMjEuMyIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsicmVub3ZhdGUvY29udGFpbmVyIiwidHlwZS9taW5vciJdfQ==-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants