feat: [FC-0070] support SPA functionality

[PKulkoRaccoonGang]

🚨 Dependencies:

• 🔗 Authoring PR
• 🔗 Edx-platform PR

Description

This PR introduces several changes to the studio-header components to integrate react-router-dom for client-side routing, along with corresponding updates to tests.

Testing:

1. Install this version of the header in the associated version of MFE Authoring and switch to the current branch
2. If the waffle flags for links in the header navigation are enabled, navigation is performed without reloading the page

[openedx-webhooks]

Thanks for the pull request, @PKulkoRaccoonGang!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently unmaintained.

To get help with finding a technical reviewer, tag the community contributions project manager for this PR in a comment and let them know that your changes are ready for review:

1. On the right-hand side of the PR, find the Contributions project, click the caret in the top right corner to expand it, and check the "Primary PM" field for the name of your PM.
2. Find their GitHub handle here.

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.75%. Comparing base (ae5253c) to head (6e4945b).
Report is 6 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #542      +/-   ##
==========================================
- Coverage   70.55%   68.75%   -1.81%     
==========================================
  Files          25       48      +23     
  Lines         360      432      +72     
  Branches       95       97       +2     
==========================================
+ Hits          254      297      +43     
- Misses        104      132      +28     
- Partials        2        3       +1     

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

[itsjeyd]

Hey @PKulkoRaccoonGang, thank you for this contribution!

It looks like the changes are ready for review (?), but let me know if you were planning to work on them some more.

[PKulkoRaccoonGang]

Hi @itsjeyd
The PR is currently in draft, but I plan to submit it for review soon.
I'll let you know, thanks!

[itsjeyd]

Sounds good @PKulkoRaccoonGang, thanks for the update.

[bradenmacdonald]

I'm missing an explanation of why we're doing this complicated onNavigate prop injection and duplicating logic from react-router instead of simply using <Link>.

[bradenmacdonald]

This is OK, but isn't it much simpler and nicer to just use the <Link> component from react-router-dom?

[PKulkoRaccoonGang]

I'm missing an explanation of why we're doing this complicated onNavigate prop injection and duplicating logic from react-router instead of simply using .

The reason why it is not possible to use the react-router-dom functionality is the lack of a react-router-dom context, in the Authoring MFE the Header is outside the react-router context of the app. If you have any workarounds, I will be happy to implement them

[bradenmacdonald]

Are you sure? I thought the root app always provides RouterProvider. And in that page you linked to, I can see the use of useLocation from react-router which means the router context is available.

https://github.com/openedx/frontend-app-authoring/blob/ecfe27b043965941d752541e7b3e512847d94169/src/CourseAuthoringPage.jsx#L38

[PKulkoRaccoonGang]

Thanks to this PR, I realized that I wasn't the only one with the router context problem. Before adding react-router-dom to peerDependencies, the following error was displayed when using Link. I don't understand why it works like that, but it does :)

[bradenmacdonald]

Glad you figured that out! Thanks, this seems to be working well, and it makes everything feel much faster :)

[arbrandes]

The code itself is great. I tested it and everything works beautifully. No more page refreshes, yay!

However, can you please make the commit a feat:? It may not be a breaking change, but it does offer a new isNewHomePage prop for the StudioHeader.

[arbrandes]

Thank you!