chore: remove command type todos #20601

sainthkh · 2022-03-14T01:44:07Z

Related with chore: revive type checker #18172

User facing changelog

N/A. It's an internal cleanup. I removed command type TODOs.

Additional details

Why was this change necessary? => I had to add a lot of TODOs on commands when trying to remove // @ts-ignore comments. They had to be cleaned up.
What is affected by this change? => Nothing.

Any implementation details to explain?

Long ago, I tried to name internally-extended options with opts in #6459. opts and options are a bit confusing and this idea was turned down. We decided to use options and userOptions.

But the problem is that TypeScript doesn't like extending objects. To do that, we need to use general types like any, Record, etc.

To solve this problem, we need a way to name this internally-extended options. I thought about a lot of name candidates like iOptions, internalOptions, etc. But decided to use _options.

Traditionally, private class members were named with initial _ (link). I think it's simple name for our purpose (options with internal private members).

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 · 2022-03-14T01:44:09Z

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 · 2022-03-15T04:41:52Z

cli/types/cypress.d.ts

-  interface BlurOptions extends Loggable, Forceable { }
+  interface BlurOptions extends Loggable, Timeoutable, Forceable { }


cy.blur supports timeout but it was missing in types. I added it.

hmm, what does .timeout actually do in cy.blur? it gets passed to Cypress.log, but shouldn't this be a synchronous operation? maybe we need to remove this if it's a no-op.

I also think it's a synchronous operation and harder to finish blur() over 4 seconds.

But it might be here because we need it for retry and verifyAssertions.

And it's also in the documentation. Removing it is a breaking change.

IDK, I feel like if it's a no-op currently, removing the option isn't really breaking. But it's ok, don't need to worry about it here.

emilyrohrbough · 2022-03-16T13:40:56Z

packages/driver/src/cy/commands/files.ts

@@ -109,16 +117,15 @@ export default (Commands, Cypress, cy, state) => {
      return verifyAssertions()
    },

