Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
ormsbee opened this issue May 10, 2023 · 6 comments
Open

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

ormsbee opened this issue May 10, 2023 · 6 comments
Assignees

Comments

@ormsbee
Copy link

ormsbee commented May 10, 2023

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.
@ormsbee ormsbee converted this from a draft issue May 10, 2023
@ormsbee ormsbee changed the title [DEPR]: Matlab API Key [DEPR]: Matlab-specific handling in edx-platform May 10, 2023
@ormsbee ormsbee changed the title [DEPR]: Matlab-specific handling in edx-platform [DEPR]: MATLAB-specific handling in edx-platform May 10, 2023
@ormsbee
Copy link
Author

ormsbee commented May 10, 2023

There was a slack thread about this as well.

@ormsbee ormsbee moved this from Proposed to Communicated in DEPR: Deprecation & Removal May 10, 2023
@ormsbee ormsbee self-assigned this May 10, 2023
@kdmccormick
Copy link
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)

@ormsbee
Copy link
Author

ormsbee commented May 11, 2023

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

@ormsbee ormsbee moved this from Communicated to Accepted in DEPR: Deprecation & Removal May 24, 2023
@ormsbee
Copy link
Author

ormsbee commented May 24, 2023

@ormsbee ormsbee moved this from Accepted to Removing in DEPR: Deprecation & Removal Jun 1, 2023
ormsbee added a commit to ormsbee/edx-platform that referenced this issue Sep 25, 2023
MATLAB support was baked into the ProblemBlock with its own input type.
The MathWorks-provided backend that this input type interacts with is no
longer supported, and course teams have long-since moved on to the
recommended LTI interface instead.

This removes all MATLAB-specific code in edx-platform. See DEPR openedx#192 for
more details:

  openedx/public-engineering#192
ormsbee added a commit to ormsbee/edx-platform that referenced this issue Oct 5, 2023
The Matlab-specific code is coupled with XQueue in places, making its
removal a little tricky. But we at least want to hide this now-useless
field from end-users before we cut the Quince release.

openedx/public-engineering#192
ormsbee added a commit to openedx/edx-platform that referenced this issue Oct 5, 2023
The Matlab-specific code is coupled with XQueue in places, making its
removal a little tricky. But we at least want to hide this now-useless
field from end-users before we cut the Quince release.

openedx/public-engineering#192
@dianakhuang
Copy link

@ormsbee is this DEPR complete now?

@ormsbee
Copy link
Author

ormsbee commented Jan 25, 2025

@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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Removal Pending
Development

No branches or pull requests

3 participants