mediawiki-extensions-Echo/modules/logger/mw.echo.Logger.js

( function ( $, mw ) {
	mw.echo = mw.echo || {};

	/**
	 * Echo logger
	 *
	 * @class
	 *
	 * @constructor
	 * @param {Object} [config] Configuration object
	 * @cfg {boolean} [clickThroughEnabled] Whether logging is enabled
	 */
	mw.echo.Logger = function MwEchoUiLogger( config ) {
		config = config || {};

		this.clickThroughEnabled = config.clickThroughEnabled || this.constructor.static.clickThroughEnabled;
		this.notificationsIdCache = [];
		if ( this.clickThroughEnabled ) {
			// This should usually already be loaded, but not always
			this.deferred = mw.loader.using( 'ext.eventLogging', function () {
				mw.eventLog.setDefaults( 'EchoInteraction', {
					version: mw.config.get( 'wgEchoConfig' ).version,
					userId: +mw.config.get( 'wgUserId' ),
					editCount: +mw.config.get( 'wgUserEditCount' )
				} );
			} );
		} else {
			this.deferred = $.Deferred().resolve();
		}
	};

	OO.initClass( mw.echo.Logger );

	/* Static methods */

	/**
	 * Default behavior in MediaWiki for whether logging Echo interactions
	 * is enabled
	 *
	 * @static
	 * @property {boolean}
	 */
	mw.echo.Logger.static.clickThroughEnabled = OO.getProp(
		mw.config.get( 'wgEchoConfig' ),
		'eventlogging',
		'EchoInteraction',
		'enabled'
	);

	/**
	 * Context definitions.
	 *
	 * 'flyout': Interactions from the popup content
	 * 'archive': Interactions from the Special:Notifications page
	 * 'badge': Interactions from the badge button
	 *
	 * @static
	 * @property {Object}
	 */
	mw.echo.Logger.static.context = {
		popup: 'flyout',
		archive: 'archive',
		badge: undefined
	};

	/**
	 * Logging action names for consistency.
	 *
	 * 'notificationClick': Click interaction
	 * 'notificationImpression': Impression interaction
	 *
	 * @static
	 * @property {Object}
	 */
	mw.echo.Logger.static.actions = {
		notificationClick: 'notification-link-click',
		notificationBundleExpand: 'notification-bundle-expand',
		notificationImpression: 'notification-impression'
	};

	/* Methods */

	/**
	 * Log all Echo interaction related events
	 *
	 * @param {string} action The interaction
	 * @param {string} [context] 'flyout'/'archive' or undefined for the badge
	 * @param {number} [eventId] Notification event id
	 * @param {string} [eventType] notification type
	 * @param {boolean} [mobile] True if interaction was on a mobile device
	 * @param {string} [notifWiki] Foreign wiki the notification came from
	 */
	mw.echo.Logger.prototype.logInteraction = function ( action, context, eventId, eventType, mobile, notifWiki ) {
		var myEvt;

		if ( !this.constructor.static.clickThroughEnabled ) {
			return;
		}

		myEvt = {
			action: action
		};

		// All the fields below are optional
		if ( context ) {
			myEvt.context = context;
		}
		if ( eventId ) {
			myEvt.eventId = Number( eventId );
		}
		if ( eventType ) {
			myEvt.notificationType = eventType;
		}
		if ( mobile ) {
			myEvt.mobile = mobile;
		}

		if ( notifWiki && notifWiki !== mw.config.get( 'wgDBname' ) && notifWiki !== 'local' ) {
			myEvt.notifWiki = notifWiki;
		}

		this.deferred.done( function () {
			mw.eventLog.logEvent( 'EchoInteraction', myEvt );
		} );
	};

	/**
	 * Log the impression of notifications. This will log each notification exactly once.
	 *
	 * @param {string} type Notification type; 'alert' or 'message'
	 * @param {number[]} notificationIds Array of notification ids
	 * @param {string} context 'flyout'/'archive' or undefined for the badge
	 * @param {string} [notifWiki='local'] Foreign wiki the notifications came from
	 * @param {boolean} [mobile=false] True if interaction was on a mobile device
	 */
	mw.echo.Logger.prototype.logNotificationImpressions = function ( type, notificationIds, context, notifWiki, mobile ) {
		var i, len, key;

		for ( i = 0, len = notificationIds.length; i < len; i++ ) {
			key = notifWiki && notifWiki !== mw.config.get( 'wgDBname' ) && notifWiki !== 'local' ?
				notificationIds[ i ] + '-' + notifWiki :
				notificationIds[ i ];

			if ( !this.notificationsIdCache[ key ] ) {
				// Log notification impression
				this.logInteraction( 'notification-impression', context, notificationIds[ i ], type, mobile, notifWiki );
				// Cache
				this.notificationsIdCache[ key ] = true;
			}
		}
	};

	mw.echo.logger = new mw.echo.Logger();
} )( jQuery, mediaWiki );