fix: Detect CT framework when unconfigured project opened with `--component` #26306

mike-plummer · 2023-03-30T14:19:16Z

Closes Framework detection doesn't occur when opening Cy with cypress open --component #22777

Additional details

The onboarding wizard automatically detects your CT framework and bundler when advancing from the testing type selection screen, but if you open the launchpad directly into CT using the --component flag this logic was being bypassed. This PR performs the necessary wizard initialization if a testing type is already selected when open mode is being set up.

Steps to test

Create a new project without any CT config
npm create vite@latest
choose React, remaining options can be anything
npm i in project dir to install dependencies.
Using current production, open the project: npx cypress open --component --project <project dir>
Observe that launchpad opens to the "Project setup" screen and no framework is auto-selected
Close Cypress, checkout this branch
Using this branch, reopen the project: yarn dev --component --project <project dir>
Observe that launchpad auto-populates the framework and bundler fields with React + Vite

How has the user experience changed?

Before

After

PR Tasks

Have tests been added/updated?
[na] Has a PR for user-facing changes been opened in cypress-documentation?
[na] Have API changes been updated in the type definitions?

…ponent`

cypress · 2023-03-30T14:48:53Z

3 flaky tests on run #45163 ↗︎

0	5121	74	0	3

Details:

Merge branch 'develop' into mikep/22777-detect-ct-framework
Project: cypress	Commit: `3d6acc61b2`
Status: Passed	Duration: 14:07 💡
Started: Mar 31, 2023 3:33 PM	Ended: Mar 31, 2023 3:47 PM

cypress/e2e/cypress/cypress.cy.js • 3 flaky tests • 5x-driver-electron

View Output Video

Test		Artifacts
... > correctly returns currentRetry		`Output` `Video`
... > correctly returns currentRetry		`Output` `Video`
... > correctly returns currentRetry		`Output` `Video`

_{This comment has been generated by cypress-bot as a result of this
project's GitHub integration settings.}

packages/data-context/src/data/ProjectLifecycleManager.ts

lmiller1990

Code looks good, won't block on merging, but if there's a quick refactor to be had, it sure would be nice to do it 💯

packages/data-context/src/data/ProjectLifecycleManager.ts

marktnoonan · 2023-03-31T17:50:52Z

This doesn't seem to be working for me with the project I tried, I'll test with a fresh react project like in the description, but let me know if my expectations are off in this loom?

Update: I might have hit a strange cache issue where yarn dev does not load up to date code sometimes, because it's working now...

marktnoonan · 2023-03-31T17:54:33Z

It works great when following the test steps in the issue description, I'm gonna try a fresh vue3-vite-ts project.

Fresh project was fine too...

Interesting that in the loom we do detect things by going out and back in 🤔

mike-plummer · 2023-03-31T18:30:03Z

@marktnoonan Very interesting. That happens every time with that specific project? Anything interesting pop in debug logs? I did notice one situation where the detection wouldn't work if the config file was invalid or otherwise couldn't be resolved correctly, but that typically caused other problems that were more noticeable.

marktnoonan · 2023-03-31T19:13:26Z

@mike-plummer I'll follow up in Slack, I updated this comment with a link to the same exact project working correctly, I think maybe it's an issue with yarn dev.

marktnoonan · 2023-03-31T19:45:07Z

I had already approved when I noticed I could actually consistently get this to not work on one project: loom

Commands:

yarn gulp open --dev --component --project ../bug-reproductions/vite-detect/vue3-vite-ts -- this is a fresh vite project just like the "steps to test" say but for Vue. This always works.

yarn gulp open --dev --component --project ../cypress-component-testing-apps/vue3-vite-ts -- this always fails, but can detect when you hit "back" and open CT again. This is using https://github.com/cypress-io/cypress-component-testing-apps/tree/main/vue3-vite-ts with CT config commented out.

Will see if I can capture useful logs.

marktnoonan · 2023-03-31T20:06:30Z

In the bad state the detection is actually fine, it's the UI not updating. If I refresh the launchpad I see the frameworks. So it's something where the gql reactivity is not working as expected?

Before refresh:

After refresh:

mike-plummer · 2023-03-31T20:59:33Z

The race condition Mark is seeing above has been identified but is a pre-existing issue that could have broader impacts to fix. Have written that up in #26388

Requested changes made

* chore(deps): bump in json5 in system-tests projects (#26379) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump set-getter from 0.1.0 to 0.1.1 (#26345) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Emily Rohrbough <[email protected]> * chore(deps): bump vm2 from 3.9.5 to 3.9.14 (#26335) Bumps [vm2](https://github.com/patriksimek/vm2) from 3.9.5 to 3.9.14. - [Release notes](https://github.com/patriksimek/vm2/releases) - [Changelog](https://github.com/patriksimek/vm2/blob/master/CHANGELOG.md) - [Commits](patriksimek/vm2@3.9.5...3.9.14) --- updated-dependencies: - dependency-name: vm2 dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Emily Rohrbough <[email protected]> * fix: Detect CT framework when unconfigured project opened with `--component` (#26306) Co-authored-by: Ryan Manuel <[email protected]> * chore: created a new github action to handle new comments better (#26234) * chore: created a new github action to handle new comments better --------- Co-authored-by: Emily Rohrbough <[email protected]> Co-authored-by: Matt Schile <[email protected]> * chore: remove debug logging on by default (#26411) * fix: remove logging * added changelog entry * chore(dependency): tweaking renovate bot settings (#26428) * Update renovate.json * Update renovate.json * chore: update devtools protocol (#26410) --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Emily Rohrbough <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Mike Plummer <[email protected]> Co-authored-by: Ryan Manuel <[email protected]> Co-authored-by: Ben M <[email protected]> Co-authored-by: Matt Schile <[email protected]> Co-authored-by: Lachlan Miller <[email protected]>

mike-plummer added 2 commits March 30, 2023 08:46

fix: Detect CT framework when unconfigured project opened with `--com…

