Skip to content

fix: require both ENABLE_CERTIFICATE_PAGE config and waffle flag to show Certificates menu#3066

Open
Anas12091101 wants to merge 4 commits into
openedx:masterfrom
mitodl:anas/fix-hide-certificate-link
Open

fix: require both ENABLE_CERTIFICATE_PAGE config and waffle flag to show Certificates menu#3066
Anas12091101 wants to merge 4 commits into
openedx:masterfrom
mitodl:anas/fix-hide-certificate-link

Conversation

@Anas12091101
Copy link
Copy Markdown
Contributor

@Anas12091101 Anas12091101 commented May 20, 2026

Description

The Certificates link in the Settings menu was always visible regardless of the ENABLE_CERTIFICATE_PAGE configuration because the conditional used an OR (||) operator to check either the config value or the useNewCertificatesPage waffle flag (mapped to legacy_studio.certificates in the platform). A recent upstream change in openedx-platform made legacy_studio.certificates always return True, which meant the OR condition was always satisfied and operators could no longer hide the Certificates menu by setting ENABLE_CERTIFICATE_PAGE=false. This PR changes the || to && so that both ENABLE_CERTIFICATE_PAGE and the waffle flag must be true for the Certificates link to appear, restoring operator control over menu visibility. Additionally, the default value of ENABLE_CERTIFICATE_PAGE has been changed from 'false' to 'true' so that existing deployments that rely on the waffle flag continue to see the menu without needing to add a new config variable. Tests have been updated to cover the new AND logic, including a case where the waffle flag is disabled but the config is enabled.

Useful information to include:

  • Which user roles will this change impact? Course Author
  • Include screenshots for changes to the UI (ideally, both "before" and "after" screenshots, if applicable).

Supporting information

Link to other information about the change, such as GitHub issues, or Discourse discussions.
Be sure to check they are publicly readable, or if not, repeat the information here.

Testing instructions

Manual Testing Steps

  1. Test: Certificates visible by default

    • Ensure .env.development has ENABLE_CERTIFICATE_PAGE=true (or remove the variable entirely — it now defaults to true).
    • Open any course in Studio (e.g., http://apps.local.openedx.io:2001/course/course-v1:edX+DemoX+Demo_Course).
    • Click the Settings dropdown in the header.
    • Expected: "Certificates" link is present.
  2. Test: Certificates hidden when config is false

    • Set ENABLE_CERTIFICATE_PAGE=false in .env.development.
    • Restart the dev server.
    • Open the same course and click Settings.
    • Expected: "Certificates" link is not present.
  3. Test: Certificates hidden when config is removed and default was relied upon

    • Remove the ENABLE_CERTIFICATE_PAGE line entirely from .env.development.
    • The default in index.jsx is now 'true', so certificates should appear.
    • Restart the dev server, open the course, click Settings.
    • Expected: "Certificates" link is present.
  4. Test: Direct URL access when disabled

    • Set ENABLE_CERTIFICATE_PAGE=false in .env.development and restart.
    • Navigate directly to http://apps.local.openedx.io:2001/course/course-v1:edX+DemoX+Demo_Course/certificates.
    • Expected: Page should show a 404 or redirect (the route in CourseAuthoringRoutes.tsx also checks this config).
  5. Run automated tests

    npx jest src/header/hooks.test.tsx --no-coverage
    
    • Expected: All 24 tests pass.

Other information

Include anything else that will help reviewers and consumers understand the change.

  • Does this change depend on other changes elsewhere?
  • Any special concerns or limitations? For example: deprecations, migrations, security, or accessibility.

Best Practices Checklist

We're trying to move away from some deprecated patterns in this codebase. Please
check if your PR meets these recommendations before asking for a review:

  • 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 openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 20, 2026
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @Anas12091101!

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
Copy link
Copy Markdown

codecov Bot commented May 20, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.55%. Comparing base (7138dfb) to head (e5ef2d3).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3066   +/-   ##
=======================================
  Coverage   95.55%   95.55%           
=======================================
  Files        1393     1393           
  Lines       32999    32994    -5     
  Branches     7645     7641    -4     
=======================================
- Hits        31532    31529    -3     
- Misses       1401     1412   +11     
+ Partials       66       53   -13     

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

@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions May 20, 2026
@bradenmacdonald
Copy link
Copy Markdown
Contributor

It sounds like the useNewCertificatesPage waffle flag has been deleted right? So shouldn't we remove all references to it entirely, and just use the ENABLE_CERTIFICATE_PAGE MFE config?

BREAKING CHANGE: The 'legacy_studio.certificates' waffle flag will no
longer be respected. The system will behave as if the flag is set to
false permanently.
~ openedx/openedx-platform@7aaeef3

See also #3063 which has a plan for removing most of the waffle flags, for the same reason.

@Anas12091101 Anas12091101 force-pushed the anas/fix-hide-certificate-link branch from 0e1e476 to e5ef2d3 Compare May 22, 2026 07:40
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: Ready for Review

Development

Successfully merging this pull request may close these issues.

4 participants