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

fix(event-construction): use CustomEvent constructor #6247

Closed
wants to merge 1 commit into from

Conversation

w0wka91
Copy link
Contributor

@w0wka91 w0wka91 commented Jan 27, 2020

User facing changelog

Additional details

How has the user experience changed?

PR Tasks

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Jan 27, 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.

@w0wka91 w0wka91 changed the title WIP: fix(event-construction): use CustomEvent constructor fix(event-construction): use CustomEvent constructor Jan 27, 2020
@w0wka91
Copy link
Contributor Author

w0wka91 commented Jan 27, 2020

It looks like the constructor that was used before to create custom events(e.g. KeyboardEvent) is not supported/available in all browsers:
event = new win['Event'](eventType, eventOptions)
So I replaced this with the CustomEvent constructor which is supported by all major browsers except IE.

@flotwig flotwig requested a review from kuceb January 27, 2020 17:46
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've manually confirmed that this does solve the original issue.

We will need a test to cover this change. A test that fails without this change and now passes with this change. Can you add this?

Keyboard tests can be found here: https://github.com/cypress-io/cypress/blob/develop/packages/driver/test/cypress/integration/e2e/keyboard_spec.coffee#L4:L4

To run the tests:

  • within cypress root, run npm i
  • cd to cypress/packages/runner and run npm watch
  • cd to cypress/packages/driver and run cypress open
  • click on the test you're writing to run it within Cypress

Instructions for running the driver tests can always be found here: https://github.com/cypress-io/cypress/blob/develop/packages/driver/README.md

@kuceb
Copy link
Contributor

kuceb commented Jan 29, 2020

I don't see why we can't use the Event constructor. and notice the win is the AUT iframe Window, which is the correct context, whereas CustomEvent here is the spec iframe. I think #6125 needs a different fix, since this worked in 3.4.1 while using the Event constructor. Closing this for now

@kuceb kuceb closed this Jan 29, 2020
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.

Cannot read property 'indexOf' of undefined when using .type()
3 participants