[core] Replace enzyme in describeConformance #42447

DiegoAndai · 2024-05-29T20:40:08Z

Part of #42454

This PR removes createMount from the describeConformance testing utility. Some notes:

I strongly encourage reviewers to review commits separately. I divided commits by test, so it will be easier to understand each change.
I provided an overview of each test change.
For Joy UI tests that failed, I simply skipped them.

mui-bot · 2024-05-29T20:42:57Z

Netlify deploy preview

https://deploy-preview-42447--material-ui.netlify.app/

Bundle size report

Details of bundle changes (Toolpad)
Details of bundle changes

Generated by 🚫 dangerJS against 3a6ae48

packages-internal/test-utils/src/describeConformance.tsx

DiegoAndai · 2024-05-30T19:50:04Z

packages-internal/test-utils/src/describeConformance.tsx


-    expect(root.props()).to.have.property(testProp, value);
+    expect(getByTestId(testId)).to.have.attribute(testProp, value);


Here, we lose the aspect of testing that the inherited component is being used and only maintain that the props are spread into whatever the component considers its root.

This follows RTL's principle of not testing implementation details. There might be a way for us to test that the inherited component is the one used, but I think it would be better to test that on each component's tests, by testing the expected functionality, classes, or whatever the inherited component provides.

AFAIK this is mostly used by the doc gen to add a message about additional props available on a component. I'm strongly in favor of removing this message and listing all available props on each component, so it's not necessary to jump between the pages to learn about available props. Afterwards, this test may be unnecessary.

Not in this PR, of course :)

DiegoAndai · 2024-05-30T19:52:20Z

packages/mui-base/test/describeConformanceUnstyled.tsx

@@ -269,6 +268,25 @@ function testSlotPropsProp(
  });
 }

