all files / src/gdpr/ Tracker.js

30.36% Statements 17/56
8.7% Branches 2/23
26.92% Functions 7/26
30.36% Lines 17/56
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176                                                                                                                                                                                                                                                                                                                             
import Cookies from 'js-cookie';
import { debug } from '../shared/utils';
 
const DEFAULT_BEACON_COOKIE_NAME = 'wikia_beacon_id';
const TRACKING_BASE = 'https://beacon.wikia-services.com/__track/special/gdpr_events';
const TRACK_PARAMS = {
    LANGUAGE_CODE: 'lang_code',
    DETECTED_GEO: 'detected_geo',
    CATEGORY: 'ga_category',
    ACTION: 'ga_action',
    LABEL: 'ga_label',
    BEACON: 'beacon',
};
const TRACK_TIMEOUT = 3000;
 
const TRACKING_CATEGORY = 'gdpr-modal';
const ACTION_IMPRESSION = 'impression';
const ACTION_CLICK = 'click';
 
function getBeaconFromCookie(cookieName) {
    return Cookies.get(cookieName || DEFAULT_BEACON_COOKIE_NAME);
}
 
class Tracker {
    constructor(language, detectedGeo, beaconCookieName, enable) {
        this.enable = enable;
        this.defaultParams = {
            [TRACK_PARAMS.LANGUAGE_CODE]: language,
            [TRACK_PARAMS.DETECTED_GEO]: detectedGeo,
        };
 
        const beacon = getBeaconFromCookie(beaconCookieName);
        Iif (beacon) {
            this.defaultParams[TRACK_PARAMS.BEACON] = beacon;
        }
    }
 
    // largely taken from https://github.com/Wikia/app/blob/a34191d/resources/wikia/modules/tracker.js
    track(category, action, label, onComplete = () => {}) {
        const params = {
            ...this.defaultParams,
            [TRACK_PARAMS.CATEGORY]: category,
            [TRACK_PARAMS.ACTION]: action,
            [TRACK_PARAMS.LABEL]: label,
        };
 
        if (!this.enable) {
            debug('TRACKING', 'Fake Tracking Event', params);
            return;
        }
 
        const container = document.head || document.getElementsByTagName( 'head' )[ 0 ] || document.documentElement;
        const requestParams = [];
 
        for (const p in params) {
            requestParams.push(`${encodeURIComponent(p)}=${encodeURIComponent(params[p])}`);
        }
 
        let script = document.createElement('script');
        script.src = `${TRACKING_BASE}?${requestParams.join('&')}`;
        if ('async' in script) {
            script.async = true;
        }
 
        script.onload = script.onreadystatechange = function( abort ) {
            if ( abort || !script.readyState || /loaded|complete/.test( script.readyState ) ) {
                // Handle memory leak in IE
                script.onload = script.onreadystatechange = null;
 
                // Remove the script
                if ( container && script.parentNode ) {
                    container.removeChild( script );
                }
 
                script = undefined;
                onComplete();
            }
        };
 
        container.insertBefore(script, container.firstChild);
        setTimeout(() => {
            if (script) {
                script.onload(true);
            }
        }, TRACK_TIMEOUT);
    }
    /**
     * Shortcuts
     */
    trackImpression(label) {
        this.track(TRACKING_CATEGORY, ACTION_IMPRESSION, label);
    }
 
    trackClick(label) {
        this.track(TRACKING_CATEGORY, ACTION_CLICK, label);
    }
 
    /**
     * All tracking events
     * @see https://docs.google.com/spreadsheets/d/1SdKVYFpAcW4xnLDOhLmpZ1h-Kr8Dq2a0tk-fb_GEEms/edit#gid=0
     */
    trackViewImpression() {
        this.trackImpression('modal-view');
    }
 
    trackNoCookieImpression() {
        this.trackImpression('no-cookie');
    }
 
    trackGpcImpression() {
        this.trackImpression('gpc');
    }
 
    trackPrivacyPolicyClick() {
        this.trackClick('privacy-policy');
    }
 
    trackPartnerListClick() {
        this.trackClick('partner-list');
    }
 
    trackLearnMoreClick() {
        this.trackClick('learn-more');
    }
 
    trackVendorExpandClick() {
        this.trackClick('vendor-expand');
    }
 
    trackAcceptClick() {
        this.trackClick('accept');
    }
 
    trackBackClick() {
        this.trackClick('back');
    }
 
    trackSaveClick() {
        this.trackClick('save');
    }
 
    trackRejectClick() {
        this.trackClick('reject');
    }
 
    trackPurposeToggleClick(id) {
        this.trackClick(`purpose-toggle-${id}`);
    }
 
    trackPurposeExpandClick(id) {
        this.trackClick(`purpose-expand-${id}`);
    }
 
    trackSpecialFeatureToggleClick(id) {
        this.trackClick(`special-feature-toggle-${id}`);
    }
 
    trackSpecialFeatureExpandClick(id) {
        this.trackClick(`special-feature-expand-${id}`);
    }
 
    trackInternalUseExpandClick() {
        this.trackClick('internal-use-expand');
    }
 
    trackAdditionalConsentExpandClick() {
        this.trackClick('additional-consent-expand');
    }
 
    trackAdditionalConsentProviderToggleClick(id) {
        this.trackClick(`additional-consent-provider-toggle-${id}`);
    }
}
 
export default Tracker;