UserClearNewTalkNotification hook: document UserIdentity instead of User
Closed, ResolvedPublic
Actions

Description

As part of T208777: Factor notification-related methods out of User and Title, introduce WatchlistNotificationManager, the replacement for User::clearNotification should only require a UserIdentity, not a full User.

The only place in the method where a full User object is required in for the hook, UserClearNewTalkNotification
Since strong typehinting was only added to hooks in the migration to interfaces in the current version, I don't believe that the object being a User is a part of the stable interface.

According to code search[1], the hook has exactly 1 use, in Echo.

I propose:

Update Echo to expect a UserIdentity rather than a User
Update interface documentation to type against a UserIdentity rather than a User

[1] https://codesearch.wmflabs.org/search/?q=UserClearNewTalkNotification&i=nope&files=&repos=

Details

	Subject	Repo	Branch	Lines +/-
	UserClearNewTalkNotification hook: Only guarantee a UserIdentity	mediawiki/core	master	+6 -6
	UserClearNewTalkNotification: Only require a UserIdentity	mediawiki/extensions/Echo	master	+6 -5

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Open	None	T208764 Remove cyclic dependency between Title and User classes
Resolved	DannyS712	T208777 Factor notification-related methods out of User and Title, introduce WatchlistNotificationManager
Resolved	DannyS712	T253435 UserClearNewTalkNotification hook: document UserIdentity instead of User

Event Timeline

DannyS712 created this task.May 23 2020, 5:05 AM

Change 598146 had a related patch set uploaded (by DannyS712; owner: DannyS712):
[mediawiki/extensions/Echo@master] UserClearNewTalkNotification: Only require a UserIdentity

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

gerritbot added a project: Patch-For-Review.May 23 2020, 5:06 AM

DannyS712 added a project: Platform Team Workboards (External Code Reviews).May 23 2020, 5:07 AM

DannyS712 moved this task from Unsorted to In progress on the User-DannyS712 board.

Change 598146 merged by jenkins-bot:
[mediawiki/extensions/Echo@master] UserClearNewTalkNotification: Only require a UserIdentity

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

Change 599757 had a related patch set uploaded (by DannyS712; owner: DannyS712):
[mediawiki/core@master] UserClearNewTalkNotification hook: Only guarantee a UserIdentity

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

DannyS712 updated the task description. (Show Details)May 29 2020, 9:22 AM

DannyS712 moved this task from In progress to Awaiting review and deployment on the User-DannyS712 board.

Change 599757 merged by jenkins-bot:
[mediawiki/core@master] UserClearNewTalkNotification hook: Only guarantee a UserIdentity

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

DannyS712 closed this task as Resolved.May 29 2020, 10:48 AM

DannyS712 removed a project: Patch-For-Review.

ReleaseTaggerBot added a project: MW-1.35-notes (1.35.0-wmf.35; 2020-06-02).May 30 2020, 8:02 AM

DannyS712 moved this task from Awaiting review and deployment to Merged on the User-DannyS712 board.Jul 9 2020, 11:15 PM