Skip to content

fix(teak): backport sidebar/navigation/breadcrumbs plugin slot changes#1916

Draft
bra-i-am wants to merge 2 commits into
openedx:release/teakfrom
eduNEXT:bc/backport-sequence-navigation-slot
Draft

fix(teak): backport sidebar/navigation/breadcrumbs plugin slot changes#1916
bra-i-am wants to merge 2 commits into
openedx:release/teakfrom
eduNEXT:bc/backport-sequence-navigation-slot

Conversation

@bra-i-am
Copy link
Copy Markdown

@bra-i-am bra-i-am commented May 26, 2026

Backports two upstream PRs onto the Teak branch to allow the course outline sidebar, sequence navigation, and breadcrumbs to be rendered simultaneously.

Changes included:

  • #1716 — migrates sequence navigation into SequenceNavigationSlot
  • #1713 — removes the courseware.enable_navigation_sidebar and courseware.always_open_auxiliary_sidebar waffle flags; sidebar is now always visible

Context

On Teak, the course outline sidebar and breadcrumbs/sequence navigation are mutually exclusive by design — the courseware.enable_navigation_sidebar waffle flag forces operators to choose one or the other. This makes it impossible to show all three elements simultaneously, which is a possible need for deployments that want to provide full course navigation context to learners without sacrificing the outline sidebar.


⚠️ Known risk

PR #1713 (upstream) also strips the default content from both plugin slots, meaning SequenceNavigationSlot and CourseBreadcrumbsSlot render nothing unless a plugin explicitly injects components into them via env.config.jsx. This creates a regression for any Teak deployment that currently has courseware.enable_navigation_sidebar = false (sidebar off, breadcrumbs and sequence navigation visible): after this backport, the sidebar will be forced on and breadcrumbs/navigation will silently disappear.

Proposed solution (not yet applied)

Restore the default children in both slot components so breadcrumbs and sequence navigation render out-of-the-box without any plugin configuration, matching the behavior operators already rely on:

  • CourseBreadcrumbsSlot — restore <CourseBreadcrumbs> as default child
  • SequenceNavigationSlot — restore <SequenceNavigation> as default child

Operators who want to replace or disable either component can still do so by setting keepDefault: false in their env.config.jsx. This preserves backward compatibility while keeping the plugin slot extensibility introduced by these two PRs.


Behavior after this change

Before After (Current - without fix of known risk) After (with fix)
Course outline sidebar Conditional on waffle flag Always visible Always visible
Sequence navigation Conditional on waffle flag Hidden (empty slot) Visible by default via slot
Breadcrumbs Conditional on waffle flag Hidden (empty slot) Visible by default via slot
Customization Not possible Via env.config.jsx plugin slots Via env.config.jsx plugin slots

…x#1713)

* feat: remove waffle flags for managing course outline sidebar

* fix: flag and tests

* fix: product-tours tests

* fix: remove default content for SequenceNavigationSlot and update tests

* fix: remove default content for CourseBreadcrumbsSlot

* fix: update plugin-slots version and documentation

* revert: update plugin-slots version

* fix: update tests
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 26, 2026
@openedx-webhooks
Copy link
Copy Markdown

openedx-webhooks commented May 26, 2026

Thanks for the pull request, @bra-i-am!

This repository is currently maintained by @openedx/committers-frontend-app-learning.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.


Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions May 26, 2026
@bra-i-am bra-i-am marked this pull request as draft May 26, 2026 16:08
@codecov
Copy link
Copy Markdown

codecov Bot commented May 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (release/teak@db0a565). Learn more about missing BASE report.

Additional details and impacted files
@@               Coverage Diff               @@
##             release/teak    #1916   +/-   ##
===============================================
  Coverage                ?   90.07%           
===============================================
  Files                   ?      344           
  Lines                   ?     5732           
  Branches                ?     1375           
===============================================
  Hits                    ?     5163           
  Misses                  ?      550           
  Partials                ?       19           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@bra-i-am bra-i-am marked this pull request as ready for review May 26, 2026 16:38
@bra-i-am bra-i-am marked this pull request as draft May 27, 2026 14:37
@bra-i-am bra-i-am changed the title feat: backport sidebar/navigation/breadcrumbs plugin slot changes feat(teak): backport sidebar/navigation/breadcrumbs plugin slot changes May 27, 2026
@bra-i-am bra-i-am changed the title feat(teak): backport sidebar/navigation/breadcrumbs plugin slot changes fix(teak): backport sidebar/navigation/breadcrumbs plugin slot changes May 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

3 participants