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. |
There was a problem hiding this comment.
Pull request overview
This PR updates XBlock’s runtime utilities to be safer in ASGI/async environments by removing a blocking thread lock from Mixologist’s class cache, and formally deprecates ObjectAggregator with a DeprecationWarning.
Changes:
- Removed
threading.RLockusage around theMixologist.mix()class cache and replaced it with a lock-freedict.setdefault()-based approach. - Added a
DeprecationWarningonObjectAggregatorinstantiation and updated tests to assert the warning. - Documented both changes in
CHANGELOG.rst.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
xblock/runtime.py |
Removes the lock from Mixologist class caching and adds a deprecation warning for ObjectAggregator. |
xblock/test/test_runtime.py |
Updates TestObjectAggregator to assert the new DeprecationWarning. |
CHANGELOG.rst |
Notes the async-safety change and the ObjectAggregator deprecation in the Unreleased section. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@ormsbee PR looks good to me. It would be great if you could take a look |
ormsbee
left a comment
There was a problem hiding this comment.
This looks fine to me as well, though I'm not sure if @kdmccormick wants to look at it.
This all happens at startup initialization before we start serving requests anyway, right? We're not actually mixing classes together during the request/response lifecycle, are we?
| )) | ||
| else: | ||
| return _CLASS_CACHE[mixin_key] | ||
| new_class = type( |
There was a problem hiding this comment.
Thank you both for reviewing.
@ormsbee , blocks are actually mixed on-demand, not at startup. If you throw a breakpoint here and start up a fresh CMS, it won't be hit until you load up a course, at which point you'll see it hit as part of the request handler once per loaded block type. Does that change your review at all?
There was a problem hiding this comment.
It doesn't change my review, but it just seems like something that should happen at one time and place during startup (triggered from an AppConfig somewhere), unless there's a really compelling reason to delay it.
There was a problem hiding this comment.
(With the justification that the Mixologist engages in weird magic, and weird magic should ideally happen only once and in obvious place and time.) To be clear, I'm not asking for this PR to change this behavior, especially since that's likely to be risky.
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