chore: refactor `create` into class `$Cy` #18715

sainthkh · 2021-11-01T02:18:07Z

Related with chore: revive type checker #18172

User facing changelog

N/A

Additional details

Why was this change necessary? => $Cy class is dummy and all the definitions were done inside the create function and _.extend. We're moving the parts into it.
What is affected by this change? => N/A

implementation details

At first, I wanted to move everything in this PR, but decided not to. Because it's still really big (+1675/-1667). I decided to break the PR to 3 steps.
1. Handle outside functions (this PR).
2. Handle queue and the functions inside _.extend (next PR)
3. Remove // @ts-nocheck in cy.ts and other outside functions.
I moved create out of export default because it requires one more indentation.
There are many functions in $Cy that are defined outside cy.ts and merged into it by _.extend. I solved the problem by creating interfaces for them. In the code, you'll find many interfaces like ITimeouts, IJQuery, etc.

How has the user experience changed?

N/A

PR Tasks

N/A

cypress-bot · 2021-11-01T02:18:10Z

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.

emilyrohrbough · 2021-11-09T22:30:37Z

packages/driver/src/cy/mouse.ts

@@ -707,6 +707,8 @@ const create = (state, keyboard, focused, Cypress) => {
  return mouse
 }

+export interface Mouse extends ReturnType<typeof create> {}


nit: I personally like when exports are at the end of files so it's easier to find. Thoughts?

I also thought about it at first but I placed it there because it would be better to place export functions in one place.

But it seems that your idea is better. I changed it.

packages/driver/src/cy/aliases.ts

emilyrohrbough · 2021-11-09T22:37:25Z

packages/driver/src/cy/aliases.ts


-      getAvailableAliases,


was this export used in other places?

It was an internal function used only inside aliases.ts. So, I removed it.

emilyrohrbough · 2021-11-09T22:41:30Z

packages/driver/src/cy/assertions.ts

