feat: add instructor dashboard MFE support for canvas and rapid response reports plugins by Anas12091101 · Pull Request #819 · mitodl/open-edx-plugins

Anas12091101 · 2026-06-19T12:12:36Z

What are the relevant tickets?

https://github.com/mitodl/hq/issues/11581

Description (What does it do?)

Adds instructor-dashboard MFE (OEP-65 / frontend-base) support to the
ol_openedx_canvas_integration and ol_openedx_rapid_response_reports plugins.

Historically these plugins integrated with the legacy (Django-rendered)
instructor dashboard via PluginContexts (context_api.plugin_context), which
injected tab sections and their data server-side. The new frontend-base
instructor dashboard MFE has no such context, so this PR makes each plugin
expose its tab and data through the supported extension points the MFE consumes:

Tab registration via the InstructorDashboardTabsRequested Open edX Filter
(org.openedx.learning.instructor.dashboard.tabs.requested.v1).
Data via small JSON API endpoints the MFE fetches.

The result is self-contained in the plugins — no edx-platform cherry-pick is
required for the MFE (the cherry-pick remains only for the legacy dashboard).

How tab visibility works

Plugin	Tab shown when…
Canvas	the course has `canvas_id` set in Advanced Settings (per-course)
Rapid Responses	the plugin is installed on the deployment

Testing

Install both plugins in an LMS running the frontend-base instructor dashboard MFE.
Confirm OPEN_EDX_FILTERS_CONFIG contains both pipeline steps under
org.openedx.learning.instructor.dashboard.tabs.requested.v1.
Canvas: set {"canvas_id": <id>} in a course's Advanced Settings → the
Canvas tab appears for that course only. GET .../canvas/api/list_canvas_tasks
returns {"tasks": [...]}.
Rapid Responses: the Rapid Responses tab appears on any course;
GET .../instructor/api/rapid_response_runs returns the run list.
Follow the testing instructions in feat: add instructor dashboard overrides to replicate canvas and rapid-response-report plugins behaviour in MFE lehrer#58 to spin up the instructor dashboard MFE.
Confirm tabs do not appear where they shouldn't (Canvas without canvas_id;
either tab on a deployment without the plugin).
Test the functionality of both plugins

Backward compatibility

Legacy instructor dashboard behavior is unchanged (the PluginContexts
integration remains).
New filter registrations merge into existing OPEN_EDX_FILTERS_CONFIG.
No edx-platform changes required for the MFE path.

Screenshots (if appropriate):

Screen.Recording.2026-06-19.at.8.41.00.PM.mov

…nse reports plugins

…oard-mfe-apis

The frontend-base site projects mount the instructor dashboard routes under /apps (wrapWithAppsPath), so the LMS-provided tab hrefs must be /apps/instructor-dashboard/<course>/<tab> to resolve. Update both tab filters and their tests accordingly. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

@patch

The view lazily imports get_run_data_for_course from rapid_response_xblock, which is a separate, undeclared plugin. CI installs plugins alphabetically and cumulatively, so ol_openedx_rapid_response_reports tests run before rapid_response_xblock is installed, making @patch("rapid_response_xblock.utils...") fail to import its target. Inject a stub module via sys.modules so the tests are deterministic regardless of whether the xblock is installed. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Copilot

Pull request overview

This PR adds frontend-base instructor dashboard MFE support for the Canvas integration and Rapid Response Reports plugins by registering instructor-dashboard tabs via the InstructorDashboardTabsRequested Open edX Filter and exposing plugin data via lightweight JSON endpoints (while keeping legacy dashboard integration intact).

Changes:

Added Open edX Filters pipeline steps to register MFE instructor dashboard tabs for Canvas (course-gated by canvas_id) and Rapid Responses (deployment-gated by plugin install).
Added JSON API endpoints consumed by the MFE (list_canvas_tasks, rapid_response_runs) plus associated tests.
Updated plugin docs/changelogs and bumped plugin versions.

Reviewed changes