-    // TODO: change the type of `any` to `Partial<Cypress.WriteFileOPtions & Cypress.Timeoutable>`
-    writeFile (fileName, contents, encoding, options: any = {}) {
+    writeFile (fileName, contents, encoding, options: Partial<Cypress.WriteFileOptions & Cypress.Timeoutable> = {}) {


It would be easier to review this if we renamed the parameter instead of changing options to _options. The majority of the changes would be adding the types then.

I changed options to userOptions and _options to options.

I was trying not to change the parameter name, because I thought it would be great to generate type definitions automatically from the source code.

But I realized that it is almost impossible for us because the first subject parameter should be specified on our commands but they don't exist in our API.

So, it doesn't matter to change those names.

This PR focuses on fixing the type TODOs.

In the next PR, other un-typed options should be renamed to userOptions and types should be specified.

sainthkh · 2022-03-18T02:48:22Z

packages/driver/cypress/integration/commands/screenshot_spec.js

-          // the runner was captured
-          expect(Cypress.action.withArgs('cy:before:screenshot').args[0][1].appOnly).to.be.true
-          expect(Cypress.automation.withArgs('take:screenshot').args[0][1].capture).to.equal('viewport')
+          // the runner was captured ("appOnly === true" means to hide the runner UI)
+          expect(Cypress.action.withArgs('cy:before:screenshot').args[0][1].appOnly).to.be.false
+          expect(Cypress.automation.withArgs('take:screenshot').args[0][1].capture).to.equal('runner')


According to the definition of appOnly below,

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

Lines 269 to 272 in b0fe8bf

// "app only" means we're hiding the runner UI

const isAppOnly = ({ capture }) => {

return (capture === 'viewport') || (capture === 'fullPage')

}

it means to hide the runner UI. In other words, it should be false to capture the runner UI.

This weird test failure happened because

appOnly exists only for testing.

And the original code was trying to check the options given with options after userOptions alias is created.

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

Lines 444 to 455 in b0fe8bf

screenshot (subject, name, options: any = {}) {

let userOptions = options

if (_.isObject(name)) {

userOptions = name

name = null

}

// make sure when we capture the entire test runner

// we are not limited to "within" subject

// https://github.com/cypress-io/cypress/issues/14253

if (options.capture !== 'runner') {

The code above, when name is { capture: 'runner' } and options is undefined. options.capture !== 'runner' is always true.

flotwig

nice, i love a good TS improvement PR. just a couple of questions

flotwig · 2022-04-13T17:26:58Z

cli/types/cypress.d.ts

-  interface BlurOptions extends Loggable, Forceable { }
+  interface BlurOptions extends Loggable, Timeoutable, Forceable { }


hmm, what does .timeout actually do in cy.blur? it gets passed to Cypress.log, but shouldn't this be a synchronous operation? maybe we need to remove this if it's a no-op.

packages/driver/src/cy/commands/files.ts

tbiethman · 2022-04-14T16:26:44Z

packages/driver/src/cy/commands/navigation.ts

@@ -973,13 +974,13 @@ export default (Commands, Cypress, cy, state, config) => {
          }

          if (options.log) {


Might be worth changing the check at this point since we're fairly removed from the initial setting of _log.

Suggested change

if (options.log) {

if (options._log) {

log and _log can be a bit different.

log is a user-provided or default option.

_log can be undefined if some conditions are met.

I personally think changing log to _log doesn't change much in this case, but I believe it's safer to leave it as-is.

+1. Agree with @tbiethman, at this point _log is referencing the Log instance created by the command when the user options are log = true

I changed log to _log when we're trying to manipulate the _log.

tbiethman

Just had the one minor comment

sainthkh · 2022-04-18T06:09:23Z

Failure caused by #20377. Fix at #21106.

emilyrohrbough · 2022-04-19T16:28:22Z

packages/driver/src/cy/keyboard.ts

@@ -12,6 +12,7 @@ import type { HTMLTextLikeElement } from '../dom/elements'
 import $selection from '../dom/selection'
 import $utils from '../cypress/utils'
 import $window from '../dom/window'
+import type { Log } from '../cypress/log'


These should pull from the existing Log Types

Suggested change

import type { Log } from '../cypress/log'

- import type { Log } from '../cypress/log'

It's not possible because the Log class under driver/src/cypress/log.ts has some internal methods.

Here are some examples:

cypress/packages/driver/src/cy/commands/actions/click.ts

Lines 138 to 140 in 68173be

if (options._log) {

consoleObj = options._log.invoke('consoleProps')

}

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

Lines 465 to 468 in 68173be

const l = cmd.getLastLog()

if (l) {

l.merge(log)

emilyrohrbough · 2022-04-19T16:28:32Z

packages/driver/src/cy/keyboard.ts

@@ -680,7 +681,7 @@ export interface typeOptions {
  force?: boolean
  simulated?: boolean
  release?: boolean
-  _log?: any
+  _log?: Log


Suggested change

_log?: Log

_log?: Cypress.Log

Please check the comment above.

emilyrohrbough · 2022-04-19T16:30:29Z

packages/driver/src/cy/commands/navigation.ts

@@ -973,13 +974,13 @@ export default (Commands, Cypress, cy, state, config) => {
          }

          if (options.log) {


+1. Agree with @tbiethman, at this point _log is referencing the Log instance created by the command when the user options are log = true

packages/driver/src/cy/commands/actions/submit.ts

packages/driver/src/cy/commands/angular.ts

packages/driver/src/cy/commands/cookies.ts

emilyrohrbough · 2022-04-19T16:36:44Z

packages/driver/src/cy/commands/files.ts

+import type { Log } from '../../cypress/log'
+
+interface InternalReadFileOptions extends Partial<Cypress.Loggable & Cypress.Timeoutable> {
+  _log?: Log


Suggested change

_log?: Log

_log?: Cypress.Log

Please check the comment above.

emilyrohrbough · 2022-04-19T16:38:20Z

packages/driver/src/cy/commands/window.ts

+interface InternalWindowOptions extends Partial<Cypress.Loggable & Cypress.Timeoutable> {
+  _log?: Log
+  error?: any
+}
+
+interface InternalDocumentOptions extends Partial<Cypress.Loggable & Cypress.Timeoutable> {


Can we reuse this interface?

I've chose this way because they're for different commands. They can grow differently. And it's only 2 of them (it's not 3 strike out yet.)

emilyrohrbough · 2022-04-19T16:39:18Z

patches/@types+jquery.scrollto+1.4.29.dev.patch

+ /// <reference types="jquery"/>
+
+-interface ScrollToOptions {
+interface ScrollToOptions extends JQuery.EffectsOptions<any> {


There wasn't a dep update. Did we need to update this patch?

It's because of the code below:

cypress/packages/driver/src/cy/commands/actions/scroll.ts

Lines 121 to 143 in 68173be

return $(options.$parent).scrollTo(options.$el, {

axis: options.axis,

easing: options.easing,

duration: options.duration,

offset: options.offset,

done () {

return resolve(options.$el)

},

fail () {

// its Promise object is rejected

try {

return $errUtils.throwErrByPath('scrollTo.animation_failed')

} catch (err) {

return reject(err)

}

},

always () {

if (parentIsWin) {

delete options.$parent.contentWindow

}

},

})

})

ScrollToOptions uses Jquery.EffectsOptions methods like done(), always(), but they don't exist without extending it.

emilyrohrbough · 2022-04-19T16:41:37Z

@sainthkh FYI - there are a BUNCH of log types coming this week! You'll appreciate them 😄 https://github.com/cypress-io/cypress/pull/18075/files#diff-a2cd504f16ad316e4675f37a2b3d9d7032d6cc6e3b591934a7b453b16a7ad924R10

sainthkh force-pushed the remove-command-type-todos branch from 1265cd0 to abac9fd Compare March 15, 2022 04:22

sainthkh commented Mar 15, 2022

View reviewed changes

sainthkh marked this pull request as ready for review March 15, 2022 04:46

sainthkh requested a review from a team as a code owner March 15, 2022 04:46

sainthkh requested review from jennifer-shehane and removed request for a team March 15, 2022 04:46

sainthkh force-pushed the remove-command-type-todos branch from abac9fd to 67dcf9b Compare March 15, 2022 04:47

emilyrohrbough reviewed Mar 16, 2022

View reviewed changes

sainthkh added 21 commits March 18, 2022 08:47

Remove @ts-ignore.

bff7f0b

clock.ts

93f2b2b

cookies.ts

a0fbd97

debugging.ts

e9120ad

files.ts

9216026

exec.ts

edb7d39

location.ts

0c62852

misc.ts

ce302e8

type.ts

585fbe8

browser.ts

b650488

angular.ts

9801c7c

navigation.ts

f4adb3a

screenshot.ts

b17da05

task.ts

0dfffc6

window.ts

6674167

focus.ts

9cf79c8

scroll.ts

0659e3b

scroll.ts

f03249a

select.ts

95cc205

submit.ts

c8face7

focused.ts

021774c

sainthkh force-pushed the remove-command-type-todos branch from 4052c73 to 136d989 Compare March 18, 2022 02:36

fix screenshot.ts test bug.

8fb7463

sainthkh commented Mar 18, 2022

View reviewed changes

tbiethman requested review from flotwig and removed request for jennifer-shehane April 13, 2022 15:39

flotwig requested a review from emilyrohrbough April 13, 2022 15:39

flotwig suggested changes Apr 13, 2022

View reviewed changes

fix _log type.

33f0885

flotwig self-requested a review April 14, 2022 15:35

flotwig approved these changes Apr 14, 2022

View reviewed changes

tbiethman requested review from tbiethman and removed request for emilyrohrbough April 14, 2022 16:01

tbiethman reviewed Apr 14, 2022

View reviewed changes

tbiethman approved these changes Apr 14, 2022

View reviewed changes

Merge branch 'develop' into remove-command-type-todos

ea2126b

jennifer-shehane and others added 2 commits April 18, 2022 10:36

Merge branch 'develop' into remove-command-type-todos

b43ca6a

Merge branch 'develop' into remove-command-type-todos

7fcf88a

emilyrohrbough requested changes Apr 19, 2022

View reviewed changes

sainthkh and others added 5 commits April 20, 2022 15:13

log to _log when we're manipulating _log.

c8e33fd

feedback

35c9445

Use a better type with generics.

fc8e114

Correct type.

4bd4536

Merge branch 'develop' into remove-command-type-todos

01de010

tbiethman requested a review from emilyrohrbough April 21, 2022 15:34

Merge branch 'develop' into remove-command-type-todos

cf50abb

flotwig merged commit 0bb655e into cypress-io:develop Apr 22, 2022

sainthkh mentioned this pull request Apr 25, 2022

chore: revive type checker #18172

Merged

4 tasks

sainthkh mentioned this pull request May 9, 2022

chore: improve pkg/driver types #21197

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: remove command type todos #20601

chore: remove command type todos #20601

sainthkh commented Mar 14, 2022 •

edited

cypress-bot bot commented Mar 14, 2022

sainthkh Mar 15, 2022

flotwig Apr 13, 2022

sainthkh Apr 14, 2022

flotwig Apr 14, 2022

emilyrohrbough Mar 16, 2022

sainthkh Mar 18, 2022

sainthkh Mar 18, 2022 •

edited

flotwig left a comment

flotwig Apr 13, 2022

tbiethman Apr 14, 2022

sainthkh Apr 18, 2022

emilyrohrbough Apr 19, 2022

sainthkh Apr 20, 2022

tbiethman left a comment

sainthkh commented Apr 18, 2022

emilyrohrbough Apr 19, 2022

sainthkh Apr 20, 2022

emilyrohrbough Apr 19, 2022

sainthkh Apr 20, 2022

emilyrohrbough Apr 19, 2022

emilyrohrbough Apr 19, 2022

sainthkh Apr 20, 2022

emilyrohrbough Apr 19, 2022

sainthkh Apr 20, 2022

emilyrohrbough Apr 19, 2022

sainthkh Apr 20, 2022

emilyrohrbough commented Apr 19, 2022

		interface BlurOptions extends Loggable, Forceable { }
		interface BlurOptions extends Loggable, Timeoutable, Forceable { }

	// "app only" means we're hiding the runner UI
	const isAppOnly = ({ capture }) => {
	return (capture === 'viewport') \|\| (capture === 'fullPage')
	}

	screenshot (subject, name, options: any = {}) {
	let userOptions = options

	if (_.isObject(name)) {
	userOptions = name
	name = null
	}

	// make sure when we capture the entire test runner
	// we are not limited to "within" subject
	// https://github.com/cypress-io/cypress/issues/14253
	if (options.capture !== 'runner') {

		@@ -973,13 +974,13 @@ export default (Commands, Cypress, cy, state, config) => {
		}

		if (options.log) {

	import type { Log } from '../cypress/log'
	- import type { Log } from '../cypress/log'

	if (options._log) {
	consoleObj = options._log.invoke('consoleProps')
	}

	return $(options.$parent).scrollTo(options.$el, {
	axis: options.axis,
	easing: options.easing,
	duration: options.duration,
	offset: options.offset,
	done () {
	return resolve(options.$el)
	},
	fail () {
	// its Promise object is rejected
	try {
	return $errUtils.throwErrByPath('scrollTo.animation_failed')
	} catch (err) {
	return reject(err)
	}
	},
	always () {
	if (parentIsWin) {
	delete options.$parent.contentWindow
	}
	},
	})
	})

chore: remove command type todos #20601

chore: remove command type todos #20601

Conversation

sainthkh commented Mar 14, 2022 • edited

User facing changelog

Additional details

Any implementation details to explain?

How has the user experience changed?

PR Tasks

cypress-bot bot commented Mar 14, 2022

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

sainthkh Mar 18, 2022 • edited

Choose a reason for hiding this comment

flotwig left a 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

tbiethman left a comment

Choose a reason for hiding this comment

sainthkh commented Apr 18, 2022

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

Choose a reason for hiding this comment

emilyrohrbough commented Apr 19, 2022

sainthkh commented Mar 14, 2022 •

edited

sainthkh Mar 18, 2022 •

edited