Implement system to convert client hint data to a string representation
Closed, ResolvedPublic
Actions

Description

Client hint data shown in the results may need to be a concatenated string in some situations. Being able to determine what is and isn't useful in this string representation is likely to require some thought. Furthermore, Special:Investigate and Special:CheckUser could be both making use of this string format.

A system could be implemented that parses the client hint data and converts it to a useful but compact representation. What this string representation should contain could vary for each usage, so this system should be easily configurable.

A need for a string representation that gives enough entropy but also be compact to make the result lines too large has been detailed in T340993.

Acceptance criteria

Create a service that allows conversion of ClientHintsData objects to a human-readable string form that is configurable using site configuration and the results of which can easily be used.

Details

	Subject	Repo	Branch	Lines +/-
	clienthints: Add UserAgentClientHintsFormatter	mediawiki/extensions/CheckUser	master	+1 K -0

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Resolved	kostajh	T257893 [EPIC] Support User-Agent Client Hints header in CheckUser
Resolved	Dreamy_Jazz	T337942 Display client hint data
Resolved	Dreamy_Jazz	T340991 Display client hint data in Special:CheckUser's 'Get users' mode
Resolved	Dreamy_Jazz	T340993 Display client hint data in Special:CheckUser's 'Get edits' mode result lines
Resolved	Dreamy_Jazz	T340996 Implement system to convert client hint data to a string representation
Resolved	Dreamy_Jazz	T341932 Create service to return Client Hints data from the database

Event Timeline

Dreamy_Jazz renamed this task from Implement system to compact client hint data to a string representation to Implement system to convert client hint data to a string representation.Jul 3 2023, 2:51 PM

Dreamy_Jazz created this task.

Dreamy_Jazz added a parent task: T340993: Display client hint data in Special:CheckUser's 'Get edits' mode result lines.

Dreamy_Jazz added a project: Anti-Harassment.Jul 4 2023, 10:44 PM

Dreamy_Jazz mentioned this in T341110: Deploy client hints functionality.Jul 17 2023, 12:25 PM

Dreamy_Jazz moved this task from Untriaged to CheckUser on the Anti-Harassment board.Jul 22 2023, 5:47 PM

Dreamy_Jazz edited projects, added Anti-Harassment (AHaT Sprint 32 - Baseball Cap); removed Anti-Harassment.Sep 13 2023, 10:30 AM

Dreamy_Jazz moved this task from Ready 🎬 (ONLY IF YOU HAVE NO MORE CODE TO REVIEW) to In Progress 💪 on the Anti-Harassment (AHaT Sprint 32 - Baseball Cap) board.

Dreamy_Jazz claimed this task.Sep 13 2023, 4:15 PM

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

[mediawiki/extensions/CheckUser@master] [Very WIP] Add UserAgentClientHintsFormatter

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

gerritbot added a project: Patch-For-Review.Sep 13 2023, 10:18 PM

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

[operations/mediawiki-config@master] clienthints: Pin wgCheckUserDisplayClientHints to false

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

Dreamy_Jazz moved this task from In Progress 💪 to Code Review 🔍 on the Anti-Harassment (AHaT Sprint 32 - Baseball Cap) board.Sep 19 2023, 10:00 AM

Dreamy_Jazz added a parent task: T340991: Display client hint data in Special:CheckUser's 'Get users' mode.Sep 20 2023, 12:15 PM

Dreamy_Jazz added a subtask: T341932: Create service to return Client Hints data from the database.

Change 957366 merged by jenkins-bot:

[mediawiki/extensions/CheckUser@master] clienthints: Add UserAgentClientHintsFormatter

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

This is similar to T341932: Create service to return Client Hints data from the database where I would suggest that QA is skipped for this patch as there isn't an easy way to test that it worked using the wiki interface until other tasks are ready for QA. If QA is skipped, this will be indirectly tested through other subtasks of T337942 (such as T340991, T340993, etc.).