mediawiki-extensions-Cite/modules/ext.cite.tracking.js
mareikeheuer 1eb405eb54 Convert Cite extention to ES6
Bug: T343220
Change-Id: I769f0bfaa5af14d6ea4861ea738b44c98feb6193
2023-08-23 12:39:29 +00:00

52 lines
1.7 KiB
JavaScript

'use strict';
/**
* @file Temporary tracking to evaluate the impact of Reference Previews on users' interaction with references.
*
* The baseline metrics are for a sample of users who don't have ReferencePreviews enabled.
*
* Users with the feature enabled are not sampled, and events are logged using the ReferencePreviewsCite schema.
*
* @see https://phabricator.wikimedia.org/T214493
* @see https://phabricator.wikimedia.org/T231529
* @see https://meta.wikimedia.org/wiki/Schema:ReferencePreviewsBaseline
* @see https://meta.wikimedia.org/wiki/Schema:ReferencePreviewsCite
*/
// EventLogging may not be installed
mw.loader.using( 'ext.eventLogging' ).then( function () {
$( function () {
const isReferencePreviewsEnabled = mw.config.get( 'wgPopupsReferencePreviews', false );
const samplingRate = isReferencePreviewsEnabled ? 1 : 1000;
if ( !navigator.sendBeacon ||
!mw.config.get( 'wgIsArticle' ) ||
!mw.eventLog ||
!mw.eventLog.eventInSample( samplingRate )
) {
return;
}
const loggingTopic = isReferencePreviewsEnabled ?
'event.ReferencePreviewsCite' :
'event.ReferencePreviewsBaseline';
// eslint-disable-next-line no-jquery/no-global-selector
$( '#mw-content-text' ).on(
'click',
// Footnote links, references block in VisualEditor, and reference content links.
'.reference a[ href*="#" ], .mw-reference-text a, .reference-text a',
function () {
const isInReferenceBlock = $( this ).parents( '.references' ).length > 0;
mw.track( loggingTopic, {
action: ( isInReferenceBlock ?
'clickedReferenceContentLink' :
'clickedFootnote' )
} );
}
);
mw.track( loggingTopic, { action: 'pageview' } );
} );
} );