+function testClassName(element: React.ReactElement, getOptions: () => ConformanceOptions) {


This was required as Base UI's describeConformance accepts async render functions. We could support those in the basic describeConformance test, but I wanted to keep the changes minimal, especially considering this base code is stale. Let me know if making the original testClassName async would be better.

Async render functions will be required when Material UI uses Floating UI. Certain interactions require flushing the microtask queue, which is an async operation. This is not strictly required now, so I agree it's ok to minimize the number of changes in this PR.

aarongarciah · 2024-06-17T09:17:13Z

@DiegoAndai just ran the describeConformance tests locally with react@18.3.1 and @types/react@18.3.3 (both are latest). Only one test was failing:

This is solved via 117cf8a and now all describeConformance tests pass locally using react@18.3.1 and @types/react@18.3.3.

There are several failures when running all unit tests with react@18.3.1, but I think those should probably be addressed in the corresponding PR upgrading React: #42047

aarongarciah · 2024-06-17T09:24:56Z

I just rebased to solve CI issues.

aarongarciah · 2024-06-17T10:25:44Z

@DiegoAndai after updating all React related deps in all the repo packages, describeConformanceUnstyled from Base UI fails:

After fixing the first error (just an import path update), we'll need to deal with other deprecations. I think we should take care of this in #42047.

DiegoAndai · 2024-06-17T14:58:21Z

Thanks for picking this up @aarongarciah

There are several failures when running all unit tests with react@18.3.1, but I think those should probably be addressed in the corresponding PR upgrading React: #42047

Yes, many things must be fixed, but I want to keep this PR scoped in describeConformance as MUI X relies on it. We can fix the other tests in a separate PR. This also includes describeConformanceUnstyled.

@LukasTy we're ready to merge this on our side, what about from the MUI X side?

cherniavskii · 2024-06-17T17:59:54Z

@LukasTy In mui/mui-x#13360 I've updated @mui/internal-test-utils to use the latest commit from this branch.
Feel free to use my branch to resolve issues related to @mui/internal-test-utils, or open a separate PR if that's more convenient.

cherniavskii · 2024-06-17T18:52:27Z

@DiegoAndai Everything looks good on the MUI X side: mui/mui-x#13360
Let's wait for @LukasTy's approval though, because there might be something I'm not aware of 🙂

LukasTy

Thank you for all the effort on it. 🙏
The solution looks great.
I've updated the mui/mui-x#12295 PR with the latest package from this PR and made some cleanup changes for things that are no longer used like this in this PR. 😉

packages-internal/test-utils/src/describeConformance.tsx

aarongarciah · 2024-06-18T13:16:45Z

For some reason all tests passed in CI but 37 tests fail locally when running test:unit 😅 I'm looking into it.

Janpot · 2024-06-18T13:42:39Z

@aarongarciah Could be related to #42670.

aarongarciah · 2024-06-18T13:43:51Z

After a rebase all tests pass locally. We had a regression causing tests to not run in CI but now that's fixed. More info https://mui-org.slack.com/archives/C042YB5RB3N/p1718610795073829

aarongarciah · 2024-06-18T13:44:10Z

Could be related to #42670

Yes, just saw the fixes. Thank you @Janpot

DiegoAndai added test core Infrastructure work going on behind the scenes labels May 29, 2024

DiegoAndai self-assigned this May 29, 2024

LukasTy changed the title ~~[code] Replace enzyme in describeConformance~~ [core] Replace enzyme in describeConformance May 30, 2024

LukasTy reviewed May 30, 2024

View reviewed changes

packages-internal/test-utils/src/describeConformance.tsx Outdated Show resolved Hide resolved

DiegoAndai force-pushed the remove-enzyme-from-describe-conformance-2 branch 7 times, most recently from b711d40 to c329f67 Compare May 30, 2024 17:49

DiegoAndai mentioned this pull request May 30, 2024

[core] Remove enzyme #42454

Closed

4 tasks

DiegoAndai force-pushed the remove-enzyme-from-describe-conformance-2 branch from c486d38 to 81f9574 Compare May 30, 2024 19:40

DiegoAndai commented May 30, 2024

View reviewed changes

packages-internal/test-utils/src/describeConformance.tsx Show resolved Hide resolved

DiegoAndai commented May 30, 2024

View reviewed changes

packages-internal/test-utils/src/describeConformance.tsx Outdated Show resolved Hide resolved

DiegoAndai commented May 30, 2024

View reviewed changes

DiegoAndai marked this pull request as ready for review May 30, 2024 19:55

DiegoAndai requested review from Janpot and michaldudak and removed request for Janpot May 30, 2024 19:55

cherniavskii mentioned this pull request Jun 4, 2024

[core] Use act from react #42414

Closed

LukasTy mentioned this pull request Jun 5, 2024

[core] Fixes in preparation for React 18.3 mui/mui-x#13378

Merged

cherniavskii mentioned this pull request Jun 5, 2024

Bump React mui/mui-x#12295

Merged

1 task

aarongarciah force-pushed the remove-enzyme-from-describe-conformance-2 branch from ac2582a to 117cf8a Compare June 17, 2024 09:23

DiegoAndai requested a review from LukasTy June 17, 2024 14:58

LukasTy approved these changes Jun 18, 2024

View reviewed changes

packages-internal/test-utils/src/describeConformance.tsx Show resolved Hide resolved

DiegoAndai and others added 8 commits June 18, 2024 15:37

Remove enzyme from testPropsSpread test

01660be

Remove enzyme from describeRef test

c984272

Remove enzyme from testClassName test

96d29af

Remove enzyme from testComponentProp test

a891f02

Remove enzyme from testComponentsProp test

ae0b1da

Remove mount from describeConformance

d0b2593

Automatically set data-testid

aceac7d

Do not spread key prop

3a6ae48

aarongarciah force-pushed the remove-enzyme-from-describe-conformance-2 branch from 117cf8a to 3a6ae48 Compare June 18, 2024 13:39

aarongarciah merged commit da7b8cf into mui:next Jun 18, 2024
22 checks passed

DiegoAndai deleted the remove-enzyme-from-describe-conformance-2 branch June 18, 2024 16:09

DiegoAndai added the React 19 support PRs required to support React 19 label Jun 21, 2024

This was referenced Jul 5, 2024

[core] Bump React to 18.3.1 #42846

Merged

[core] Replace enzyme in describeConformance #42847

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[core] Replace enzyme in describeConformance #42447

[core] Replace enzyme in describeConformance #42447

DiegoAndai commented May 29, 2024 •

edited

Loading

mui-bot commented May 29, 2024 •

edited

Loading

DiegoAndai May 30, 2024

michaldudak Jun 4, 2024

DiegoAndai May 30, 2024 •

edited

Loading

michaldudak Jun 4, 2024

aarongarciah commented Jun 17, 2024 •

edited

Loading

aarongarciah commented Jun 17, 2024

aarongarciah commented Jun 17, 2024 •

edited

Loading

DiegoAndai commented Jun 17, 2024

cherniavskii commented Jun 17, 2024

cherniavskii commented Jun 17, 2024

LukasTy left a comment

aarongarciah commented Jun 18, 2024

Janpot commented Jun 18, 2024 •

edited

Loading

aarongarciah commented Jun 18, 2024

aarongarciah commented Jun 18, 2024 •

edited

Loading


		expect(root.props()).to.have.property(testProp, value);
		expect(getByTestId(testId)).to.have.attribute(testProp, value);

[core] Replace enzyme in describeConformance #42447

[core] Replace enzyme in describeConformance #42447

Conversation

DiegoAndai commented May 29, 2024 • edited Loading

mui-bot commented May 29, 2024 • edited Loading

Netlify deploy preview

Bundle size report

DiegoAndai May 30, 2024

Choose a reason for hiding this comment

michaldudak Jun 4, 2024

Choose a reason for hiding this comment

DiegoAndai May 30, 2024 • edited Loading

Choose a reason for hiding this comment

michaldudak Jun 4, 2024

Choose a reason for hiding this comment

aarongarciah commented Jun 17, 2024 • edited Loading

aarongarciah commented Jun 17, 2024

aarongarciah commented Jun 17, 2024 • edited Loading

DiegoAndai commented Jun 17, 2024

cherniavskii commented Jun 17, 2024

cherniavskii commented Jun 17, 2024

LukasTy left a comment

Choose a reason for hiding this comment

aarongarciah commented Jun 18, 2024

Janpot commented Jun 18, 2024 • edited Loading

aarongarciah commented Jun 18, 2024

aarongarciah commented Jun 18, 2024 • edited Loading

DiegoAndai commented May 29, 2024 •

edited

Loading

mui-bot commented May 29, 2024 •

edited

Loading

DiegoAndai May 30, 2024 •

edited

Loading

aarongarciah commented Jun 17, 2024 •

edited

Loading

aarongarciah commented Jun 17, 2024 •

edited

Loading

Janpot commented Jun 18, 2024 •

edited

Loading

aarongarciah commented Jun 18, 2024 •

edited

Loading