fix: make component derived info not throw #24571
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for taking the time to open a PR!
|
lmiller1990
approved these changes
Nov 7, 2022
| @@ -108,7 +108,7 @@ export const makeMountFn = ( | |||
| consoleProps: () => { | |||
| return { | |||
| // @ts-ignore protect the use of jsx functional components use ReactNode | |||
| props: jsx.props, | |||
| props: jsx?.props, | |||
There was a problem hiding this comment.
I think React defaults to an empty object for no props?
There was a problem hiding this comment.
Maybe when creating the component but jsx here is just the first argument to mount, so passing cy.mount(null) would throw. I know it doesn't make sense to do that, but the types allow it and React doesn't throw so I thought I'd be safe here.
|
Looks good! |
|
Test summaryRun details
View run in Cypress Dashboard ➡️ This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
User facing changelog
Do not throw error/throw better error when providing improper but still valid arguments to
mountAdditional details
We derive information from the component/class passed into
cy.mountsuch as the name of the component or whether it is a standalone component (Angular). Our mount would error in certain scenarios:cy.mount(some_primitive_value)e.g.cy.mount('Hello World')class MyClass {}; cy.mount(MyClass)The goal of this PR isn't to validate what is passed. If
cy.mount(null)is called, stuff should break and that's expected but if the types allow for certain values likecy.mount(5)then it shouldn't throw an error. If it does throw an error, it should be the render throwing the error and notCannot read "displayName" of undefinedwhere we are trying to pull info from the component passed in.Steps to test
System-tests help here. If you want to test an external project, you'll first have to build the mount package and then symlink/copy it to your project's
node_modules/cypress/{framework}How has the user experience changed?
Before:
Screen.Recording.2022-11-07.at.2.17.56.PM.mov
After:
Screen.Recording.2022-11-07.at.2.20.16.PM.mov
PR Tasks
cypress-documentation?type definitions?