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

Remove strict cookie validation from cookie commands #5957

Merged
merged 5 commits into from
Dec 16, 2019

Conversation

flotwig
Copy link
Contributor

@flotwig flotwig commented Dec 13, 2019

User facing changelog

  • The strict cookie validation added in 3.5.0 for cy.setCookie, cy.clearCookie, and cy.getCookie has been removed.

Additional details

  • added error wrapping for the automation errors, since they are more likely now

How has the user experience changed?

Users will now get the browser's error message and won't be subject to the overly strict strict-cookie-parser rules

PR Tasks

  • Have tests been added/updated?
  • Has the original issue been tagged with a release in ZenHub?

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Dec 13, 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.

@cypress
Copy link

cypress bot commented Dec 13, 2019



Test summary

3584 0 47 0


Run details

Project cypress
Status Passed
Commit 6b239e7
Started Dec 13, 2019 10:44 PM
Ended Dec 13, 2019 10:49 PM
Duration 04:34 💡
OS Linux Debian - 9.11
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

@flotwig flotwig requested a review from a team December 13, 2019 19:01
Copy link
Member

@brian-mann brian-mann left a comment

Choose a reason for hiding this comment

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

I see we previously validated getCookie, setCookie, and clearCookie - and that we wrap the error but this error message is never tested.

Can we write a driver test or e2e test that actually causes this to fail - so we can provide a good error experience? For instance, in the old extension API's - when chrome would fail to set a cookie it would provide a virtually useless error.

@flotwig
Copy link
Contributor Author

flotwig commented Dec 13, 2019

I see we previously validated getCookie, setCookie, and clearCookie - and that we wrap the error but this error message is never tested.

Can we write a driver test or e2e test that actually causes this to fail - so we can provide a good error experience? For instance, in the old extension API's - when chrome would fail to set a cookie it would provide a virtually useless error.

@brian-mann There is such a test for setCookie:

context "when setting an invalid cookie", ->
it "throws an error if the backend responds with an error", (done) ->
cy.on "fail", (err) =>
expect(errStub).to.be.calledOnce
expect(err.message).to.contain('unexpected error setting the requested cookie')
done()
errStub = cy.stub(Cypress.utils, "throwErrByPath")
errStub.callThrough()
## browser backend should yell since this is invalid
cy.setCookie("foo", " bar")

The error looks like this:

image

I'll apply similar wrapping to the other cookie commands.

@flotwig flotwig requested review from brian-mann and a team December 13, 2019 21:59
@flotwig flotwig merged commit bb7252b into develop Dec 16, 2019
@flotwig flotwig deleted the issue-5642-setcookie-parse-error branch January 24, 2022 18:19
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.

setCookie() can't save object anymore
2 participants