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

sainthkh · 2021-12-14T02:03:03Z

Related with chore: refactor create into class $Cy #18715
Next step of chore: refactor cy funcs #19080

User facing changelog

N/A. It's just removing // @ts-nocheck comments and defining types to avoid type errors.

Additional details

Why was this change necessary? => To make pkg/driver files more type-safe.
What is affected by this change? => N/A
Any implementation details to explain? => N/A

How has the user experience changed?

N/A

PR Tasks

[na] Have tests been added/updated?
[na] Has the original issue (or this PR, if no issue exists) been tagged with a release in ZenHub? (user-facing changes only)
[na] Has a PR for user-facing changes been opened in cypress-documentation?
[na] Have API changes been updated in the type definitions?
[na] Have new configuration options been added to the cypress.schema.json?

cypress-bot · 2021-12-14T02:03:05Z

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.

sainthkh · 2021-12-14T02:04:32Z

packages/driver/src/cy/mouse.ts

-      const skipMouseupEvent = mouseDownPhase.events.pointerdown.skipped || mouseDownPhase.events.pointerdown.preventedDefault
+      const skipMouseupEvent = mouseDownPhase.events.pointerdown.preventedDefault


By definition, mouseDownPhase.events.pointerdown.skipped is always undefined.

ryanthemanuel · 2021-12-15T18:45:18Z

packages/driver/src/cy/mouse.ts

@@ -720,6 +740,9 @@ const sendEvent = (evtName, el, evtOptions, bubbles = false, cancelable = false,
    evt.stopPropagation = function (...args) {
      evt._hasStoppedPropagation = true

+      // stopPropagation doesn't have argument. So, we cannot type-safely pass the second argument.


Suggested change

// stopPropagation doesn't have argument. So, we cannot type-safely pass the second argument.

// stopPropagation doesn't have any arguments. So, we cannot type-safely pass the second argument.

AtofStryker · 2021-12-15T18:48:41Z

packages/driver/src/cy/assertions.ts

@@ -54,12 +52,18 @@ const isDomSubjectAndMatchesValue = (value, subject) => {
  return false
 }

+type Parsed = {
+  subject?: any


Are these subjects always jQuery objects? if that is true, would the type be something like jQuery<TElement>? Not sure it really matters here though.

I handled it as JQuery<any>. To use JQuery<TElement>, we need the type info of value.

AtofStryker · 2021-12-15T20:50:50Z

packages/driver/src/cy/assertions.ts

@@ -77,7 +81,7 @@ export const create = (Cypress, cy) => {
  const getUpcomingAssertions = () => {
    const index = cy.state('index') + 1

-    const assertions = []
+    const assertions: any[] = []


Suggested change

const assertions: any[] = []

const assertions: { attributes: EnqueuedCommand}[] = []

I think that is the right type here but I am not sure we have access to it's context in the driver

The specific type of any is $Command here. But I made it to any for now. Because it should be worked with $Cy.queue and the other $Cy members.

Do we want to have the types be explicit with the the other cy members or address that in another PR? For now any seems like it fits the bill 😄 .

Right. Removing // @ts-nocheck from pkg/driver is a big work. So, I'm breaking them down to bite-size.

(Actually, there are sometimes so many things to think. So I'm postponing them for the later PRs.)

packages/driver/src/cy/chai.ts

fix merge.

@ts-nocheck

…ert-with-stack * tgriesser/10.0-release/refactor-lifecycle: (50 commits) Remove unused test file update task spec to use correct projectRoot update Fix test Fix test Fix tests update tests fix test correct config path Fix TS resolve conflicts Fixing component & e2e tests build: fix dev process on windows (#19401) fix: `cy.contains()` ignores `<style>` and `<script>` without removing them. (#19424) Fix some tests chore: Fix the broken codeowners automation (#19431) chore: add types for Cypress.session.clearAllSavedSessions (#19412) fix: No unnecessary snapshotting (#19311) chore: Remove pkg/driver @ts-nocheck part 1 (#19353) fix: add CYPRESS_VERIFY_TIMEOUT param and a test for it (#19282) ...

sainthkh commented Dec 14, 2021

View reviewed changes

sainthkh marked this pull request as ready for review December 14, 2021 02:32

jennifer-shehane assigned sainthkh Dec 14, 2021

tbiethman requested review from mjhenkes and ryanthemanuel December 15, 2021 17:55

ryanthemanuel reviewed Dec 15, 2021

View reviewed changes

ryanthemanuel previously approved these changes Dec 15, 2021

View reviewed changes

mjhenkes previously approved these changes Dec 15, 2021

View reviewed changes

AtofStryker reviewed Dec 15, 2021

View reviewed changes

sainthkh added 9 commits December 16, 2021 08:47

Define registerFetch.

e38dcbb

fix type errors.

bd4293a

fix cy.ts

2474484

fix merge.

fix chai.ts

99a1cf0

fix mouse.ts and related.

d523928

fix assertions.ts

32c99a6

fix unfetch name.

a40d993

fix comment.

b9ef618

Change type.

0e27c09

sainthkh dismissed stale reviews from mjhenkes and ryanthemanuel via 0e27c09 December 16, 2021 00:03

sainthkh force-pushed the remove-driver-no-check-part-1 branch from ffada01 to 0e27c09 Compare December 16, 2021 00:03

AtofStryker approved these changes Dec 16, 2021

View reviewed changes

ryanthemanuel approved these changes Dec 16, 2021

View reviewed changes

mjhenkes approved these changes Dec 16, 2021

View reviewed changes

mjhenkes and others added 3 commits December 16, 2021 08:47

Merge branch 'develop' into remove-driver-no-check-part-1

55063ac

Merge branch 'develop' into remove-driver-no-check-part-1

9f5375d

Merge branch 'develop' into remove-driver-no-check-part-1

e642e21

chrisbreiding merged commit 01f0261 into cypress-io:develop Dec 20, 2021

sainthkh mentioned this pull request Dec 27, 2021

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

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

sainthkh commented Dec 14, 2021

cypress-bot bot commented Dec 14, 2021

sainthkh Dec 14, 2021

ryanthemanuel Dec 15, 2021

AtofStryker Dec 15, 2021

sainthkh Dec 15, 2021

AtofStryker Dec 16, 2021

AtofStryker Dec 15, 2021

sainthkh Dec 16, 2021

AtofStryker Dec 16, 2021

sainthkh Dec 17, 2021

		const skipMouseupEvent = mouseDownPhase.events.pointerdown.skipped \|\| mouseDownPhase.events.pointerdown.preventedDefault
		const skipMouseupEvent = mouseDownPhase.events.pointerdown.preventedDefault

	// stopPropagation doesn't have argument. So, we cannot type-safely pass the second argument.
	// stopPropagation doesn't have any arguments. So, we cannot type-safely pass the second argument.

	const assertions: any[] = []
	const assertions: { attributes: EnqueuedCommand}[] = []

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

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

Conversation

sainthkh commented Dec 14, 2021

User facing changelog

Additional details

How has the user experience changed?

PR Tasks

cypress-bot bot commented Dec 14, 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