Page MenuHomePhabricator
Create Task
Maniphest T296477

Log when the user sees and bounces from the terms of use agreement in the infobox
Closed, ResolvedPublic3 Estimated Story Points
Actions

Assigned To
STran
Authored By
phuedx
Nov 25 2021, 12:48 PM
Tags
Referenced Files
F35020580: Screen Shot 2022-03-22 at 5.22.01 PM.png
Mar 23 2022, 2:41 AM
F35020576: Screen Shot 2022-03-22 at 5.12.10 PM.png
Mar 23 2022, 2:41 AM
F35020575: Screen Shot 2022-03-22 at 5.21.47 PM.png
Mar 23 2022, 2:41 AM
F35020202: t296477_1.png
Mar 22 2022, 5:37 PM
F35020209: t296477_2.png
Mar 22 2022, 5:37 PM
F35014957: Screen Shot 2022-03-21 at 10.18.35 PM.png
Mar 22 2022, 2:36 AM
F35014955: Screen Shot 2022-03-21 at 10.29.27 PM.png
Mar 22 2022, 2:36 AM
F35014908: Screen Shot 2022-03-21 at 9.23.48 PM.png
Mar 22 2022, 1:33 AM
Subscribers
• AGueyte
Aklapper
dom_walden
• imaigwilo
jwang
Niharika
phuedx
• wikitrent

Description

Background

Following on from T296415: Basic ipinfo instrument setup and first events, we'd like to know how many users see the terms of use agreement infobox treatment and bounce from it.

AC
  • When I sees the terms of use agreement infobox treatment, an event should be logged
    • The event_action property should be "init_disclaimer"
  • When I have seen the terms of use agreement infobox treatment and accept the terms of the disclaimer
    • The event_action property should be "accept_disclaimer"
  • When I have seen the terms of use agreement infobox treatment and I close the browser tab/window before accepting the agreement, an event should be logged
    • The event_action property should be "close_disclaimer"
Notes
  1. At the time of writing, the user will only see the terms of use agreement infobox treatment when:
    • They have enabled IP Info via Special:Preferences; and
    • They navigate to /wiki/Special:Contributions/$ip
  2. For performance reasons, listen for the beforeunload event (not the unload event)
  3. wt:Event Platform/Instrumentation How To is a step-by-step guide to creating a creating a schema and validating an event with it
  4. https://www.mediawiki.org/wiki/MediaWiki-Docker/Configuration_recipes/EventLogging is a step-by-step guide to setting up your local development environment

Details

SubjectRepoBranchLines +/-
Add event logging for user interactions with use agreementmediawiki/extensions/IPInfomaster+52 -18
Customize query in gerrit

Related Objects
Search...

Event Timeline

phuedx created this task.Nov 25 2021, 12:48 PM
phuedx updated the task description. (Show Details)Nov 25 2021, 12:51 PM
phuedx edited parent tasks, added: T292803: IP Info: Explore Instrumentation; removed: T296415: Basic ipinfo instrument setup and first events.
phuedx added a subtask: T296415: Basic ipinfo instrument setup and first events.
phuedx moved this task from Untriaged to Analytics on the Anti-Harassment board.Nov 25 2021, 2:56 PM
phuedx moved this task from Analytics to Pre-estimation/Triage on the Anti-Harassment board.Nov 25 2021, 3:03 PM
phuedx assigned this task to Niharika.Dec 1 2021, 5:54 AM

Per yesterday's AHT Estimation meeting, @Niharika will confirm with @jwang whether we intend to count unique users (and therefore send a unique token to deduplicate users during analysis).

jwang added a comment.Dec 4 2021, 12:28 AM

@Niharika, counting unique users is to answer below measurement questions (also mentioned in T292803). If below reframed measurement questions are OK to you, a unique token is enough for us.

Original measurement questionsNew measurement questions
How many people see the disclaimer ?How many times people see the disclaimer?
How many people accept the terms of the disclaimer ?How many times people accept the terms of the disclaimer?
How many people churn away ?How many times people churn away?
• wikitrent subscribed.Dec 7 2021, 7:22 PM

@Niharika just to confirm, we are counting how many users open the agreement and then bounce WITHOUT accepting the terms?

• wikitrent added a comment.Dec 7 2021, 7:29 PM

@phuedx should we be using Wikimedia Events or hard code an mw-track event?

phuedx updated the task description. (Show Details)Dec 8 2021, 10:18 AM
phuedx added a comment.Dec 8 2021, 10:22 AM
In T296477#7553989, @wikitrent wrote:

