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

Update Never Cache Cookies textarea description to explain partial matches are allowed #3334

Closed
alfonso100 opened this issue Nov 20, 2020 · 4 comments · Fixed by #3457
Closed
Assignees
Labels
effort: [XS] < 1 day of estimated development time Module: dashboard priority: low Issues that can wait type: enhancement Improvements that slightly enhance existing functionality and are fast to implement
Milestone

Comments

@alfonso100
Copy link
Contributor

alfonso100 commented Nov 20, 2020

Is your feature request related to a problem? Please describe.
Our Never Cache Cookies exclusion box accepts a partial match, so adding wp_woocommerce_session_ will also exclude any cookie including that string on its name, like in the case of tokenized cookies, ie: wp_woocommerce_session_[TOKEN]

This is not clearly documented and it might lead users to understand the cookie match has to be literal.

Describe the solution you'd like

  • Update the field description to let users know that a partial match is allowed: "Partial matches are allowed"
  • Create a DOC about Never Cache Cookies, explaining its usage, documenting the possibility of using partial matches. and linked from UI like in other exclusion boxes with the "More Info" links: https://jmp.sh/ZcUiRfo

Additional context
On this doc we already recommend the usage of a partial match to exclude yith_wcwl_session_ type cookies.

On this issue: #1358 we are requesting the usage of wildcards, and it could lead users to think that any cookie exclusion has to be literal.

Example ticket:
https://secure.helpscout.net/conversation/1341907384/213435/

Suggested update to the help text (#3334 (comment)): Specify full or partial IDs of cookies that, when set in the visitor's browser, should prevent a page from getting cached (one per line). More info

@Tabrisrp Tabrisrp added Module: dashboard needs: grooming type: enhancement Improvements that slightly enhance existing functionality and are fast to implement labels Nov 20, 2020
@arunbasillal arunbasillal added the priority: low Issues that can wait label Nov 23, 2020
@arunbasillal
Copy link
Contributor

Current help text: Specify the IDs of cookies that, when set in the visitor's browser, should prevent a page from getting cached (one per line)

Suggested update: Specify full or partial IDs of cookies that, when set in the visitor's browser, should prevent a page from getting cached (one per line)

@webtrainingwheels What do you think? Also, do you think creating a doc is feasible for this?

@webtrainingwheels
Copy link

@arunbasillal Looks good! And yes, we can do a doc!

@arunbasillal arunbasillal added needs: documentation Issues which need to create or update a documentation and removed waiting for feedback labels Nov 24, 2020
@Tabrisrp
Copy link
Contributor

Scope a solution ✅

Update the helper text for the never cache cookie field in Engine/Admin/Settings/Page::advanced_cache_section()

Estimate the effort ✅

Effort [XS]

@Tabrisrp Tabrisrp added effort: [XS] < 1 day of estimated development time and removed needs: grooming labels Dec 16, 2020
@arunbasillal arunbasillal added this to the 3.8.2 milestone Dec 21, 2020
@webtrainingwheels
Copy link

@Tabrisrp This will be the doc url: https://docs.wp-rocket.me/article/1382-never-cache-cookies (it will be published by release time)
And article ID: 5fe5462df24ccf588e3fe804

@engahmeds3ed engahmeds3ed self-assigned this Dec 31, 2020
@piotrbak piotrbak linked a pull request Dec 31, 2020 that will close this issue
@Tabrisrp Tabrisrp closed this as completed Jan 4, 2021
@Tabrisrp Tabrisrp removed the needs: documentation Issues which need to create or update a documentation label Jan 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort: [XS] < 1 day of estimated development time Module: dashboard priority: low Issues that can wait type: enhancement Improvements that slightly enhance existing functionality and are fast to implement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants