Repository navigation
Description
RFC Start Date
2025-01-29
Target Plan Accepted Date
2025-02-12
Target Transition Unblocked Date
(currently unblocked)
Earliest Breaking Changes Unblocked Date
2026-04-09 -- After Verawood is cut.
Earliest Open edX Named Release Without This Functionality
Willow - 2026-12
Rationale
The XQueue service adds a lot of operational complexity for the capability that it provides. While it did originally do more (e.g. push grading), that functionality is no longer used because it was prone to operational issues. The current form of XQueue mostly serves as a holding area for submissions, waiting for xqueue-watcher to poll for them.
A larger deprecation was proposed in #214, but we concluded that the off-site grading functionality that XQueue represented was still valuable to preserve.
Removal
The XQueue service will be discontinued and the xqueue repo will be archived.
The following settings will be removed from edx-platform:
XQUEUE_INTERFACEXQUEUE_WAITTIME_BETWEEN_REQUESTS
We will maintain support for xqueue-watcher and ProblemBlock use of code graders.
When xqueue references are eventually completely removed from edx-platform (post-Teak), we will also execute #192 (MATLAB removal). The two systems are tightly coupled enough where it makes sense to remove them at the same time.
Replacement
Instead of having a separate XQueue service, the edx-submissions repo will be expanded to cover the same use case while running in-process in the LMS. The LMS will also re-implement the REST API that xqueue-watcher interacts with.
The LonCapaSystem service XQueueService will be replaced with a generic XBlock runtime service that is not ProblemBlock-specific.
Deprecation
The LMS will emit warning log messages in Teak whenever the old xqueue-callback URL for ProblemBlocks is hit.
Migration
- No content changes will be required for authored problems. Existing content is intended to work exactly as it always has.
- No code changes will be required for
xqueue-watcher. - Configuration changes will be required for
xqueue-watcher, to point it at the LMS instead of at the XQueue service.
In the Teak release, all code grader submissions will be written to the new backend in edx-submissions, and will be available for xqueue-watcher to pull directly from the LMS. If XQUEUE_INTERFACE is also configured for edx-platform, the LMS will additionally post the request to the XQueue service. If the LMS gets a response from the XQueue service, it will delete the queued submission in edx-submissions.
This should allow us a smooth transition path where operators could make their transition by deploying updated configuration for their xqueue-watcher. Operators that are very downtime sensitive could run multiple xqueue-watcher instances concurrently during the transition, falling back to the old behavior if necessary.
Open question:
- Should duplicate grading attempts for the same submission be "first one wins" or "last one wins"?
- Do we need to preserve an alias for the old Loncapa XQueueService? This would only need to be done if people have extended their instance ProblemBlocks with custom input/response-types that use that service... which seems unlikely?
Support for posting to the XQueue service would be removed after 2025-08-12, and all code and tests in edx-platform related to xqueue will be removed at that point.
Additional Info
We ultimately want to iterate on this and create a much more flexible off-platform grading capability that can:
- Make better use of other communications mechanisms, like the message queue backend that openedx-events can utilize.
- Allows for multiple interfaces, and so accepts things like LTI's grade passbacks, and possibly bulk grading.
- Understands team-related grading, like ORA does.
- Remove some of the contortions we make to allow LTI blocks to authenticate non-user requests for grade passback purposes.
But the first step is to preserve the existing functionality while reducing operational complexity of running this system, which this DEPR represents.
Task List
No response
Metadata
Metadata
Labels
Type
Projects
- StatusShow more project fieldsBreaking Changes Unblocked
Activity
ormsbee commentedon Jan 29, 2025
Posted to forum: https://discuss.openedx.org/t/deprecation-xqueue-again/14864
kdmccormick commentedon Feb 12, 2025
Excellent plan 👍🏻
robrap commentedon May 29, 2025
[inform/request] This ticket was accepted under the old DEPR process. The updated Process States in OEP-21 help add clarity to communications and timing regarding the introduction of breaking changes. This ticket must move to Transition Unblocked before moving to Breaking Changes Unblocked. The default minimum time to wait in Transition Unblocked is 1 month, so early deployers have time to prepare. If you wish to make breaking changes in less than 1 month, please initiate discussions to negotiate a date as soon as possible. Thank you!
feanil commentedon May 30, 2025
Confirming that after a review, this ticket is currently in the right state. It can move to transition unblocked once we have documented what changes need to be made in edx-platform to switch from using the old xqueue service to using the in-process version. Once that document has been posted and live, we can move this to "Transition Unblocked" and remove support for the old code 1 month after that.
robrap commentedon May 30, 2025
Thanks @feanil.
8 remaining items
feanil commentedon Mar 5, 2026
Thanks Dave, I've updated this ticket so that we don't look at it again in DEPR review until a ew weeks after the Verawood cut since I assume, you'll probably close this out around then.
sarina commentedon Mar 5, 2026
@feanil full disclosure we currently don't have a resourcing plan on this DEPR.
docs: Remove DEPR warning from README
docs: Update DEPR date
docs: Remove DEPR warning from README
docs: Update DEPR date
feanil commentedon Apr 2, 2026
This work is still not resourced so pushing out the date when we next check in on this to after the conference in May
feanil commentedon Jun 12, 2026
@ormsbee @sarina Aximprovements could take this on potentially, if you could provide more info on what needs to be done? Is there work in openedx-platform or is this mostly archivingthe XQueue repo?
sarina commentedon Jun 12, 2026
Will leave to @ormsbee to detail, but that would be a HUGE assist! Thank you!
kdmccormick commentedon Nov 12, 2026
@ormsbee has confirmed that all support for the XQueue microservice is safe to be removed!
XQueue repo archival is happening now: openedx-unsupported/xqueue#991 (comment)
We don't yet have a specific plan for when XQueue microservice support will be removed from openedx-platform. Aximprovements might be able to pick it up in the future? But if anyone else is interested in doing that part of the removal, please let us know!
@ormsbee I know we are keeping xqueue-watcher, but do you know if any cleanup should be done in that repo as it no longer needs to talk to the XQueue microservice?
kdmccormick commentedon Nov 12, 2026
I think the docs could use a sweep too https://docs.openedx.org/en/latest/site_ops/references/xqueue_external_grader.html#xqueue-reference
docs: update README for repository archival (#991)
graderkey of<grader_payload>edx-submissions#390