Repository navigation
Conversation
The ETag middleware currently assumes that it is handling a GET request and many of our ETagCalculators calculate a strong ETag by hashing the body of a GET request. However, this does not make sense for POST requests. A POST request is not idempotent and is intended to modify the state of the resource it is posted too. This results in a duplicate GET request being unnecessarily handled to calculate an incorrect ETag for the response to the POST request. In situations like the API candidates endpoint, this can be costly and unnecessary for projects with a high number of candidates. This changes the middleware to not calculate an ETag for POST requests. The ETag spec specifies that the header can be used for ensuring the right resource is being modified for other HTTP methods such as PUT and DELETE, so only POST is excluded by this change.
This branch has not been deployed
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
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.
The ETag middleware currently assumes that it is
handling a GET request and many of our ETagCalculators calculate a strong ETag by hashing the body of a GET request. However, this does not make sense for POST requests. A POST request is not idempotent and is intended to modify the state of the resource it is posted too.
This results in a duplicate GET request being unnecessarily handled to calculate an incorrect ETag for the response to the POST request. In situations like the API candidates endpoint, this can be costly and unnecessary for projects with a high number of candidates.
This changes the middleware to not calculate an ETag for POST requests. The ETag spec specifies that the header can be used for ensuring the right resource is being modified for other HTTP methods such as PUT and DELETE, so only POST is excluded by this change.