Use json rather than flask.json to generate ETag #393
Merged
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.
Historically, we used flask.json because it serializes lazy strings but this should not be the responsibility of this framework.
Then, we decided not to force
sort_keys
for consistency with the way flask dumps the payload (#305). But there is no reason to do that for the "explicit ETag" (arbitrary data) case. And even if the app doesn't sort keys, doing it for ETag computation makes sense.It is not easy to provide a one-size-fits-all solution. User is free to override
_generate_etag
for specific cases (specific json serializer, sort_keys=False,...).Things can probably be improved in a wider ETag rework. Meanwhile, this change simplifies the code and fixes compatibility with Flask 2.2+ without breaking compatibility with Flask <2.2.