Copilot reviewed 18 out of 19 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/ol_openedx_rapid_response_reports/tests/test_pipeline.py	New tests for Rapid Responses tab registration pipeline step.
src/ol_openedx_rapid_response_reports/tests/test_api.py	New tests for the Rapid Responses JSON endpoint behavior and permissions.
src/ol_openedx_rapid_response_reports/tests/init.py	Test package init (added/updated).
src/ol_openedx_rapid_response_reports/pyproject.toml	Version bump and pytest configuration for plugin tests.
src/ol_openedx_rapid_response_reports/ol_openedx_rapid_response_reports/urls.py	Exposes `rapid_response_runs` endpoint under the plugin URL mount.
src/ol_openedx_rapid_response_reports/ol_openedx_rapid_response_reports/settings/common.py	Registers the instructor-dashboard tabs filter pipeline step in `OPEN_EDX_FILTERS_CONFIG`.
src/ol_openedx_rapid_response_reports/ol_openedx_rapid_response_reports/pipeline.py	Adds the Rapid Responses instructor dashboard tab pipeline step.
src/ol_openedx_rapid_response_reports/ol_openedx_rapid_response_reports/app.py	Wires COMMON settings so filter registration happens when installed.
src/ol_openedx_rapid_response_reports/ol_openedx_rapid_response_reports/api.py	Adds `list_rapid_response_runs` JSON endpoint.
src/ol_openedx_rapid_response_reports/CHANGELOG.rst	Documents the new MFE support and endpoint in the release notes.
src/ol_openedx_canvas_integration/tests/test_views.py	New tests for the Canvas `list_canvas_tasks` JSON endpoint.
src/ol_openedx_canvas_integration/tests/test_pipeline.py	New tests for Canvas tab registration pipeline step, including failure swallowing.
src/ol_openedx_canvas_integration/README.rst	Clarifies cherry-pick requirement applies only to the legacy instructor dashboard.
src/ol_openedx_canvas_integration/pyproject.toml	Version bump for the Canvas plugin.
src/ol_openedx_canvas_integration/ol_openedx_canvas_integration/views.py	Adds `list_canvas_tasks` endpoint for MFE task-status polling.
src/ol_openedx_canvas_integration/ol_openedx_canvas_integration/urls.py	Routes `list_canvas_tasks`.
src/ol_openedx_canvas_integration/ol_openedx_canvas_integration/settings/lms/common.py	Registers the Canvas tab pipeline step in `OPEN_EDX_FILTERS_CONFIG`.
src/ol_openedx_canvas_integration/ol_openedx_canvas_integration/pipeline.py	Adds the Canvas instructor dashboard tab pipeline step (course-gated).
src/ol_openedx_canvas_integration/CHANGELOG.rst	Documents the new MFE support and endpoint in the release notes.

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

+import logging
+
+from django.utils.translation import gettext as _
+from openedx_filters import PipelineStep
+
+log = logging.getLogger(__name__)


Anas12091101 · 2026-06-22T17:05:31Z

+    for task in tasks_qs:
+        feature = extract_task_features(task)
+        # Override the message for Canvas task types with the plugin's formatter
+        # so the result reads e.g. "N grades and M assignments updated or created".
+        if task.task_type in CANVAS_TASK_TYPES and task.task_output:
+            try:


The endpoint does filter to Canvas task types. It calls get_filtered_instructor_tasks (task_helpers.py), whose history query is constrained by task_type__in=CANVAS_TASK_TYPES; the Canvas-specific message override is also gated by CANVAS_TASK_TYPES. The only un-typed rows come from the union with the platforms get_running_instructor_tasks, which is intentional — it mirrors the legacy Canvas "Pending Tasks" view that surfaces any currently-running task. This helper is pre-existing (added in #387) and reused as-is here. If we want strictly Canvas-typed rows even for the running set, I can add a final task_type in CANVAS_TASK_TYPES` filter — happy to do that if you prefer.

asadali145

This is just the code review. Overall looks good. I just have a few minor suggestions.

asadali145 · 2026-06-22T11:49:23Z

+                "Failed to evaluate Canvas instructor tab for course %s", course_key
+            )
+
+        return {"tabs": tabs}


We should return all args received in run_filter as a dict at the end, so that if there is any other pipeline step, it gets all the args.

asadali145 · 2026-06-22T11:49:49Z

