fix: make Mixologist async-safe, deprecate ObjectAggregator#934
fix: make Mixologist async-safe, deprecate ObjectAggregator#934irfanuddinahmad wants to merge 1 commit into
Conversation
Remove threading.RLock from Mixologist's class cache so mix() no longer blocks the event loop under ASGI deployments. dict.setdefault() atomicity (via CPython's GIL) provides equivalent thread safety, and asyncio's cooperative scheduler ensures mix() — which has no await points — is never interleaved within the same thread. ObjectAggregator has no production callers; mark it deprecated so it can be removed in a future major release. Closes openedx#918 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Thanks for the pull request, @irfanuddinahmad! 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. |
Summary
threading.RLock(_CLASS_CACHE_LOCK) fromMixologist's class cache, makingmix()safe for ASGI/async deployments.dict.setdefault()atomicity (via CPython's GIL) provides equivalent thread safety without ever blocking the event loop.ObjectAggregatorwith aDeprecationWarning— it has no production callers anywhere in XBlock or edx-platform and will be removed in a future major release.Why the lock had to go
In ASGI (single event-loop thread), calling
with threading.RLock():stalls the entire event loop if another operation holds the lock, blocking every concurrent request. This is one of the threading hazards catalogued in the parent epic.Two reasons no replacement lock is needed:
mix()has zeroawaitpoints, so the scheduler can never interleave two calls on the same thread.dict.setdefault()atomic — under true multi-threading, two racing threads may both construct thetype(...)object, butsetdefaultguarantees only one is stored. The other is discarded. This is a benign, one-time cost.Test plan
TestMixologisttests pass unchanged (caching and mixin behaviour is identical)TestObjectAggregatortests pass and assert the newDeprecationWarningfires on instantiationgrep threading xblock/runtime.pyreturns nothingCloses #918
Part of openedx/openedx-platform#38680
🤖 Generated with Claude Code