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

Detect consent managers on the selected site and show a setup link #19794

Merged
merged 3 commits into from Sep 30, 2022

Conversation

bx80
Copy link
Contributor

@bx80 bx80 commented Sep 29, 2022

Description:

This PR adds a new 'challenge' to the 'Become a Matomo Expert' widget which is part of the Tour plugin. It will check for popular consent managers installed on the currently selected site and if detected will show a link to an FAQ showing how to integrate them with Matomo. Additionally it will check to see if the integration code is present on the website and if so automatically mark the challenge as complete.

A bit more detail:

When the Challenge object is constructed it will perform a simple cURL request to grab the current site main URL into a string and then check this against a known list of consent manager identifiers.

There are three possible outcomes:

  • No consent manager is detected on the website - if this happens the challenge constructor will use the new Challenge::isDisabled() method to disable itself and it will not be shown on the widget.
  • A consent manager is detected, but no integration code was detected - the challenge will be shown on the widget as uncompleted.
  • A consent manager is detected and the integration code is detected - the challenge will be shown on the widget as completed.

The known consent managers are stored in a assoc array with detection strings and the URL for the guide, this can easily be extended in the future to cover more consent managers.

Currently supported: Osano, Cookiebot, CookieYes, Tarte au Citron, Klaro and Complianz GDPR for WordPress.

The linked guides are not public yet, but the included URLs will point to the correct location when they published.

One issue to consider is that this will cause a page load hit to the tracked website every time the widget is loaded. We could possibly soften this by adding a 'last checked' timestamp somewhere to ensure that we never check more frequently than say every 5 minutes. Another tweak could be to set the last checked timestamp a week(?) into the future if either no consent manager is detected or the consent manager is detected and is connected. Additionally we might want the cURL page load to use a user agent that avoids tracking or at least identifies as a robot of some sort.

Thoughts on this much appreciated!

Ref: DEV-3004

Review

@bx80 bx80 added Enhancement For new feature suggestions that for example enhance Matomo's cabapilities.. Needs Review For pull requests that need a code review. labels Sep 29, 2022
@bx80 bx80 added this to the 4.12.0 milestone Sep 29, 2022
@bx80 bx80 self-assigned this Sep 29, 2022
Copy link
Contributor

@justinvelluppillai justinvelluppillai left a comment

Choose a reason for hiding this comment

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

Do we need to handle failing outbound http requests? Maybe simply try catching the Http::sendHttpRequestBy call would be sufficient as there's not overly harm in false negatives, or unnecessary?

@justinvelluppillai justinvelluppillai removed the Needs Review For pull requests that need a code review. label Sep 30, 2022
@bx80
Copy link
Contributor Author

bx80 commented Sep 30, 2022

Makes sense 👍 I've added handling for any exceptions thrown by the Http class method.

Copy link
Contributor

@peterhashair peterhashair left a comment

Choose a reason for hiding this comment

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

test coupe consent manager works as expected. The actual link is not published yet, once we merge this PR and FAQ published. Maybe should test the links.

@bx80 bx80 merged commit 378c193 into next_release Sep 30, 2022
@bx80 bx80 deleted the detect-consent-manager branch September 30, 2022 18:13
justinvelluppillai added a commit that referenced this pull request Oct 2, 2022
justinvelluppillai added a commit that referenced this pull request Oct 2, 2022
@justinvelluppillai justinvelluppillai restored the detect-consent-manager branch October 2, 2022 19:35
@bx80 bx80 mentioned this pull request Oct 6, 2022
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement For new feature suggestions that for example enhance Matomo's cabapilities..
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants