feat: caching of map and image tiles #74
Open
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
Contributor
Author
|
LINT build is failing because the pre-commit hasn't been updated to only run on files changed as part of the PR. @jtblack-aws already made those changes as part of PR #73 . |
drduhe
approved these changes
Mar 31, 2025
| output_size=(tile_size, tile_size), | ||
| ) | ||
| return Response(content=bytes(image_bytes), media_type=get_media_type(tile_format), status_code=status.HTTP_200_OK) | ||
| headers = {"Cache-Control": "private, max-age=604800"} |
Collaborator
There was a problem hiding this comment.
Would this max age be something we want set as a configuration variable somewhere??
jtblack-aws
reviewed
Apr 2, 2025
| """ | ||
| cached_tile_count_env = "TILE_PROVIDER_CACHED_TILE_COUNT" | ||
| cached_tile_count_default = 400 | ||
| cached_tile_count = os.getenv(cached_tile_count_env) |
Contributor
There was a problem hiding this comment.
In the past we've been handling reading env vars in app_config.py and then importing the values from there.
drduhe
requested changes
Apr 9, 2025
Collaborator
drduhe
left a comment
drduhe
left a comment
There was a problem hiding this comment.
Needs unit tests passing
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This PR updates the tile server to cache previously created map and image tiles. It also adds a Cache-Control header that instructs clients to keep the tiles for up to 7 days. Combined these two features eliminate many duplicate tile generation requests improving the overall responsiveness of visualization tools using the tile server.
The implementation introduces a new
TileProviderservice that is injected into the handlers for various tile / map routes. Theget_image_tileandget_map_tilemethods are wrapped in a LRU cache with a max size that can be configured by setting theTILE_PROVIDER_CACHED_TILE_COUNTenvironment variable. This configuration setting defaults to 400 tiles if not found in the environment.Unit tests were updated to validate the new TileProvider and end-to-end functionality was checked through an integration with STACBrowser.
This PR also contains a second commit for a small build issue found during testing. The autopep8 checks run in our pre-commit setup were failing because they could not find the lib2to3 module. That module was officially deprecated / removed in Python 3.11 but older versions of the autopep8 tool still depended on it. Updating to the latest version resolved the issue.
Checklist
Before you submit a pull request, please make sure you have the following:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.