feat: add is_enrolled field to learners endpoint response#38405
feat: add is_enrolled field to learners endpoint response#38405dwong2708 wants to merge 2 commits intoopenedx:masterfrom
Conversation
|
Thanks for the pull request, @dwong2708! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. 🔘 Update the status of your PRYour PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate. Where can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
There was a problem hiding this comment.
Pull request overview
This PR extends the Instructor API v2 learner detail endpoint to include a learner’s current enrollment status (is_enrolled) and adds/updates tests to validate the new response field.
Changes:
- Add
is_enrolledtoLearnerSerializeroutput schema. - Populate
is_enrolledinLearnerViewviaCourseEnrollment.is_enrolled(...). - Extend learner detail endpoint tests to cover enrolled vs non-enrolled scenarios.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
lms/djangoapps/instructor/views/serializers_v2.py |
Adds is_enrolled boolean field to the learner response serializer. |
lms/djangoapps/instructor/views/api_v2.py |
Includes is_enrolled in the learner detail response and updates the documented example JSON. |
lms/djangoapps/instructor/tests/views/test_api_v2.py |
Adds assertions and a new test case to verify is_enrolled behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| from common.djangoapps.student.tests.factories import InstructorFactory, UserFactory | ||
| from lms.djangoapps.courseware.models import StudentModule | ||
| from lms.djangoapps.instructor_task.models import InstructorTask | ||
| from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase | ||
| from xmodule.modulestore.tests.django_utils import CourseEnrollment, ModuleStoreTestCase | ||
| from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory |
There was a problem hiding this comment.
The test imports CourseEnrollment from xmodule.modulestore.tests.django_utils, which is a modulestore test helper module. To keep dependencies clear and consistent with other instructor tests in this repo, import CourseEnrollment directly from the student models module instead (e.g., the same import path used in lms/djangoapps/instructor/tests/test_api_v2.py).
| assert response.status_code == status.HTTP_200_OK | ||
| data = response.json() | ||
| assert data['is_enrolled'] |
There was a problem hiding this comment.
This file’s tests primarily use unittest.TestCase assertions (e.g., self.assertEqual, self.assertFalse), but this new test uses bare assert statements. Please switch these to the existing assertion style for consistency and clearer failure messages.
| assert response.status_code == status.HTTP_200_OK | |
| data = response.json() | |
| assert data['is_enrolled'] | |
| self.assertEqual(response.status_code, status.HTTP_200_OK) # noqa: PT009 | |
| data = response.json() | |
| self.assertTrue(data['is_enrolled']) # noqa: PT009 |
Description
This PR adds a new is_enrolled field to the learners endpoint and integrates it into the Instructor Dashboard UI.
The goal is to expose enrollment status directly in the learners data, enabling the frontend to display or act on whether a learner is currently enrolled in a course without requiring additional API calls.
Related Issue
openedx/frontend-app-instructor-dashboard#164
Changes:
Add is_enrolled field to learners endpoint response
Update frontend data handling to include the new field
Ensure compatibility with existing learners view/components
Notes
This change is backward compatible (adds a new field without modifying existing ones)
No impact expected on existing functionality
Deadline
Verawood