Skip to content

fix: make Mixologist async-safe, deprecate ObjectAggregator#934

Open
irfanuddinahmad wants to merge 1 commit into
openedx:masterfrom
irfanuddinahmad:fix/async-safe-mixologist-918
Open

fix: make Mixologist async-safe, deprecate ObjectAggregator#934
irfanuddinahmad wants to merge 1 commit into
openedx:masterfrom
irfanuddinahmad:fix/async-safe-mixologist-918

Conversation

@irfanuddinahmad

Copy link
Copy Markdown
Contributor

Summary

  • Removes threading.RLock (_CLASS_CACHE_LOCK) from Mixologist's class cache, making mix() safe for ASGI/async deployments. dict.setdefault() atomicity (via CPython's GIL) provides equivalent thread safety without ever blocking the event loop.
  • Deprecates ObjectAggregator with a DeprecationWarning — 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:

  1. asyncio is cooperativemix() has zero await points, so the scheduler can never interleave two calls on the same thread.
  2. CPython's GIL makes dict.setdefault() atomic — under true multi-threading, two racing threads may both construct the type(...) object, but setdefault guarantees only one is stored. The other is discarded. This is a benign, one-time cost.

Test plan

  • All existing TestMixologist tests pass unchanged (caching and mixin behaviour is identical)
  • TestObjectAggregator tests pass and assert the new DeprecationWarning fires on instantiation
  • grep threading xblock/runtime.py returns nothing

Closes #918
Part of openedx/openedx-platform#38680

🤖 Generated with Claude Code

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>
@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Jun 29, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @irfanuddinahmad!

This repository is currently maintained by @openedx/axim-engineering.

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 approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where 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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.RLock usage around the Mixologist.mix() class cache and replaced it with a lock-free dict.setdefault()-based approach.
  • Added a DeprecationWarning on ObjectAggregator instantiation 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.

@farhan

farhan commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

@ormsbee PR looks good to me. It would be great if you could take a look

@ormsbee ormsbee left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Comment thread xblock/runtime.py
))
else:
return _CLASS_CACHE[mixin_key]
new_class = type(

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

@ormsbee ormsbee Jul 1, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

Investigate and possibly replace threading RLock in ObjectAggregator

6 participants