User Story
Update QuickSurvey Initiation to collect editCountBucket, similar to QuickSurvey Responses, based on discussions between @TAndic @jsn.sherman @eigyan.
This will help QuickSurveys users to be able to adjust for nonresponse bias and weight data by editor type by allowing us to compare impression and response data.
(Note: T303736 deployment date will need to be decided based on effort and timeline of this task.)
Technical information
Based on conversation with Sam Smith (Readers Web), the process to do this is:
- Update the analytics/legacy/quicksurveyinitiation schema (defined in the schemas/event/secondary repository)
- Update both parts of the QS codebase that log QuickSurveyInitiation events
- Update any tests (IIRC there aren't any but we'd have to check)
- Has been started here: https://gerrit.wikimedia.org/r/c/schemas/event/secondary/+/768014/
Relevant links based on conversation with @jsn.sherman @eigyan:
we'd need to update logInitialized
https://gerrit.wikimedia.org/r/plugins/gitiles/mediawiki/extensions/QuickSurveys/+/refs[…]er/resources/ext.quicksurveys.lib/vue/QuickSurveyLogger.js
as well as the schema
https://meta.wikimedia.org/wiki/Schema:QuickSurveyInitiation
actual schema file
https://gerrit.wikimedia.org/r/plugins/gitiles/schemas/event/secondary/+/refs/heads/mas[…]onschema/analytics/legacy/quicksurveyinitiation/1.0.0.yaml
you can see where editcount bucket lives in the response schema
https://gerrit.wikimedia.org/r/plugins/gitiles/schemas/event/secondary/+/refs/heads/mas[…]onschema/analytics/legacy/quicksurveysresponses/1.0.0.yaml
Testing and QA steps
- TBD e.g. beta cluster
- In the developer console, under the NETWORK tab, locate the events request and validate that the userEditCountBucket exist in the Request Payload
- Validate new editCount bucket is being capture in data farm.
Acceptance Criteria
- QuickSurvey initiation (impressions) collect editCountBucket.
