PB-796: handle paths without trailing slash without redirection. #440
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adk-swisstopo
force-pushed
the
feat-PB-796-trailing-slash
branch
2 times, most recently
from
b125272
to
a810b67
Compare
boecklic
approved these changes
Aug 13, 2024
Comment on lines
+39
to
+43
| self.logger.error( | ||
| 'Not redirecting path that already ends with a slash: %s: %s', | ||
| request.path_info, | ||
| request | ||
| ) |
There was a problem hiding this comment.
so this is a case that should never happen, right?
There was a problem hiding this comment.
It should not. But if it does I think it's better to return gracefully and log the error than to get stuck in an infinite loop or to return 500 to the user.
API Gateway v1 strips trailing slashes from the request paths. We have a few endpoints that use trailing slashes. Specifically: - /api/stac/v1/ - /api/stac/v0.9/ - /api/stac/admin/* Django's CommonMiddleware already has a feature to redirect URLs without trailing slash to their "slashed" equivalent when they exist. When combined with API Gateway v1 this causes a redirection loop. This change introduces CommonMiddlewareWithInternalRedirect which handles the redirection internally to serve the query like if it had hit the "slashed" page directly. It also updates the test to verify both endpoints work correctly. Based on discussion in https://ltwiki.adr.admin.ch:8443/display/~adrien.kunysz@swisstopo.ch/STAC+API+trailing+slash+inconsistency
adk-swisstopo
force-pushed
the
feat-PB-796-trailing-slash
branch
from
453748f
to
4eda290
Compare
adk-swisstopo
added a commit
that referenced
this pull request
Sep 24, 2024
In #440 we added CommonMiddlewareWithInternalRedirect to respond to URLs that don't end with a trailing slash without user-visible redirection. This was primarily done to handle a limitation of AWS API Gateway v1. We eventually decided to use API Gateway v2 which does not have this limitation. Hence, we remove this code that is not useful and update the tests accordingly. This is basically a revert of #440 although we keep some of the test refactoring/improvements.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
API Gateway v1 strips trailing slashes from the request paths. We have a few endpoints that use trailing slashes. Specifically:
/api/stac/v1/
/api/stac/v0.9/
/api/stac/admin/*
Django's CommonMiddleware already has a feature to redirect URLs without trailing slash to their "slashed" equivalent when they exist. When combined with API Gateway v1 this causes a redirection loop.
This change introduces CommonMiddlewareWithInternalRedirect which handles the redirection internally to serve the query like if it had hit the "slashed" page directly.
It also updates the test to verify both endpoints work correctly.
Based on discussion in https://ltwiki.adr.admin.ch:8443/display/~adrien.kunysz@swisstopo.ch/STAC+API+trailing+slash+inconsistency