+    """
+
+    def run_filter(self, tabs, course_key, **kwargs):  # noqa: ARG002
+        try:


Can we remove this broad try-except to be specific if we need it?

asadali145 · 2026-06-22T11:55:59Z

+                            "tab_id": CANVAS_TAB_ID,
+                            "title": _("Canvas"),
+                            "url": (
+                                f"/apps/instructor-dashboard/{course_key}/{CANVAS_TAB_ID}"


Can we use settings INSTRUCTOR_MICROFRONTEND_URL?

asadali145 · 2026-06-22T11:56:50Z

+                            "url": (
+                                f"/apps/instructor-dashboard/{course_key}/{CANVAS_TAB_ID}"
+                            ),
+                            "sort_order": CANVAS_TAB_SORT_ORDER,


If the idea is to display this at the end of the list, maybe we should generate this using existing sort_orders?

asadali145 · 2026-06-22T12:05:33Z

+CANVAS_TAB_ID = "canvas_integration"
+CANVAS_TAB_SORT_ORDER = 110


Can we move these to constants?

asadali145 · 2026-06-22T12:14:39Z

+    course_id,
+):
+    """Return JSON list of rapid response runs for the given course."""
+    from rapid_response_xblock.utils import get_run_data_for_course  # noqa: PLC0415


This is a general comment. I don't see rapid_response_xblock as a dependency in pyproject.toml.

asadali145 · 2026-06-22T12:14:56Z

+RAPID_RESPONSE_TAB_ID = "rapid_response"
+RAPID_RESPONSE_TAB_SORT_ORDER = 120


Please move these to constants.

asadali145 · 2026-06-22T12:16:31Z

+            tabs.append(
+                {
+                    "tab_id": RAPID_RESPONSE_TAB_ID,
+                    "title": _("Rapid Responses"),


Same, move this to constants.

asadali145 · 2026-06-22T12:16:42Z

+                    "tab_id": RAPID_RESPONSE_TAB_ID,
+                    "title": _("Rapid Responses"),
+                    "url": (
+                        f"/apps/instructor-dashboard/{course_key}/{RAPID_RESPONSE_TAB_ID}"


Use the setting.

asadali145 · 2026-06-22T12:17:25Z

@@ -0,0 +1,103 @@
+"""Tests for the rapid response reports MFE endpoint."""


Suggested change

"""Tests for the rapid response reports MFE endpoint."""

"""Tests for the rapid response reports API"""

sentry · 2026-06-23T07:55:41Z

+        # so the result reads e.g. "N grades and M assignments updated or created".
+        if task.task_type in CANVAS_TASK_TYPES and task.task_output:
+            try:
+                feature["task_message"] = get_task_output_formatted_message(


Bug: The list_canvas_tasks API endpoint incorrectly includes all running instructor tasks for a course, leaking task information between instructors.
_{Severity: MEDIUM}

Suggested Fix

Modify get_running_instructor_tasks or its usage within get_filtered_instructor_tasks to filter the running tasks by the current user (request.user). This will ensure the API only returns tasks initiated by the user making the request.

Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: src/ol_openedx_canvas_integration/ol_openedx_canvas_integration/views.py#L213 Potential issue: The `list_canvas_tasks` API endpoint leaks information about tasks run by other instructors. The view calls `get_filtered_instructor_tasks`, which combines two querysets. One is correctly filtered by the current user. The other, from `get_running_instructor_tasks`, includes all running instructor tasks for the course, regardless of which user initiated them. As a result, an instructor calling this API may see details of tasks run by other instructors in the same course, including tasks unrelated to Canvas.

asadali145 · 2026-06-24T09:34:22Z

+    full page reload.
+    """
+
+    def run_filter(self, tabs, course_key, **kwargs):


Can we use the original signature here? I am not sure how it is working as the 2nd arg is user in the original definition.

Suggested change

def run_filter(self, tabs, course_key, **kwargs):

def run_filter(self, tabs, user, course_key):

asadali145 · 2026-06-24T09:34:39Z

+                )
+
+        # Return every argument so any subsequent pipeline step gets the full set.
+        return {"tabs": tabs, "course_key": course_key, **kwargs}


This will change with the definition.

