diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-09-17 21:11:44 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-09-17 21:11:44 +0300 |
commit | 4e582508047c7f5feedeba627461298e584e99dc (patch) | |
tree | 310eff30567463d986547a2d19ed31a3e657f900 /app/assets/javascripts/tracking | |
parent | 3b9468e8b913d43f45e472b69b98c9da05f338bb (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'app/assets/javascripts/tracking')
-rw-r--r-- | app/assets/javascripts/tracking/constants.js | 4 | ||||
-rw-r--r-- | app/assets/javascripts/tracking/index.js | 3 | ||||
-rw-r--r-- | app/assets/javascripts/tracking/tracking.js | 40 | ||||
-rw-r--r-- | app/assets/javascripts/tracking/utils.js | 24 |
4 files changed, 70 insertions, 1 deletions
diff --git a/app/assets/javascripts/tracking/constants.js b/app/assets/javascripts/tracking/constants.js index 598111e4086..062a3404355 100644 --- a/app/assets/javascripts/tracking/constants.js +++ b/app/assets/javascripts/tracking/constants.js @@ -24,3 +24,7 @@ export const LOAD_ACTION_ATTR_SELECTOR = '[data-track-action="render"]'; export const DEPRECATED_EVENT_ATTR_SELECTOR = '[data-track-event]'; export const DEPRECATED_LOAD_EVENT_ATTR_SELECTOR = '[data-track-event="render"]'; + +export const URLS_CACHE_STORAGE_KEY = 'gl-snowplow-pseudonymized-urls'; + +export const REFERRER_TTL = 24 * 60 * 60 * 1000; diff --git a/app/assets/javascripts/tracking/index.js b/app/assets/javascripts/tracking/index.js index b7240bc6d6d..7e99ecb4f4e 100644 --- a/app/assets/javascripts/tracking/index.js +++ b/app/assets/javascripts/tracking/index.js @@ -39,6 +39,9 @@ export function initDefaultTrackers() { const opts = { ...DEFAULT_SNOWPLOW_OPTIONS, ...window.snowplowOptions }; + // must be before initializing the trackers + Tracking.setAnonymousUrls(); + window.snowplow('enableActivityTracking', 30, 30); // must be after enableActivityTracking const standardContext = getStandardContext(); diff --git a/app/assets/javascripts/tracking/tracking.js b/app/assets/javascripts/tracking/tracking.js index a1f745bc172..657e0a79911 100644 --- a/app/assets/javascripts/tracking/tracking.js +++ b/app/assets/javascripts/tracking/tracking.js @@ -1,7 +1,14 @@ import { LOAD_ACTION_ATTR_SELECTOR, DEPRECATED_LOAD_EVENT_ATTR_SELECTOR } from './constants'; import { dispatchSnowplowEvent } from './dispatch_snowplow_event'; import getStandardContext from './get_standard_context'; -import { getEventHandlers, createEventPayload, renameKey, addExperimentContext } from './utils'; +import { + getEventHandlers, + createEventPayload, + renameKey, + addExperimentContext, + getReferrersCache, + addReferrersCacheEntry, +} from './utils'; export default class Tracking { static queuedEvents = []; @@ -159,6 +166,37 @@ export default class Tracking { } /** + * Replaces the URL and referrer for the default web context + * if the replacements are available. + * + * @returns {undefined} + */ + static setAnonymousUrls() { + const { snowplowPseudonymizedPageUrl: pageUrl } = window.gl; + + if (!pageUrl) { + return; + } + + const referrers = getReferrersCache(); + const pageLinks = Object.seal({ url: '', referrer: '', originalUrl: window.location.href }); + + pageLinks.url = `${pageUrl}${window.location.hash}`; + window.snowplow('setCustomUrl', pageLinks.url); + + if (document.referrer) { + const node = referrers.find((links) => links.originalUrl === document.referrer); + + if (node) { + pageLinks.referrer = node.url; + window.snowplow('setReferrerUrl', pageLinks.referrer); + } + } + + addReferrersCacheEntry(referrers, pageLinks); + } + + /** * Returns an implementation of this class in the form of * a Vue mixin. * diff --git a/app/assets/javascripts/tracking/utils.js b/app/assets/javascripts/tracking/utils.js index 1189b2168ad..3507872b511 100644 --- a/app/assets/javascripts/tracking/utils.js +++ b/app/assets/javascripts/tracking/utils.js @@ -6,6 +6,8 @@ import { LOAD_ACTION_ATTR_SELECTOR, DEPRECATED_EVENT_ATTR_SELECTOR, DEPRECATED_LOAD_EVENT_ATTR_SELECTOR, + URLS_CACHE_STORAGE_KEY, + REFERRER_TTL, } from './constants'; export const addExperimentContext = (opts) => { @@ -100,3 +102,25 @@ export const renameKey = (o, oldKey, newKey) => { return ret; }; + +export const filterOldReferrersCacheEntries = (cache) => { + const now = Date.now(); + + return cache.filter((entry) => entry.timestamp && entry.timestamp > now - REFERRER_TTL); +}; + +export const getReferrersCache = () => { + try { + const referrers = JSON.parse(window.localStorage.getItem(URLS_CACHE_STORAGE_KEY) || '[]'); + + return filterOldReferrersCacheEntries(referrers); + } catch { + return []; + } +}; + +export const addReferrersCacheEntry = (cache, entry) => { + const referrers = JSON.stringify([{ ...entry, timestamp: Date.now() }, ...cache]); + + window.localStorage.setItem(URLS_CACHE_STORAGE_KEY, referrers); +}; |