fix: omit the CCX Coach student_grades tab when the writable gradebook is unavailable

未关闭
#39,148 0 条评论 0 个 reaction 已指派 1 人 在 GitHub 查看

维护者通常 1 天内回复

@brianjbuck-wgu 已经在做这个了。

开始于 2026年9月24日。

评估

这个 Issue 还没有评估数据。

描述

Description

The CCX Coach v2 metadata endpoint always advertises the student_grades tab,
regardless of whether the gradebook is actually available. In
lms/djangoapps/ccx/api/v2/serializers.py the tab list is a static tuple:

CCX_COACH_TABS = (
    ('enrollments', _('Enrollment'), 10),
    ('schedule', _('Schedule'), 20),
    ('student_grades', _('Student Grades'), 30),
    ('grading_policy', _('Grading Policy'), 40),
)

The Student Grades experience depends on the writable gradebook, which is gated
by the grades.writable_gradebook waffle flag and the
WRITABLE_GRADEBOOK_URL setting. When either is missing, the MFE still renders a
Student Grades tab that cannot work, so coaches get a dead tab.

The backend can detect this, and there is already a precedent for exactly this
check.

Prior art

lms/djangoapps/instructor/views/serializers_v2.py::get_gradebook_url (~line 480)
returns None — i.e. omits the link — when either signal is unavailable:

mfe_base_url = configuration_helpers.get_value(
    'WRITABLE_GRADEBOOK_URL',
    getattr(settings, 'WRITABLE_GRADEBOOK_URL', None)
)
if not is_writable_gradebook_enabled(course_key) or not mfe_base_url:
    return None
return f'{mfe_base_url.rstrip("/")}/{course_key}'

Note configuration_helpers.get_value consults site configuration first and
falls back to the Django setting, so this honours per-site config.

is_writable_gradebook_enabled comes from lms.djangoapps.grades.api and wraps
the grades.writable_gradebook CourseWaffleFlag.

Proposed change

Build the CCX Coach tab list dynamically and omit student_grades when the
gradebook is unavailable, reusing the same two signals as the instructor
dashboard. Remaining tabs keep their existing sort_order values (10/20/40), so
gaps are expected and harmless — the MFE sorts by sort_order.

Open question: which course key to check

grades.writable_gradebook is a CourseWaffleFlag, and a course-scoped override
on the master course does not apply to the CCX key. Verified locally:

flag master=True  ccx=False

Recommendation: check the CCX key (ccx-v1:...), because that is the key the
gradebook endpoints are actually called with. The tab's presence then predicts
whether the endpoint will work, instead of advertising a tab that 403s. This does
mean operators must enable the flag for the CCX key (or globally / via site
config) — worth calling out in the rollout notes.

Dependency

Even with the flag and URL configured, the gradebook REST endpoints currently
reject CCX ids; that is being fixed in #39145 ("change in endpoint to support CCX
id"). This ticket is about advertising the tab correctly and can land
independently, but the tab is only genuinely usable once #39145 merges.

Acceptance criteria

  • metadata omits the student_grades tab when grades.writable_gradebook
    is disabled for the course, or when WRITABLE_GRADEBOOK_URL is not
    configured (honouring site configuration).
  • metadata includes the tab when both signals are present.
  • Remaining tabs and their sort_order values are unchanged.
  • Decide and document which course key the flag is evaluated against.
  • Tests cover: flag on + URL set (tab present), flag off (tab absent), URL
    unset (tab absent).

Supporting information

  • Epic: #38982 (CCX Coach Conversion to MFE)
  • Introduced the tab list: #39031
  • Gradebook CCX id support: #39145
  • Related: #39135 (ADR 0038 URL conformance), #39142 (CCX Coach MFE routing flag)
  • Code: lms/djangoapps/ccx/api/v2/serializers.py,
    lms/djangoapps/grades/config/waffle.py,
    lms/djangoapps/instructor/views/serializers_v2.py
主要语言
Python
星标
8.2k
派生
4.4k
平均合并
2 天 10 小时
30 天内合并 PR
40

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

openedx/openedx-platform 的其他 Issue

查看 openedx/openedx-platform 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。