Fix: Prevent duplicate root_path in pagination links #250
Conversation
This file contains hidden or 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
When a custom `ROOT_PATH` environment variable is used, the "next" pagination link could incorrectly include the root_path twice. This was because the `BaseLinks.url` property, which generates the base for these links, did not properly account for the `ROOT_PATH` already being part of `self.base_url` (derived from `get_base_url`) when joining it with the request path. The `BaseLinks.url` property in `stac_fastapi/pgstac/models/links.py` has been updated to ensure that the request path is made relative to the `base_url`'s path component before joining. This prevents the duplication. A new test case, `test_pagination_link_with_root_path`, has been added to `tests/api/test_links.py` to specifically verify that pagination links are generated correctly when `ROOT_PATH` is set.
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.
When a custom
ROOT_PATHenvironment variable is used, the "next" pagination link could incorrectly include the root_path twice.This was because the
BaseLinks.urlproperty, which generates the base for these links, did not properly account for theROOT_PATHalready being part ofself.base_url(derived fromget_base_url) when joining it with the request path.The
BaseLinks.urlproperty instac_fastapi/pgstac/models/links.pyhas been updated to ensure that the request path is made relative to thebase_url's path component before joining. This prevents the duplication.A new test case,
test_pagination_link_with_root_path, has been added totests/api/test_links.pyto specifically verify that pagination links are generated correctly whenROOT_PATHis set.PR Checklist:
pre-commithooks pass locallymake test)make docs)