search

octokit / octokit.rb

Ruby toolkit for the GitHub API
http://octokit.github.io/octokit.rb/
MIT License
3.83k stars 1.13k forks source link

[BUG]: HTTP caching middleware returns cached responses to wrong users #1660

Open DimitriosLisenko opened 5 months ago

DimitriosLisenko commented 5 months ago

What happened?

In version 4.22.0 (and onwards), http.authorization 'Bearer', @bearer_token (which immediately sets the Authorization header) was changed to http.request :authorization, 'Bearer', @bearer_token, which instead adds the Faraday::Request::Authorization to the middleware chain, which sets the Authorization header when called.

Since the authorization middleware is added at the point of the request, while the caching middleware is added on Faraday initialization (as suggested in the README), it means that the HTTP caching middleware runs first, and the authorization middleware runs second.

This means that when the caching middleware runs, it does not have the Authorization header set, and therefore caches requests and then returns them without having the ability to know that these requests are for different users.

For example, GET /user/installations?per_page=100 should return different results for different users, but with the HTTP caching enabled, it does not.

I have a PR that fixes the issue here: https://github.com/octokit/octokit.rb/pull/1661/files. Open to other approaches as well.

Versions

Octokit v8.0.0, Ruby v3.2.2

Relevant log output

No response

Code of Conduct

github-actions[bot] commented 5 months ago

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

nickfloyd commented 5 months ago

Hey @DimitriosLisenko, great catch! Thanks for tracking this down. Let us know if you'd be interested in fixing the issue and submitting a PR. For now I have labeled this as "Up For Grabs" so that the community can take a stab at getting this fixed as well. ❤️

DimitriosLisenko commented 5 months ago

Hey @nickfloyd! I have already submitted a PR at https://github.com/octokit/octokit.rb/pull/1661/files :)

nickfloyd commented 5 months ago

Hey @nickfloyd! I have already submitted a PR at https://github.com/octokit/octokit.rb/pull/1661/files :)

Oof, sorry about that I completely missed that. Thank you for the follow up and the contributions! We'll have a look shortly! ❤