WIP: refactoring launchpad & data context #18906

tgriesser · 2021-11-14T19:15:20Z

User Facing Changes

Removal of the interim "clickthrough" screen when setting up the events / sourcing the browsers for the project, replaces with a spinner & automatically loads the browser selection page
Add a spinner when sourcing the config initially, to get rid of the delay when choosing a project from Global Mode
Proper handling of various potential error states with the config.json / cypress.config.js files
- Warn if there are both cypress.config.js and .ts but use the .ts - it likely means their tsconfig.json compiled it on a build. We can give them instructions in the error on how to fix/ignore in their tsconfig.json
- Warn if there's both a cypress.config.{js|ts} and a cypress.json but use the cypress.config.js and tell them the .json will be ignored and that they should remove - it likely happened because they switched branches and the old one was left around
- Show the onboarding wizard / setup pages if a testing type has not been setup yet
- Error in run mode if the testing type has not been setup yet
Properly handle the --browser and --e2e / --component flags from the CLI in open mode
- Most of this worked, but there were some edge cases & things that needed to be fixed due to other changes in the config management workflow
Improved performance of GraphQL driven user interactions across the application (toggle switches in browser app), etc.

Technical Changes

Client:

Removes all of the onboarding Wizard strings, either importing them directly from @packages/types or sourcing the title/descriptions from the i18n package.
- Keeps the transient routing state for onboarding in pinia rather than the server
Refactors the GraphQL types to better align with the states we need to support in the frontend onboarding flow

Server:

Consolidate the "setup" of the DataContext making it clear how/where to source the setup & teardown
Uses immer for immutable state management: https://immerjs.github.io/immer/
- Eliminates the random mutation of state throughout the application, forces all updates to go through a single codepath which tracks the updates & providing an audit log for a faster developer feedback
  - This eliminates the need to log things with debug all over the place
- Tracks all config / setupNodeEvents (Plugins)
- Eventually will track all application state, but this PR aimed to only do the minimum amount necessary to set the patterns
Consolidates & standardizes config sourcing to eliminate mutations due to the above, and to handle the new pattern of sourcing config via the IPC / config script execution
- server/lib/config & server/lib/util/settings → ProjectConfigDataSource
- server/lib/plugins/index -> ProjectConfigActions
Removes all file watching, other than the watching provided by component-testing plugins
- plugins watchFile
- project-base watchSettings
- we will add these back in separately as a centralized approach
Removes open_project, moving state to the DataContext trims down project-base , which will eventually be removed but does not need to block this PR
- A number of lifecycle hooks that are no longer needed without desktop-gui are cleaned up
Refactor of the entire settings management lifecycle
- Documented the Config Management Summary to understand the core assumptions while refactoring
- Clearly defines the sources of data that feed into the settings, so that when we detect changes in one in the immer update, we can recompute the composite
  - (env.json / cypress.config.js / cli / plugin / default / runtime)
Removes createLegacyDataContext - the context should be passed through the application source as needed, and as we continue to fix more of the current server package code, more and more of it will move to the DataContext
Removes legacy code scaffolding. This is no longer needed
Temporarily disables @packages/server unit/integration tests. Many of these will be audited and added back in via open-mode tests, or re-added with the proper spies/mocks given the new server structure, they are too closely coupled with the existing mutable architecture to provide any positive value for these changes.
- Specifically need to revisit the --config-file=false option and if/how we want to support this with the new flow, or warn / migrate those who are using it - Jess mentioned it might be tied more to using "module" mode
Proper typings for the config passed through source as it's run through the CLI into the open mode - these have been incorrectly defined in the past
- Sourced these from running the current integration / system tests
Strict typings for the @packages/config so it can be consumed by the DataContext package
Improvements to the E2E testing workflow - previously a fresh DataContext & graphql server was being sourced for every test. This was causing slowdown on each test, likely due to memory leaks, and makes it difficult to debug the flow after a failure. Instead, with the support of many of the changes above, we are able to "reset" the context before each test, and keep the server alive after the test runs, so we can debug the immer state changes with GraphiQL.

