Skip to content

feat!: remove the legacy XQueue HTTP path and the MATLAB integration - #338

Open
feanil wants to merge 2 commits into
openedx:mainfrom
feanil:feanil/remove-legacy-xqueue-matlab
Open

feanil wants to merge 2 commits into
openedx:mainfrom
feanil:feanil/remove-legacy-xqueue-matlab

Conversation

@feanil

@feanil feanil commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

The XQueue service is deprecated and its repo archived (openedx/public-engineering#286). The LMS queues external grader submissions in edx-submissions and serves the API that xqueue-watcher polls, and scores come back through the EXTERNAL_GRADER_SCORE_SUBMITTED signal. This removes the code that only existed for the old service, and the MATLAB integration that only worked through it (openedx/public-engineering#192).

XQueue

  • XQueueInterface no longer posts to the XQueue service over HTTP. The login round trip, the request timeouts, parse_xreply and the use_submission_service switch are gone. It now takes the block and hands every submission to XQueueInterfaceSubmission.
  • make_xheader no longer takes lms_callback_url. Nothing calls back any more.
  • The runtime's xqueue service no longer needs construct_callback.

MATLAB

  • MatlabInput, its template, fixture and CodeMirror octave mode, and the sanitize_html helper only it used are gone.
  • matlab_api_key is gone from ProblemBlock and LoncapaSystem, and CodeResponse no longer adds the API key to the grader payload.
  • The ungraded_response handlers that carried MATLAB's plot output are gone.
  • <matlabinput> stays as a tag on CodeInput, so existing problems still parse and learners keep their scores. It renders as a plain code box.

Both commits are feat!, so this releases as a major version. openedx-platform needs a matching change for the new XQueueInterface signature and the dropped LoncapaSystem argument: openedx/openedx-platform#39405. The pin bump and that PR have to land together, since dropping matlab_api_key from the non-editable list here makes the field editable again in Studio on a platform that still has it on the inheritance mixin.

The Python suite passes locally (836 tests). The JS spec that covered polling on a queued problem now uses a codeinput fixture instead of the MATLAB one.

return default


def sanitize_html(html_code):

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

MatlabInput was the onlything using this so it and its tests can be removed.

feanil and others added 2 commits November 20, 2026 12:21
The MATLAB integration sent code to the MathWorks hosted service through
the XQueue service and got results back on the XQueue callback URL.
Neither exists any more: the service is deprecated and its repo archived
(openedx/public-engineering#286), and the LMS
now queues submissions in edx-submissions, which has no callback.
openedx/public-engineering#192 deprecated the
MATLAB handling in 2023 because the endpoint it talked to no longer
worked.

Remove MatlabInput, its template, fixture and CodeMirror octave mode, the
sanitize_html helper only it used, the matlab_api_key field on
ProblemBlock and LoncapaSystem, the API key payload in CodeResponse, and
the ungraded_response handlers that carried MATLAB's plot output.

<matlabinput> stays as a tag on CodeInput so existing problems still
parse and learners keep their scores.  It renders as a plain code box.

BREAKING CHANGE: LoncapaSystem no longer accepts matlab_api_key, and
ProblemBlock no longer has that field or the ungraded_response handler.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
XQueueInterface could still post to the XQueue service over HTTP when the
send_to_submission_course.enable flag was off for a course, with a login
round trip, request timeouts and reply parsing to go with it.  The XQueue
service is deprecated and its repo archived
(openedx/public-engineering#286), and
edx-submissions is the only queue the LMS serves, so the HTTP path goes.

XQueueInterface now takes the block and hands every submission to
XQueueInterfaceSubmission.  The header no longer carries a callback URL:
scores come back through the EXTERNAL_GRADER_SCORE_SUBMITTED signal, not
an HTTP callback.  The header is an internal envelope now; edx-submissions
reads the queue name and the queue key out of it and builds its own
header for the grader.

send_to_queue reports a failure inside edx-submissions the way it
reported a connection failure to the XQueue service.  It catches
SubmissionError and XQueueSubmissionError and returns (1, message), so
the learner sees an error instead of waiting on a submission that was
never queued.  It returns 0 on success, as the HTTP path did, where the
edx-submissions path returned None.

BREAKING CHANGE: XQueueInterface(url, django_auth, requests_auth, block,
use_submission_service) is now XQueueInterface(block).  make_xheader no
longer takes lms_callback_url.  The runtime's xqueue service no longer
needs construct_callback.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@feanil
feanil force-pushed the feanil/remove-legacy-xqueue-matlab branch from 2eb406f to 9e40e5e Compare November 20, 2026 20:19
@feanil
feanil marked this pull request as ready for review November 20, 2026 20:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant