Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Show warnings for invalid CT Framework Definition #25838

Closed
lmiller1990 opened this issue Feb 16, 2023 · 3 comments · Fixed by #26183
Closed

Show warnings for invalid CT Framework Definition #25838

lmiller1990 opened this issue Feb 16, 2023 · 3 comments · Fixed by #26183
Assignees
@marktnoonan @astone123
Labels
CT Issue related to component testing

Comments

@lmiller1990
Copy link
Contributor

lmiller1990 commented Feb 16, 2023 •
edited by marktnoonan
Loading

Description

#25780 introduces a public API for CT Framework definitions.

It is possible a third party definition might be invalid or incorrectly identified, either:

  • developer made a mistake
  • the package was called cypress-ct-* but is not intended to be a framework adapter

In these cases, we should show a warning on the onboarding screen using our usual patterns. You probably want to catch or warn here, where we detect the frameworks: https://github.com/cypress-io/cypress/blob/feature/ct-public-api/packages/data-context/src/actions/WizardActions.ts#L169-L176.

ss

Note: specifically wording isn't locked in - use your best judgement, and we will make a proposal to the design team.

Acceptance Criteria

  • shows warning for malformed packages
  • shows warning for correctly formatted but incorrect packages (does not comply to API)
  • ideally each package that is shown as errored, the text should should link to the relevant link on npm, eg npmjs.com/package/<name here>. If this is hard to implement, we can drop this requirement.
  • has link to docs for framework definitions (https://on.cypress.io/component-integrations)
  • update cypress documentation under the "Testing" header on the "Integrating with Third Parties" to show how to use these warnings to debug during framework definition development.

Resources
@lmiller1990 lmiller1990 mentioned this issue Feb 20, 2023
Merged
@lmiller1990 lmiller1990 added the CT Issue related to component testing label Feb 22, 2023
@lmiller1990
Copy link
Contributor Author

Hey team! Please add your planning poker estimate with Zenhub @astone123 @marktnoonan @mike-plummer @warrensplayer @ZachJW34

@marktnoonan marktnoonan self-assigned this Mar 8, 2023
@astone123 astone123 self-assigned this Mar 23, 2023
@astone123 astone123 mentioned this issue Mar 23, 2023
Merged
2 tasks
@marktnoonan
Copy link
Contributor

marktnoonan commented Apr 3, 2023 •
edited
Loading

Update on this one:

  • code is done (also added a component test)
  • going to finalize with Design before updating the description and requesting PR review
  • struck the npm link requirement for now
  • will make the docs PR before we move this to Done.

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Apr 17, 2023

Released in 12.10.0.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v12.10.0, please open a new issue.

@cypress-bot cypress-bot bot locked as resolved and limited conversation to collaborators Apr 17, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@marktnoonan marktnoonan

@astone123 astone123

Labels
CT Issue related to component testing
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: display framework definition errors cypress-io/cypress
3 participants
@marktnoonan @astone123 @lmiller1990