Create IP utilities for sanitizing and prettifying IPs via js
Closed, ResolvedPublic3 Estimated Story Points
Actions

Description

In IPUtils.php there are the sanitizeIP and prettifyIP functions which do not have equivalents in js. It would be useful for IP Info (specifically for T299382: Error in popup when trying to view info for IPv6 edits in Recent Changes enhanced view) if these did exist in the js.

AC

Add sanitizeIP and prettifyIP functions to resources/src/mediawiki.util/util.js which already has some IP utility functions
Write unit tests for the new functions

Notes

Documentation on testing in JavaScript: https://www.mediawiki.org/wiki/Manual:JavaScript_unit_testing

Details

	Subject	Repo	Branch	Lines +/-
	Create IP utilities for sanitizing and prettifying IPs via js	mediawiki/core	master	+169 -0
	mediawiki.util: Make internal repeatString() function non-public	mediawiki/core	master	+21 -36

Customize query in gerrit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Resolved		• TThoabala	T301174 Create IP utilities for sanitizing and prettifying IPs via js
		Resolved	BUG REPORT	Tchanders	T299382 Error in popup when trying to view info for IPv6 edits in Recent Changes enhanced view

Event Timeline

STran created this task.Feb 7 2022, 8:03 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptFeb 7 2022, 8:03 PM

STran set the point value for this task to 3.Feb 7 2022, 8:03 PM

STran moved this task from Untriaged to Cards ready for development on the Anti-Harassment board.

STran added a subtask: T299382: Error in popup when trying to view info for IPv6 edits in Recent Changes enhanced view.

Tchanders moved this task from Cards ready for development to The Letter Song on the Anti-Harassment board.Feb 14 2022, 12:38 PM

Tchanders edited projects, added Anti-Harassment (The Letter Song); removed Anti-Harassment.

• TThoabala claimed this task.Feb 15 2022, 8:58 AM

ARamirez_WMF edited projects, added Anti-Harassment (AHaT Sprint 2: The Pork Pie); removed Anti-Harassment (The Letter Song), IP Info.Feb 17 2022, 8:46 PM

• TThoabala moved this task from Ready 🎬 (ONLY IF YOU HAVE NO MORE CODE TO REVIEW) to In Progress 💪 on the Anti-Harassment (AHaT Sprint 2: The Pork Pie) board.Feb 22 2022, 8:44 AM

Tchanders updated the task description. (Show Details)Feb 28 2022, 2:47 PM

Tchanders updated the task description. (Show Details)

Niharika added a project: IP Info.Mar 1 2022, 7:12 AM

Change 767049 had a related patch set uploaded (by TsepoThoabala; author: TsepoThoabala):

[mediawiki/core@master] WIP: Create IP utilities for sanitizing and prettifying IPs via js

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

gerritbot added a project: Patch-For-Review.Mar 1 2022, 8:33 AM

Tchanders moved this task from In Progress 💪 to Code Review 🔍 on the Anti-Harassment (AHaT Sprint 2: The Pork Pie) board.Mar 3 2022, 2:05 PM

ARamirez_WMF edited projects, added Anti-Harassment (AHaT Sprint 3: Lady Dimitrescu); removed Anti-Harassment (AHaT Sprint 2: The Pork Pie).Mar 7 2022, 7:35 PM

ARamirez_WMF moved this task from Ready 🎬 (ONLY IF YOU HAVE NO MORE CODE TO REVIEW) to Code Review 🔍 on the Anti-Harassment (AHaT Sprint 3: Lady Dimitrescu) board.Mar 7 2022, 7:40 PM

Tchanders moved this task from Code Review 🔍 to QA/Testing 🐞 on the Anti-Harassment (AHaT Sprint 3: Lady Dimitrescu) board.Mar 14 2022, 2:31 PM

Change 767049 merged by jenkins-bot:

[mediawiki/core@master] Create IP utilities for sanitizing and prettifying IPs via js

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

ReleaseTaggerBot added a project: MW-1.38-notes (1.38.0-wmf.26; 2022-03-14).Mar 14 2022, 3:00 PM

Maintenance_bot removed a project: Patch-For-Review.Mar 14 2022, 3:10 PM

Moving this to Done since it can be tested via T299382: Error in popup when trying to view info for IPv6 edits in Recent Changes enhanced view

Tchanders mentioned this in T299382: Error in popup when trying to view info for IPv6 edits in Recent Changes enhanced view.Mar 14 2022, 3:38 PM

In T301174#7774453, @Tchanders wrote:

Moving this to Done since it can be tested via T299382: Error in popup when trying to view info for IPv6 edits in Recent Changes enhanced view

Actually, I would like to test this in isolation (I assume I can via the browser console). Moving back into QA.

I assume we want these new JavaScript functions to behave the same as the PHP functions in IPUtils on which they are based. Therefore, I compared the output of these JavaScript functions (when run in Firefox's console) with the PHP functions for the same input.

I took test data from the IPUtils unit tests (P22787) and randomly generated some more (P22786).

There were no differences in output from either function when compared to PHP, with the exception of non-string inputs which threw an error in JavaScript. I raised this separately T304082.

EDIT Because I understand we had some problems with ES5 vs. ES6, so I repeated some of the above testing with IE11 (which apparently only has partial ES6 support). It was also fine.

Test environment: https://en.wikipedia.beta.wmflabs.org MediaWiki 1.39.0-alpha (a41d695) 13:19, 17 March 2022.
Test browser: Firefox 91. IE11.

Niharika closed this task as Resolved.Apr 8 2022, 10:41 PM

Niharika closed subtask T299382: Error in popup when trying to view info for IPv6 edits in Recent Changes enhanced view as Resolved.Apr 12 2022, 12:45 AM

Change 793084 had a related patch set uploaded (by Krinkle; author: Krinkle):

[mediawiki/core@master] mediawiki.util: Make internal repeatString() function non-public

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

gerritbot added a project: Patch-For-Review.May 18 2022, 3:38 PM

Change 793084 merged by jenkins-bot:

[mediawiki/core@master] mediawiki.util: Make internal repeatString() function non-public

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

Maintenance_bot removed a project: Patch-For-Review.May 18 2022, 4:30 PM

ReleaseTaggerBot added a project: MW-1.39-notes (1.39.0-wmf.13; 2022-05-23).May 18 2022, 5:00 PM

Niharika moved this task from Backlog to Closed on the IP Info board.Aug 8 2022, 7:58 PM

Create IP utilities for sanitizing and prettifying IPs via jsClosed, ResolvedPublic3 Estimated Story PointsActions