Declare Wikibase JavaScript hooks stable
Closed, ResolvedPublic2 Estimated Story Points
Actions

Description

We want to declare the wikibase.entityPage.entityLoaded, wikibase.statement.saved, wikibase.statement.removed, and perhaps wikibase.entityPage.entityView.rendered hooks as stable interfaces.

We might also want to amend the Stable Interface Policy to clarify that adding arguments to a hook is not a breaking change. (I have to admit, I don’t remember what the PM / Engineering Time decision on this was – were we going to do this or not?)

This includes making and maintaining the documentation of JS hooks on mediawiki.org.

https://www.wikidata.org/wiki/Wikidata:Stable_Interface_Policy

Tasks:

Add documentation about hooks to mediawiki.org. https://www.mediawiki.org/wiki/Extension:Wikibase_Repository
Add documentation about hooks in the code (/docs/hooks.txt)
Add a section about JS hook to Stable Interface Policy on wikidata.org

Details

	Subject	Repo	Branch	Lines +/-
	Split hooks documentation by programming language	mediawiki/extensions/Wikibase	master	+13 -14
	Add documentation about JavaScript hooks	mediawiki/extensions/Wikibase	master	+13 -0

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Declined	None	T59765 Provide JavaScript hook
Resolved	Lydia_Pintscher	T63131 Eliminate or reduce delay between selection of property and displaying of input fields when adding statements
Resolved	None	T58090 Do not change targets to javascript:void(0); on JavaScript load for various "edit" links
Invalid	None	T56098 [Epic][UI] Front-end performance: Improve loading time of items
Resolved	Ladsgroup	T85499 wbEntity shouldn't be served on every page load
Resolved	Lea_Lacroix_WMDE	T169775 Declare Wikibase JavaScript hooks stable

Event Timeline

Lucas_Werkmeister_WMDE created this task.Jul 5 2017, 4:35 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJul 5 2017, 4:35 PM

Lucas_Werkmeister_WMDE updated the task description. (Show Details)Jul 18 2017, 10:25 AM

Lucas_Werkmeister_WMDE mentioned this in T189599: Create hook when entity view has finished rendering.Mar 13 2018, 3:34 PM

Lucas_Werkmeister_WMDE updated the task description. (Show Details)Mar 14 2018, 11:58 AM

Lucas_Werkmeister_WMDE updated the task description. (Show Details)Mar 14 2018, 12:51 PM

• Jonas added a project: Wikidata-Campsite.Jul 16 2018, 10:50 AM

• Jonas moved this task from Incoming to Ready to estimate on the Wikidata-Campsite board.Jul 24 2018, 7:17 PM

• Jonas updated the task description. (Show Details)Jul 24 2018, 7:21 PM

Addshore subscribed.Jul 27 2018, 9:14 AM

Before: check that statement.removed and statement.saved hooked are passed the Form or Sense ID, when the statement on form- or sense-level on lexemes is in question.

WMDE-leszek updated the task description. (Show Details)Jul 31 2018, 1:27 PM

WMDE-leszek set the point value for this task to 2.

WMDE-leszek updated the task description. (Show Details)Jul 31 2018, 2:05 PM

Let me know if you need help for this. I'll also take care of announcing it on the community channels.

@Jonas: it was not really discussed earlier, but do you think doing this deserves some ADR document to be added to Wikibase repo?

Do you mean the decision to use mw.hooks in Wikibase JS?
Or what exactly you think should be documented?

that hooks are made stable (this is the decision)
what were the arguments in favour doing this
what implications does it have for developers of Wikibase

Basically, I think it make sense to say _together_with_code_ that if you change this, you need to X and Z.

• Jonas claimed this task.Aug 20 2018, 9:09 AM

• Jonas moved this task from Ready to estimate to In Progress on the Wikidata-Campsite board.

• Jonas updated the task description. (Show Details)Aug 20 2018, 9:16 AM

• Jonas updated the task description. (Show Details)Aug 20 2018, 9:42 AM

Change 454012 had a related patch set uploaded (by Jonas Kress (WMDE); owner: Jonas Kress (WMDE)):
[mediawiki/extensions/Wikibase@master] Add documentation about JavaScript hooks

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

