fix: display programs nav button only if it is configured #506

dcoa · 2024-11-18T23:19:42Z

Description

This PR removes the link of programs from the Header if the service is not configured.

It aims to solve the following issue #372

How to test

Create a instance with frontend-app-learner-dashobord mounted in the current branch.
Launch the instance and open it in the browser.
Access the learner dashboard.
By default you should not see nav button.

openedx-webhooks · 2024-11-18T23:19:48Z

Thanks for the pull request, @dcoa!

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 maintained by @2U-aperture. Tag them in a comment and let them know that your changes are ready for review.

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 · 2024-11-18T23:22:51Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.40%. Comparing base (ce1848a) to head (89cae33).
Report is 2 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #506   +/-   ##
=======================================
  Coverage   97.40%   97.40%           
=======================================
  Files         157      157           
  Lines        1387     1389    +2     
  Branches      230      231    +1     
=======================================
+ Hits         1351     1353    +2     
  Misses         34       34           
  Partials        2        2

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

🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests
JS Bundle Analysis - Avoid shipping oversized bundles

deborahgu

this looks good to me. If we weren't time constrained I would want to add the test for a unpermissioned user, just because that's what broke last time, but I doubt we have a great way to do that quickly, and this shouldn't remotely have a chance of running into that problem. Thanks for the quick turnaround on the fix!

arbrandes

Thanks for doing this! Just a couple of changes, if you don't mind.

arbrandes · 2024-11-19T15:43:15Z

src/config/index.js

@@ -19,6 +19,7 @@ const configuration = {
  LOGO_URL: process.env.LOGO_URL,
  ENABLE_EDX_PERSONAL_DASHBOARD: process.env.ENABLE_EDX_PERSONAL_DASHBOARD === 'true',
  SEARCH_CATALOG_URL: process.env.SEARCH_CATALOG_URL || null,
+  ENABLE_PROGRAMS: !!process.env.ENABLE_PROGRAMS,


Can you please check for the 'true' string explicitly, like in line 20 above? There's a reason for it: .env files only support strings, not booleans. (Yes, I know, there are some boolean checks that don't respect this - they're basically wrong.)

That leads me to a second request: can you please add ENABLE_PROPRAMS to the existing .env files?

I addressed both comments :)

@arbrandes

arbrandes · 2024-11-19T15:44:41Z

src/containers/LearnerDashboardHeader/index.test.jsx

@@ -39,4 +39,9 @@ describe('LearnerDashboardHeader', () => {
    const wrapper = shallow(<LearnerDashboardHeader />);
    expect(wrapper.instance.findByType(Header)[0].props.secondaryMenuItems.length).toBe(1);
  });
+  test('should display Programs link if the service is configured in the backend', () => {


Looks like we need to reword the test title, here.

Suggested change

test('should display Programs link if the service is configured in the backend', () => {

test('should display Programs link if it's enabled by configuration', () => {

arbrandes

Thank you @dcoa, looks great!

deborahgu · 2024-11-20T21:40:05Z

for what it's worth I verified this again with your changes, and it still works great, so merge whenever you are ready.

dcoa · 2024-11-21T00:52:11Z

Thank you!!
I don't have write access on this repo, could any of you help me with the merge @deborahgu , @arbrandes ?

deborahgu · 2024-11-21T14:10:27Z

I've got you, @dcoa! 😃

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 18, 2024

dcoa changed the title ~~fix: display programs tab only if it is configured~~ fix: display programs nav button only if it is configured Nov 18, 2024

dcoa marked this pull request as ready for review November 18, 2024 23:23

dcoa requested a review from a team as a code owner November 18, 2024 23:23

fix: display programs tab only if it is configured

94e1483

dcoa force-pushed the dcoa/programs-setting branch from dcc9c94 to 94e1483 Compare November 18, 2024 23:25

dcoa requested a review from arbrandes November 19, 2024 00:12

dcoa mentioned this pull request Nov 19, 2024

fix: display support and programs in nav only if they are configured #507

Merged

deborahgu self-assigned this Nov 19, 2024

deborahgu added the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Nov 19, 2024

deborahgu approved these changes Nov 19, 2024

View reviewed changes

arbrandes requested changes Nov 19, 2024

View reviewed changes

fix: apply feedback

89cae33

dcoa force-pushed the dcoa/programs-setting branch from f4d65f5 to 89cae33 Compare November 19, 2024 20:55

dcoa requested a review from arbrandes November 20, 2024 01:42

arbrandes approved these changes Nov 20, 2024

View reviewed changes

itsjeyd added core contributor PR author is a Core Contributor (who may or may not have write access to this repo). and removed waiting for eng review PR is ready for review. Review and merge it, or suggest changes. labels Nov 21, 2024

deborahgu merged commit a0e5f75 into openedx:master Nov 21, 2024
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: display programs nav button only if it is configured #506

fix: display programs nav button only if it is configured #506

dcoa commented Nov 18, 2024 •

edited

Loading

openedx-webhooks commented Nov 18, 2024 •

edited

Loading

codecov bot commented Nov 18, 2024 •

edited

Loading

deborahgu left a comment

arbrandes left a comment

arbrandes Nov 19, 2024

dcoa Nov 19, 2024

arbrandes Nov 19, 2024

arbrandes left a comment

deborahgu commented Nov 20, 2024

dcoa commented Nov 21, 2024 •

edited

Loading

deborahgu commented Nov 21, 2024

	test('should display Programs link if the service is configured in the backend', () => {
	test('should display Programs link if it's enabled by configuration', () => {

fix: display programs nav button only if it is configured #506

fix: display programs nav button only if it is configured #506

Conversation

dcoa commented Nov 18, 2024 • edited Loading

openedx-webhooks commented Nov 18, 2024 • edited Loading

What's next?

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

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

Who will review my changes?

Where can I find more information?

When can I expect my changes to be merged?

codecov bot commented Nov 18, 2024 • edited Loading

Codecov Report

deborahgu left a comment

Choose a reason for hiding this comment

arbrandes left a comment

Choose a reason for hiding this comment

arbrandes Nov 19, 2024

Choose a reason for hiding this comment

dcoa Nov 19, 2024

Choose a reason for hiding this comment

arbrandes Nov 19, 2024

Choose a reason for hiding this comment

arbrandes left a comment

Choose a reason for hiding this comment

deborahgu commented Nov 20, 2024

dcoa commented Nov 21, 2024 • edited Loading

deborahgu commented Nov 21, 2024

dcoa commented Nov 18, 2024 •

edited

Loading

openedx-webhooks commented Nov 18, 2024 •

edited

Loading

codecov bot commented Nov 18, 2024 •

edited

Loading

dcoa commented Nov 21, 2024 •

edited

Loading