e155ee6

…ponent`

Add changelog entry

1554dc8

warrensplayer previously requested changes Mar 30, 2023

View reviewed changes

packages/data-context/src/data/ProjectLifecycleManager.ts Outdated Show resolved Hide resolved

warrensplayer requested review from marktnoonan and a team and removed request for marktnoonan March 30, 2023 15:07

lmiller1990 approved these changes Mar 31, 2023

View reviewed changes

packages/data-context/src/data/ProjectLifecycleManager.ts Outdated Show resolved Hide resolved

lmiller1990 requested a review from a team March 31, 2023 00:04

ryanthemanuel changed the title ~~fix: Detect CT framework when unconfigured project opened with --component~~ fix: Detect CT framework when unconfigured project opened with `--component Mar 31, 2023

ryanthemanuel changed the title ~~fix: Detect CT framework when unconfigured project opened with `--component~~ fix: Detect CT framework when unconfigured project opened with --component Mar 31, 2023

ryanthemanuel and others added 4 commits March 31, 2023 01:20

Merge branch 'develop' into mikep/22777-detect-ct-framework

a2e404a

Refactor common logic into shared fn

a449fa1

Add missing awaits

43d208f

Merge branch 'develop' into mikep/22777-detect-ct-framework

3d6acc6

mike-plummer requested a review from warrensplayer March 31, 2023 15:52

marktnoonan approved these changes Mar 31, 2023

View reviewed changes

mike-plummer merged commit 1c385e0 into develop Mar 31, 2023

mike-plummer deleted the mikep/22777-detect-ct-framework branch March 31, 2023 21:00

MikeMcC399 mentioned this pull request Aug 1, 2023

CT setup detection may fail if launchpad skipped (--component used to open) #27410

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Detect CT framework when unconfigured project opened with `--component` #26306

fix: Detect CT framework when unconfigured project opened with `--component` #26306

mike-plummer commented Mar 30, 2023

cypress bot commented Mar 30, 2023 •

edited

Loading

lmiller1990 left a comment

marktnoonan commented Mar 31, 2023 •

edited

Loading

marktnoonan commented Mar 31, 2023 •

edited

Loading

mike-plummer commented Mar 31, 2023

marktnoonan commented Mar 31, 2023 •

edited

Loading

marktnoonan commented Mar 31, 2023

marktnoonan commented Mar 31, 2023

mike-plummer commented Mar 31, 2023

fix: Detect CT framework when unconfigured project opened with --component #26306

fix: Detect CT framework when unconfigured project opened with --component #26306

Conversation

mike-plummer commented Mar 30, 2023

Additional details

Steps to test

How has the user experience changed?

PR Tasks

cypress bot commented Mar 30, 2023 • edited Loading

3 flaky tests on run #45163 ↗︎

lmiller1990 left a comment

Choose a reason for hiding this comment

marktnoonan commented Mar 31, 2023 • edited Loading

marktnoonan commented Mar 31, 2023 • edited Loading

mike-plummer commented Mar 31, 2023

marktnoonan commented Mar 31, 2023 • edited Loading

marktnoonan commented Mar 31, 2023

marktnoonan commented Mar 31, 2023

mike-plummer commented Mar 31, 2023

fix: Detect CT framework when unconfigured project opened with `--component` #26306

fix: Detect CT framework when unconfigured project opened with `--component` #26306

cypress bot commented Mar 30, 2023 •

edited

Loading

marktnoonan commented Mar 31, 2023 •

edited

Loading

marktnoonan commented Mar 31, 2023 •

edited

Loading

marktnoonan commented Mar 31, 2023 •

edited

Loading