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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Decaff driver part 4 #7227

Merged
merged 3 commits into from May 8, 2020
Merged

Conversation

sainthkh
Copy link
Contributor

@sainthkh sainthkh commented May 5, 2020

Part of #2690

Now no CoffeeScript file in driver/src! 馃帄

NEVER SQUASH THIS PR

@cypress-bot
Copy link
Contributor

cypress-bot bot commented May 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鈥檚 intended functionality in the best way possible.

Internal

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

@sainthkh sainthkh marked this pull request as ready for review May 6, 2020 05:46
@sainthkh
Copy link
Contributor Author

sainthkh commented May 6, 2020

Flaky failure.

@chrisbreiding
Copy link
Contributor

chrisbreiding commented May 6, 2020

In regards to error_messages.js, I think it's less than ideal that has to be left-aligned in order to get the proper whitespace. That鈥檚 an area where CoffeeScript is superior because it allows you to indent to align with the code, but strips out unnecessary whitespace in an intuitive way.

I wonder if we can pass these strings to a function or use a tagged template for them that can do something similar. Since tagged templates don鈥檛 have CoffeeScript鈥檚 benefit of being executed at compile-time, they can鈥檛 know the correct level of indentation to strip. I think we might need to just use a function and pass in the level of indentation, which isn鈥檛 the best, but it鈥檚 better than left-aligning everything in my opinion.

So it might look something like:

{
  command: {
    some_error: s(3, `
      You made a grievous error.

      I can't believe you've done this.
    `)
  }
}

We pass 3 because it鈥檚 3 levels of indentation (6 spaces) in. It can also strip the opening and closing newline and extra whitespace, so we don鈥檛 need the backslashes, and the string ends up like this:

You made a grievous error.\n\nI can't believe you've done this.

@flotwig
Copy link
Contributor

flotwig commented May 6, 2020

We use common-tags stripIndent elsewhere:

const failedDownload = {
description: 'The Cypress App could not be downloaded.',
solution: stripIndent`
Does your workplace require a proxy to be used to access the Internet? If so, you must configure the HTTP_PROXY environment variable before downloading Cypress. Read more: https://on.cypress.io/proxy-configuration
Otherwise, please check network connectivity and try again:`,
}

@chrisbreiding
Copy link
Contributor

Nice! That's probably what we should use here. This seems like a big caveat for our use-case here though:

Important note: this tag will not indent multiline strings coming from the substitutions. If you want that behavior, use the html tag (aliases: source, codeBlock).

Some error message substitute in other error messages, which could be multiline. I wonder if there's any reason not to just always use the html tag (and alias it as stripIndent or something).

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.

@sainthkh Feel free to move out the error_messages.coffee conversion from this PR if it's easier, since we want more changes and review on that specific file. I can approve everything else otherwise.

There are some conflicts now since we merged in a big feature.

@sainthkh sainthkh marked this pull request as draft May 7, 2020 09:47
@sainthkh sainthkh marked this pull request as ready for review May 7, 2020 11:08
@sainthkh
Copy link
Contributor Author

sainthkh commented May 7, 2020

  • Flaky failure.
  • Removed error_message.coffee from the decaff list.
  • Fixed conflicts.

@jennifer-shehane
Copy link
Member

oh no, more conflicts 馃う鈥嶁檧锔

@sainthkh
Copy link
Contributor Author

sainthkh commented May 8, 2020

  • Merge conflicts.
  • Flaky failures.

@jennifer-shehane jennifer-shehane merged commit c5d7da6 into cypress-io:develop May 8, 2020
@cypress-bot
Copy link
Contributor

cypress-bot bot commented May 20, 2020

Released in 4.6.0.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v4.6.0, please open a new issue.

@cypress-bot cypress-bot bot locked as resolved and limited conversation to collaborators May 20, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants