Page MenuHomePhabricator
Create Task
Maniphest T368728

CommunityConfiguration: skipDashboardListing should fully hide the provider from UI
Closed, ResolvedPublicBUG REPORT
Actions

Description

In T361123: Make it possible to declare a Community configuration provider that does not display on the dashboard, we added a skipDashboardListing flag that allows customers to hide any provider from the dashboard at Special:CommunityConfiguration. This works, but the dashboard is not the only part of CommunityConfiguration UI we have. The links added in T363788: Community Configuration: Edit History lead to Special:CommunityConfiguration/PROVIDER do not work when the provider in question has skipDashboardListing enabled.

If a provider is excluded from the dashboard, we should not display it in any portion of CommunityConfiguration-generated UI. This is what we need to implement within this task (it might also make sense to rename skipDashboardListing to something more generic, such as excludeFromUI?). See T367655#9934331 for related conversation.

Details

SubjectRepoBranchLines +/-
Drop the old option name `skipDashboardListing`mediawiki/extensions/GrowthExperimentsmaster+0 -1
Hide providers with `excludeFromUI` flag from UI componentsmediawiki/extensions/CommunityConfigurationmaster+25 -20
Add `excludeFromUI` flag to extension.jsonmediawiki/extensions/GrowthExperimentsmaster+2 -1
Customize query in gerrit

Related Objects
Search...

Event Timeline

Urbanecm_WMF created this task.Jun 28 2024, 1:28 PM
Restricted Application added a project: Growth-Team. · View Herald TranscriptJun 28 2024, 1:28 PM
Restricted Application added a subscriber: Aklapper. · View Herald Transcript
Urbanecm_WMF triaged this task as Medium priority.Jun 28 2024, 1:29 PM
Urbanecm_WMF changed the subtype of this task from "Task" to "Bug Report".

This is a minor bug that affects providers with skipDashboardListing enabled (none at the moment, will affect T367575: Structured Mentor list should make use of CommunityConfiguration extension eventually).

Urbanecm_WMF moved this task from Inbox to Up Next on the Growth-Team board.Jun 28 2024, 1:29 PM
Urbanecm_WMF moved this task from Backlog to Needed before all Growth wikis release on the MediaWiki-extensions-CommunityConfiguration board.
Urbanecm_WMF mentioned this in T367655: Community configuration: Add support for dynamically-hidden providers.Jun 28 2024, 1:38 PM
Urbanecm_WMF moved this task from Needed before all Growth wikis release to Needed before all-wikis release on the MediaWiki-extensions-CommunityConfiguration board.Jun 28 2024, 3:41 PM
Sgs subscribed.EditedJul 4 2024, 12:07 PM

The renaming and expansion of the option scope seem fair. For the mentor list case, there's indeed a "form" to update the configuration. Should we allow providers to define an option for the "View form" URL, for the cases in which it is provided by them rather than by CC extension? cc @Urbanecm_WMF

Urbanecm_WMF added a comment.Jul 4 2024, 3:15 PM
In T368728#9953644, @Sgs wrote:

The renaming and expansion of the option scope seem fair. For the mentor list case, there's indeed a "form" to update the configuration. Should we allow providers to define an option for the "View form" URL, for the cases in which it is provided by them rather than by CC extension? cc @Urbanecm_WMF

I don't think so. If an extension wants to include its own special form in Special:CommunityConfiguration, they can do that already thanks to T364283: Community configuration: Allow client extensions to define their own editor capability. I think we should keep hiding for cases when the other extension has a reason for not including the UI elements at all, and we should honour that decision.

Arguably, the mentor list is a different kind of configuration than other things that are in Community configuration.

Michael subscribed.Jul 10 2024, 4:25 PM
Urbanecm_WMF moved this task from Needed before all-wikis release to Backlog on the MediaWiki-extensions-CommunityConfiguration board.Jul 17 2024, 5:31 PM
Michael mentioned this in T370568: [betalabs] CommunityConfiguration: View form redirects to "Provider GrowthMentorList is not found".Jul 22 2024, 8:10 AM
Urbanecm_WMF added a subtask: T370568: [betalabs] CommunityConfiguration: View form redirects to "Provider GrowthMentorList is not found".Jul 29 2024, 10:20 AM
Cyndymediawiksim claimed this task.Jul 30 2024, 1:47 PM
gerritbot added a comment.Jul 30 2024, 3:14 PM

Change #1058192 had a related patch set uploaded (by Cyndywikime; author: Cyndywikime):

