Support passing request params to a source #929
Draft
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
A use case for passing a request parameter to the source is passing an API key thorough MapProxy onto a source with the response being cached. Unlike dimensions, these parameters are not taken into account when caching. Adds the concept of extra_params which are those request parameters that are not part of a standard request. The extra_params are available to WMS and tile sources for inclusion in source requests. To include an extra_params in a WMS source request the forward_req_params property is set to a list of parameter names; for a tile source a placeholder is defined in the URL. Existing tests have been updated to take into account this new functionality.
The system/test_wmts.py::TestWMTS::test_get_tile_flipped_axis test doesn't rely on the contents of test/system/fixture/cache_data being copied into it's newly created cache_dir so remove the fixture from the test. The test asserts that the cache_data/tile_locks directory does not exist as a prerequisite, I ran into an issue where I had been debugging tests by running `mapproxy-util serve-develop` against a config file under system/fixture which resulted in a tile_locks directory being created; this caused the test_get_tile_flipped_axis to fail unexpectedly.
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.
We (@AstunTechnology) have a requirement to pass an API key through MapProxy onto a WMTS source with the response being cached. Unlike dimensions the API key should not be taken into account when caching, resulting in all users benefiting from a short-term cache.
This PR adds the concept of
extra_paramswhich are those request parameters that are not part of a standard request. Theextra_paramsare available to WMS and tile sources for inclusion in source requests. To include a parameter fromextra_paramsin a WMS source request theforward_req_paramsproperty is set to a list of required parameter names; for a tile source a placeholder is defined in the URL.Existing tests have been updated to take into account this new functionality.