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

Quote strings in DEBUG logs for easier reading #6700

Merged
merged 3 commits into from Mar 11, 2020

Conversation

jennifer-shehane
Copy link
Member

@jennifer-shehane jennifer-shehane commented Mar 11, 2020

So, I was looking at logs #6669 from the cypress:launcher trying to figure out why we weren’t detecting someones browser and just see the below.

I thought that Running without a11y support was some kind of log from Cypress talking about a11y? I dunno. This was confusing and would have been clearer to distinguish Cypress logs from the actual strings we found with quotation marks in the DEBUG logs like below:

Before

cypress:launcher stdout: Running without a11y support!
Mozilla Firefox 68.5.0esr +75ms
cypress:launcher Could not extract version from Running without a11y support!
Mozilla Firefox 68.5.0esr using regex /^Mozilla Firefox ([^\sab]+)$/ +1ms

After

cypress:launcher stdout: “Running without a11y support!
Mozilla Firefox 68.5.0esr” +75ms
cypress:launcher Could not extract version from stdout using regex: {
  stdout: Running without a11y support! Mozilla Firefox 68.5.0esr,
  versionRegex: /^Mozilla Firefox ([^\sab]+)$/ 
} +1ms

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Mar 11, 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.

@cypress
Copy link

cypress bot commented Mar 11, 2020



Test summary

6966 0 97 0


Run details

Project cypress
Status Passed
Commit d06d8e1
Started Mar 11, 2020 3:22 PM
Ended Mar 11, 2020 3:29 PM
Duration 06:48 💡
OS Linux Debian - 10.0
Browser Multiple

View run in Cypress Dashboard ➡️


This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

bahmutov
bahmutov previously approved these changes Mar 11, 2020
Copy link
Contributor

@bahmutov bahmutov left a comment

Choose a reason for hiding this comment

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

super, makes sense

flotwig
flotwig previously approved these changes Mar 11, 2020
Comment on lines 20 to 22
'Could not extract version from %s using regex %s',
'Could not extract version from "%s" using regex %s',
stdout,
versionRegex,
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm more partial to using the object notation for things like this, since it will include the variable names and ensure strings are quoted correctly:

Suggested change
'Could not extract version from %s using regex %s',
'Could not extract version from "%s" using regex %s',
stdout,
versionRegex,
'Could not extract version from stdout %o', { stdout, versionRegex },

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated with object

@jennifer-shehane jennifer-shehane dismissed stale reviews from flotwig and bahmutov via d06d8e1 March 11, 2020 15:17
@jennifer-shehane jennifer-shehane merged commit ec027e9 into develop Mar 11, 2020
@cypress-bot
Copy link
Contributor

cypress-bot bot commented Mar 16, 2020

Released in 4.2.0.

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

@cypress-bot cypress-bot bot locked as resolved and limited conversation to collaborators Mar 16, 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

3 participants