Skip to content

feat: add is_enrolled field to learners endpoint response#38405

Draft
dwong2708 wants to merge 2 commits intoopenedx:masterfrom
WGU-Open-edX:dwong2708/fix-learners-isenrolled
Draft

feat: add is_enrolled field to learners endpoint response#38405
dwong2708 wants to merge 2 commits intoopenedx:masterfrom
WGU-Open-edX:dwong2708/fix-learners-isenrolled

Conversation

@dwong2708
Copy link
Copy Markdown
Contributor

@dwong2708 dwong2708 commented Apr 21, 2026

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

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 21, 2026
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @dwong2708!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

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 approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If 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 PR

Your 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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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_enrolled to LearnerSerializer output schema.
  • Populate is_enrolled in LearnerView via CourseEnrollment.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.

Comment on lines 11 to 15
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
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

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

Copilot uses AI. Check for mistakes.
Comment on lines +66 to +68
assert response.status_code == status.HTTP_200_OK
data = response.json()
assert data['is_enrolled']
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
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

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

3 participants