Skip to content

chore: move the program dashboard APIs#36420

Merged
deborahgu merged 4 commits intomasterfrom
dkaplan1/APER-3949_move-currently-and-future-useful-code-from-deprecated-learner_dashboard-to-current-programs-djangoapp
Mar 24, 2025
Merged

chore: move the program dashboard APIs#36420
deborahgu merged 4 commits intomasterfrom
dkaplan1/APER-3949_move-currently-and-future-useful-code-from-deprecated-learner_dashboard-to-current-programs-djangoapp

Conversation

@deborahgu
Copy link
Copy Markdown
Member

Description

Moves the Program Dashboard APIs out of the deprecated remnants of the legacy learner dashboard, into the Programs djangoapp.

Keeps the old legacy routes for this API, left over from the deprecated remnants of the legacy learner dashboard, alongside future-proofed routes which will work when the deprecated, legacy Program Dashboard is replaced with functionality in the Learner Dashboard MFE.

FIXES: APER-3949

Moves the Program Dashboard APIs out of the deprecated remnants of the
legacy learner dashboard, into the Programs djangoapp.

Keeps the old legacy routes for this API, left over from the deprecated
remnants of the legacy learner dashboard, alongside future-proofed
routes which will work when the deprecated, legacy Program Dashboard is
replaced with functionality in the Learner Dashboard MFE.

FIXES: APER-3949
@deborahgu deborahgu requested a review from a team as a code owner March 20, 2025 21:02
…re-useful-code-from-deprecated-learner_dashboard-to-current-programs-djangoapp
removing left over duplicate test
fixing the tests so that they will load on CMS but also don't run there.
Comment thread cms/envs/common.py
'openedx.core.djangoapps.content.search',

# For Programs API
'lms.djangoapps.program_enrollments',
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I feel like I'm missing something here -- why is this change needed?

I don't see anything in this PR that affects the program_enrollments app.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

because even having marked all of the tests as lms_only, running the CMS test suite as the CI matrix does ( eg. python -Wd -m pytest -p no:randomly --ds=cms.envs.test openedx/core/djangoapps/programs) failed, kvetching about test_views import from program_enrollments (from lms.djangoapps.program_enrollments.tests.factories import ProgramEnrollmentFactory). I believe this happened because I moved to these tests from the LMS to OpenEdx core, so the imports weren't all already there.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ah, thanks for the explanation. That makes more sense!


import logging

from enterprise.models import EnterpriseCourseEnrollment
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I know we're mostly just moving code around to help support a pending DEPR. It would be nice if we're touching some of these files to remove the direct imports of models from other Django apps.

If we don't fix this here and now, can we at least get a ticket in the backlog to remove the direct import and use of the EnterpriseCourseEnrollment and CourseEnrollment models in this file?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I'm working on cleanup tickets now, and that would be a great cleanup ticket, so I will go ahead and create that right away. Nice catch.

Copy link
Copy Markdown
Contributor

@justinhynes justinhynes left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@deborahgu deborahgu merged commit 3136134 into master Mar 24, 2025
49 checks passed
@deborahgu deborahgu deleted the dkaplan1/APER-3949_move-currently-and-future-useful-code-from-deprecated-learner_dashboard-to-current-programs-djangoapp branch March 24, 2025 16:06
@edx-pipeline-bot
Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

@edx-pipeline-bot
Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

leoaulasneo98 pushed a commit to aulasneo/edx-platform that referenced this pull request Mar 26, 2025
Moves the Program Dashboard APIs out of the deprecated remnants of the legacy learner dashboard, into the Programs djangoapp.

Keeps the old legacy routes for this API, left over from the deprecated remnants of the legacy learner dashboard, alongside future-proofed routes which will work when the deprecated, legacy Program Dashboard is eventually replaced with functionality in the Learner Dashboard MFE.

FIXES: APER-3949
tonybusa pushed a commit to tonybusa/edx-platform that referenced this pull request Apr 23, 2025
Moves the Program Dashboard APIs out of the deprecated remnants of the legacy learner dashboard, into the Programs djangoapp.

Keeps the old legacy routes for this API, left over from the deprecated remnants of the legacy learner dashboard, alongside future-proofed routes which will work when the deprecated, legacy Program Dashboard is eventually replaced with functionality in the Learner Dashboard MFE.

FIXES: APER-3949
UsamaSadiq pushed a commit that referenced this pull request May 14, 2025
Moves the Program Dashboard APIs out of the deprecated remnants of the legacy learner dashboard, into the Programs djangoapp.

Keeps the old legacy routes for this API, left over from the deprecated remnants of the legacy learner dashboard, alongside future-proofed routes which will work when the deprecated, legacy Program Dashboard is eventually replaced with functionality in the Learner Dashboard MFE.

FIXES: APER-3949
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.

3 participants