Page MenuHomePhabricator
Create Task
Maniphest T419551

Update QuickSurveys to support ReadingLists beta survey
Closed, ResolvedPublic3 Estimated Story Points
Actions

Assigned To
Sneha
Authored By
AnneT
Mar 10 2026, 3:11 PM
Project Tags
Referenced Files
F72823707: Screenshot 2026-03-12 at 4.17.27 PM.png
Mar 12 2026, 8:23 PM
F72823396: image.png
Mar 12 2026, 7:41 PM
F72823392: image.png
Mar 12 2026, 7:41 PM
F72823385: image.png
Mar 12 2026, 7:41 PM
F72052735: Saved pages (5).png
Mar 10 2026, 3:11 PM
File Not Attached
F72052728: Saved pages (4).png
Mar 10 2026, 3:11 PM
File Not Attached
F72052709: Saved pages (3).png
Mar 10 2026, 3:11 PM
File Not Attached
F72052615: New Vector (16).png
Mar 10 2026, 3:11 PM
File Not Attached
View All 9 Files
Subscribers
Aklapper
AnneT
Jdlrobson
Jdlrobson-WMF
Sneha
SToyofuku-WMF

Description

Background

The ReadingLists beta survey has a modern design to capture user satisfaction. The desired UI is not currently supported in the QuickSurveys extension.

Design requirements

Link to figma

Desktop

New Vector (17).png (1,440×773 px, 193 KB)
New Vector (16).png (1,440×773 px, 341 KB)

Mobile

Saved pages (3).png (384×773 px, 146 KB)
Saved pages (4).png (384×773 px, 145 KB)
Saved pages (5).png (384×773 px, 45 KB)

Technical requirements

We explored adding a new question type or other config property to QuickSurveys that would enable anyone to create a survey following the design spec for the ReadingLists beta survey. However, it wasn't worth refactoring QuickSurveys' UI code or styles, nor complicating its configuration.

Instead, we will:

  • Add a simple API to QuickSurveys that allows you to log a survey response from an extension
  • Build the survey UI in ReadingLists
  • Use the new API to log survey responses in ReadingLists

Prior art:

Requirements

Acceptance criteria

  • Reader Experience team agrees on how to implement this.
  • QuickSurveys exports an API to log survey responses
  • The survey in ReadingLists meets the design spec
  • When the ReadingLists survey is submitted, a survey response is logged

BDD

  • For QA engineer to fill out.

Test Steps

  • For QA engineer to fill out.

Rollback plan

Since we're just adding a simple API to QuickSurveys, there should be no risk of disrupting currently running surveys.

This task was created by Version 1.0.0 of the Reader Experience team task template using phabulous.

Details

Related Changes in Gerrit:
SubjectRepoBranchLines +/-
Add beta feature surveymediawiki/extensions/ReadingListsmaster+444 -7
Proof of concept: Simple Feedback componentmediawiki/extensions/QuickSurveysmaster+111 -9
POC: A custom UI survey that uses QuickSurveys APImediawiki/extensions/ReadingListsmaster+36 -10
Add new API for logging answers from custom survey UIsmediawiki/extensions/QuickSurveysmaster+33 -6
[PoC] Build user sentiment survey stylemediawiki/extensions/QuickSurveysmaster+289 -95
Proof of concept: Configure quicksurvey to show layoutmediawiki/extensions/ReadingListsmaster+52 -3
Customize query in gerrit

Related Objects
Search...

Event Timeline

AnneT created this task.Mar 10 2026, 3:11 PM
AnneT set the point value for this task to 3.
AnneT mentioned this in T417405: [EPIC] Reading list quick survey for beta users.Mar 10 2026, 3:17 PM
aude renamed this task from Update QuickSurveys to support ReadingListts beta survey to Update QuickSurveys to support ReadingLists beta survey.Mar 10 2026, 3:17 PM
aude moved this task from Backlog to Feedback channel on the FY25-26 Reading Lists (Phase 2 - Beta feature) board.
AnneT moved this task from Incoming to Ready for sprint on the Reader Experience Team board.Mar 10 2026, 3:18 PM

Sample config for local dev and testing:

$wgQuickSurveysConfig = [
	[
		'name' => 'ReadingLists beta feature survey',
		'type' => 'internal',
		'questions' => [
			[
				'name' => 'enjoyment',
				'question' => 'readinglists-betafeature-quicksurvey-question',
				'layout' => 'simple-feedback',
				'answers' => [
					[ 'label' => 'readinglists-betafeature-quicksurvey-answer-positive' ],
					[ 'label' => 'readinglists-betafeature-quicksurvey-answer-negative' ]
				],
				'shuffleAnswersDisplay' => false,
			],
		],
		// TODO: set embedElementId to ~ and display survey via showSurvey API.
		// This is all configured to make the survey show up for everyone.
		// TODO: Show survey for the right users.
		'audience' => [
			'minEdits' => 0,
			'registrationStart' => '2018-01-01',
			'registrationEnd' => '2080-01-31'
		],
		'privacyPolicy' => 'ext-quicksurveys-example-external-survey-privacy-policy',
		'enabled' => true,
		'coverage' => 100,
		'platforms' => [
			'desktop' => [ 'stable' ],
			'mobile' => [ 'stable' ]
		],
	]
]

Then add the following to your i18n files in ReadingLists:

// in en.json
	"readinglists-betafeature-quicksurvey-question": "Are you enjoying this feature?",
	"readinglists-betafeature-quicksurvey-answer-positive": "👍 Yes",
	"readinglists-betafeature-quicksurvey-answer-negative": "👎 No"

// in qqq.json
	"readinglists-betafeature-quicksurvey-question": "QuickSurvey question asking for feedback on the ReadingLists beta feature.",
	"readinglists-betafeature-quicksurvey-answer-positive": "Positive response to survey question",
	"readinglists-betafeature-quicksurvey-answer-negative": "Negative response to survey question"
HFan-WMF triaged this task as High priority.Mar 10 2026, 4:05 PM
bwang moved this task from Ready for sprint to REx Sprint 16 [Q3 Mar 10 - Mar 23] on the Reader Experience Team board.Mar 10 2026, 5:29 PM
bwang edited projects, added: Reader Experience Team (REx Sprint 16 [Q3 Mar 10 - Mar 23]); removed: Reader Experience Team.
SToyofuku-WMF claimed this task.Mar 11 2026, 1:57 PM
SToyofuku-WMF moved this task from Ready to In progress on the Reader Experience Team (REx Sprint 16 [Q3 Mar 10 - Mar 23]) board.
AnneT added a subscriber: Jdlrobson.Mar 11 2026, 5:18 PM

hey @SToyofuku-WMF, @Jdlrobson has some feedback on how we might handle this that differs from what I've suggested, so let's discuss before you get too far on this task (sorry if you already have!)

gerritbot added a comment.Mar 12 2026, 7:35 PM

Change #1251163 had a related patch set uploaded (by Stoyofuku-wmf; author: Stoyofuku-wmf):

[mediawiki/extensions/ReadingLists@master] Proof of concept: Configure quicksurvey to show layout

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

gerritbot added a project: Patch-For-Review.Mar 12 2026, 7:35 PM
PatchDemoBot added a comment.Mar 12 2026, 7:37 PM

Test wiki created on Patch demo by SToyofuku-WMF using patch(es) linked to this task:
https://ca06638f4e.catalyst.wmcloud.org/w/

SToyofuku-WMF added a comment.Mar 12 2026, 7:41 PM

Patchdemo was just down and is back up, but I'm getting database errors that don't seem to have anything to do with what I changed - while I'm debugging that, here are screenshots as promised:

image.png (1,970×910 px, 142 KB)

image.png (1,960×980 px, 155 KB)

image.png (1,980×1,020 px, 159 KB)

Some clear limitations with quicksurveys out of the box 🙃

SToyofuku-WMF added a comment.Mar 12 2026, 7:50 PM

Patchdemo is now working: https://ca06638f4e.catalyst.wmcloud.org/wiki/Sdkjbskdjbfksjdfksdf

AnneT added a subscriber: Sneha.Mar 12 2026, 7:51 PM

Thanks @SToyofuku-WMF! Yeahhhh not being able to label the text input is a big problem :/ The radio buttons also look pretty silly IMO. Curious what @Sneha thinks!

AnneT added a comment.Mar 12 2026, 8:23 PM
This comment was removed by AnneT.
Sneha added a comment.EditedMar 13 2026, 8:50 PM

