Page MenuHomePhabricator
Create Task
Maniphest T219222

Make notification counts update without page reload
Closed, ResolvedPublic
Actions

Description

Extension:Echo provides a notification system for MediaWiki. This system includes a set of icons in the header that are updated with a count of notifications on page load. There is a long-standing request for the notifications count to update without requiring a page reload, similar to how Special:RecentChanges provides live updates.

This project will involve:

  • updating the notifications count via a polling mechanism. There is some existing code (Echo/+/126201, Echo/+/239766) and discussion that can be used as a reference point.
  • (optional) Writing the code and user preference to temporarily display the notification text using the mw.notify() library
  • (optional) Providing a visual cue that the count has updated

Skills required Knowledge of JavaScript. PHP knowledge will be helpful

Mentors Kosta Harlan (@kostajh), Roan Kattouw (@Catrope)

Microtasks

Details

SubjectRepoBranchLines +/-
Echo: Enable poll for updates feature on testwiki and mediawikiwikioperations/mediawiki-configmaster+7 -0
Make Notification count update without page reloadmediawiki/extensions/Echomaster+108 -69
Echo: Enable poll for updates feature on enwiki betaoperations/mediawiki-configmaster+1 -0
Make notification count update without page reloadmediawiki/extensions/Echomaster+44 -0
Customize query in gerrit

Related Objects
Search...

