Add ETag to /custom_component route to control browser caching
#8170
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
🪼 branch checks and previews
Install Gradio from this PR pip install https://gradio-builds.s3.amazonaws.com/6fff2d0cc8cabcfb835df9dbc2e71cf2cc4e6ff8/gradio-4.28.3-py3-none-any.whlInstall Gradio Python Client from this PR pip install "gradio-client @ git+https://github.com/gradio-app/gradio@6fff2d0cc8cabcfb835df9dbc2e71cf2cc4e6ff8#subdirectory=client/python" |
🦄 change detectedThis Pull Request includes changes to the following packages.
With the following changelog entry.
Maintainers or the PR author can modify the PR title to modify this entry.
|
freddyaboulton
commented
Apr 29, 2024
| key = f"{id}-{type}-{file_name}" | ||
|
|
||
| if key not in app.custom_component_hashes: | ||
| app.custom_component_hashes[key] = hashlib.md5( |
There was a problem hiding this comment.
We only need to compute the hash once as changing the frontend files is not supported after the server starts. This route is not used for dev mode.
freddyaboulton
requested review from
pngwn,
abidlabs,
aliabid94,
aliabd,
dawoodkhan82 and
hannahblair
pngwn
approved these changes
Apr 30, 2024
There was a problem hiding this comment.
I think this is preferable than setting a max-age because it should minimize the chance of a stale cache.
This makes sense, cache is always busted when devtools are open but that cant be guaranteed, just an old habit of mine.
Looks good. Thanks for taking care of this @freddyaboulton!
|
Thanks for the review @pngwn !! |
Merged
dawoodkhan82
pushed a commit
that referenced
this pull request
May 6, 2024
* Add code * add changeset * add changeset --------- Co-authored-by: gradio-pr-bot <gradio-pr-bot@users.noreply.github.com>
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.
Description
Setting an ETag in the response of
/custom_componentthat's equal to the hash of the requested file. I think this is preferable than setting amax-agebecause it should minimize the chance of a stale cache. During development, it's possible to build frequently to see if latest changes work outside the development server ( I do that atleast) so themax-agewould be hard to set in this case.Closes: #8168
🎯 PRs Should Target Issues
Before your create a PR, please check to see if there is an existing issue for this change. If not, please create an issue before you create this PR, unless the fix is very small.
Not adhering to this guideline will result in the PR being closed.
Tests
PRs will only be merged if tests pass on CI. To run the tests locally, please set up your Gradio environment locally and run the tests:
bash scripts/run_all_tests.shYou may need to run the linters:
bash scripts/format_backend.shandbash scripts/format_frontend.sh