refactor: sidebar back-navigation to take user to parent block by navinkarkera · Pull Request #3037 · openedx/frontend-app-authoring

navinkarkera · 2026-04-29T11:03:20Z

Description

Fix sidebar back-navigation behavior in Course Outline so parent container selection stays consistent.

Latest changes:

Add/back flows now navigate to correct parent container instead of always clearing selection.
Preserve and pass parent index when navigating back (section / subsection) so sidebar state remains stable.
Apply same behavior across:
- Align sidebar (OutlineAlignSidebar)
- Add sidebar (AddSidebar)
- Info sidebars (SubsectionInfoSidebar, UnitInfoSidebar)

Also update legacy libraries warning copy in Studio Home tabs section.

Change text from generic future release message to Willow-specific timeline:

Before: In a future release, legacy libraries will no longer be supported.
After: In the Willow release, legacy libraries will no longer be supported.

Impact:

Role: Course Author

Supporting information

Fixes [verawood] Legacy Libraries DEPR: Warnings in the UI #2876 (comment)
Fixes Sidebar Structure #2787 (comment)
Private-ref: https://tasks.opencraft.com/browse/FAL-4338

Testing instructions

Open Course Outline and select a unit/subsection/section.
Use back navigation from:
- Align sidebar
- Add sidebar
- Subsection/Unit info sidebars
Verify navigation returns to correct parent container.
Verify parent index is preserved (no jump/reset in sidebar selection).

For warning update:

Open Studio Home where libraries migration alert appears.
Verify alert body shows: In the Willow release, legacy libraries will no longer be supported.
Confirm remaining alert paragraph text unchanged.

Other information

Dependencies: None.

Best Practices Checklist

Any new files are using TypeScript (.ts, .tsx).
Avoid propTypes and defaultProps in any new or modified code.
Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
Do not add new fields to the Redux state/store. Use React Context to share state among multiple components.
Use React Query to load data from REST APIs. See any apiHooks.ts in this repo for examples.
All new i18n messages in messages.ts files have a description for translators to use.
Avoid using ../ in import paths. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

openedx-webhooks · 2026-04-29T11:03:27Z

Thanks for the pull request, @navinkarkera!

This repository is currently maintained by @bradenmacdonald.

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.

Details

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.

codecov · 2026-04-29T11:15:00Z

Codecov Report

❌ Patch coverage is 98.11321% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 95.52%. Comparing base (da4e81b) to head (063528e).

Files with missing lines	Patch %	Lines
.../course-outline/outline-sidebar/back-navigation.ts	97.67%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #3037   +/-   ##
=======================================
  Coverage   95.52%   95.52%           
=======================================
  Files        1392     1393    +1     
  Lines       32911    32962   +51     
  Branches     7340     7357   +17     
=======================================
+ Hits        31437    31487   +50     
- Misses       1419     1420    +1     
  Partials       55       55

☔ 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.

ChrisChV

Looks good 👍 I commented on some nits. Fix the coverage to merge

I tested this: I followed the testing instructions
I read through the code and considered the security, stability and performance implications of the changes.
I tested that the UI can be used with a keyboard only (tab order, keyboard controls).
Includes tests for bugfixes and/or features added.
Includes documentation

ChrisChV · 2026-04-29T16:48:42Z

+    const { currentId, subsectionId, sectionId } = selectedContainerState;
+    const sectionIndex = sections.findIndex((section) => section.id === sectionId);
+    const subsectionIndex = sections
+      .find((section) => section.id === sectionId)


Is it possible to avoid performing a double search of the section?

const section = sections.find((s) => s.id === sectionId); const sectionIndex = section ? sections.indexOf(section) : -1; const subsectionIndex = section?.childInfo.children.findIndex((s) => s.id === subsectionId) ?? -1;

@ChrisChV Done.

ChrisChV · 2026-04-29T16:49:57Z

+    const { currentId, subsectionId, sectionId } = selectedContainerState || {};
+    const sectionIndex = sections.findIndex((section) => section.id === sectionId);
+    const subsectionIndex = sections
+      .find((section) => section.id === sectionId)


Same question about duplicating the section search

rpenido · 2026-04-29T20:22:52Z

LGTM 👍
Thank you for your work, @navinkarkera!

I tested this using the instructions from the PR
I read through the code
I checked for accessibility issues
Includes documentation

navinkarkera · 2026-04-30T12:12:28Z

@ChrisChV @rpenido I refactored a bit to centralize the logic in a hook, please take a look.

rpenido · 2026-04-30T14:31:27Z

Great @navinkarkera! This is working as expected.

openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Apr 29, 2026

openedx-webhooks added this to Contributions Apr 29, 2026

github-project-automation Bot moved this to Needs Triage in Contributions Apr 29, 2026

navinkarkera requested a review from ChrisChV April 29, 2026 11:03

navinkarkera requested a review from rpenido April 29, 2026 11:57

mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Apr 29, 2026

ChrisChV approved these changes Apr 29, 2026

View reviewed changes

navinkarkera added 5 commits April 30, 2026 12:56

refactor: update legacy libraries warning text

3f5fbed

fix(course-outline): update sidebar back navigation

2399ea5

fix(course-outline): preserve sidebar indices on back nav

d5d4160

fix(course-outline): avoid re-finding section

9eedb9c

test: improve coverage

0fad221

navinkarkera force-pushed the navin/fal-4338/message-update branch from aaff0a7 to 0fad221 Compare April 30, 2026 10:01

fix(course-outline): handle back from subsection without section

8dea05b

navinkarkera changed the title ~~refactor: update legacy libraries warning text~~ refactor: sidebar back-navigation to take user to parent block Apr 30, 2026

navinkarkera added 2 commits April 30, 2026 17:22

refactor(outline-sidebar): extract back navigation helper

d66a42d

refactor(outline-sidebar): centralize back navigation

063528e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: sidebar back-navigation to take user to parent block#3037

refactor: sidebar back-navigation to take user to parent block#3037
navinkarkera wants to merge 8 commits intoopenedx:masterfrom
open-craft:navin/fal-4338/message-update

navinkarkera commented Apr 29, 2026 •

edited

Loading

Uh oh!

openedx-webhooks commented Apr 29, 2026

Uh oh!

codecov Bot commented Apr 29, 2026 •

edited

Loading

Uh oh!

ChrisChV left a comment

Uh oh!

ChrisChV Apr 29, 2026

Uh oh!

navinkarkera Apr 30, 2026

Uh oh!

ChrisChV Apr 29, 2026

Uh oh!

navinkarkera Apr 30, 2026

Uh oh!

rpenido commented Apr 29, 2026

Uh oh!

navinkarkera commented Apr 30, 2026

Uh oh!

rpenido commented Apr 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

navinkarkera commented Apr 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Testing instructions

Other information

Best Practices Checklist

Uh oh!

openedx-webhooks commented Apr 29, 2026

Uh oh!

codecov Bot commented Apr 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ChrisChV left a comment

Choose a reason for hiding this comment

Uh oh!

ChrisChV Apr 29, 2026

Choose a reason for hiding this comment

Uh oh!

navinkarkera Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

ChrisChV Apr 29, 2026

Choose a reason for hiding this comment

Uh oh!

navinkarkera Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

rpenido commented Apr 29, 2026

Uh oh!

navinkarkera commented Apr 30, 2026

Uh oh!

rpenido commented Apr 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

navinkarkera commented Apr 29, 2026 •

edited

Loading

codecov Bot commented Apr 29, 2026 •

edited

Loading