perf(user_api): implement centralized caching for user preferences#38783
perf(user_api): implement centralized caching for user preferences#38783andrey-canon wants to merge 1 commit into
Conversation
|
Thanks for the pull request, @andrey-canon! 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. |
Introduces a Django-based caching mechanism at the Model layer for UserPreference lookups. This mitigates severe database load caused by redundant queries, stabilizes the DB, and centralizes cache logic. Updated affected tests with LocMemCache to assert the new, reduced query counts.
021462a to
a2f03ad
Compare
Description
This PR introduces a centralized caching mechanism for the User Preferences API to mitigate severe database load and reduce redundant queries across the platform.
Previously, frequent user preference lookups were causing high operational impact, specifically driven by the user preference lookup query.
By centralizing the cache at the Model layer using Django's standard caching framework, this PR stabilizes the database, improves global cache utilization, and simplifies the API layer.
Key Changes
@request_cached()decorator fromUserPreference.get_all_preferences()inmodels.py. The cache Hit/Miss logic is now explicitly handled inside this method.openedx/core/djangoapps/user_api/helpers.py.api.py. Methods likehas_user_preference,get_user_preference, andget_user_preferencesnow directly delegate to the model layer rather than handling caching themselves.Testing & Impact
lang_pref/tests/test_middleware.pydropped from 1 to 0 and 3 to 2; taxonomy tags test queries reduced by 1).@override_settings(CACHES={'default': {'BACKEND': 'django.core.cache.backends.locmem.LocMemCache'}})to affected test cases (likeIndexQueryTestCase). Since the architecture no longer relies on thread-local memory, tests that previously defaulted toDummyCachenow require a functional cache backend to accurately assert the optimized query counts.