Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade go-chi/chi to commit that handles Vary header properly #803

Merged
merged 1 commit into from Apr 11, 2022

Conversation

albertchae
Copy link
Contributor

Fixes #802

For CORS, the server needs to include Origin in the Vary response (if Access-Control-Allow-Origin is not set to *)
https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#access-control-allow-origin

Flipt is using go-chi/cors to handle CORS which does include that header
https://github.com/go-chi/cors/blob/9b0b248d5e6ba10c954f076a98c5f7760f243882/cors.go#L242-L247

However, if the request includes Accept-Encoding, this triggers this line
https://github.com/go-chi/chi/blob/86f9a6e7ce9bf453eaa339b51f88f586edbccbc1/middleware/compress.go#L321
which overrides any previously set Vary headers

N.B. Accept-Encoding is a forbidden header https://developer.mozilla.org/en-US/docs/Glossary/Forbidden_header_name
meaning it can only be set by the user agent and cannot be modified in JS as a workaround

This bug was fixed in go-chi/chi#640, so this
commit updates go-chi/chi to that commit hash with
go get github.com/go-chi/chi/v5@b750c805b4ee0952b

For CORS, the server needs to include `Origin` in the `Vary` response
https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#access-control-allow-origin

Flipt is using go-chi/cors to handle CORS which does include that header
https://github.com/go-chi/cors/blob/9b0b248d5e6ba10c954f076a98c5f7760f243882/cors.go#L242-L247

However, if the request includes `Accept-Encoding`, this triggers this line
https://github.com/go-chi/chi/blob/86f9a6e7ce9bf453eaa339b51f88f586edbccbc1/middleware/compress.go#L321
which overrides any previously set Vary headers

N.B. `Accept-Encoding` is a forbidden header https://developer.mozilla.org/en-US/docs/Glossary/Forbidden_header_name
meaning it can only be set by the user agent and cannot be modified in JS as a workaround

This bug was fixed in go-chi/chi#640, so this
commit updates go-chi/chi to that commit hash with
`go get github.com/go-chi/chi/v5@b750c805b4ee0952b`
Copy link
Collaborator

@markphelps markphelps left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cheers @albertchae thanks for the PR!

@markphelps markphelps merged commit c7b4e56 into flipt-io:master Apr 11, 2022
@markphelps
Copy link
Collaborator

@all-contributors please add @albertchae for code

@allcontributors
Copy link
Contributor

@markphelps

I've put up a pull request to add @albertchae! 🎉

@albertchae albertchae deleted the update-go-chi-vary-origin branch April 11, 2022 22:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants