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.

Sign up for GitHub

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

Jump to bottom

Have cy.request support urls with specials Unicodes chars #5813

Merged
merged 8 commits into from
Dec 11, 2019
Merged

Have cy.request support urls with specials Unicodes chars #5813

merged 8 commits into from
Dec 11, 2019

Conversation

avallete
Copy link
Contributor

@avallete avallete commented Nov 27, 2019 •
edited by flotwig

User facing changelog

  • cy.request will now automatically encode special characters in the request URL, including Unicode.

Additional details

  • Providing some urls with some unicode characters (eg: ’) was throwing an ERR_UNESCAPED_CHARACTERS error.

How has the user experience changed?

Before

cy.request('https://on.cypress.io/key-differences#What-you’ll-learn') // wont work
cy.request(encodeURI('https://on.cypress.io/key-differences#What-you’ll-learn')) // work

After

cy.request('https://on.cypress.io/key-differences#What-you’ll-learn') // work
cy.request(encodeURI('https://on.cypress.io/key-differences#What-you’ll-learn')) // work

PR Tasks

  • Have tests been added/updated?
  • Has the original issue been tagged with a release in ZenHub?
  • [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?

@avallete
test(pkg/driver): url with unicode characters into .request command
9280333
@avallete
fix(pkg/driver): unicode character escaping in url for .request command
4b8e583 
Use encodeURI inside `cy.request` to make sure the url does not contain
any unescaped Unicode character.

Fixes cypress-io#5274
@cypress-bot
Copy link
Contributor

cypress-bot bot commented Nov 27, 2019

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.

@jennifer-shehane jennifer-shehane changed the title Issue 5274 Have cy.request support urls with specials Unicodes chars Nov 29, 2019
@jennifer-shehane jennifer-shehane requested a review from a team November 29, 2019 05:51
@flotwig flotwig self-requested a review December 2, 2019 16:29
flotwig
flotwig suggested changes Dec 2, 2019
View reviewed changes
Copy link
Contributor

@flotwig flotwig left a comment

Choose a reason for hiding this comment

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

Thanks for opening this PR!

packages/driver/src/cy/commands/request.coffee Outdated Show resolved Hide resolved
packages/driver/src/cy/commands/request.coffee Outdated Show resolved Hide resolved
@avallete
Merge branch 'develop' of https://github.com/cypress-io/cypress into …
d5c3b0b 
…issue-5274
@avallete
fix(pkg/driver): unicode character escaping in url for .request command
5eca3e9 
Use `URL constructor` inside `cy.request` to make sure the url is well
encoded when for both domain and pathname.

Fixes cypress-io#5274
@avallete
Copy link
Contributor Author

avallete commented Dec 9, 2019 •
edited

After review comments, I've changed the way I deal with the URL encoding.

I've also refactored the tests to fix the issue raised by @brian-mann

@avallete avallete requested a review from flotwig December 9, 2019 00:32
flotwig
flotwig suggested changes Dec 9, 2019
View reviewed changes
Copy link
Contributor

@flotwig flotwig left a comment

Choose a reason for hiding this comment

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

Looks good, just one minor thing about how the tests are organized and then looks good.

packages/driver/test/cypress/integration/issues/5274_spec.coffee Outdated Show resolved Hide resolved
@avallete
refactor(tests): Move the tests to request_spec test file
a4f840f 
- Move the tests inside the request_spec test file instead of his own
test file to be sure it will be maintain.
- Rename some "it" test titles to semantically fit in the actual tests
naming convention.
- Remove the no more used 5274_spec.coffee test file.
@flotwig flotwig merged commit d122be5 into cypress-io:develop Dec 11, 2019
@cypress-bot cypress-bot bot mentioned this pull request Dec 11, 2019
Closed
@flotwig flotwig mentioned this pull request Dec 11, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@flotwig flotwig flotwig approved these changes

@brian-mann brian-mann brian-mann requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

cy.request() errors when URL's path contains ’ character
3 participants
@avallete @flotwig @brian-mann