refactor: use frontend-base helpButtonSlotOperation for the help link#840
Merged
brian-smith-tcril merged 1 commit intoApr 29, 2026
Merged
Conversation
brian-smith-tcril
force-pushed
the
help-button
branch
from
01669e9 to
9355324
Compare
Replaces the per-app SupportLinkMenuItem widget with the centralized helper from frontend-base. The shared HelpButton component lives in frontend-base now (see openedx/frontend-base#245), and apps register it with one helper call. Also drops SUPPORT_URL: '' from app.ts. lodash.merge in getAppConfig treats the empty string as a real value that shadows commonAppConfig.SUPPORT_URL, breaking the documented precedence fallback chain. With the field absent, runtime config still flows in via mergeAppConfig, and commonAppConfig flows through getAppConfig's merge when no per-app override is set. The unused help message and SupportLinkMenuItem component are removed. Refs openedx/frontend-base#245 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
brian-smith-tcril
force-pushed
the
help-button
branch
from
9355324 to
38e9211
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## frontend-base #840 +/- ##
================================================
Coverage ? 91.00%
================================================
Files ? 151
Lines ? 1279
Branches ? 270
================================================
Hits ? 1164
Misses ? 110
Partials ? 5 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
🎉 This PR is included in version 1.0.0-alpha.16 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Companion PR to openedx/frontend-base#251. Switches learner-dashboard's existing per-app
SupportLinkMenuItemwidget to the new sharedhelpButtonSlotOperationhelper. Functionally equivalent — same Help link, same SUPPORT_URL semantics, same desktop-only scope.Also drops
SUPPORT_URL: ''fromsrc/app.ts. lodash.merge ingetAppConfigtreats''as a real value that shadowscommonAppConfig.SUPPORT_URL, breaking the documented precedence fallback. Removing it lets commonAppConfig flow through naturally when no per-app override is set; runtime config still flows in viamergeAppConfigwhen present. (Other empty-string keys in that block —ECOMMERCE_BASE_URL,ORDER_HISTORY_URL— likely have the same latent issue but are out of scope here.)The previously per-app
SupportLinkMenuItem.jsxand thehelpmessage are deleted; the rendering now lives in frontend-base.This PR targets the
frontend-basebranch (the in-progress frontend-base migration branch). It depends on openedx/frontend-base#251 — do not merge before that.Test plan
nvm use && npm run test— full suite green (existing header tests still pass; SupportLinkMenuItem tests removed)commonAppConfig.SUPPORT_URLand verify Help renders on a learner-dashboard route, links to the URL🤖 Generated with Claude Code