Prepare upgrade to justinrainbow/json-schema to 6.x in CommunityConfiguration
Open, MediumPublic3 Estimated Story PointsSpike
Actions

Assigned To

Authored By

	Michael
	Jan 22 2026, 1:59 PM

Project Tags

Referenced Files

None

Subscribers

Description

For the update of the justinrainbow/json-schema library in core (see parent task) several CommunityConfiguration unit tests are failing in JsonSchemaValidatorTest.php, like the following:

00:01:35.130 1) MediaWiki\Extension\CommunityConfiguration\Tests\JsonSchemaValidatorTest::testValidate with data set "wrong type" (MediaWiki\Extension\CommunityConfiguration\Schema\JsonSchema@anonymous/workspace/src/extensions/CommunityConfiguration/tests/phpunit/unit/Validation/JsonSchemaValidatorTest.php:66$27a Object (), array('baz'), false, array('type'), false, false, array(array('Number', '/Number', 'String value found, but a num...quired', array('type'))))
00:01:35.135 Failed asserting that two arrays are identical.
00:01:35.135 --- Expected
00:01:35.135 +++ Actual
00:01:35.135 @@ @@
00:01:35.135  Array &0 (
00:01:35.135 -    0 => 'type'
00:01:35.135 +    0 => Array &1 (
00:01:35.135 +        'name' => 'type'
00:01:35.135 +        'params' => Array &2 (
00:01:35.135 +            'found' => 'string'
00:01:35.135 +            'expected' => 'a number'
00:01:35.135 +        )
00:01:35.135 +    )
00:01:35.135  )
00:01:35.135 
00:01:35.135 /workspace/src/extensions/CommunityConfiguration/tests/phpunit/unit/Validation/JsonSchemaValidatorTest.php:359

We should:

figure out if any production code changes are required to make use of the v6 version
figure out how to adjust the tests so that they either work with both v5 and v6 of the library, or disable the tests, do the library update, and then reenable them for v6
investigate if the new version of the library contains any improvements that we may want to make use of

Details

Related Changes in Gerrit:

Subject	Repo	Branch	Lines +/-
JsonSchemaValidator: Prepare for justinrainbow/json-schema 6.x	mediawiki/extensions/CommunityConfiguration	master	+7 -2
JsonSchemaValidatorTest: Test for justinrainbow/json-schema 6.x	mediawiki/extensions/CommunityConfiguration	master	+0 -0
JsonSchemaValidatorTest: Update for justinrainbow/json-schema 6.x	mediawiki/extensions/CommunityConfiguration	master	+168 -30

Customize query in gerrit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Open		None	T412876 Upgrade justinrainbow/json-schema to 6.x
		Open	Spike	Michael	T415261 Prepare upgrade to justinrainbow/json-schema to 6.x in CommunityConfiguration

Event Timeline

Michael created this task.Jan 22 2026, 1:59 PM

Restricted Application removed a project: Patch-For-Review. · View Herald TranscriptJan 22 2026, 1:59 PM

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

Sgs subscribed.Jan 22 2026, 3:45 PM

Michael mentioned this in T388380: Migrate Community Configuration PHP library from justinrainbow/json-schema to opis/json-schema.Jan 22 2026, 5:25 PM

Michael mentioned this in T383719: Declare the Community Configuration extension stable.Jan 22 2026, 5:39 PM

Reedy moved this task from Backlog to Wikimedia production on the PHP 8.5 support board.Jan 25 2026, 2:55 AM

Pppery removed projects: MediaWiki-Vendor, MediaWiki-General.Jan 27 2026, 12:12 AM

Change #1233935 had a related patch set uploaded (by Reedy; author: Reedy):

[mediawiki/extensions/CommunityConfiguration@master] JsonSchemaValidatorTest: Update for justinrainbow/json-schema 6.x

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

gerritbot added a project: Patch-For-Review.Jan 28 2026, 12:43 AM

Change #1233943 had a related patch set uploaded (by Reedy; author: Reedy):

[mediawiki/extensions/CommunityConfiguration@master] JsonSchemaValidatorTest: Test for justinrainbow/json-schema 6.x

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

Sgs moved this task from Inbox to Needs Estimation on the Growth-Team board.Jan 29 2026, 4:23 PM

KStoller-WMF triaged this task as Medium priority.Feb 2 2026, 5:47 PM

This is more of a spike task, where we need to understand what work we need to do.

KStoller-WMF set the point value for this task to 3.Mar 9 2026, 3:56 PM

KStoller-WMF moved this task from Needs Estimation to Estimated tasks backlog on the Growth-Team board.

KStoller-WMF moved this task from Estimated tasks backlog to FY2025-26 Q4 Sprint 2 on the Growth-Team board.Apr 21 2026, 5:00 PM

KStoller-WMF edited projects, added: Growth-Team (FY2025-26 Q4 Sprint 2); removed: Growth-Team.

Michael claimed this task.Apr 27 2026, 6:32 PM

Restricted Application added a project: User-Michael. · View Herald TranscriptApr 27 2026, 6:32 PM

Michael moved this task from Incoming to Doing on the Growth-Team (FY2025-26 Q4 Sprint 2) board.Apr 28 2026, 3:15 PM

Ok, so I looked into this, and I think in practice the actual changes are almost only related to tests?

The upgrade changes what the API returns in the additionalData field if there is a validation issue. However, crucially, I could not find any users of that field! (code search, none of the other uses seem to refer to the CommunityConfiguration api.)
That makes somewhat sense, as that field introduced as "intentionally undocumented" in Introduce ValidationStatus.

Still, it would be great if someone could verify that it is indeed unused.

Change #1285405 had a related patch set uploaded (by Michael Große; author: Reedy):

[mediawiki/extensions/CommunityConfiguration@master] JsonSchemaValidator: Prepare for justinrainbow/json-schema 6.x

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

I read through your reasoning and the linked code search results. I think your reasoning makes sense, but I'd like an engineer who was on the team when ValidationStatus was introduced to double-check this.

Michael added a project: Essential-Work.May 11 2026, 11:07 AM

In T415261#11902939, @Michael wrote:

Ok, so I looked into this, and I think in practice the actual changes are almost only related to tests?

The upgrade changes what the API returns in the additionalData field if there is a validation issue. However, crucially, I could not find any users of that field! (code search, none of the other uses seem to refer to the CommunityConfiguration api.)
That makes somewhat sense, as that field introduced as "intentionally undocumented" in Introduce ValidationStatus.

Still, it would be great if someone could verify that it is indeed unused.

It looks indeed unused. I would consider even removing it if we don't have a good use case for it, but that's not part of this task.

DMburugu moved this task from FY2025-26 Q4 Sprint 2 to Estimated tasks backlog on the Growth-Team board.Mon, May 18, 2:04 PM

DMburugu edited projects, added: Growth-Team; removed: Growth-Team (FY2025-26 Q4 Sprint 2).

Change #1285405 merged by jenkins-bot: