Maniphest T207448

Resetting a custom global preference via API does not work
Closed, ResolvedPublicBUG REPORT
Actions

Assigned To

Authored By

	Schnark
	Oct 19 2018, 8:53 AM

Description

This got lost due to my confusion in T203864: Resetting a global preference via API does not work:

I can set custom (i.e. prefixed with userjs-) options globally, but I can't make them local again:

Save userjs-foo=foo as global preference: https://de.wikipedia.org/wiki/Spezial:ApiSandbox#action=globalpreferences&format=json&change=userjs-foo%3Dfoo
Confirm it is set properly: https://de.wikipedia.org/wiki/Spezial:ApiSandbox#action=query&format=json&meta=globalpreferences
Remove userjs-foo as global preference: https://de.wikipedia.org/wiki/Spezial:ApiSandbox#action=globalpreferences&format=json&change=userjs-foo
Repeat step 2.

(Don't forget to fill in the tokens in step 1 and 3.)

Expected: The preference should be gone.
Actual: It is still there, with the old value, even though step 3 complete with "success".

Details

	Subject	Repo	Branch	Lines +/-
	ApiGlobalPreferences: allow resetting of preferences	mediawiki/extensions/GlobalPreferences	master	+85 -12

Customize query in gerrit

Related Objects

Mentioned In: rMGCD736012ebde8e: Really delete global preferences instead of setting them to empty string
T238487: GlobalPreferences: Unable to delete `userjs-` option
Mentioned Here: rEGPRd7d80166d836: Merge "Use expression builder to avoid raw sql"
T203864: Resetting a global preference via API does not work

Event Timeline

Schnark created this task.Oct 19 2018, 8:53 AM

Restricted Application added a project: Community-Tech. · View Herald TranscriptOct 19 2018, 8:53 AM

Restricted Application added a subscriber: Aklapper. · View Herald Transcript

Anomie moved this task from Unsorted to Non-core-API stuff on the MediaWiki-Action-API board.Oct 19 2018, 12:57 PM

Poke @MaxSem to reproduce.

Niharika moved this task from New & TBD Tickets to Maintenance Backlog on the Community-Tech board.Oct 25 2018, 10:19 PM

Mooeypoo moved this task from Maintenance Backlog to New & TBD Tickets on the Community-Tech board.Nov 27 2018, 11:15 PM

Mooeypoo moved this task from New & TBD Tickets to Bug backlog on the Community-Tech board.

Niharika removed a project: Community-Tech.Feb 11 2019, 11:21 PM

I've come across this with Convenient-Discussions trying to delete a property created for testing purposes, and I couldn't. I was lucky not to mess with the users' options (only faced this behavior while in the development stage)—they would have an undeletable junk option. A particularly unfortunate feature of this is that global preferences override local ones by default, so if there is a userjs- option with the same name locally, then, unless there is a local override set (which requires additional actions), it has no effect.

Restricted Application added a project: Platform Engineering. · View Herald TranscriptAug 13 2020, 9:41 AM

Jack_who_built_the_house mentioned this in T238487: GlobalPreferences: Unable to delete `userjs-` option.Aug 13 2020, 9:42 AM

Ailbeve subscribed.Aug 16 2020, 2:41 PM

I think we got automatically tagged because of the API but since this is GP probably better for Community Tech to handle. Re-tag us if we're needed.

Aklapper merged a task: T238487: GlobalPreferences: Unable to delete `userjs-` option.Aug 23 2020, 5:18 PM

Aklapper added a subscriber: DannyS712.

In T207448#6394691, @eprodromou wrote:

I think we got automatically tagged because of the API but since this is GP probably better for Community Tech to handle. Re-tag us if we're needed.

@Niharika removed Community-Tech, so I assume they weren't interested in handling this though

Nardog merged a task: T263687: Custom global preferences (userjs-...) cannot be removed via GlobalPreferences API.Sep 23 2020, 7:51 PM

Nardog subscribed.

Pppery merged a task: T263687: Custom global preferences (userjs-...) cannot be removed via GlobalPreferences API.Sep 23 2020, 7:51 PM

@Pppery Jinx! :D

I'd like to add that reset for action=globalpreferences also doesn't work, whether resetkinds is specified or not.

Pppery unsubscribed.Sep 23 2020, 8:08 PM

Jack_who_built_the_house added a comment.Jun 14 2021, 3:18 PM

This comment was removed by Jack_who_built_the_house.

So how may we get this solved? I tried poking at the code with Vagrant the other day but it quickly became clear it was above my pay grade...

GeneralNotability subscribed.Dec 23 2021, 3:40 AM

TheDJ added a project: User-TheDJ.Dec 23 2021, 10:21 AM

I have just encountered this issue. A gadget migrated its options schema, and there are a bunch of old items to clean up. Currently, the best I can do is to set these to empty values, so that at least it takes little space.

But the stale items remain, so they can only accumulate over time… (imagine a gadget developer who ends up with dozens of items)

As a reminder, the items are included in the HTML of every pageview.

Od1n triaged this task as High priority.Oct 22 2023, 1:48 PM

Jack_who_built_the_house awarded a token.Feb 27 2024, 6:46 PM

MusikAnimal added a project: Community-Tech.Feb 27 2024, 8:20 PM

MusikAnimal changed the subtype of this task from "Task" to "Bug Report".

MusikAnimal moved this task from Bug backlog to Needs Discussion on the Community-Tech board.

This ticket is clearly a bug, but are there clear workarounds? GlobealPreferences is in passive maintenance, and I'm not sure this qualifies as something we'd need to unbreak now.

JWheeler-WMF added a comment.Mar 26 2024, 9:18 PM

This comment was removed by JWheeler-WMF.

JWheeler-WMF added a comment.Mar 26 2024, 9:23 PM

This comment was removed by JWheeler-WMF.

I've got a fix for this that I made a while back. I'll revisit it and get it submitted for review soon.

Moving to the Kanban board so I don't forget :)

MusikAnimal moved this task from Ready 🎬 to In Development 💻 on the Community-Tech (CommTech-Kanban) board.Apr 3 2024, 4:40 PM

Change #1018779 had a related patch set uploaded (by MusikAnimal; author: MusikAnimal):

[mediawiki/extensions/GlobalPreferences@master] ApiGlobalPreferences: allow resetting of preferences

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

gerritbot added a project: Patch-For-Review.Apr 10 2024, 7:56 PM

MusikAnimal moved this task from In Development 💻 to Review/Feedback 💬 on the Community-Tech (CommTech-Kanban) board.Apr 10 2024, 7:56 PM

Change #1018779 merged by jenkins-bot:

[mediawiki/extensions/GlobalPreferences@master] ApiGlobalPreferences: allow resetting of preferences

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

ReleaseTaggerBot added a project: MW-1.43-notes (1.43.0-wmf.1; 2024-04-16).Apr 15 2024, 11:00 PM

I totally forgot to move to this to QA! It's already live on all wikis and has been for a week.

Jack_who_built_the_house mentioned this in rMGCD736012ebde8e: Really delete global preferences instead of setting them to empty string.Apr 23 2024, 10:09 PM

I cannot reproduce the bug in the description.

Test environment: https://en.wikipedia.beta.wmflabs.org GlobalPreferences 0.1.2 (d7d8016) 21:17, 23 April 2024.

MusikAnimal closed this task as Resolved.Apr 24 2024, 5:18 PM

Maintenance_bot removed a project: Patch-For-Review.Apr 26 2024, 6:41 PM

Resetting a custom global preference via API does not workClosed, ResolvedPublicBUG REPORTActions

Description

Details

Related Objects

Event Timeline

Resetting a custom global preference via API does not work
Closed, ResolvedPublicBUG REPORT
Actions