[mediawiki/extensions/CommunityConfiguration@master] Hide providers with `excludeFromUI` flag from UI components

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

gerritbot added a project: Patch-For-Review.Jul 30 2024, 3:14 PM
Cyndymediawiksim moved this task from Up Next to FY2024-25 Q1 Sprint 2 on the Growth-Team board.Jul 30 2024, 3:21 PM
Cyndymediawiksim edited projects, added Growth-Team (FY2024-25 Q1 Sprint 2); removed Growth-Team.
Cyndymediawiksim moved this task from Incoming to Code Review on the Growth-Team (FY2024-25 Q1 Sprint 2) board.
Urbanecm_WMF moved this task from Code Review to Doing on the Growth-Team (FY2024-25 Q1 Sprint 2) board.Jul 31 2024, 10:27 AM

As I noted on Gerrit, the change to CommunityConfiguration looks good. However, renaming skipDashboardListing to excludeFromUI is technically a breaking change. You'd need to ensure GrowthExperiments doesn't break during the process. A safe way to do that would be to have three patches:

  1. in GrowthExperiments, add the excludeFromUI option, but keep the skipDashboardListing option as well (only one of them would get processed)
  2. in CommunityConfiguration, https://gerrit.wikimedia.org/r/1058192 would depend on the first patch
  3. in GrowthExperiments, once the CC patch was merged, it is possible to remove the old skipDashboardListing option

If dependencies using the Depends-On footer in Gerrit are set correctly, then merging those patches cannot result in GrowthExperiments usage of skipDashboardListing breaking at any point. Moving to Doing for now – happy to merge once the above is done :).

gerritbot added a comment.Jul 31 2024, 11:58 AM

Change #1058589 had a related patch set uploaded (by Cyndywikime; author: Cyndywikime):

[mediawiki/extensions/GrowthExperiments@master] Hide providers with `excludeFromUI` flag from UI components

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

gerritbot added a comment.Jul 31 2024, 11:59 AM

Change #1058590 had a related patch set uploaded (by Cyndywikime; author: Cyndywikime):

[mediawiki/extensions/GrowthExperiments@master] Hide providers with `excludeFromUI` flag from UI components

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

Cyndymediawiksim moved this task from Doing to Code Review on the Growth-Team (FY2024-25 Q1 Sprint 2) board.Jul 31 2024, 12:38 PM
gerritbot added a comment.Jul 31 2024, 1:56 PM

Change #1058590 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] Add `excludeFromUI` flag to extension.json

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

gerritbot added a comment.Jul 31 2024, 1:56 PM

Change #1058192 merged by jenkins-bot:

[mediawiki/extensions/CommunityConfiguration@master] Hide providers with `excludeFromUI` flag from UI components

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

Cyndymediawiksim mentioned this in rECOM0b2c097ee252: Hide providers with `excludeFromUI` flag from UI components.Jul 31 2024, 1:56 PM
ReleaseTaggerBot added a project: MW-1.43-notes (1.43.0-wmf.17; 2024-08-06).Jul 31 2024, 2:00 PM
gerritbot added a comment.Aug 1 2024, 12:36 PM

Change #1058589 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] Drop the old option name `skipDashboardListing`

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

Maintenance_bot removed a project: Patch-For-Review.Aug 1 2024, 1:32 PM
Urbanecm_WMF moved this task from Code Review to QA on the Growth-Team (FY2024-25 Q1 Sprint 2) board.Aug 2 2024, 1:22 PM
Urbanecm_WMF edited projects, added Growth-Team (FY2024-25 Q1 Sprint 3); removed Growth-Team (FY2024-25 Q1 Sprint 2).Aug 6 2024, 5:20 PM
Urbanecm_WMF moved this task from Incoming to QA on the Growth-Team (FY2024-25 Q1 Sprint 3) board.
Michael edited projects, added Growth-Team (FY2024-25 Q1 Sprint 4); removed Growth-Team (FY2024-25 Q1 Sprint 3).Aug 20 2024, 11:22 AM
Michael moved this task from Incoming to QA on the Growth-Team (FY2024-25 Q1 Sprint 4) board.Aug 20 2024, 11:23 AM
Etonkovidova closed this task as Resolved.Aug 29 2024, 12:33 AM
Etonkovidova closed subtask T370568: [betalabs] CommunityConfiguration: View form redirects to "Provider GrowthMentorList is not found" as Resolved.Sep 24 2024, 9:11 PM
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