asadali145 · 2026-06-24T09:35:55Z

+    (``createInstructorDashboardCustomApp`` in the shared MFE module).
+    """
+
+    def run_filter(self, tabs, course_key, **kwargs):


Same comments as in canvas plugin.

asadali145

LGTM!

…oard-mfe-apis # Conflicts: # uv.lock

Anas12091101 added 6 commits June 17, 2026 16:32

WIP: Instructor dashbaord MFE APIs

6ea4428

feat: add instructor dashboard MFE support for canvas and rapid respo…

58668c0

…nse reports plugins

fix: uncomment commented code

dc5d108

Merge remote-tracking branch 'origin/main' into anas/instructor-dashb…

43edcae

…oard-mfe-apis

test: add tests

c2c5a2d

fix: issues

340c7ec

Anas12091101 force-pushed the anas/instructor-dashboard-mfe-apis branch from a0fc075 to 340c7ec Compare June 19, 2026 13:50

Anas12091101 and others added 4 commits June 19, 2026 20:56

chore: bump version

be98c78

fix: pre-commit

79a696a

Anas12091101 force-pushed the anas/instructor-dashboard-mfe-apis branch from 280e680 to 79a696a Compare June 19, 2026 17:02

Anas12091101 changed the title ~~Anas/instructor dashboard mfe apis~~ feat: add instructor dashboard MFE support for canvas and rapid response reports plugins Jun 19, 2026

docs: update changlog

b054cb4

Anas12091101 requested a review from asadali145 June 22, 2026 09:34

Anas12091101 added the Needs Review label Jun 22, 2026

asadali145 requested a review from Copilot June 22, 2026 10:12

asadali145 self-assigned this Jun 22, 2026

Copilot started reviewing on behalf of asadali145 June 22, 2026 10:13 View session

Copilot AI reviewed Jun 22, 2026

View reviewed changes

asadali145 requested changes Jun 22, 2026

View reviewed changes

asadali145 added Waiting on Author and removed Needs Review labels Jun 22, 2026

fix: issues

de501e3

sentry Bot reviewed Jun 23, 2026

View reviewed changes

Comment thread src/ol_openedx_rapid_response_reports/ol_openedx_rapid_response_reports/api.py

fix: pre-commits issues

7fcd4cf

sentry Bot reviewed Jun 23, 2026

View reviewed changes

fix: CI

3b1e253

sentry Bot reviewed Jun 23, 2026

View reviewed changes

Comment thread src/ol_openedx_canvas_integration/ol_openedx_canvas_integration/pipeline.py

fix: tests

0c96c64

Anas12091101 added Needs Review and removed Waiting on Author labels Jun 23, 2026

asadali145 reviewed Jun 24, 2026

View reviewed changes

fix: issue

a3dcd8b

Anas12091101 requested a review from asadali145 June 24, 2026 15:12

asadali145 approved these changes Jun 29, 2026

View reviewed changes

asadali145 added Waiting on Author and removed Needs Review labels Jun 29, 2026

Merge remote-tracking branch 'origin/main' into anas/instructor-dashb…

5050095

…oard-mfe-apis # Conflicts: # uv.lock

Anas12091101 merged commit c8aace4 into main Jul 1, 2026
9 checks passed

Anas12091101 deleted the anas/instructor-dashboard-mfe-apis branch July 1, 2026 07:06

		CANVAS_TAB_ID = "canvas_integration"
		CANVAS_TAB_SORT_ORDER = 110

		RAPID_RESPONSE_TAB_ID = "rapid_response"
		RAPID_RESPONSE_TAB_SORT_ORDER = 120

		@@ -0,0 +1,103 @@
		"""Tests for the rapid response reports MFE endpoint."""

	def run_filter(self, tabs, course_key, **kwargs):
	def run_filter(self, tabs, user, course_key):

Uh oh!

Conversation

Anas12091101 commented Jun 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What are the relevant tickets?

Description (What does it do?)

How tab visibility works

Testing

Backward compatibility

Screenshots (if appropriate):

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

asadali145 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sentry Bot Jun 23, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

asadali145 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Anas12091101 commented Jun 19, 2026 •

edited

Loading