IP auto-reveal: Indicate on sidebar tool link if auto-reveal mode is on
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	Tchanders
	May 13 2025, 5:02 PM

Description

Background

Users need a visual indicator of whether IP auto-reveal mode is on. For the minimal first release, we will change the wording of this sidebar link, to indicate when the mode is on.

User story

As a patroller using IP auto-reveal to view IP addresses of temporary accounts automatically, I want to know whether I have auto-reveal switched on or off.

Specification

In the sidebar tools menu, display the state of IP auto-reveal mode in parentheses, e.g.:

Note that we also have designs to do this via a bottom-dock menu, which may replace this in the future: T386496: IP auto-reveal: Allow managing auto-reveal mode from the bottom dock menu.

Technical notes

SidebarLinksHandler::addIPAutoReveal will need to check if IP auto-reveal is on.

REST API handlers currently do this via TemporaryAccountAutoRevealTrait. This trait could be replaced by (or updated to call) a service, for re-use by the hook handler.

Acceptance criteria

The text of the sidebar tool link indicates whether IP auto-reveal mode is on or off

Details

Related Changes in Gerrit:

	Subject	Repo	Branch	Lines +/-
	IP auto-reveal: Update the tool link to indicate status	mediawiki/extensions/CheckUser	master	+114 -8
	IP auto-reveal: Move TemporaryAccountAutoRevealTrait to a service	mediawiki/extensions/CheckUser	master	+121 -112

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
		Restricted Task
Resolved	kostajh	T294511 2021 Security Team wikireplicas audit
Declined	None	T284948 Raw IPs of logged-out users disclosed in wiki-replicas
Resolved	Niharika	T324492 Temporary accounts - MVP
Resolved	Niharika	T325238 [Epic] IP Address Reveal for Privileged Users
Open	None	T358853 Temporary accounts: Automatically resolve temporary account names to IP addresses on displaying (auto reveal feature)
Resolved	Tchanders	T386492 IP auto-reveal: Assign the IP auto-reveal right to user groups
Resolved	Tchanders	T394074 IP auto-reveal: Indicate on sidebar tool link if auto-reveal mode is on

Event Timeline

@KColeman-WMF Please feel free to update the task description.

What do you think the link should display when auto-reveal is off? I'm wondering whether it should just say IP auto-reveal or IP auto-reveal (off). It might look a bit strange to explicitly say that it's off, especially for a user who rarely uses the tool.

Yes, I agree it will look strange to explicitly say it's off.

I'm happy to use IP Auto-reveal for the default/off state and IP Auto-reveal (on) for when the tool is enabled.

Tchanders moved this task from Priority Backlog to Ready on the Trust and Safety Product Sprint (Sprint Key Lime Pie (May 5 - May 23)) board.May 14 2025, 4:15 PM

Tchanders claimed this task.May 19 2025, 11:13 AM

Tchanders moved this task from Ready to In Progress on the Trust and Safety Product Sprint (Sprint Key Lime Pie (May 5 - May 23)) board.

Change #1147770 had a related patch set uploaded (by Tchanders; author: Tchanders):

[mediawiki/extensions/CheckUser@master] IP auto-reveal: Move TemporaryAccountAutoRevealTrait to a service

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

gerritbot added a project: Patch-For-Review.May 19 2025, 1:55 PM

Change #1148396 had a related patch set uploaded (by Tchanders; author: Tchanders):

[mediawiki/extensions/CheckUser@master] IP auto-reveal: Update the tool link to indicate status

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

Tchanders moved this task from In Progress to Needs Review on the Trust and Safety Product Sprint (Sprint Key Lime Pie (May 5 - May 23)) board.May 20 2025, 5:22 PM

Tchanders moved this task from Backlog to In progress on the Temporary accounts (Major pilot wiki deployment) board.May 21 2025, 10:14 AM

Change #1147770 merged by jenkins-bot:

[mediawiki/extensions/CheckUser@master] IP auto-reveal: Move TemporaryAccountAutoRevealTrait to a service

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

ReleaseTaggerBot added a project: MW-1.45-notes (1.45.0-wmf.3; 2025-05-27).May 21 2025, 11:00 AM

Change #1148396 merged by jenkins-bot:

[mediawiki/extensions/CheckUser@master] IP auto-reveal: Update the tool link to indicate status

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

Maintenance_bot removed a project: Patch-For-Review.May 22 2025, 11:30 AM

All patches have been merged, so I'm moving this to QA.

QA is completed, I have verified the new code changes have been implemented and is functioning as expected (Per the Acceptance Criteria):

When IP Auto-reveal is ON: the sidebar tool link will display IP Auto-reveal (on)

When IP Auto-reveal is OFF: the sidebar tool link will display IP Auto-reveal

kostajh closed this task as Resolved.May 25 2025, 6:51 PM

	F60395553: image.png
	May 24 2025, 6:22 AM

	F60395312: image.png
	May 24 2025, 6:22 AM

IP auto-reveal: Indicate on sidebar tool link if auto-reveal mode is onClosed, ResolvedPublicActions