-    }
-  },
+export interface IAssertions {
+  verifyUpcomingAssertions: ReturnType<typeof create>['verifyUpcomingAssertions']


Missing finishAssertions?

I intentionally didn't add it because it's not a public API. Check the code below:

cypress/packages/driver/src/cypress/cy.ts

Lines 611 to 612 in 50d1070

assert: assertions.assert,

verifyUpcomingAssertions: assertions.verifyUpcomingAssertions,

packages/driver/src/cy/ensures.ts

emilyrohrbough · 2021-11-09T23:00:09Z

packages/driver/src/cy/stability.ts

-      // we notify the outside world because this is what the runner uses to
-      // show the 'loading spinner' during an app page loading transition event
-      return Cypress.action('cy:stability:changed', stable, event)
+// eslint-disable-next-line @cypress/dev/arrow-body-multiline-braces


If you had maintained the code structure here, would you have needed to disable this rule?

export const create = (Cypress, state) => { const isStabe = () => {} const whenStable = () => {} return { isStable, whenStable, } }

I structured them in this way because I want to emphasize all functions are exported. When we use return, we cannot be sure if it's exported or not until we check if it's included in return. I didn't follow this convention there are internal functions or functions that are shared between other functions.

emilyrohrbough · 2021-11-09T23:13:03Z

packages/driver/src/cypress/cy.ts

@@ -118,58 +120,284 @@ const setTopOnError = function (Cypress, cy) {

 // NOTE: this makes the cy object an instance
 // TODO: refactor the 'create' method below into this class


TO DO is done? 😄

Not yet. This is the first step to remove it. I'll remove it in the next PR.

packages/driver/src/cypress/cy.ts

* develop: (329 commits) 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) release 9.0.0 feat: ensure major release have conduit app wait on localhost:3000 fix install-required-node use --legacy-peer-deps feat: ensure major release fix darwin node install chore(driver): fix integration test retry configuration (#18643) feat(deps): update dependency electron to v15 🌟 (#18317) chore: Bind this correctly when setting response headers with cy.route() (#18859) feat: create config package for config validation (#18589) chore: patch `winston` to suppress `padLevels` warning (#18824) chore: test out major release build fix: remove outdated npm registry links (#18727) fix: Adding an existing command with `Cypress.Commands.add()` will throw an error (#18587) ...

* develop: (52 commits) feat: use hoisted yarn install in binary build (#17285) 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 feat: ensure major release have conduit app wait on localhost:3000 fix install-required-node use --legacy-peer-deps ...

* 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) ...

sainthkh force-pushed the refactor-create-into-class-cy branch 2 times, most recently from 8b1d81e to 07b7cb3 Compare November 8, 2021 03:56

sainthkh marked this pull request as ready for review November 8, 2021 05:39

sainthkh requested a review from a team as a code owner November 8, 2021 05:39

sainthkh requested review from jennifer-shehane and removed request for a team November 8, 2021 05:40

jennifer-shehane requested review from emilyrohrbough and chrisbreiding and removed request for jennifer-shehane November 8, 2021 19:32

emilyrohrbough reviewed Nov 9, 2021

View reviewed changes

packages/driver/src/cy/aliases.ts Outdated Show resolved Hide resolved

emilyrohrbough reviewed Nov 9, 2021

View reviewed changes

sainthkh force-pushed the refactor-create-into-class-cy branch from e4bcacc to b2a99d0 Compare November 12, 2021 01:27

sainthkh requested a review from emilyrohrbough November 12, 2021 02:39

emilyrohrbough previously approved these changes Nov 15, 2021

View reviewed changes

chrisbreiding requested changes Nov 15, 2021

View reviewed changes

packages/driver/src/cypress/cy.ts Outdated Show resolved Hide resolved

sainthkh added 13 commits November 16, 2021 10:08

video recorder

80e2c73

timeouts

fbc1b05

fix timeouts errors.

dcf22ac

fix timeouts errors.

4f40527

fix failed tests.

9f96d12

stability

d4fb418

Minor type fixes.

0ca068d

Stability type defs.

6bacb6d

assertions and retries.

7087f7c

fix errors.

c845f89

jquery, location

ebc55ca

Remove some variables + timers, testConfigOverrides.

2ae2854

chai

1ab1ae6

sainthkh added 14 commits November 16, 2021 10:08

Fix error: cannot pass cy.$$ as an argument.

4ce2480

xhrs, solved todo.

58f1285

aliases

83ebfaf

Update chai create type.

4877de3

ensures

14c0383

snapshots.

da29102

keyboard, focused.

95b3299

mouse

fdcea2b

Fix types.

2e4ba79

fix failed tests.

bdf2b07

feedback

2dfd68d

resolve conflicts.

beee58f

fix failures.

ebf043b

Remove duplicates.

f5d740e

sainthkh dismissed emilyrohrbough’s stale review via f5d740e November 16, 2021 01:09

sainthkh force-pushed the refactor-create-into-class-cy branch from 2544da9 to f5d740e Compare November 16, 2021 01:09

chrisbreiding self-requested a review November 16, 2021 16:39

chrisbreiding approved these changes Nov 16, 2021

View reviewed changes

chrisbreiding merged commit 3817e50 into cypress-io:develop Nov 17, 2021

sainthkh mentioned this pull request Nov 26, 2021

chore: refactor cy funcs #19080

Merged

sainthkh mentioned this pull request Dec 14, 2021

chore: Remove pkg/driver @ts-nocheck part 1 #19353

Merged

sainthkh mentioned this pull request Dec 27, 2021

chore: remove pkg/driver //@ts-nocheck part 2 #19483

Merged

sainthkh mentioned this pull request Jan 24, 2022

chore: Remove pkg/driver //@ts-nocheck part 3 #19837

Merged

sainthkh mentioned this pull request Feb 14, 2022

chore: remove pkg/driver //@ts-nocheck final #20169

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: refactor `create` into class `$Cy` #18715

chore: refactor `create` into class `$Cy` #18715

sainthkh commented Nov 1, 2021 •

edited

Loading

cypress-bot bot commented Nov 1, 2021

emilyrohrbough Nov 9, 2021

sainthkh Nov 12, 2021

emilyrohrbough Nov 9, 2021

sainthkh Nov 12, 2021

emilyrohrbough Nov 9, 2021

sainthkh Nov 12, 2021

emilyrohrbough Nov 9, 2021

sainthkh Nov 12, 2021

emilyrohrbough Nov 9, 2021

sainthkh Nov 12, 2021

	assert: assertions.assert,
	verifyUpcomingAssertions: assertions.verifyUpcomingAssertions,

		@@ -118,58 +120,284 @@ const setTopOnError = function (Cypress, cy) {

		// NOTE: this makes the cy object an instance
		// TODO: refactor the 'create' method below into this class

chore: refactor create into class $Cy #18715

chore: refactor create into class $Cy #18715

Conversation

sainthkh commented Nov 1, 2021 • edited Loading

User facing changelog

Additional details

implementation details

How has the user experience changed?

PR Tasks

cypress-bot bot commented Nov 1, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chore: refactor `create` into class `$Cy` #18715

chore: refactor `create` into class `$Cy` #18715

sainthkh commented Nov 1, 2021 •

edited

Loading