Page MenuHomeWickedGov Phorge
Files F2750363

ext.centralNotice.impressionDiet.js
No OneTemporary
Actions

Size
6 KB
Referenced Files
None
Subscribers
None

ext.centralNotice.impressionDiet.js
View Options

/**
* Impression diet mixin. Provides knobs to cap the number of impressions
* each user will see.
*
* This mixin will migrate count data in cookies to kvStore, which will use
* LocalStorage, or (if that's not available and the campaigns is in a
* category using legacy mechanisms) fall back to a new sort of cookie.
*
* In general, showing a banner entails that a certain number of impressions
* have already occurred in a time period. Parameter documentation is provided
* in the CentralNotice campaign management UI.
*
* Banner may be forced if URL parameter force = 1
* Counters may be reset if URL parameter reset = 1
*
* Flow chart: https://commons.wikimedia.org/wiki/File:CentralNotice_-_wait_cookie_code_flow.png
* (FIXME: update ^^ with new parameter names)
*/
( function () {
'use strict';
var identifier, multiStorageOption,
cn = mw.centralNotice,
mixin = new cn.Mixin( 'impressionDiet' ),
/**
* Object with data used to determine whether to hide the banner
* Properties:
* seenCount: Total number of impressions seen by this user
* skippedThisCycle: Number of initial impressions we've skipped this cycle
* nextCycleStart: Unix timestamp after which we can show more banners
* seenThisCycle: Number of impressions seen this cycle
*/
counts,
now = Date.now(),
STORAGE_KEY = 'impression_diet',
// Suffix used with legacy cookies only
WAIT_COOKIE_SUFFIX = '-wait',
// Time to store impression-counting data, in days
COUNTS_STORAGE_TTL = 365;
mixin.setPreBannerHandler( function ( mixinParams ) {
var hide;
// URL forced a banner
if ( mw.util.getParamValue( 'force' ) ) {
return;
}
identifier = mixinParams.cookieName; // TODO change param name
// Check if and how we can store counts
multiStorageOption = cn.kvStore.getMultiStorageOption(
cn.getDataProperty( 'campaignCategoryUsesLegacy' ) );
// In all cases, check for legacy cookies and try to migrate if
// found
possiblyMigrateLegacyCookies();
// Banner was hidden already
if ( cn.isCampaignFailed() ) {
return;
}
// No options for storing stuff, so hide banner and bow out
if ( multiStorageOption === cn.kvStore.multiStorageOptions.NO_STORAGE ) {
cn.failCampaign( 'waitnostorage' );
return;
}
// Reset counts if requested (for testing)
if ( mw.util.getParamValue( 'reset' ) === '1' ) {
counts = getZeroedCounts();
} else {
// Otherwise get counts from storage
counts = getCounts();
}
if ( now > counts.nextCycleStart &&
counts.seenThisCycle >= mixinParams.maximumSeen
) {
// We're beyond the wait period, and have nothing to do except
// maybe start a new cycle.
if ( mixinParams.restartCycleDelay !== 0 ) {
// Begin a new cycle by clearing counters.
counts.skippedThisCycle = 0;
counts.seenThisCycle = 0;
}
}
// Compare counts against campaign settings and decide whether to
// show a banner
if ( counts.seenThisCycle < mixinParams.maximumSeen ) {
// You haven't seen the maximum count of banners per cycle!
if ( counts.skippedThisCycle < mixinParams.skipInitial ) {
// Skip initial impressions.
hide = 'waitimps';
counts.skippedThisCycle += 1;
} else {
// Show a banner--you win!
hide = false;
}
} else {
// Wait for the next cycle to begin.
hide = 'waitdate';
}
if ( hide ) {
// Hide based on the results.
cn.failCampaign( hide );
} else {
// Count shown impression.
counts.seenThisCycle += 1;
counts.seenCount += 1;
// Reset the wait timer on every impression. The configured delay
// is the minimum amount of time allowed between the final impression
// and the start of the next cycle.
counts.nextCycleStart = now +
( mixinParams.restartCycleDelay * 1000 );
}
// Bookkeeping.
storeCounts( counts );
} );
function getZeroedCounts() {
return {
seenCount: 0,
skippedThisCycle: 0,
nextCycleStart: 0,
seenThisCycle: 0
};
}
/**
* TODO: Delete fix code a year after deploy
* Update names of stored counts for clarity.
*
* @param {Object} kvStoreCounts possibly using legacy names
* @return {Object} counts object using new names
*/
function fixCountNames( kvStoreCounts ) {
// If we get an object with new names, don't change it
if ( kvStoreCounts.skippedThisCycle !== undefined ) {
return kvStoreCounts;
}
return {
seenCount: kvStoreCounts.seenCount,
skippedThisCycle: kvStoreCounts.waitCount,
nextCycleStart: kvStoreCounts.waitUntil,
seenThisCycle: kvStoreCounts.waitSeenCount
};
}
function possiblyMigrateLegacyCookies() {
var rawCookie, rawWaitCookie, waitData, cookieCounts;
// Legacy cookies required an identifier
if ( !identifier ) {
return;
}
rawCookie = $.cookie( identifier );
if ( !rawCookie ) {
return;
}
rawWaitCookie = $.cookie( identifier + WAIT_COOKIE_SUFFIX );
waitData = ( rawWaitCookie || '' ).split( /[|]/ );
cookieCounts = {
seenCount: parseInt( rawCookie, 10 ) || 0,
skippedThisCycle: parseInt( waitData[ 0 ], 10 ) || 0,
nextCycleStart: parseInt( waitData[ 1 ], 10 ) || 0,
seenThisCycle: parseInt( waitData[ 2 ], 10 ) || 0
};
storeCounts( cookieCounts );
$.removeCookie( identifier, { path: '/' } );
$.removeCookie( identifier + WAIT_COOKIE_SUFFIX, { path: '/' } );
}
/**
* Get running impression counts from kvStore, if available, or return
* zeroed counts.
*
* @return {Object} An object containing count data.
*/
function getCounts() {
var c;
if ( identifier ) {
c = cn.kvStore.getItem(
STORAGE_KEY + '_' + identifier,
cn.kvStore.contexts.GLOBAL,
multiStorageOption
);
} else {
c = cn.kvStore.getItem(
STORAGE_KEY,
cn.kvStore.contexts.CATEGORY,
multiStorageOption
);
}
c = c || getZeroedCounts();
return fixCountNames( c );
}
/*
* Store updated counts
*/
function storeCounts( c ) {
if ( identifier ) {
cn.kvStore.setItem(
STORAGE_KEY + '_' + identifier,
c,
cn.kvStore.contexts.GLOBAL,
COUNTS_STORAGE_TTL,
multiStorageOption
);
} else {
cn.kvStore.setItem(
STORAGE_KEY,
c,
cn.kvStore.contexts.CATEGORY,
COUNTS_STORAGE_TTL,
multiStorageOption
);
}
}
// Register the mixin
cn.registerCampaignMixin( mixin );
}() );

File Metadata

Mime Type
text/plain
Expires
Fri, Jul 3, 16:22 (6 h, 26 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
62/d4/ce01ccbd5afa3b2b88721ff83dce
Default Alt Text
ext.centralNotice.impressionDiet.js (6 KB)

Event Timeline