Skip to content

fix: use COMMUNICATIONS_MICROFRONTEND_URL for bulk_email tab in instuctor dashboard v2 API (#38017)#38018

Open
brianjbuck-wgu wants to merge 2 commits intoopenedx:masterfrom
WGU-Open-edX:bugfix/38017-fix-bulk-email-tab-url-communications-mfe
Open

fix: use COMMUNICATIONS_MICROFRONTEND_URL for bulk_email tab in instuctor dashboard v2 API (#38017)#38018
brianjbuck-wgu wants to merge 2 commits intoopenedx:masterfrom
WGU-Open-edX:bugfix/38017-fix-bulk-email-tab-url-communications-mfe

Conversation

@brianjbuck-wgu
Copy link
Contributor

@brianjbuck-wgu brianjbuck-wgu commented Feb 17, 2026

Description

Fixes a bug in the v2 instructor dashboard API (/api/instructor/v2/courses/{course_id}) where the bulk_email tab URL incorrectly pointed to the Instructor MFE instead of the Communications MFE.

Before:
http://apps.local.openedx.io:8081/instructor/course-v1:OpenEdX+DemoX+DemoCourse/bulk_email

After:
http://apps.local.openedx.io:1984/communications/courses/course-v1:OpenEdX+DemoX+DemoCourse/bulk_email

Changes:

  • Updated get_tabs() in serializers_v2.py to construct the bulk_email tab URL using COMMUNICATIONS_MICROFRONTEND_URL with the /courses/ path pattern, consistent with the existing behavior in instructor_dashboard.py
  • Added COMMUNICATIONS_MICROFRONTEND_URL = None as a base default in lms/envs/common.py (previously only defined in environment-specific configs, which would cause AttributeError in test environments)

Impacts: Operators (must have COMMUNICATIONS_MICROFRONTEND_URL configured) and Course Authors/Staff using the Instructor Dashboard v2 API.

Supporting information

Fixes: #38017

Testing instructions

  1. Configure COMMUNICATIONS_MICROFRONTEND_URL in your environment (e.g., http://localhost:1984/communications)
  2. Enable bulk email for a course
  3. Call GET /api/instructor/v2/courses/{course_id} as a staff user
  4. Verify the bulk_email entry in the tabs array has a URL of the form: {COMMUNICATIONS_MICROFRONTEND_URL}/courses/{course_id}/bulk_email

Deadline

None

Other information

No migrations required. No breaking changes — this is a bug fix for a v2 URL that has not been released.

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

openedx-webhooks commented Feb 17, 2026

Thanks for the pull request, @brianjbuck-wgu!

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.

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

@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Feb 17, 2026
@mphilbrick211 mphilbrick211 added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Feb 18, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Feb 18, 2026
@diana-villalvazo-wgu
Copy link

Tested bulk email url on instructor tabs PR on my local and works as expected, thanks! 👍

@diana-villalvazo-wgu
Copy link

Pls link on PR description corresponding GH issue (:

@brianjbuck-wgu brianjbuck-wgu force-pushed the bugfix/38017-fix-bulk-email-tab-url-communications-mfe branch from 4d463c6 to fb3a78d Compare February 19, 2026 17:49
@brianjbuck-wgu brianjbuck-wgu changed the title [WIP] fix: use COMMUNICATIONS_MICROFRONTEND_URL for bulk_email tab in instuctor dashboard v2 API (#38017) fix: use COMMUNICATIONS_MICROFRONTEND_URL for bulk_email tab in instuctor dashboard v2 API (#38017) Feb 19, 2026
@brianjbuck-wgu brianjbuck-wgu marked this pull request as ready for review February 19, 2026 17:57
Copy link
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

Fixes the Instructor Dashboard v2 API bulk_email tab URL to point to the Communications MFE instead of the Instructor MFE.

Changes:

  • Build the bulk_email tab URL from COMMUNICATIONS_MICROFRONTEND_URL using a /courses/{course_key}/bulk_email path.
  • Define a default COMMUNICATIONS_MICROFRONTEND_URL = None in lms/envs/common.py to avoid missing-setting errors in some environments.
  • Add a regression test asserting the bulk_email tab URL uses the Communications MFE setting.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File Description
lms/envs/common.py Adds a base default for COMMUNICATIONS_MICROFRONTEND_URL with settings docs.
lms/djangoapps/instructor/views/serializers_v2.py Switches bulk_email tab URL construction to use COMMUNICATIONS_MICROFRONTEND_URL and /courses/ path.
lms/djangoapps/instructor/tests/test_api_v2.py Adds a test to validate bulk_email tab URL uses the communications setting.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@brianjbuck-wgu brianjbuck-wgu force-pushed the bugfix/38017-fix-bulk-email-tab-url-communications-mfe branch from fb3a78d to 0ec4ee1 Compare February 19, 2026 22:33
Copy link
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

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@brianjbuck-wgu brianjbuck-wgu force-pushed the bugfix/38017-fix-bulk-email-tab-url-communications-mfe branch from 0ec4ee1 to ac3f713 Compare February 19, 2026 22:37
@diana-villalvazo-wgu
Copy link

re tested it, bulk email url works correctly 👍

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

Labels

mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Waiting on Author

Development

Successfully merging this pull request may close these issues.

Instructor Dashboard - Bulk email tab URL uses wrong MFE host and path in instructor dashboard v2 API

4 participants

Comments