jenkins-bot has submitted this change and it was merged.
Change subject: Allow notification model and widget to show combined
notifications
......................................................................
Allow notification model and widget to show combined notifications
Make sure it's possible to create a combined notification widget
that features both alerts and messages.
Change-Id: I4b3f263039f54430a61acc1a261d8aca8e894a90
---
M modules/viewmodel/mw.echo.dm.APIHandler.js
M modules/viewmodel/mw.echo.dm.AbstractAPIHandler.js
M modules/viewmodel/mw.echo.dm.NotificationsModel.js
3 files changed, 62 insertions(+), 35 deletions(-)
Approvals:
Catrope: Looks good to me, approved
jenkins-bot: Verified
diff --git a/modules/viewmodel/mw.echo.dm.APIHandler.js
b/modules/viewmodel/mw.echo.dm.APIHandler.js
index f7f9380..7818daa 100644
--- a/modules/viewmodel/mw.echo.dm.APIHandler.js
+++ b/modules/viewmodel/mw.echo.dm.APIHandler.js
@@ -46,10 +46,14 @@
/**
* @inheritdoc
*/
- mw.echo.dm.APIHandler.prototype.updateSeenTime = function () {
+ mw.echo.dm.APIHandler.prototype.updateSeenTime = function ( type ) {
+ type = type || this.type;
+
return this.api.postWithToken( 'edit', {
action: 'echomarkseen',
- type: this.type
+ // TODO: The API should also work with piped types like
+ // getting notification lists
+ type: $.isArray( type ) ? 'all' : type
} )
.then( function ( data ) {
return data.query.echomarkseen.timestamp;
diff --git a/modules/viewmodel/mw.echo.dm.AbstractAPIHandler.js
b/modules/viewmodel/mw.echo.dm.AbstractAPIHandler.js
index 2c0204b..1ce0a38 100644
--- a/modules/viewmodel/mw.echo.dm.AbstractAPIHandler.js
+++ b/modules/viewmodel/mw.echo.dm.AbstractAPIHandler.js
@@ -51,6 +51,8 @@
/**
* Update the seen timestamp
*
+ * @param {string|string[]} [type] Notification type 'message', 'alert'
or
+ * an array of both.
* @return {jQuery.Promise} A promise that resolves with the seen
timestamp
*/
mw.echo.dm.AbstractAPIHandler.prototype.updateSeenTime = null;
diff --git a/modules/viewmodel/mw.echo.dm.NotificationsModel.js
b/modules/viewmodel/mw.echo.dm.NotificationsModel.js
index 2e57476..28f70ea 100644
--- a/modules/viewmodel/mw.echo.dm.NotificationsModel.js
+++ b/modules/viewmodel/mw.echo.dm.NotificationsModel.js
@@ -8,7 +8,8 @@
* @constructor
* @param {mw.echo.dm.AbstractAPIHandler} apiHandler API handler
* @param {Object} [config] Configuration object
- * @cfg {string} [type='alert'] Notification type 'alert', 'message' or
'all'
+ * @cfg {string|string[]} [type='alert'] Notification type 'alert',
'message'
+ * or an array [ 'alert', 'message' ]
* @cfg {number} [limit=25] Notification limit
* @cfg {string} [userLang] User language
*/
@@ -150,9 +151,9 @@
/**
* Get the type of the notifications that this model deals with.
- * Notifications type are given from the API: 'alert', 'message', 'all'
+ * Notifications types can be 'alert', 'message' or an array of both.
*
- * @return {string} Notifications type
+ * @return {string|string[]} Notifications type
*/
mw.echo.dm.NotificationsModel.prototype.getType = function () {
return this.type;
@@ -183,27 +184,39 @@
* @param {string} Mediawiki seen timestamp in Mediawiki timestamp
format
*/
mw.echo.dm.NotificationsModel.prototype.setSeenTime = function ( time )
{
- this.seenTime[ this.type ] = time;
+ var i,
+ type = $.isArray( this.type ) ? this.type : [ this.type
];
+
+ for ( i = 0; i < type.length; i++ ) {
+ // Update all types
+ this.seenTime[ type[ i ] ] = time;
+ }
};
/**
* Get the system seen time
*
+ * @param {string} [type] Notification type
* @return {string} Mediawiki seen timestamp in Mediawiki timestamp
format
*/
- mw.echo.dm.NotificationsModel.prototype.getSeenTime = function () {
- return this.seenTime[ this.type ];
+ mw.echo.dm.NotificationsModel.prototype.getSeenTime = function ( type )
{
+ type = type || ( $.isArray( this.type ) ? this.type[ 0 ] :
this.type );
+
+ return this.seenTime[ type ];
};
/**
* Update the seen timestamp
*
+ * @param {string|string[]} [type] Notification type
* @return {jQuery.Promise} A promise that resolves with the seen
timestamp
* @fires updateSeenTime
*/
- mw.echo.dm.NotificationsModel.prototype.updateSeenTime = function () {
+ mw.echo.dm.NotificationsModel.prototype.updateSeenTime = function (
type ) {
var i, len,
items = this.unseenNotifications.getItems();
+
+ type = type || this.type;
// Update the notifications seen status
for ( i = 0, len = items.length; i < len; i++ ) {
@@ -211,7 +224,7 @@
}
this.emit( 'updateSeenTime' );
- return this.apiHandler.updateSeenTime()
+ return this.apiHandler.updateSeenTime( type )
.then( this.setSeenTime.bind( this ) );
};
@@ -273,39 +286,47 @@
// it exists in a failed state
return this.apiHandler.fetchNotifications( apiPromise )
.then( function ( result ) {
- var notifData, i, len, $content,
notificationModel,
+ var notifData, i, len, t, tlen, $content,
+ notificationModel, types,
optionItems = [],
idArray = [],
data = OO.getProp( result.query,
'notifications', model.type ) || { index: [] };
- for ( i = 0, len = data.index.length; i < len;
i++ ) {
- notifData = data.list[ data.index[i] ];
- if ( model.getItemById( notifData.id )
) {
- // Skip if we already have the
item
- continue;
- }
- // TODO: This should really be
formatted better, and the OptionWidget
- // should be the one that displays
whatever icon relates to this notification
- // according to its type.
- $content = $( $.parseHTML(
notifData['*'] ) );
+ types = $.isArray( model.type ) ? model.type :
[ model.type ];
- notificationModel = new
mw.echo.dm.NotificationItem(
- notifData.id,
- {
- read: !!notifData.read,
- seen: !!notifData.read
|| notifData.timestamp.mw <= model.getSeenTime(),
- timestamp:
notifData.timestamp.mw,
- category:
notifData.category,
- content: $content,
- type: model.getType(),
- // Hack: Get the
primary link from the $content
- primaryUrl:
$content.find( '.mw-echo-notification-primary-link' ).attr( 'href' )
+ for ( t = 0, tlen = types.length; t < tlen; t++
) {
+ data = OO.getProp( result.query,
'notifications', types[ t ] ) || { index: [] };
+ for ( i = 0, len = data.index.length; i
< len; i++ ) {
+ notifData = data.list[
data.index[i] ];
+ if ( model.getItemById(
notifData.id ) ) {
+ // Skip if we already
have the item
+ continue;
}
- );
+ // TODO: This should really be
formatted better, and the OptionWidget
+ // should be the one that
displays whatever icon relates to this notification
+ // according to its type.
+ $content = $( $.parseHTML(
notifData['*'] ) );
- idArray.push( notifData.id );
- optionItems.push( notificationModel );
+ notificationModel = new
mw.echo.dm.NotificationItem(
+ notifData.id,
+ {
+ read:
!!notifData.read,
+ seen:
!!notifData.read || notifData.timestamp.mw <= model.getSeenTime(),
+ timestamp:
notifData.timestamp.mw,
+ category:
notifData.category,
+ content:
$content,
+ type:
model.getType(),
+ // Hack: Get
the primary link from the $content
+ primaryUrl:
$content.find( '.mw-echo-notification-primary-link' ).attr( 'href' )
+ }
+ );
+
+ idArray.push( notifData.id );
+ optionItems.push(
notificationModel );
+ }
}
+
+ // Add to the model
model.addItems( optionItems, 0 );
return idArray;
--
To view, visit https://gerrit.wikimedia.org/r/249031
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I4b3f263039f54430a61acc1a261d8aca8e894a90
Gerrit-PatchSet: 10
Gerrit-Project: mediawiki/extensions/Echo
Gerrit-Branch: master
Gerrit-Owner: Mooeypoo <mor...@gmail.com>
Gerrit-Reviewer: Catrope <roan.katt...@gmail.com>
Gerrit-Reviewer: Mooeypoo <mor...@gmail.com>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