@Niharika just to confirm, we are counting how many users open the agreement and then bounce WITHOUT accepting the terms?

For some reason, I thought that this question was addressed to me and clarified the task description (the answer is yes). Sorry, @Niharika!

phuedx added a comment.Dec 8 2021, 10:26 AM
In T296477#7554033, @wikitrent wrote:

@phuedx should we be using Wikimedia Events or hard code an mw-track event?

Let's discuss this in today's AHT Engineering Meeting meeting.

• AGueyte updated the task description. (Show Details)Dec 21 2021, 7:50 PM
• AGueyte subscribed.Dec 21 2021, 7:57 PM

Hi @phuedx, what is the best practice for using the salt and hash here?
Thank you!

phuedx updated the task description. (Show Details)Jan 4 2022, 1:54 PM
phuedx removed Niharika as the assignee of this task.Jan 4 2022, 2:57 PM
In T296477#7584057, @AGueyte wrote:

Hi @phuedx, what is the best practice for using the salt and hash here?

Thanks for the question, @AGueyte. @Niharika confirmed out-of-band that we wouldn't be recording the number of unique users performing any of the actions in the task description so we won't need to salt and hash the user ID in this instance. I've updated the task description accordingly.

Regardless, see https://gerrit.wikimedia.org/g/mediawiki/extensions/WikimediaEvents/+/6a0d947efa2a5183f89159e36610f815c13439fa/includes/VectorPrefDiffInstrumentation.php#163 for an example salting and hashing the user ID in PHP.

• TThoabala moved this task from Pre-estimation/Triage to Triage/To be Estimated on the Anti-Harassment board.Jan 10 2022, 5:12 PM
ARamirez_WMF renamed this task from Log when the user sees and bounces from the terms of use agreement in the infobox to Log when the user sees and bounces from the terms of use agreement in the infobox [M].Jan 11 2022, 5:07 PM
ARamirez_WMF moved this task from Triage/To be Estimated to Cards ready for development on the Anti-Harassment board.
Tchanders edited projects, added Anti-Harassment (The Letter Song); removed Anti-Harassment.Jan 12 2022, 3:48 AM
Tchanders moved this task from Ready 🎬 (ONLY IF YOU HAVE NO MORE CODE TO REVIEW) to Blocked/Stalled 🚧 on the Anti-Harassment (The Letter Song) board.Jan 12 2022, 3:52 AM
phuedx updated the task description. (Show Details)Jan 13 2022, 11:59 AM
ARamirez_WMF moved this task from The Letter Song to Blocked/Stalled on the Anti-Harassment board.Feb 8 2022, 4:45 PM
ARamirez_WMF edited projects, added Anti-Harassment; removed Anti-Harassment (The Letter Song).
ARamirez_WMF renamed this task from Log when the user sees and bounces from the terms of use agreement in the infobox [M] to Log when the user sees and bounces from the terms of use agreement in the infobox.Feb 15 2022, 6:50 PM
ARamirez_WMF set the point value for this task to 3.
Tchanders edited projects, added Anti-Harassment (AHaT Sprint 2: The Pork Pie); removed Anti-Harassment.Mar 3 2022, 10:04 PM
ARamirez_WMF edited projects, added Anti-Harassment (AHaT Sprint 3: Lady Dimitrescu); removed Anti-Harassment (AHaT Sprint 2: The Pork Pie).Mar 7 2022, 7:35 PM
STran claimed this task.Mar 9 2022, 12:16 AM
STran moved this task from Ready 🎬 (ONLY IF YOU HAVE NO MORE CODE TO REVIEW) to In Progress 💪 on the Anti-Harassment (AHaT Sprint 3: Lady Dimitrescu) board.Mar 9 2022, 5:27 AM
gerritbot added a comment.Mar 9 2022, 6:12 AM

Change 769274 had a related patch set uploaded (by STran; author: STran):

[mediawiki/extensions/IPInfo@master] Add event logging for user interactions with use agreement

https://gerrit.wikimedia.org/r/769274

gerritbot added a project: Patch-For-Review.Mar 9 2022, 6:12 AM
STran moved this task from In Progress 💪 to Code Review 🔍 on the Anti-Harassment (AHaT Sprint 3: Lady Dimitrescu) board.Mar 9 2022, 6:19 AM
• AGueyte moved this task from Code Review 🔍 to QA/Testing 🐞 on the Anti-Harassment (AHaT Sprint 3: Lady Dimitrescu) board.Mar 11 2022, 5:53 PM
gerritbot added a comment.Mar 11 2022, 5:56 PM

