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

Blocks: Cookie Consent: Hide the consent banner client-side when the user has dismissed it. #36815

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

dd32
Copy link
Member

@dd32 dd32 commented Apr 10, 2024

Fixes #36814

Proposed changes:

  • Hide the cookie consent block at render time, if the cookie is set.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

  • Go to '..'
Copy link
Contributor

github-actions bot commented Apr 10, 2024

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the fix/blocks/cookie-consent-dismiss branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack fix/blocks/cookie-consent-dismiss
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2
@github-actions github-actions bot added [Block] Cookie Consent [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Apr 10, 2024
Copy link
Contributor

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • 🔴 Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • 🔴 Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


🔴 Action required: Please add missing changelog entries for the following projects: projects/plugins/jetpack

Use the Jetpack CLI tool to generate changelog entries by running the following command: jetpack changelog add.
Guidelines: /docs/writing-a-good-changelog-entry.md


Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for May 7, 2024 (scheduled code freeze on April 29, 2024).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Apr 10, 2024
@dd32 dd32 requested a review from jeherve April 10, 2024 04:37
Copy link
Member

@jeherve jeherve left a comment

Choose a reason for hiding this comment

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

Of note for anyone else reviewing this:

#36814 (comment)


Related: #29831

I wonder if we could find a more generic way to fix this problem. I believe WP Super Cache has something similar with wp_cache_get_cookies_values, but @donnchawp will know a lot more and may have a better idea on how to fix this for everyone.

@dd32
Copy link
Member Author

dd32 commented Apr 11, 2024

Here's an example of a nginx caching that would not work with the existing setup:
https://www.linode.com/docs/guides/how-to-use-nginx-fastcgi-page-cache-with-wordpress/

Specifically; That the $skip_cache is only triggered by specific cookies, and that any other cookies set don't vary the cache key (fastcgi_cache_key) because that would be unwanted in general (You don't want a client being able to trigger the server to cache a million clones of the same page)

In this case, the caching that's problematic was some generic Enable nginx caching function in a cpanel.

Copy link
Contributor

This PR has been marked as stale. This happened because:

  • It has been inactive for the past 3 months.
  • It hasn’t been labeled `[Pri] BLOCKER`, `[Pri] High`, etc.

If this PR is still useful, please do a [trunk merge or rebase](https://github.com/Automattic/jetpack/blob/trunk/docs/git-workflow.md#keeping-your-branch-up-to-date) and otherwise make sure it's up to date and has clear testing instructions. You may also want to ping possible reviewers in case they've forgotten about it. Please close this PR if you think it's not valid anymore — if you do, please add a brief explanation.

If the PR is not updated (or at least commented on) in another month, it will be automatically closed.

@donnchawp
Copy link
Contributor

So, the issue is that the cookie banner flashes if it's used on a cached page, and has already been clicked through?

Batcache and WPSC come from a time when hardly any cookies were used, but now almost every page has a first party cookie once a cookie banner is clicked. For the Page Cache in Jetpack Boost we decided to just add the entire COOKIE array to the cache key and be done with it.

For WPSC, you can use the wpsc_add_cookie action to add a new cookie to the cache key used by WPSC. Call it once. No need to call it on every request. There's also a wpsc_delete_cookie action. See the docs.

do_action( 'wpsc_add_cookie', 'eucookielaw' );
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Cookie Consent [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you!
3 participants