Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Convert command actions tests to Javascript #6647

Closed
wants to merge 4 commits into from
Closed

[WIP] Convert command actions tests to Javascript #6647

wants to merge 4 commits into from

Conversation

clarmso
Copy link
Contributor

@clarmso clarmso commented Mar 5, 2020

This PR consists of the command actions tests from the driver package converted to Javascript from Coffeescript. The conversion has been done via the following command:

"command": "yarn decaffeinate-bulk convert --file ${file} ${file}",

I've converted the files in as few commits as possible. (bulk-decaffeinate creates commits for stages of the conversion.) Please do not squash this commit. :)

A part of #2690

User facing changelog

No user facing changelog specific to these tests should be needed.

Additional details

This PR is a part of continuous improvement in maintaining the codebase. We hope the codebase will be in Typescript. :) Javascript is an intermediate step.

I've reviewed the results of the bulk-decaffeinate command. I've ensured the following:

  • arrow functions are used if applicable. The remaining use of the function() notation is necessary. (Example: use of "this" keyword in the tests)
  • Remove unnecessary returns.
  • Remove variable declarations that are unnecessary.

How has the user experience changed?

No noticeable changes should be detected by the developers and the users. The new version of the tests should work the same as the old Coffeescript ones.

PR Tasks

  • Have tests been added/updated?
  • Ensure only decaffeinate + 1 cleanup commits are issued

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Mar 5, 2020

Thanks for the contribution! Below are some guidelines Cypress uses when doing PR reviews.

  • Please write [WIP] in the title of your Pull Request if your PR is not ready for review - someone will review your PR as soon as the [WIP] is removed.
  • Please familiarize yourself with the PR Review Checklist and feel free to make updates on your PR based on these guidelines.

PR Review Checklist

If any of the following requirements can't be met, leave a comment in the review selecting 'Request changes', otherwise 'Approve'.

User Experience

  • The feature/bugfix is self-documenting from within the product.
  • The change provides the end user with a way to fix their problem (no dead ends).

Functionality

  • The code works and performs its intended function with the correct logic.
  • Performance has been factored in (for example, the code cleans up after itself to not cause memory leaks).
  • The code guards against edge cases and invalid input and has tests to cover it.

Maintainability

  • The code is readable (too many nested 'if's are a bad sign).
  • Names used for variables, methods, etc, clearly describe their function.
  • The code is easy to understood and there are relevant comments explaining.
  • New algorithms are documented in the code with link(s) to external docs (flowcharts, w3c, chrome, firefox).
  • There are comments containing link(s) to the addressed issue (in tests and code).

Quality

  • The change does not reimplement code.
  • There's not a module from the ecosystem that should be used instead.
  • There is no redundant or duplicate code.
  • There are no irrelevant comments left in the code.
  • Tests are testing the code’s intended functionality in the best way possible.

Internal

  • The original issue has been tagged with a release in ZenHub.

@clarmso clarmso changed the title [WIP] Convert command actions tests to Javascript Convert command actions tests to Javascript Mar 5, 2020
@clarmso
Copy link
Contributor Author

clarmso commented Mar 6, 2020

The test failures from driver-integration-tests-firefox and server-e2e-tests-electron-3 does not seem to be related to this change. Please let me know if it is.

https://app.circleci.com/jobs/github/cypress-io/cypress/272830

@jennifer-shehane jennifer-shehane self-requested a review March 9, 2020 05:06
Copy link
Member

@jennifer-shehane jennifer-shehane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did not do a full review yet, but I see a lot of this calls that are within arrow functions when you noted:

The remaining use of the function() notation is necessary. (Example: use of "this" keyword in the tests)

Can you re-review all uses of this?

beforeEach(() => {
cy.on('log:added', (attrs, log) => {
if (log.get('name') === 'assert') {
this.lastLog = log
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this with arrow functions, is this maintaining the correct this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, ditto. I've tested with a cy.log(this.lastLog) in an existing test locally.

Comment on lines +296 to +301
this.logs = []

cy.on('log:added', (attrs, log) => {
this.lastLog = log

this.logs.push(log)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this with arrow functions, is this maintaining the correct this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the cy.on('fail', (err) => ... in the subsequent tests receives this.logs

@clarmso clarmso changed the title Convert command actions tests to Javascript [WIP] Convert command actions tests to Javascript Mar 11, 2020
@clarmso
Copy link
Contributor Author

clarmso commented Mar 23, 2020

I'd be happy to change the arrow functions back to function() if it's easier for everyone. Please let me know.

@jennifer-shehane
Copy link
Member

Sorry, this got out of date so quickly. You're welcome to open a new PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants