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

オープン
#348 コメント 0 件 リアクション 0 件 担当者 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時間
マージ済み PR(30日)
4

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

openedx/frontend-base のほかの issue

openedx/frontend-base の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。