gerritbot added a project: Patch-For-Review.Aug 20 2018, 1:11 PM

• Jonas updated the task description. (Show Details)Aug 20 2018, 1:13 PM

• Jonas updated the task description. (Show Details)

Addshore added a project: Wikidata-Campsite (Wikidata-Campsite-Iteration-∞ (On Hold)).Aug 23 2018, 9:27 AM

Addshore moved this task from To Do (prioritised from top to bottom) to Doing on the Wikidata-Campsite (Wikidata-Campsite-Iteration-∞ (On Hold)) board.Aug 23 2018, 9:27 AM

Change 454012 merged by jenkins-bot:
[mediawiki/extensions/Wikibase@master] Add documentation about JavaScript hooks

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

ReleaseTaggerBot added a project: MW-1.32-notes (WMF-deploy-2018-08-28 (1.32.0-wmf.19)).Aug 24 2018, 3:00 PM

• Jonas updated the task description. (Show Details)Aug 27 2018, 11:58 AM

@Addshore @WMDE-leszek if you agree I would add a section 'Stable hooks' to the https://www.wikidata.org/wiki/Wikidata:Stable_Interface_Policy stating that all hooks defined in https://phabricator.wikimedia.org/diffusion/EWBA/browse/master/docs/hooks.txt excluding deprecated hooks are considered stable.

In T169775#4534151, @Jonas wrote:

@Addshore @WMDE-leszek if you agree I would add a section 'Stable hooks' to the https://www.wikidata.org/wiki/Wikidata:Stable_Interface_Policy stating that all hooks defined in https://phabricator.wikimedia.org/diffusion/EWBA/browse/master/docs/hooks.txt excluding deprecated hooks are considered stable.

Per the policy:

Wikibase PHP code is not considered a stable interface. Since there are currently no official releases of the Wikibase extension, just a rolling deployment to wikidata.org, there is no point in time at which any given PHP class or interface can be assumed to remain stable.

PHP hooks shouldn't be added / marked as stable

Yes, I'd rather see the policy only mention JS hooks explicitly.

Change 455785 had a related patch set uploaded (by Jonas Kress (WMDE); owner: Jonas Kress (WMDE)):
[mediawiki/extensions/Wikibase@master] Split hooks documentation by programming language

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

• Jonas moved this task from Doing to Test (Verification) on the Wikidata-Campsite (Wikidata-Campsite-Iteration-∞ (On Hold)) board.Aug 28 2018, 2:37 PM

Change 455785 merged by jenkins-bot:
[mediawiki/extensions/Wikibase@master] Split hooks documentation by programming language

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

ReleaseTaggerBot edited projects, added MW-1.32-notes (WMF-deploy-2018-09-04 (1.32.0-wmf.20)); removed MW-1.32-notes (WMF-deploy-2018-08-28 (1.32.0-wmf.19)).Aug 29 2018, 8:00 AM

Text for the wiki and the announcement on the mailing list:
To allow better gadget integration hooks (JavaScript) documented in this file hooks-js.txt are considered stabled

\o/
All good from my side besides small typo at end of message (stabled -> stable).

So final text:

To allow better gadget integration JavaScript hooks documented in the hooks-js.txt file delivered together with Wikibase source code are considered stable.

https://www.wikidata.org/w/index.php?title=Wikidata%3AStable_Interface_Policy&type=revision&diff=741948123&oldid=716051185

WMDE-leszek reassigned this task from • Jonas to Lea_Lacroix_WMDE.Sep 7 2018, 4:11 PM

WMDE-leszek updated the task description. (Show Details)

WMDE-leszek moved this task from Test (Verification) to Needs Announcement on the Wikidata-Campsite (Wikidata-Campsite-Iteration-∞ (On Hold)) board.

Lea_Lacroix_WMDE closed this task as Resolved.Sep 7 2018, 6:45 PM

Lea_Lacroix_WMDE moved this task from Needs Announcement to Done on the Wikidata-Campsite (Wikidata-Campsite-Iteration-∞ (On Hold)) board.

Addshore removed a project: Wikidata-Campsite.Nov 1 2018, 11:22 AM