* unified-desktop-gui: refactor: move currentProject to root data (#18834) chore: additional app shape cleanup (#18826) feat(useCollapsibleTree): adding support for building expandable and collapsible trees (#18860) feat: reconcile terminal command components (#18853) feat: setup keyboard shortcuts modal (#18864) feat: inline spec list header (#18863) feat: Runner spec list (#18821)

…e-data-clean-refactor * tgriesser/chore/e2e-data-clean: refactor: move currentProject to root data (#18834) chore: additional app shape cleanup (#18826) feat(useCollapsibleTree): adding support for building expandable and collapsible trees (#18860) feat: reconcile terminal command components (#18853) feat: setup keyboard shortcuts modal (#18864) feat: inline spec list header (#18863) feat: Runner spec list (#18821)

cypress-bot · 2021-11-14T19:15:22Z

Thanks for taking the time to open a PR!

Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.
Become familiar with the Code Review Checklist for guidelines on coding standards and what needs to be done before a PR can be merged.

* 10.0-release: feat: improve vite DX (#18937) feat: Use plugins on config files (#18798) BREAKING CHANGE: trigger major bump BREAKING CHANGE: trigger major bump fix: fix cypress/package.json crasher fix(breaking): change circle.yml to release binary fix: build-prod-ui deps before build-prod packages feat: implement spec list tree (#18901) chore: adding 10.0-release to the circle.yml build script (#18926) feat(app): remove __vite__ route and default to unified runner (#18909) fix: app layout + specs list review (#18862) feat(app): show previous versions (#18838) feat: scaffold integration files in app (#18763) feat: add footer to the settings (#18867) fix: Exit when both --e2e and --component flags are passed in (#18855)

* 10.0-release: feat: use fuzzy search (#18966) fix: onUnmounted warning in topnav (#18988) fix: CYPRESS_INTERNAL_VITE_DEV for development feat: Create default config file (#18943) feat(app): support editor preference (#18932)

* 10.0-release: (56 commits) chore: post-merge cleanup feat: use hoisted yarn install in binary build (#17285) fix: fix spec list header, "Create specs" prompt, add workspace recommended apollo extension (#18993) feat(unify): reporter settings (#18946) feat: add devServer to config file (#18962) fix: compile npm packages for node 12 (#18989) fix: show call count even if `cy.stub().log(false)`. (#18907) chore: Update TypeScript to 4.4.4 (#18930) fix: wrap playground selectors in double quotes if not included (#18442) fix: flaky settings_spec test (#18979) chore: Update Chrome (stable) to 96.0.4664.45 (#18931) fix: Loading of specs with % in the filename (#18877) chore: refactor `create` into class `$Cy` (#18715) chore: Update Chrome (beta) to 96.0.4664.45 (#18891) fix: flaky `system-tests-firefox` job (#18848) chore: release @cypress/webpack-preprocessor-v5.10.0 chore: release @cypress/vue-v3.0.5 chore: release @cypress/schematic-v1.6.0 chore: release create-cypress-tests-v1.2.0 release 9.0.0 ...

…e-data-clean-refactor * tgriesser/chore/e2e-data-clean: (76 commits) chore: post-merge cleanup feat: use hoisted yarn install in binary build (#17285) fix: fix spec list header, "Create specs" prompt, add workspace recommended apollo extension (#18993) feat(unify): reporter settings (#18946) feat: add devServer to config file (#18962) fix: compile npm packages for node 12 (#18989) fix: show call count even if `cy.stub().log(false)`. (#18907) chore: Update TypeScript to 4.4.4 (#18930) feat: use fuzzy search (#18966) fix: onUnmounted warning in topnav (#18988) fix: wrap playground selectors in double quotes if not included (#18442) fix: flaky settings_spec test (#18979) fix: CYPRESS_INTERNAL_VITE_DEV for development feat: Create default config file (#18943) feat(app): support editor preference (#18932) chore: Update Chrome (stable) to 96.0.4664.45 (#18931) fix: Loading of specs with % in the filename (#18877) feat: improve vite DX (#18937) chore: refactor `create` into class `$Cy` (#18715) feat: Use plugins on config files (#18798) ...

* 10.0-release: fix: change // -> //z to @types comments once on postinstall (#19041) feat(unify): cypress version update ui (#18964)

* 10.0-release: feat: Improve launchpad browser warning (#18939)

cypress · 2021-11-23T12:06:54Z

Test summary

18125 • 0 • 202 • 0 • 6

Run details


Project	cypress
Status	Passed
Commit	`1bd9ffa`
Started	Nov 24, 2021 2:41 AM
Ended	Nov 24, 2021 2:53 AM
Duration	12:17 💡
OS	Linux Debian - 10.10
Browser	Multiple

View run in Cypress Dashboard ➡️

Flakiness

	commands/net_stubbing_spec.ts	3
1	network stubbing > waiting and aliasing > can timeout waiting on a single request using "alias.request"
2	network stubbing > waiting and aliasing > can timeout incrementally waiting on requests
3	network stubbing > waiting and aliasing > can timeout incrementally waiting on requests
	commands/navigation_spec.js	1
1	src/cy/commands/navigation > #visit > window immediately resolves and doesn't reload when visiting the same URL with hashes
	cypress/proxy-logging-spec.ts	1
1	... > works with forceNetworkError
This comment includes only the first 5 flaky tests. See all 6 flaky tests in the 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

* 10.0-release: refactor: remove @packages/desktop-gui (#19127) feat: switch browser runner (#19048) fix: bump resource class for tests that require node_modules install (#19079) fix(unify): reporter styles (#19034) fix test feat(unify): add number of matches to specs search (#19076) feat(launchpad): open in IDE modal and feature (#18975) fix: 10.0 appveyor updateyaml (#19074)

* 10.0-release: feat(graphql): ability to update/query for appData (#19082) fix system test fix failing tests due to merge resolve conflicts test: node_modules installs for system-tests, other improvements (#18574) update yarn.lock chore(deps): update dependency semantic-release to v17.2.3 [security] (#19022) chore: remove flaky ci jobs for main builds (#19071) chore(contributing): clarify PULL_REQUEST_TEMPLATE (#19068) fix: the shadow root container element is ignored when clicking an element in it. (#18908) 'Fix' flaky redirect test (#19042) release 9.1.0 [skip ci] fix: Allow 'this' to be used in overridden commands (#18899) fix(react): link to rerender example (#19020) chore(deps): update dependency aws-sdk to v2.814.0 [security] (#18948) fix: test config overrides leak for .only execution (#18961) feat: Set CYPRESS=true as env var in child processes where Cypress runs user code in Node (#18981) fix: Restore broken gif (#18987) chore: release @cypress/vite-dev-server-v2.2.1

BlueWinds · 2021-12-06T18:31:08Z

packages/server/lib/plugins/index.js

+const getPluginIpcHandlers = () => {
+  return handlers
+}
+
 module.exports = {
  getPluginPid,
  execute,
  has,
  init,


Looks like you're still exporting 'init' even though the body has been removed, causing an error.

tgriesser · 2021-12-10T16:24:18Z

Closing in favor of #19325, #19308, and forthcoming PR for lifecycle/config management.

tgriesser added 10 commits November 9, 2021 19:13

app_data js -> ts

3c362c4

Test specific app dir, cleanup data pre/post test

9f58f2c

setupE2E -> openE2E

203fa25

prefix tasks with __internal

30ea1d2

cleanup

8ee06f1

WIP on refactoring many things

26a1be7

WIP

f6b3cdf

WIP

0bb22f8

tgriesser mentioned this pull request Nov 17, 2021

feat(app): support editor preference #18932

Merged

tgriesser added 4 commits November 17, 2021 11:41

tgriesser changed the base branch from tgriesser/chore/e2e-data-clean to 10.0-release November 21, 2021 21:07

tgriesser mentioned this pull request Nov 22, 2021

feat: Improve launchpad browser warning #18939

Merged

1 task

Merge branch '10.0-release' into tgriesser/chore/e2e-data-clean-refactor

a046e9b

* 10.0-release: fix: change // -> //z to @types comments once on postinstall (#19041) feat(unify): cypress version update ui (#18964)

tgriesser mentioned this pull request Nov 22, 2021

refactor: e2e open mode test cleanup #18865

Closed

tgriesser added 4 commits November 22, 2021 22:44

Merge branch '10.0-release' into tgriesser/chore/e2e-data-clean-refactor

ae6dafb

* 10.0-release: feat: Improve launchpad browser warning (#18939)

WIP after merge

9e96634

Fix

74fc1a1

fix

77e22a7

tgriesser added 5 commits November 23, 2021 07:10

fix

3d1b5e2

fix

84c1664

Merge branch '10.0-release' into tgriesser/chore/e2e-data-clean-refactor

2efc775

Fix

7f7c810

Fixing tests, adding immer

95646ea

tgriesser added 8 commits November 23, 2021 12:46

Fix types

bc7e37b

More fixes

1bd9ffa

WIP standardizing the data layer

c519e7d

wip before sync, not quite there yet

c9750f3

WIP

b7d0a38

broken WIP

3fe0c73

BlueWinds reviewed Dec 6, 2021

View reviewed changes

everything is broken

951f391

tgriesser mentioned this pull request Dec 8, 2021

chore: Refactoring to support e2e testing #19306

Merged

4 tasks

tgriesser closed this Dec 10, 2021

tgriesser deleted the tgriesser/chore/e2e-data-clean-refactor branch December 10, 2021 16:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: refactoring launchpad & data context #18906

WIP: refactoring launchpad & data context #18906

tgriesser commented Nov 14, 2021 •

edited

Loading

cypress-bot bot commented Nov 14, 2021

cypress bot commented Nov 23, 2021 •

edited

Loading

BlueWinds Dec 6, 2021

tgriesser commented Dec 10, 2021

WIP: refactoring launchpad & data context #18906

WIP: refactoring launchpad & data context #18906

Conversation

tgriesser commented Nov 14, 2021 • edited Loading

cypress-bot bot commented Nov 14, 2021

cypress bot commented Nov 23, 2021 • edited Loading

Test summary

Run details

Flakiness

BlueWinds Dec 6, 2021

Choose a reason for hiding this comment

tgriesser commented Dec 10, 2021

tgriesser commented Nov 14, 2021 •

edited

Loading

cypress bot commented Nov 23, 2021 •

edited

Loading