StatusSubtypeAssignedTask
 ResolvedNoneT14884 Login and account creation should be by secure http.
 InvalidNoneT11816 Improve security for Special:Userlogin (tracking)
 InvalidWikinautT3932 [DO NOT USE] ENotif/EConfirm & further enhancements (tracking) [superseded by #MediaWiki-Email]
 OpenNoneT125653 Create new types of notifications
 OpenFeatureNoneT5234 Extend edit-user-talk notification to include edits to subpages of a user's talk page
 Resolved• demonT11838 Send notification to account owner on multiple unsuccessful login attempts
 DuplicateNoneT21248 Hotwatch: User_talk-style banner notifications for select article changes
 DeclinedQuiddityT22541 Watchlist, LiquidThreads and Echo notifications need to be unified
 ResolvedNoneT29829 welcome users without relying on additions to talk page
 ResolvedGalorefitzT31856 Email notification to old address when verified email address is changed or removed
 DeclinedNoneT13636 Allowing watchlist notifications if the watchlist is smaller than a certain size
 OpenFeatureNoneT31857 Welcome back email notification after renewed account activity
 ResolvedkostajhT34281 MediaWiki needs a sane notification system (tracking)
 OpenNoneT75209 The document title should be dynamically updated to include a (n) notifications count in the browser title bar.
 StalledNoneT116243 Offer system tray area desktop notifications
 OpenNoneT34284 Update Echo Notifications in real time without page reloads
 ResolvedShivanshbindal9T219222 Make notification counts update without page reload
 ResolvedShivanshbindal9T225259 Visual Cue to indicate change in notification count
 OpenNoneT226127 Change the color of Alert/Message indicator.
 ResolvedShivanshbindal9T226130 Display notification text for incoming notification
 ResolvedShivanshbindal9T227501 Change polling rate when document not visible
 ResolvedShivanshbindal9T229732 Define preference for poll updates
 OpenNoneT231697 Notifications auto-updater should be able to get the updates with one API call, not two

Event Timeline

kostajh created this task.Mar 25 2019, 7:47 PM
Restricted Application added a project: Growth-Team. · View Herald TranscriptMar 25 2019, 7:47 PM
Restricted Application added a subscriber: Aklapper. · View Herald Transcript
kostajh updated the task description. (Show Details)Mar 25 2019, 7:49 PM
Catrope updated the task description. (Show Details)Mar 25 2019, 7:49 PM
Catrope updated the task description. (Show Details)
Catrope updated the task description. (Show Details)Mar 25 2019, 7:51 PM
kostajh added a project: Google-Summer-of-Code (2019).Mar 25 2019, 8:11 PM
srishakatux moved this task from Backlog to Featured Projects on the Google-Summer-of-Code (2019) board.Mar 25 2019, 8:13 PM
kostajh updated the task description. (Show Details)Mar 29 2019, 2:21 AM
kostajh mentioned this in T139779: Kill badgeicons.json and use OOUI's icons-alerts.json instead.
Shivanshbindal9 subscribed.Apr 1 2019, 9:34 AM

Hi @kostajh @Catrope, I am a sophomore at Indian Institute of Technology, Roorkee, India. I have a good experience in Javascript, React, Python, Django(python), PHP, Yii2(PHP framework). I have been contributing to various projects of WikiMedia for some time such as WikiEduDashboard and MediaWiki Action API and have got some PR's merged. I recently came across the project idea and will like to contribute to this project either in GSoC 19 or apart from GSoC 19 would be fine too. I have already started working on the microtasks and will soon add patches for review once I get the developer's account.

Shivanshbindal9 added a comment.Apr 1 2019, 7:08 PM

Hello @kostajh @Catrope, I have certain doubts regarding the project

  1. Along with making live updates on https://www.mediawiki.org/wiki/Special:Notifications similar to that in Special:RecentChanges do we need to make the counter of notifications change itself using polling mechanism as mentioned in the discussion?
    notice_bar.png (49×741 px, 7 KB)
  2. The user should be notified of any notification on any page not just only on the notification page (Writing the code and user preference to temporarily display the notification text using the mw.notify() library)

I'll be highly grateful if you could please help me with it.
Thank you

kostajh added a comment.Apr 1 2019, 7:30 PM

Along with making live updates on https://www.mediawiki.org/wiki/Special:Notifications similar to that in Special:RecentChanges do we need to make the counter of notifications change itself using polling mechanism as mentioned in the discussion?

@Shivanshbindal9 the primary goal for this project is to update the notification counter in the header, along with a visual indicator that there are new notifications. Making Special:Notifications update via polling is an optional follow-up item.

The user should be notified of any notification on any page not just only on the notification page (Writing the code and user preference to temporarily display the notification text using the mw.notify() library)

Yes, the idea is to have this happen on any page. But this is an optional task and the details could be decided out later.

I have already started working on the microtasks and will soon add patches for review once I get the developer's account.

That's great! Looking forward to seeing the patches. :)

JTannerWMF moved this task from Inbox to External on the Growth-Team board.Apr 2 2019, 6:04 PM
JTannerWMF subscribed.

We are moving this to External because it is for the Google Summer of Code program.

kostajh updated the task description. (Show Details)Apr 2 2019, 8:27 PM
Shivanshbindal9 added a comment.EditedApr 2 2019, 9:00 PM

Hi @kostajh, should I work on some microtasks, as some new microtasks have been added, or should I start with the proposal, as you advised me to?
I would be really grateful if you could help.
Thank you

Shivanshbindal9 added a comment.Apr 8 2019, 5:58 PM

Hi @kostajh @Catrope , I am almost done with my proposal (https://phabricator.wikimedia.org/T220324). I don't want to seem to interrupt but I'll be grateful if you could review it and suggest changes so that I can refine my proposal.
Thank you

gerritbot added a comment.May 28 2019, 6:34 PM

Change 512943 had a related patch set uploaded (by Shivanshbindal9; owner: shivanshbindal9):
[mediawiki/extensions/Echo@master] This is a sample module for notification count update without page reload.

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

gerritbot added a project: Patch-For-Review.May 28 2019, 6:34 PM
Shivanshbindal9 claimed this task.May 29 2019, 3:05 PM
kostajh mentioned this in T168570: JavaScript function to update notifications.Jun 6 2019, 7:30 PM
kostajh merged a task: T168570: JavaScript function to update notifications.
kostajh added subscribers: Nirmos, Mooeypoo.
Shivanshbindal9 added a subtask: T225259: Visual Cue to indicate change in notification count.Jun 6 2019, 10:35 PM
gerritbot added a comment.Jun 10 2019, 7:02 PM

Change 512943 abandoned by Shivanshbindal9:
Make notification count update without page reload

Reason:
The new implementation using MVC is addressed in https://gerrit.wikimedia.org/r/c/mediawiki/extensions/Echo/ /516285/

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

gerritbot added a comment.Jun 11 2019, 5:54 PM

Change 516285 had a related patch set uploaded (by Shivanshbindal9; owner: shivanshbindal9):
[mediawiki/extensions/Echo@master] Make Notification count update without page reload

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

gerritbot added a comment.Jun 18 2019, 11:39 PM

Change 516285 merged by jenkins-bot:
[mediawiki/extensions/Echo@master] Make Notification count update without page reload

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

ReleaseTaggerBot added a project: MW-1.34-notes (1.34.0-wmf.11; 2019-06-26).Jun 19 2019, 12:00 AM
matej_suchanek added a parent task: T34284: Update Echo Notifications in real time without page reloads.Jun 19 2019, 4:57 PM
Shivanshbindal9 added a subtask: T226127: Change the color of Alert/Message indicator..Jun 19 2019, 9:26 PM
Shivanshbindal9 added a subtask: T226130: Display notification text for incoming notification.Jun 19 2019, 9:43 PM
Krinkle mentioned this in T73539: Move Echo site-level data from MakeGlobalVariablesScript to a module.Jul 4 2019, 7:20 PM
Maintenance_bot removed a project: Patch-For-Review.Jul 4 2019, 8:11 PM
Shivanshbindal9 added a subtask: T227501: Change polling rate when document not visible.Jul 8 2019, 5:03 PM
Catrope closed subtask T225259: Visual Cue to indicate change in notification count as Resolved.Jul 11 2019, 9:57 PM
kostajh mentioned this in T34284: Update Echo Notifications in real time without page reloads.Jul 15 2019, 1:57 AM
Catrope mentioned this in T220753: Homepage and help panel: identify when a question has been responded to.Jul 16 2019, 9:44 PM
Shivanshbindal9 added a subtask: T229732: Define preference for poll updates.Aug 3 2019, 6:33 PM
gerritbot added a comment.Aug 16 2019, 8:37 PM

Change 530639 had a related patch set uploaded (by Kosta Harlan; owner: Kosta Harlan):
[operations/mediawiki-config@master] Echo: Enable poll for updates feature on testwiki

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

gerritbot added a project: Patch-For-Review.Aug 16 2019, 8:38 PM

Change 530640 had a related patch set uploaded (by Kosta Harlan; owner: Kosta Harlan):
[operations/mediawiki-config@master] Echo: Enable poll for updates feature on enwiki beta

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

kostajh closed subtask T229732: Define preference for poll updates as Resolved.Aug 19 2019, 12:08 PM
gerritbot added a comment.Aug 30 2019, 9:37 PM

Change 530640 merged by jenkins-bot:
[operations/mediawiki-config@master] Echo: Enable poll for updates feature on enwiki beta

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

kostajh added a subtask: T231697: Notifications auto-updater should be able to get the updates with one API call, not two.Sep 3 2019, 10:30 AM
kostajh mentioned this in T231697: Notifications auto-updater should be able to get the updates with one API call, not two.
srishakatux added a comment.Sep 4 2019, 12:24 AM

Is there anything remaining in this task from GSoC'19? If not, then please consider marking it as resolved! If yes, and would need another GSoC or volunteer help then consider creating a new task with the leftover items. Thanks!

kostajh closed this task as Resolved.Sep 9 2019, 12:11 PM
gerritbot added a comment.Sep 27 2019, 7:24 AM

Change 530639 abandoned by Kosta Harlan:
Echo: Enable poll for updates feature on testwiki

Reason:
Not needed at the moment.

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

Maintenance_bot removed a project: Patch-For-Review.Sep 27 2019, 8:10 AM
srishakatux closed subtask T226130: Display notification text for incoming notification as Resolved.Jan 17 2020, 10:18 AM
gerritbot added a comment.Feb 17 2020, 8:41 AM

Change 530639 restored by Kosta Harlan:
Echo: Enable poll for updates feature on testwiki

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

Aklapper closed subtask T227501: Change polling rate when document not visible as Resolved.May 6 2020, 12:43 PM
gerritbot added a comment.May 4 2021, 9:50 AM

Change 530639 abandoned by Kosta Harlan:

[operations/mediawiki-config@master] Echo: Enable poll for updates feature on testwiki and mediawikiwiki

Reason:

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

kostajh mentioned this in T219592: Frequent Echo DB_PRIMARY write queries on HTTP GET.Jun 11 2021, 9:49 AM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL