Skip to content

feat!: remove the XQueue service settings, callback and the MATLAB API key - #39405

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

feanil wants to merge 2 commits into
openedx:masterfrom
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, serves the API that xqueue-watcher polls, and gets scores back through the EXTERNAL_GRADER_SCORE_SUBMITTED signal. This removes the platform code that only existed for the old service, and the MATLAB handling that only worked through it (openedx/public-engineering#192).

Depends on openedx/xblocks-core#338. That PR changes XQueueInterface to take only the block and drops the matlab_api_key argument to LoncapaSystem. CI here fails until it is released and the pin is bumped; I will add the bump commit when the release is out. The bump and this PR have to land together: with the new xblocks-core and the old mixin, the "Matlab API key" box comes back in Studio.

XQueue

  • XQUEUE_INTERFACE is gone from the settings, the mock YAML and the test settings, along with XQUEUE_PORT. XQUEUE_WAITTIME_BETWEEN_REQUESTS stays, since it is the wait a learner has to observe between submissions to a queued problem and the in-platform queue still enforces it.
  • The xqueue_callback view and its two URL patterns are gone. handle_external_grader_score in lms/djangoapps/grades/signals/handlers.py already does the same job in-process.
  • XQueueService no longer builds HTTP auth or a callback URL, and the send_to_submission_course.enable course waffle flag that picked between the two backends is gone. Every course's external grader submissions go to edx-submissions.

MATLAB

  • The matlab_api_key field is gone from ProblemBlock and from the inheritance mixin that put it on the course's Advanced Settings, along with the ungraded_response ajax handler and the MATLAB wording on the Studio import and export pages.
  • Existing <matlabinput> problems still parse: xblocks-core keeps the tag on CodeInput, so learners keep their scores.
  • The cms tests that used matlab_api_key as a sample synced settings field use source_code instead.

Follow-ups outside this PR

feanil and others added 2 commits November 19, 2026 15:56
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, and xblocks-core has dropped MatlabInput and the
matlab_api_key argument to LoncapaSystem
(openedx/xblocks-core#338).
openedx/public-engineering#192 deprecated the
MATLAB handling in 2023 because the endpoint it talked to no longer
worked.

Remove the matlab_api_key field from ProblemBlock and from the
inheritance mixin that put it on the course's Advanced Settings, the
ungraded_response ajax handler that carried MATLAB's plot output, and the
MATLAB wording on the Studio import and export pages. The cms tests that
used matlab_api_key as a sample settings field use source_code instead.

Existing <matlabinput> problems still parse: xblocks-core keeps the tag
on CodeInput so learners keep their scores.

BREAKING CHANGE: the "Matlab API key" advanced setting is gone from
courses and problems. Course exports that carry matlab_api_key still
import; the value is dropped.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
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. Nothing posts to the service any
more: xblocks-core's XQueueInterface only hands submissions to
edx-submissions (openedx/xblocks-core#338).

Remove what only existed for the service: the XQUEUE_INTERFACE setting
and its mock and test values, XQUEUE_PORT, the xqueue_callback view and
its two URL patterns, XQueueService's HTTP setup and construct_callback,
and the send_to_submission_course.enable course flag that picked between
the two backends. XQUEUE_WAITTIME_BETWEEN_REQUESTS stays: it is the wait
a learner has to observe between submissions to a queued problem.

BREAKING CHANGE: XQUEUE_INTERFACE is no longer read. The
send_to_submission_course.enable waffle flag is gone; every course's
external grader submissions now go to edx-submissions. The
/courses/<id>/xqueue/<user>/<block>/<dispatch> callback URL is gone.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

This branch has not been deployed

No deployments
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