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 CDP cookie matching algorithm #5862

Merged
merged 5 commits into from
Dec 6, 2019

Conversation

flotwig
Copy link
Contributor

@flotwig flotwig commented Dec 3, 2019

User facing changelog

Fixed a bug where cy.getCookie would incorrectly filter cookies by their domain, leading to unexpected results.

Additional details

  • previously, we were using tough.cookieMatch to filter cookies:
    const cookieMatches = (cookie: CyCookie, data) => {
    if (data.domain && !tough.domainMatch(cookie.domain, data.domain)) {
    return false
    }
    if (data.path && !tough.pathMatch(cookie.path, data.path)) {
    return false
    }
    if (data.name && data.name !== cookie.name) {
    return false
    }
    return true
    }
  • however, this is incorrect
    • Cypress was designed around the internal 'cookie filter' having the same structure as the filter for WebExtensions cookies.getAll: https://developer.chrome.com/extensions/cookies#method-getAll
    • the WebExtensions filter uses domain like this: "Restricts the retrieved cookies to those whose domains match or are subdomains of this one."
    • we were using tough.domainMatch, which matches like an actual browser, instead

How has the user experience changed?

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 3, 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 3, 2019



Test summary

3517 0 45 0


Run details

Project cypress
Status Passed
Commit bf0f50a
Started Dec 4, 2019 10:47 PM
Ended Dec 4, 2019 10:51 PM
Duration 04:28 💡
OS Linux Debian - 9.8
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 changed the title [WIP] Fix CDP cookie matching algorithm Fix CDP cookie matching algorithm Dec 3, 2019
@flotwig flotwig requested review from brian-mann and a team December 3, 2019 19:35
@@ -18,18 +17,29 @@ interface CyCookie {
httpOnly: boolean
}

// Cypress uses the webextension-style filtering
// https://developer.chrome.com/extensions/cookies#method-getAll
type CyCookieFilter = chrome.cookies.GetAllDetails
Copy link
Member

Choose a reason for hiding this comment

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

why not import the chrome types at the top vs putting them in the compilerOptions? I feel like this comes out of nowhere

Copy link
Contributor Author

Choose a reason for hiding this comment

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

if i do import 'chrome', build fails

if i do import chrome from 'chrome', it says 'chrome' is not a module

i can dig into why import 'chrome' makes the build fail if you'd like, i'm not sure this is the best way either

Copy link
Member

Choose a reason for hiding this comment

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

ask @tgriesser in #typescript channel

Copy link
Member

Choose a reason for hiding this comment

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

nvm he's on his way to the airport - @tgriesser or @thlorenz can you explain why this is necessary whenever you have time?

@flotwig flotwig merged commit 93b5c0e into develop Dec 6, 2019
avallete pushed a commit to avallete/cypress that referenced this pull request Dec 10, 2019
* use correct tough.match param order

* add chrome extension types

* fix CDP cookie matching algorithm

* improve domain suffix match

* add tests for cookie matching utils
@flotwig flotwig deleted the issue-5656-cdp-automation-domainMatch branch January 24, 2022 18:18
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.

Cypress incorrectly validates domain of cookies in 3.5.0
2 participants