mediawiki-extensions-Relate.../resources/ext.relatedArticles.readMore.eventLogging/index.js
jdlrobson 298790a944 Upgrade to eslint
We're going to want to use a newer version of JSHint
anyway to support use of ES6 in our browser tests so now
seems a good time to do this.

Bug: T149202
Change-Id: I5526b020cfc12c0e065ad15ed711a0e3a7bff1bc
2017-04-10 14:12:25 +02:00

68 lines
1.9 KiB
JavaScript

// See https://meta.wikimedia.org/wiki/Schema:RelatedArticles
( function ( $, mw ) {
var $readMore,
schemaRelatedPages,
skin = mw.config.get( 'skin' ),
$window = $( window );
if ( !$.isFunction( navigator.sendBeacon ) ) {
return;
}
/**
* Log when ReadMore is seen by the user
*/
function logReadMoreSeen() {
if ( mw.viewport.isElementInViewport( $readMore.get( 0 ) ) ) {
$window.off( 'scroll', logReadMoreSeen );
schemaRelatedPages.log( { eventName: 'seen' } );
}
}
schemaRelatedPages = new mw.eventLog.Schema(
'RelatedArticles',
// not sampled if the config variable is not set
mw.config.get( 'wgRelatedArticlesLoggingSamplingRate', 0 ),
{
pageId: mw.config.get( 'wgArticleId' ),
skin: ( skin === 'minerva' ) ? skin + '-' + mw.config.get( 'wgMFMode' ) : skin,
// We cannot depend on the uniqueness of mw.user.generateRandomSessionId(),
// thus append the timestamp. See mw.user documentation for more info.
userSessionToken: mw.user.generateRandomSessionId() +
( new Date() ).getTime().toString()
}
);
mw.trackSubscribe( 'ext.relatedArticles.logEnabled', function ( _, data ) {
schemaRelatedPages.log( {
eventName: data.isEnabled ? 'feature-enabled' : 'feature-disabled'
} );
} );
mw.trackSubscribe( 'ext.relatedArticles.logReady', function ( _, data ) {
$readMore = data.$readMore;
// log ready
schemaRelatedPages.log( { eventName: 'ready' } );
// log when ReadMore is seen by the user
$window.on(
'scroll',
$.debounce( 250, logReadMoreSeen )
);
logReadMoreSeen();
// track the clicked event
// TODO: This should be moved into the PageList component or, preferably, the CardList/Card views.
$readMore.on( 'click', 'a', function () {
var index = $( this ).parents( 'li' ).index();
schemaRelatedPages.log( {
eventName: 'clicked',
clickIndex: index + 1
} );
} );
} );
}( jQuery, mediaWiki ) );