Thanks Steph... Yeah I agree the radio buttons don't have the same effect. But we could change the copy/options that may be more suitable for this UI. Also I wonder if that input box can be made any bigger its so small. Also curious if this box would overlap the reading list items?

We can discuss this in our mid sprint review on Monday.

gerritbot added a comment.Mar 17 2026, 3:01 PM

Change #1251163 abandoned by Stoyofuku-wmf:

[mediawiki/extensions/ReadingLists@master] Proof of concept: Configure quicksurvey to show layout

Reason:

Not doing this approach anymore

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

Maintenance_bot removed a project: Patch-For-Review.Mar 17 2026, 3:32 PM
gerritbot added a comment.Mar 19 2026, 5:23 PM

Change #1255811 had a related patch set uploaded (by Jdlrobson; author: Jdlrobson):

[mediawiki/extensions/QuickSurveys@master] POC: Add new API for logging answers from custom survey UIs

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

gerritbot added a project: Patch-For-Review.Mar 19 2026, 5:23 PM

Change #1255812 had a related patch set uploaded (by Jdlrobson; author: Jdlrobson):

[mediawiki/extensions/ReadingLists@master] POC: A custom UI survey that uses QuickSurveys API

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

Jdlrobson-WMF subscribed.Mar 19 2026, 5:25 PM

@SToyofuku-WMF @AnneT I went ahead and created a proof of concept to suggest a lightweight change we can make to QuickSurveys to unblock this. Let me know what you think.

PatchDemoBot added a comment.Mar 19 2026, 7:13 PM

Test wiki created on Patch demo by Jon (WMF) using patch(es) linked to this task:
https://4afcc7ad05.catalyst.wmcloud.org/w/

gerritbot added a comment.Mar 20 2026, 1:36 PM

Change #1256387 had a related patch set uploaded (by Stoyofuku-wmf; author: Stoyofuku-wmf):

[mediawiki/extensions/QuickSurveys@master] Proof of concept: Simple Feedback component

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

SToyofuku-WMF changed the task status from Open to Stalled.Mar 20 2026, 1:48 PM
SToyofuku-WMF moved this task from In progress to Ready on the Reader Experience Team (REx Sprint 16 [Q3 Mar 10 - Mar 23]) board.

Gonna be bold and move this to stalled as there is ongoing discussion around the approach in slack

AnneT updated the task description. (Show Details)Mar 25 2026, 2:46 PM
AnneT added a comment.Mar 25 2026, 2:49 PM

hey @Jdlrobson, I'm writing a testing strategy and am looking into how we can discover currently running surveys. So far, I'm looking at $wgQuickSurveysConfig in mediawiki-config and other codebases, plus searching for uses of showSurvey(). Is there anything I'm missing?

AnneT changed the task status from Stalled to In Progress.Mar 25 2026, 5:29 PM
AnneT claimed this task.
AnneT added a subscriber: SToyofuku-WMF.
AnneT updated the task description. (Show Details)Mar 25 2026, 5:35 PM
gerritbot added a comment.Mar 26 2026, 1:05 PM

Change #1261437 had a related patch set uploaded (by Anne Tomasevich; author: Anne Tomasevich):

[mediawiki/extensions/QuickSurveys@master] [PoC] Build user sentiment survey style

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

gerritbot added a comment.Mar 26 2026, 1:15 PM

Change #1261441 had a related patch set uploaded (by Anne Tomasevich; author: Anne Tomasevich):

[mediawiki/extensions/ReadingLists@master] Add beta feature survey

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

AnneT moved this task from REx Sprint 16 [Q3 Mar 10 - Mar 23] to REx Sprint 17 [Q3 Mar 24 - Apr 3] on the Reader Experience Team board.Mar 26 2026, 1:34 PM
AnneT edited projects, added: Reader Experience Team (REx Sprint 17 [Q3 Mar 24 - Apr 3]); removed: Reader Experience Team (REx Sprint 16 [Q3 Mar 10 - Mar 23]).
AnneT moved this task from Ready to In progress on the Reader Experience Team (REx Sprint 17 [Q3 Mar 24 - Apr 3]) board.
PatchDemoBot added a comment.Mar 26 2026, 2:09 PM