Change 769274 merged by jenkins-bot:

[mediawiki/extensions/IPInfo@master] Add event logging for user interactions with use agreement

https://gerrit.wikimedia.org/r/769274

ReleaseTaggerBot added a project: MW-1.38-notes (1.38.0-wmf.26; 2022-03-14).Mar 11 2022, 6:00 PM
Maintenance_bot removed a project: Patch-For-Review.Mar 11 2022, 6:10 PM
STran mentioned this in T296472: Log when a user enables/disables IP Info.Mar 15 2022, 8:41 AM
• imaigwilo subscribed.Mar 22 2022, 1:33 AM

I have tried several times and the disclaimer event is not showing. Here is what I see on beta

Screen Shot 2022-03-21 at 9.23.48 PM.png (1×2 px, 558 KB)

@STran I checked on local box and beta.

STran added a comment.Mar 22 2022, 1:47 AM

If you check Preserve Log do you see it? The event is triggered on the page as you leave it they won't be there if you check the logs on the new page unless you explicitly preserved them. Additionally, this is only from the infobox on Special:Contributions. You can make the form appear by only checking the first checkbox "Show the IP Information tool on Special:Contributions page for IP addresses." from Special:Preferences.

• imaigwilo added a comment.Mar 22 2022, 2:36 AM

@STran I checked preserve log, did as above. I didn't see those disclaimer events listed in the task acceptance criteria. I do see something called page views. Not sure if this is a different naming convention for the disclaimer events?

Screen Shot 2022-03-21 at 10.29.27 PM.png (1×2 px, 832 KB)

However I do see in my local the logs for enable/disable access
Screen Shot 2022-03-21 at 10.18.35 PM.png (1×2 px, 611 KB)

ARamirez_WMF edited projects, added Anti-Harassment (AHaT Sprint 4: The Stetson); removed MW-1.38-notes (1.38.0-wmf.26; 2022-03-14), Anti-Harassment (AHaT Sprint 3: Lady Dimitrescu), IP Info.Mar 22 2022, 4:57 PM
ARamirez_WMF moved this task from Ready 🎬 (ONLY IF YOU HAVE NO MORE CODE TO REVIEW) to QA/Testing 🐞 on the Anti-Harassment (AHaT Sprint 4: The Stetson) board.Mar 22 2022, 5:04 PM
ARamirez_WMF added projects: IP Info, MW-1.38-notes (1.38.0-wmf.26; 2022-03-14).
dom_walden subscribed.Mar 22 2022, 5:37 PM

How I got this to work on beta:

  1. Go to Special:Preferences (e.g. https://en.wikipedia.beta.wmflabs.org/wiki/Special:Preferences)
  2. Make sure that Show the IP Information tool on Special:Contributions page for IP addresses is checked and I agree to use this information for my patrolling and anti-vandalism work is unchecked. If not, make the appropriate changes to those inputs in the form and submit.
    t296477_1.png (106×623 px, 13 KB)
  3. Go to Special:Contributions for an IP (e.g. https://en.wikipedia.beta.wmflabs.org/wiki/Special:Contributions/81.187.41.249)
  4. Open the browser's network
  5. Check I agree to use this information for my patrolling and anti-vandalism work and click the submit button.
    t296477_2.png (212×1 px, 25 KB)

At this point I saw 3 requests to https://intake-analytics.wikimedia.beta.wmflabs.org/v1/events. One of them had the event init_disclaimer and another had the event accept_disclaimer. (The third was unrelated.)

• imaigwilo added a comment.Mar 23 2022, 2:41 AM

The event loads for me. Thanks @Tran and @dom_walden for your help.

Screen Shot 2022-03-22 at 5.21.47 PM.png (1×2 px, 549 KB)

Screen Shot 2022-03-22 at 5.12.10 PM.png (1×2 px, 571 KB)

Screen Shot 2022-03-22 at 5.22.01 PM.png (1×2 px, 556 KB)

• imaigwilo moved this task from QA/Testing 🐞 to Done Q3 2022 on the Anti-Harassment (AHaT Sprint 4: The Stetson) board.Mar 23 2022, 2:42 AM
Niharika closed subtask T296415: Basic ipinfo instrument setup and first events as Resolved.Apr 8 2022, 10:41 PM
Niharika closed this task as Resolved.Apr 12 2022, 12:45 AM
Niharika moved this task from Backlog to Closed on the IP Info board.Aug 8 2022, 7:58 PM
jwang mentioned this in T313340: Analyse IP Info metrics.Sep 1 2022, 4:26 AM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL