Maniphest T196962

Module prefix 'wbeu' is shared between Wikibase\Client\Api\ApiListEntityUsage and Wikibase\Client\Api\ApiPropsEntityUsage
Closed, ResolvedPublic3 Estimated Story Points
Actions

Assigned To

Authored By

	Legoktm
	Jun 12 2018, 1:22 AM

Description

Noticed as part of https://gerrit.wikimedia.org/r/c/mediawiki/core/+/439794. The module prefix needs to be globally unique.

While running MediaWiki core tests with Wikibase, I eventually got a failure:

1) PrefixUniquenessTest::testPrefixes
Module prefix 'wbeu' is shared between Wikibase\Client\Api\ApiListEntityUsage and Wikibase\Client\Api\ApiPropsEntityUsage

tests/phpunit/includes/api/PrefixUniquenessTest.php:24
tests/phpunit/MediaWikiTestCase.php:469
maintenance/doMaintenance.php:94

PrefixUniquenessTest::testPrefixes is described as:

Checks that all API query modules, core and extensions, have unique prefixes.

It is part of mediawiki/core, since the test is not a structure test, it is never run for extension, only for mediawiki/core patches. Which explains why it has never been noticed yet.

Related code:

client/includes/Api/ApiListEntityUsage.php:34:          parent::__construct( $query, $moduleName, 'wbeu' );
client/includes/Api/ApiPropsEntityUsage.php:32:         parent::__construct( $query, $moduleName, 'wbeu' );

Module references:

Class:	ApiPropsEntityUsage	ApiListEntityUsage
Doc	https://www.wikidata.org/w/api.php?action=help&recursivesubmodules=1#query+wbentityusage	https://www.wikidata.org/w/api.php?action=help&recursivesubmodules=1#query+wblistentityusage
Call	prop=wbentityusage	list=wblistentityusage
Initial commit	c2364b8ac2ec62b74dc076129f12f0a3515b94e3	382ac75c7b8cecf7ab518e5119e5cd2f1187dbc3
Feature task	T143118	T143147

NOTE: This is a breaking change. Announcement is being prepared here.

Details

Subject	Repo	Branch	Lines +/-
ApiPrefixUniquenessTest: Drop wbeu hack	mediawiki/core	master	+1 -1
ApiListEntityUsage: Remove legacy prefix	mediawiki/extensions/Wikibase	master	+62 -212
wblistentityusage: Deprecate wbeu prefix, new output format	mediawiki/extensions/Wikibase	wmf/1.41.0-wmf.6	+197 -26
wblistentityusage: Deprecate wbeu prefix, new output format	mediawiki/extensions/Wikibase	wmf/1.41.0-wmf.7	+197 -26
wblistentityusage: Deprecate wbeu prefix, new output format	mediawiki/extensions/Wikibase	master	+197 -26

Customize query in gerrit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Resolved		Arian_Bozorg	T330130 API changes Spring 2023
		Resolved		hoo	T196962 Module prefix 'wbeu' is shared between Wikibase\Client\Api\ApiListEntityUsage and Wikibase\Client\Api\ApiPropsEntityUsage

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes

Fixing it is one line change (might need to change some tests too but very unlikely) but it's a public interface and per stable interface policy it has to be announced beforehand. @Lydia_Pintscher would it work for you?

Krinkle awarded a token.Jun 26 2018, 1:41 AM

• Vvjjkkii renamed this task from Module prefix 'wbeu' is shared between Wikibase\Client\Api\ApiListEntityUsage and Wikibase\Client\Api\ApiPropsEntityUsage to 57aaaaaaaa.Jul 1 2018, 1:04 AM

• Vvjjkkii triaged this task as High priority.

• Vvjjkkii added projects: CheckUser, Connected-Open-Heritage-Batch-uploads (RAÄ-KMB_1_2017-02), Tamil-Sites, Gamepress, Hashtags, Jade, KartoEditor, Language-2018-Apr-June, New-Editor-Experiences, Mail, TCB-Team (now WMDE-TechWish).

• Vvjjkkii updated the task description. (Show Details)

• Vvjjkkii removed subscribers: gerritbot, Aklapper.

CommunityTechBot renamed this task from 57aaaaaaaa to Module prefix 'wbeu' is shared between Wikibase\Client\Api\ApiListEntityUsage and Wikibase\Client\Api\ApiPropsEntityUsage.Jul 2 2018, 2:09 PM

CommunityTechBot raised the priority of this task from High to Needs Triage.

CommunityTechBot updated the task description. (Show Details)

CommunityTechBot removed projects: TCB-Team (now WMDE-TechWish), Mail, New-Editor-Experiences, Language-2018-Apr-June, KartoEditor, Jade, Hashtags, Gamepress, Tamil-Sites, Connected-Open-Heritage-Batch-uploads (RAÄ-KMB_1_2017-02), CheckUser.

CommunityTechBot added subscribers: gerritbot, Aklapper.

@Lydia_Pintscher so the "wbeu" prefix this mentions is used in parameter names of the particular API modules.
This can be seen at https://en.wikipedia.org/w/api.php?action=help&modules=query%2Bwbentityusage and https://en.wikipedia.org/w/api.php?action=help&modules=query%2Bwblistentityusage.
If one (or both) of API module would have their prefix changed, this would mean the parameter names would change as well. This change would be a subject to wikidata's stable interface policy (any users using parameter would probably need to adjust their API calls).

Ok cool. Then I think it's fine. It should indeed follow the stable interface policy. Can you work with @Lea_Lacroix_WMDE on the announcement?

Change 454049 had a related patch set uploaded (by Jforrester; owner: Jforrester):
[mediawiki/core@master] ApiPrefixUniquenessTest: Drop wbeu hack

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

gerritbot added a project: Patch-For-Review.Aug 20 2018, 4:13 PM

When I make an API call with action=query and generator=wblistentityusage, like https://en.wikipedia.org/w/api.php?action=query&generator=wblistentityusage&gwbeuentities=Q42 I get an RuntimeException:

{
    "error": {
        "code": "internal_api_error_RuntimeException",
        "info": "[66cd48ca-659d-4873-92dc-505e78f08159] Caught exception of type RuntimeException",
        "errorclass": "RuntimeException"
    },
    "servedby": "mw1382"
}

I get the expected result if I use action=list and list=wblistentityusage, like in https://en.wikipedia.org/w/api.php?action=query&list=wblistentityusage&wbeuentities=Q42.

Is this a consequence of the shared module prefix, or should I create a new task for the RuntimeException?

hashar unsubscribed.May 22 2020, 1:18 PM

• Lucas_Werkmeister_WMDE updated the task description. (Show Details)Jun 3 2020, 10:11 AM

@Dipsacus_fullonum no, that’s an independent error (I was still able to reproduce it locally after disabling the prop=wbentityusage module). I’ve reported it as T254334: WikibaseClient wblistentityusage API module throws RuntimeException when used as generator.

Aklapper removed a subscriber: Anomie.Oct 16 2020, 5:01 PM

Change 719554 had a related patch set uploaded (by Inductiveload; author: Inductiveload):

[mediawiki/core@master] Api prefix uniqueness: suppress for 'pi'

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

Inductiveload mentioned this in T290585: ProofreadPage and PageImages share an API prefix (pi).Sep 8 2021, 4:38 PM

LucasWerkmeister mentioned this in T300460: [API] WikibaseClient: wblistentityusage API module adds its results to the `query.pages` key in response.Jan 30 2022, 3:50 PM

How can we move forward on this?

@ItamarWMDE maybe we can pull this, T300460 and T254334 into the tech backlog, as a general “fix the entity usage API(s)” project? (At least two of the tasks, and maybe all three, probably require a breaking change to the API, so it would be best to do them at the same time.)

Restricted Application added a project: User-ItamarWMDE. · View Herald TranscriptOct 4 2022, 1:21 PM

Sure, I will need more context on why this was stalled to begin with, but let's discuss this in tech prio.

ItamarWMDE added a project: wmde-wikidata-tech.Oct 17 2022, 3:36 PM

Maintenance_bot moved this task from Inbox to Sorted Team A on the [DEPRECATED] wdwb-tech board.Oct 17 2022, 4:15 PM

Prio Notes:

Affects end users / production systems (consult product about breaking change to stable interface)
Does not affect development efforts (These tests are currently not running)
Does not affect onboarding efforts
Does affect additional stakeholders (Tests are run for core, where they fail - but are blocked by a special case)

ItamarWMDE moved this task from Incoming to [DOT] Prioritized on the wmde-wikidata-tech board.Oct 25 2022, 9:06 AM

ItamarWMDE added a project: Wikidata Dev Team.

ItamarWMDE moved this task from Incoming to [DOT] Tech Backlog on the Wikidata Dev Team board.Oct 25 2022, 2:03 PM

We decided to wait with this task in anticipation for T327062: Show entity labels in parsed edit summaries in API requests as well as we want to batch together announcements of significant changes

ItamarWMDE moved this task from [DOT] Prioritized to Ongoing on the wmde-wikidata-tech board.Jan 18 2023, 4:45 PM

ItamarWMDE moved this task from [DOT] Tech Backlog to Epics+STALLED on the Wikidata Dev Team board.Jan 20 2023, 8:33 AM

• Lucas_Werkmeister_WMDE mentioned this in T254334: WikibaseClient wblistentityusage API module throws RuntimeException when used as generator.Jan 30 2023, 4:02 PM

karapayneWMDE mentioned this in T330130: API changes Spring 2023.Feb 21 2023, 10:01 AM

Lydia_Pintscher added a parent task: T330130: API changes Spring 2023.Feb 21 2023, 10:05 AM

karapayneWMDE set the point value for this task to 3.Feb 21 2023, 10:21 AM

karapayneWMDE moved this task from Epics+STALLED to Unified DOT Backlog on the Wikidata Dev Team board.

See T300460#8625492 for my latest suggestion for how to fix this without inconveniencing API users too much.

ItamarWMDE changed the task status from Stalled to Open.Feb 21 2023, 10:23 AM

ItamarWMDE moved this task from Radar to Radar on the User-ItamarWMDE board.Feb 22 2023, 10:58 AM

Change 893508 had a related patch set uploaded (by Hoo man; author: Hoo man):

[mediawiki/extensions/Wikibase@master] wblistentityusage: Deprecate wbeu prefix, new output format

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

Lydia_Pintscher updated the task description. (Show Details)Apr 6 2023, 1:50 PM

Sarai-WMDE moved this task from Unified DOT Backlog to Sprint-∞ on the Wikidata Dev Team board.Apr 18 2023, 9:29 AM

Sarai-WMDE edited projects, added Wikidata Dev Team (Sprint-∞); removed Wikidata Dev Team.

ItamarWMDE moved this task from Parents/Waiting to Todo/Backlog on the Wikidata Dev Team (Sprint-∞) board.Apr 20 2023, 7:43 AM

I think this can go back to waiting, actually – the Gerrit change exists and I already reviewed it, and it’s only blocked on the announcement / timing and otherwise ready.

Change 914297 had a related patch set uploaded (by Michael Große; author: Hoo man):

[mediawiki/extensions/Wikibase@wmf/1.41.0-wmf.7] wblistentityusage: Deprecate wbeu prefix, new output format

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

Change 893508 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] wblistentityusage: Deprecate wbeu prefix, new output format

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

ItamarWMDE moved this task from Parents/Waiting to Todo/Backlog on the Wikidata Dev Team (Sprint-∞) board.May 3 2023, 9:16 AM

Change 914437 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Hoo man):

[mediawiki/extensions/Wikibase@wmf/1.41.0-wmf.6] wblistentityusage: Deprecate wbeu prefix, new output format

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

Change 914297 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@wmf/1.41.0-wmf.7] wblistentityusage: Deprecate wbeu prefix, new output format

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

Mentioned in SAL (#wikimedia-operations) [2023-05-03T10:00:32Z] <lucaswerkmeister-wmde@deploy1002> Started scap: Backport for [[gerrit:914297|wblistentityusage: Deprecate wbeu prefix, new output format (T300460 T196962)]]

Mentioned in SAL (#wikimedia-operations) [2023-05-03T10:18:46Z] <lucaswerkmeister-wmde@deploy1002> lucaswerkmeister-wmde and migr: Backport for [[gerrit:914297|wblistentityusage: Deprecate wbeu prefix, new output format (T300460 T196962)]] synced to the testservers: mwdebug1002.eqiad.wmnet, mwdebug2002.codfw.wmnet, mwdebug2001.codfw.wmnet, mwdebug1001.eqiad.wmnet

Mentioned in SAL (#wikimedia-operations) [2023-05-03T10:35:25Z] <lucaswerkmeister-wmde@deploy1002> Finished scap: Backport for [[gerrit:914297|wblistentityusage: Deprecate wbeu prefix, new output format (T300460 T196962)]] (duration: 34m 53s)

HasanAkgun_WMDE moved this task from Todo/Backlog to Peer Review on the Wikidata Dev Team (Sprint-∞) board.May 3 2023, 11:41 AM

Change 914437 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@wmf/1.41.0-wmf.6] wblistentityusage: Deprecate wbeu prefix, new output format

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

Mentioned in SAL (#wikimedia-operations) [2023-05-03T13:24:30Z] <lucaswerkmeister-wmde@deploy1002> Started scap: Backport for [[gerrit:914437|wblistentityusage: Deprecate wbeu prefix, new output format (T300460 T196962)]]

Mentioned in SAL (#wikimedia-operations) [2023-05-03T13:41:59Z] <lucaswerkmeister-wmde@deploy1002> lucaswerkmeister-wmde: Backport for [[gerrit:914437|wblistentityusage: Deprecate wbeu prefix, new output format (T300460 T196962)]] synced to the testservers: mwdebug2002.codfw.wmnet, mwdebug2001.codfw.wmnet, mwdebug1001.eqiad.wmnet, mwdebug1002.eqiad.wmnet

Mentioned in SAL (#wikimedia-operations) [2023-05-03T13:52:25Z] <lucaswerkmeister-wmde@deploy1002> Finished scap: Backport for [[gerrit:914437|wblistentityusage: Deprecate wbeu prefix, new output format (T300460 T196962)]] (duration: 27m 54s)

back to Waiting until we can drop support for the old prefix.

ReleaseTaggerBot added a project: MW-1.41-notes (1.41.0-wmf.10; 2023-05-23).May 16 2023, 5:01 AM

ReleaseTaggerBot edited projects, added MW-1.41-notes (1.41.0-wmf.7; 2023-05-01); removed MW-1.41-notes (1.41.0-wmf.10; 2023-05-23).May 16 2023, 7:02 AM

Task Breakdown Notes:

We concluded that the only remaining work on this ticket is to remove support for the old prefix, therefore, we will create a subtask for this.
As this change doesn't rely on configuration, and it is already live, we can just let the support for the old prefix drop with the next train. i.e. this doesn't require a deployment window scheduling.
By looking at the changes made by Marius (893508 on gerrit) we can ascertain which methods and parameters should be removed n order to only support the new prefix. In case of doubt, ask @hoo