A site cannot override an installed app's route for a role with an external route

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

@arbrandes 已经在做这个了。

开始于 2026年11月16日。

  • #352 来自 @arbrandes —— 未关闭

评估

难度
4/5
预计耗时
3-5 天
新手友好度
45/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
typescript
领域
frontend

调研方向

Start with runtime/routing/utils.ts, especially getUrlByRouteRole, and trace how resolveRouteByRole and getLinkProps use it. The issue describes precedence between app routes and externalRoutes but leaves the override behavior and duplicate-role reporting as design questions. Done means the issue's intended precedence is decided and role resolution follows it; the payload names no tests to run.

由索引模型根据 Issue 内容生成。

描述

An app that declares a route for a role always wins over the site's externalRoutes for that role, so a site cannot send a role an installed app declares to a destination of its own. Found while planning to move Learning's tab links onto route roles (openedx/frontend-app-learning#2190, part of #1905): once it does, an operator who wants Learning's dates or outline link to go somewhere else has no way to say so.

[!NOTE]
The details below were generated by Claude (Claude Code) and reviewed before posting.

Claude Plan

How a role resolves today

  • getUrlByRouteRole walks siteConfig.apps in list order and each app's route tree depth-first, and returns the first route whose handle.roles includes the role. Only when no app declares the role does it read siteConfig.externalRoutes, again first match. There is no check for a second match and no warning, so when two apps declare the same role the one listed first in apps wins silently, and an external route for a role any app declares is never consulted.
  • resolveRouteByRole and getLinkProps build on it, so every link resolved through a role follows the same order.
  • ExternalRoute is a role and a URL; nothing on it or on the site config says it should take precedence.

What the docs say

  • The migration guide's URL Config changes: URLs "should now be expressed as part of the apps config as route roles, or as externalRoutes, and resolved in code via resolveRouteByRole()". It names both sources and does not say what happens when both declare a role.

Where it bites

  • Learning declares org.openedx.frontend.role.courseDates, courseOutline and courseProgress on its routes, which it must for the shell's course bar. Its progress tab is to link to the dates and outline tabs through those roles (openedx/frontend-app-learning#2190). A site that then wants one of those links to go elsewhere cannot express that in site config: an external route for the role is never reached while Learning is installed.
  • The same holds for any app that declares a role for a page it serves and any site that wants to point that role elsewhere.

Questions

  • Should a site be able to override an installed app's route for a role with a destination of its own, without uninstalling the app?
  • If so, how does the site say so?
  • Should the resolver report when two sources declare the same role?
主要语言
TypeScript
星标
4
派生
13
平均合并
3 天 5 小时
30 天内合并 PR
4

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

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

openedx/frontend-base 的其他 Issue

查看 openedx/frontend-base 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

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