Skip to content

[DEPR]: MATLAB-specific handling in edx-platform #192

Open

Description

@ormsbee

Overview

Our system currently has special handling for MATLAB problems via an old integration through xqueue that isn't really supported any longer, and appears to be broken today. Since this integration should now be done via LTI, we can remove:

  • matlab_api_key attribute in ProblemBlock, as well as the version defined for inheritance purposes.
  • MatlabInput
    • Associated JavaScript, CSS, template, and text fixture code.
    • It may be that removing this would adversely affect grades, in which case it may be better to leave behind a bare shell that does nothing but acting as a dumb placeholder for legacy content scoring purposes. More investigation needed.
    • Scattered special-case hanlding for MATLAB in coderesponse and xqueue.

This would eliminate the "MATLAB API Key" advanced course setting UI in Studio:

Screenshot 2023-05-11 at 10 08 33 AM

And the equivalent one at the ProblemBlock level:

Screenshot 2023-05-11 at 10 08 04 AM

Effect on old course content:

  • Student scores must be preserved.
  • It is not necessary to be able to render the original student submission or detailed response information.

Proposal Date

10 May 2023

Target Ticket Acceptance Date

24 May 2023

Earliest Open edX Named Release Without This Functionality

Quince.

Since it is not currently in a working state, there's no need to offer an extra release for migration.

Rationale

  1. The current endpoint does not hook up to a working external service, and is not useful.
  2. LTI is already the accepted way to integrate MATLAB content.
  3. It will slightly simplify ProblemBlock and the LMS's XBlock runtime to remove this.

Activity

  1. converted this from a draft issue on May 10, 2023
  2. changed the title [-][DEPR]: Matlab API Key[/-] [+][DEPR]: Matlab-specific handling in edx-platform[/+] on May 10, 2023
  3. changed the title [-][DEPR]: Matlab-specific handling in edx-platform[/-] [+][DEPR]: MATLAB-specific handling in edx-platform[/+] on May 10, 2023
  4. ormsbee commented on May 10, 2023

    @ormsbee
    Author

    There was a slack thread about this as well.

  5. moved this from Proposed to Communicated in DEPR: Deprecation & Removalon May 10, 2023
  6. self-assigned this
    on May 10, 2023
  7. kdmccormick commented on May 11, 2023

    @kdmccormick
    Member

    Just to be clear @ormsbee , would this DEPR also cover the Matlab API Key field in the problem editor, thus clearing up 2U's T&L team to remove it from the new React-based problem editor? (cc @jristau1984)

  8. ormsbee commented on May 11, 2023

    @ormsbee
    Author

    @kdmccormick: Yes, but to be clear: I don't think that work needs to wait for this DEPR to be accepted, since it's more of a bookkeeping DEPR–i.e. I'm pretty sure that it's been broken for years, so immediately removing the view of the broken thing doesn't negatively impact users. I'm leaving it open for a couple of weeks of comment Just In Case, and if people want to add any more information.

  9. moved this from Communicated to Accepted in DEPR: Deprecation & Removalon May 24, 2023
  10. ormsbee commented on May 24, 2023

    @ormsbee
    Author
  11. moved this from Accepted to Removing in DEPR: Deprecation & Removalon Jun 1, 2023
  12. added a commit that references this issue on Sep 25, 2023
  13. 2 remaining items

  14. ormsbee commented on Jan 25, 2025

    @ormsbee
    Author

    @dianakhuang: No, its not. I removed it from the settings interface so that people wouldn't see it anymore, but I didn't remove the underlying code because a lot of capa's xqueue interface code uses MATLAB for its tests. So if I removed MATLAB, I'd have to re-implement those tests for xqueue, which didn't seem worthwhile since xqueue itself was on the chopping block. I'm now thinking that this DEPR will be executed when the xqueue code in edx-platform finally dies as part of #286

  15. moved this from Breaking Changes Unblocked to Blocked in DEPR: Deprecation & Removalon Jun 26, 2025
  16. added
    deprProposal for deprecation & removal per OEP-21
    on Jun 26, 2025
  17. dianakhuang commented on Jun 26, 2025

    @dianakhuang

    Blocked on the XQueue ticket: #286

  18. feanil commented on Sep 4, 2025

    @feanil
    Contributor

    Given that the old implementation doesn't work, this can be considered unblocked for removal. We don't need to work on it separately if the removal of all the xqueue related code is close to landing but this can be picked up for removal sooner if that's gonna be a while.

  19. moved this from Blocked to Breaking Changes Unblocked in DEPR: Deprecation & Removalon Sep 4, 2025
  20. ormsbee commented on Sep 8, 2025

    @ormsbee
    Author

    @feanil: The FC work for xqueue removal was restarted this morning, so I'd ask that this still wait behind that work.

  21. moved this from Breaking Changes Unblocked to Plan Accepted in DEPR: Deprecation & Removalon Sep 15, 2025
  22. feanil commented on Sep 15, 2025

    @feanil
    Contributor

    Ok, I'll move this back to Plan Accepted for now then since the XQueue work is still in progress.

  23. added theissue type on Jan 28, 2026
  24. dianakhuang commented on Jun 25, 2026

    @dianakhuang

    The XQueue work is actively in progress. Will move review date to match review date of XQueue.

  25. moved this from Plan Accepted to Breaking Changes Unblocked in DEPR: Deprecation & Removalon Nov 12, 2026
  26. self-assigned this
    on Nov 12, 2026
  27. kdmccormick commented on Nov 12, 2026

    @kdmccormick
    Member

    This is safe to be removed at any time, but it's less work to remove it after XQueue compatibility is removed. So, we're marking this as blocked on #286

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

Metadata

Metadata

Assignees

Labels

deprProposal for deprecation & removal per OEP-21

Type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions