Skip to content

Deprecate react-unit-test-utils 9/15 #668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 24, 2025

Conversation

diana-villalvazo-wgu
Copy link
Contributor

Description

Remove use of 'shallow' (react-unit-test-utils) in following files:

  • src/containers/LearnerDashboardHeader/ConfirmEmailBanner/index.test.jsx
  • src/containers/LearnerDashboardHeader/index.test.jsx
  • src/containers/MasqueradeBar/index.test.jsx
  • src/containers/RelatedProgramsModal/components/ProgramCard.test.jsx
  • src/containers/RelatedProgramsModal/index.test.jsx

Note: As part of this work we find out paragon components were mocked on src/setupTest.jsx causing testing library unit tests to fail, since we are doing this work in multiple PRs and in order to not break other existing snapshot tests, we will unmock paragon or needed things on new tests and by end of react-unit-test-utils removal we will remove paragon mocks and unmock lines accordingly.

Support Information

Closes #649

@diana-villalvazo-wgu diana-villalvazo-wgu requested a review from a team as a code owner June 23, 2025 16:07
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jun 23, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @diana-villalvazo-wgu!

This repository is currently maintained by @2U-aperture.

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.


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 Jun 23, 2025
@diana-villalvazo-wgu diana-villalvazo-wgu added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Jun 23, 2025
@diana-villalvazo-wgu diana-villalvazo-wgu moved this from Needs Triage to Ready for Review in Contributions Jun 23, 2025
Copy link

codecov bot commented Jun 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.59%. Comparing base (6ae8180) to head (440293c).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #668   +/-   ##
=======================================
  Coverage   97.59%   97.59%           
=======================================
  Files         152      152           
  Lines        1332     1332           
  Branches      229      229           
=======================================
  Hits         1300     1300           
  Misses         31       31           
  Partials        1        1           

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

Comment on lines 35 to 43
describe('On unverified', () => {
it('show banner', () => {
hooks.mockReturnValueOnce({ ...hookProps });
render(<IntlProvider locale="en"><ConfirmEmailBanner /></IntlProvider>);
const banner = screen.getByRole('alert');
expect(banner).toContainHTML('Remember to confirm');
});
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe we can de-duplicate some of this code by using beforeAll and mocking the hooks for all tests so that the hooks.mockReturnValueOnce({ ...hookProps }); mock doesn't need to be repeated for each test block.

Suggested change
describe('On unverified', () => {
it('show banner', () => {
hooks.mockReturnValueOnce({ ...hookProps });
render(<IntlProvider locale="en"><ConfirmEmailBanner /></IntlProvider>);
const banner = screen.getByRole('alert');
expect(banner).toContainHTML('Remember to confirm');
});
describe('On unverified', () => {
beforeAll(() => {
hooks.mockReturnValue({ ...hookProps });
});
it('show banner', () => {
render(<IntlProvider locale="en"><ConfirmEmailBanner /></IntlProvider>);
const banner = screen.getByRole('alert');
expect(banner).toContainHTML('Remember to confirm');
});

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done 👍

expect(screen.getByText('MasqueradeBar')).toBeInTheDocument();
expect(screen.getByText('Header')).toBeInTheDocument();
const props = mockedHeaderProps.mock.calls[0][0];
const { mainMenuItems = [] } = props;
Copy link
Member

@MaxFrank13 MaxFrank13 Jun 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a need for the default empty array here? I would assume that if mainMenuItems is not in props, we'd see that the test would just fail, which is what we'd want in that case?

Suggested change
const { mainMenuItems = [] } = props;
const { mainMenuItems } = props;

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done 👍

Copy link
Member

@MaxFrank13 MaxFrank13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@diana-villalvazo-wgu
Copy link
Contributor Author

rebased master 👍

@MaxFrank13 MaxFrank13 enabled auto-merge (squash) June 24, 2025 16:49
@MaxFrank13 MaxFrank13 merged commit cae7b1b into openedx:master Jun 24, 2025
4 checks passed
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in Contributions Jun 24, 2025
@diana-villalvazo-wgu diana-villalvazo-wgu deleted the 649/depr9of15 branch June 24, 2025 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

Deprecate react-unit-test-utils 9/15
3 participants