Page MenuHomePhabricator

[Spike] Allow quicksurveys to be run on special pages
Closed, ResolvedPublic

Description

NOTE: While this ticket is unaddressed you can use the deprecated mw.extQuickSurveys.showSurvey T390782: Deprecate mw.extQuickSurveys

Background

Currently a limitation of quicksurveys is that they cannot be run on non-article pages, which came up most recently in T387846. There exists a function mw.extQuickSurveys.showSurvey, which can be used to show a quicksurvey on any page, but it is marked as deprecated and unsupported. Should we wish to fully deprecate this method we would need to provide a supported method by which to display quicksurveys on non-standard pages

User story

As a user of quicksurveys, I want the extensibility to be able to show a quicksurvey on a special page using supported APIs

Requirements

  • familiarize yourself with the main quicksurvey flows to be able to answer high-level questions
  • discuss with team how we want to support quicksurveys on non-article pages architecturally
  • make a follow up ticket to implement the discussed approach, and ensure that it is also a blocker for T390782

Acceptance criteria

  1. a ticket has been created to implement allowing quicksurveys to be run on special pages
  2. said ticket is blocking T390782

Outcome

An ADR which explores the different options we should consider and makes a decision. For each decision evaluate from the perspective of 1) future code maintenance 2) developer experience 3) effort involved

Those options should include but are not limited to:

  • Updates to the configuration of a QuickSurvey - rethinking/replacing the existing pageid setting.
  • A new publicly facing API for adding a quick survey to a page (potentially with limitations defined)

Communication criteria - does this need an announcement or discussion?

Communication is not required as part of this ticket

Rollback plan

By the time this functionality is used a revert will likely not be possible - ideally we will be familiar enough with the code and it will have good test coverage, but either way the rollback plan here is likely to fix forward after knowing what the specific issue is

Event Timeline

Jdlrobson-WMF updated the task description. (Show Details)
Jdlrobson-WMF changed the task status from Open to In Progress.Apr 3 2025, 6:42 PM