fix: throttle cache key fixed for same scoped classes#38850
fix: throttle cache key fixed for same scoped classes#38850marslanabdulrauf wants to merge 1 commit into
Conversation
|
Thanks for the pull request, @marslanabdulrauf! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
Description
This pull request introduces namespacing to the cache keys used by custom throttling classes in API views. By prefixing each throttle's cache key, it ensures that rate-limiting buckets are unique to each throttle, preventing unintended sharing of rate limits across different API endpoints that might use the same scope name.
Improvements to throttling cache key namespacing:
get_cache_keymethod to the custom throttle class inlms/djangoapps/course_api/views.pyto prefix the cache key withcourse_list., ensuring isolation of rate-limiting buckets for the course list API.get_cache_keymethod to the custom throttle class inlms/djangoapps/course_api/views.pyto prefix the cache key withcourse_id_list., ensuring isolation of rate-limiting buckets for the course ID list API.get_cache_keymethod to the custom throttle class inopenedx/core/djangoapps/enrollments/views.pyto prefix the cache key withenrollment., ensuring isolation of rate-limiting buckets for the enrollment API.Supporting information
https://github.com/mitodl/hq/issues/11918 (MIT Internal)
Testing instructions