IP reveal: REST APIs throw an exception if site is in read only mode
Closed, ResolvedPublic1 Estimated Story Points
Actions

Assigned To

Authored By

	Dreamy_Jazz
	Feb 26 2025, 5:56 PM

Description

Summary

When a site is in read only mode, the CheckUser IP reveal REST APIs will encounter an exception and return a 500 error with a stack trace. This should instead return a more user friendly error.

Background

When a user uses the CheckUser "Show IP" button, a REST API request is made to the IP reveal REST API
- This request will create a log entry if the user has the permissions to perform the action
Inserting jobs on wikis may require writing to the DB, if the $wgJobTypeConf is configured to use the DB (which is the default)
- This write will fail if the site is in read only mode
- Even if the job is inserted, the write in the job will still fail
When in read-only mode we should return a more friendly 503 error

Acceptance criteria

CheckUser REST APIs return a user-friendly server error message when the site is in read only mode

Details

Related Changes in Gerrit:

	Subject	Repo	Branch	Lines +/-
	IP reveal: Return user friendly error when site in read only mode	mediawiki/extensions/CheckUser	master	+69 -17

Customize query in gerrit

Event Timeline

Dreamy_Jazz created this task.Feb 26 2025, 5:56 PM

Restricted Application added a project: Trust and Safety Product Team. · View Herald TranscriptFeb 26 2025, 5:56 PM

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

Change #1123013 had a related patch set uploaded (by Dreamy Jazz; author: Dreamy Jazz):

[mediawiki/extensions/CheckUser@master] IP reveal: Return user friendly error when site in read only mode

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

gerritbot added a project: Patch-For-Review.Feb 26 2025, 6:11 PM

Dreamy_Jazz moved this task from Priority Backlog to Needs Review on the Trust and Safety Product Sprint (Sprint Hurdy-Gurdy (Feb 10 - Feb 28)) board.Feb 26 2025, 6:52 PM

Dreamy_Jazz set the point value for this task to 1.

Change #1123013 merged by jenkins-bot:

[mediawiki/extensions/CheckUser@master] IP reveal: Return user friendly error when site in read only mode

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

Maintenance_bot removed a project: Patch-For-Review.Feb 27 2025, 10:30 AM

Dreamy_Jazz moved this task from Needs Review to Needs QA on the Trust and Safety Product Sprint (Sprint Hurdy-Gurdy (Feb 10 - Feb 28)) board.Feb 27 2025, 10:44 AM

ReleaseTaggerBot added a project: MW-1.44-notes (1.44.0-wmf.19; 2025-03-04).Feb 27 2025, 11:00 AM

Dreamy_Jazz claimed this task.Feb 27 2025, 12:41 PM

Dreamy_Jazz moved this task from Inbox to Engineering on the Trust and Safety Product Team board.Feb 28 2025, 5:52 PM

Dreamy_Jazz edited projects, added Trust and Safety Product Team (Engineering); removed Trust and Safety Product Team.

Dreamy_Jazz moved this task from Sprint Hurdy-Gurdy (Feb 10 - Feb 28) to Sprint Lemon Meringue (March 3 - 21) on the Trust and Safety Product Sprint board.Mar 3 2025, 3:45 PM

Dreamy_Jazz edited projects, added Trust and Safety Product Sprint (Sprint Lemon Meringue (March 3 - 21)); removed Trust and Safety Product Sprint (Sprint Hurdy-Gurdy (Feb 10 - Feb 28)).

Dreamy_Jazz moved this task from Priority Backlog to Needs QA on the Trust and Safety Product Sprint (Sprint Lemon Meringue (March 3 - 21)) board.

QA is completed, I have verified the new code has been implemented and is functioning as expected (When a site is in read-only mode, and a user is viewing a page with the Show IP button (such as: Logs or Recent Changes or View History or IP Information), and then the user selects the Show IP button, it will display an error message).

Dreamy_Jazz closed this task as Resolved.Mar 4 2025, 11:27 AM

	F58588593: image.png
	Mar 4 2025, 7:49 AM

	F58588586: image.png
	Mar 4 2025, 7:49 AM

IP reveal: REST APIs throw an exception if site is in read only modeClosed, ResolvedPublic1 Estimated Story PointsActions