fix: omit the CCX Coach student_grades tab when the writable gradebook is unavailable
维护者通常 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
-
metadataomits thestudent_gradestab whengrades.writable_gradebook
is disabled for the course, or whenWRITABLE_GRADEBOOK_URLis not
configured (honouring site configuration). -
metadataincludes the tab when both signals are present. - Remaining tabs and their
sort_ordervalues 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
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
openedx/openedx-platform 的其他 Issue
-
Discussion API: missing thread returns 500 (ForumV2RequestError not mapped to ThreadNotFoundError)可能重新可做 @mbhavu2007-lang 于 17 天前认领,目前没有进行中的 PR。 未关闭
难度 2/5 1-3 小时 新手友好度 72/100
openedx/openedx-platform#39225 · 1 条评论 ·
维护者通常 1 天内回复
-
v3 notification preferences: PUT with email_cadence but no notification_channel raises KeyError (500)可能重新可做 关联的 PR 已关闭且未合并。 未关闭bug
难度 2/5 1-3 小时 新手友好度 66/100
openedx/openedx-platform#39221 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 86/100
openedx/openedx-platform#39169 · 1 条评论 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 82/100
openedx/openedx-platform#39084 ·
维护者通常 1 天内回复
-
难度 2/5 1 小时以内 新手友好度 82/100
openedx/openedx-platform#38792 ·
维护者通常 1 天内回复
查看 openedx/openedx-platform 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 82/100
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 2 天内回复
-
audit-reference-check
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
site-bug triage
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 77/100
canonical/paas-charm#407 · 1 条评论 ·
维护者通常 5 天内回复