Test wiki created on Patch demo by ATomasevich (WMF) using patch(es) linked to this task:
https://ae000ede16.catalyst.wmcloud.org/w/

Jdlrobson-WMF added a comment.Mar 26 2026, 3:58 PM
In T419551#11749296, @AnneT wrote:

hey @Jdlrobson, I'm writing a testing strategy and am looking into how we can discover currently running surveys. So far, I'm looking at $wgQuickSurveysConfig in mediawiki-config and other codebases, plus searching for uses of showSurvey(). Is there anything I'm missing?

https://codesearch.wmcloud.org/search/?q=%28QuickSurveysConfig%7ConQuickSurveysEnabled%29&files=&excludeFiles=&repos= is sufficient. Note the hook onQuickSurveysEnabled now allows registering surveys outside of configuration.

AnneT updated the task description. (Show Details)Mar 27 2026, 2:13 AM
AnneT moved this task from In progress to Needs code review on the Reader Experience Team (REx Sprint 17 [Q3 Mar 24 - Apr 3]) board.
AnneT mentioned this in T421455: Add privacy policy to ReadingLists beta feature survey.Mar 27 2026, 2:18 AM
AnneT removed AnneT as the assignee of this task.Mar 30 2026, 6:00 PM
gerritbot added a comment.Mar 30 2026, 7:22 PM

Change #1255811 merged by jenkins-bot:

[mediawiki/extensions/QuickSurveys@master] Add new API for logging answers from custom survey UIs

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

Jdlrobson-WMF added a project: QuickSurveys.Mar 30 2026, 7:44 PM

I documented the new API at https://www.mediawiki.org/wiki/Extension:QuickSurveys#Changing_how_surveys_are_rendered

Jdlrobson-WMF moved this task from Not triaged to Feature requests on the QuickSurveys board.Mar 30 2026, 7:44 PM
ReleaseTaggerBot added a project: MW-1.46-notes (1.46.0-wmf.22; 2026-03-31).Mar 30 2026, 8:00 PM
Jdlrobson-WMF moved this task from Needs code review to Needs QA on the Reader Experience Team (REx Sprint 17 [Q3 Mar 24 - Apr 3]) board.Mar 30 2026, 9:04 PM
gerritbot added a comment.Mar 30 2026, 9:06 PM

Change #1261441 merged by jenkins-bot:

[mediawiki/extensions/ReadingLists@master] Add beta feature survey

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

Jdrewniak assigned this task to Sneha.Mar 31 2026, 6:10 PM
Jdrewniak moved this task from Needs QA to Sign-off on the Reader Experience Team (REx Sprint 17 [Q3 Mar 24 - Apr 3]) board.
Aklapper added a project: MediaWiki-extensions-ReadingLists.Mar 31 2026, 8:57 PM
gerritbot added a comment.Apr 1 2026, 12:20 PM

Change #1255812 abandoned by Anne Tomasevich:

[mediawiki/extensions/ReadingLists@master] POC: A custom UI survey that uses QuickSurveys API

Reason:

In favor of I7cd187eb374f728593f43b80d81cb9ce52694978

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

Jdlrobson-WMF moved this task from Feature requests to API feature requests on the QuickSurveys board.Apr 8 2026, 10:23 PM
gerritbot added a comment.Apr 9 2026, 6:08 PM

Change #1256387 abandoned by Stoyofuku-wmf:

[mediawiki/extensions/QuickSurveys@master] Proof of concept: Simple Feedback component

Reason:

We're no longer going with this approach

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

HFan-WMF closed this task as Resolved.Apr 12 2026, 3:09 AM
PatchDemoBot added a comment.May 12 2026, 7:13 PM

Test wiki on Patch demo by ATomasevich (WMF) using patch(es) linked to this task was deleted:

https://ae000ede16.catalyst.wmcloud.org/w/

PatchDemoBot added a comment.May 12 2026, 9:02 PM

Test wiki on Patch demo by Jon (WMF) using patch(es) linked to this task was deleted:

https://4afcc7ad05.catalyst.wmcloud.org/w/

PatchDemoBot added a comment.May 12 2026, 9:02 PM

Test wiki on Patch demo by SToyofuku-WMF using patch(es) linked to this task was deleted:

https://ca06638f4e.catalyst.wmcloud.org/w/

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 · Credits