documentation/snowplow.js at main · snowplow/documentation · GitHub

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
import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment'
import {
  newTracker,
  trackPageView,
  addGlobalContexts,
  enableActivityTracking,
  disableAnonymousTracking,
  crossDomainLinker,
} from '@snowplow/browser-tracker'
import {
  LinkClickTrackingPlugin,
  enableLinkClickTracking,
} from '@snowplow/browser-plugin-link-click-tracking'
import {
  ButtonClickTrackingPlugin,
  enableButtonClickTracking,
} from '@snowplow/browser-plugin-button-click-tracking'
import {
  FormTrackingPlugin,
  enableFormTracking,
} from '@snowplow/browser-plugin-form-tracking'
import Cookies from 'js-cookie'
import { DOCS_SITE_URLS, SP5_COOKIE_NAME, BIZ1_COOKIE_NAME } from './src/constants/config'
import { reloadOnce } from './src/helpers/reloadOnce'
import { isEmpty, pickBy } from 'lodash'
import { SnowplowMediaPlugin } from '@snowplow/browser-plugin-media'
import { BotDetectionPlugin } from '@snowplow/browser-plugin-bot-detection'

const CROSS_DOMAIN_TARGETS = ['snowplowanalytics.com']

const crossDomainLinkerFn = (linkElement) => {
  return CROSS_DOMAIN_TARGETS.some((domain) =>
    linkElement.hostname.endsWith(domain)
  )
}

const createTrackerConfig = (cookieName) => {
  const appId = DOCS_SITE_URLS.includes(window.location.hostname)
    ? 'docs2'
    : 'test'
  const domain = location.host.split('.').reverse()

  const trackerConfig = {
    appId,
    eventMethod: 'post',
    plugins: [
      LinkClickTrackingPlugin(),
      SnowplowMediaPlugin(),
      ButtonClickTrackingPlugin(),
      FormTrackingPlugin(),
      BotDetectionPlugin(),
    ],
    cookieDomain: `.${domain[1]}.${domain[0]}`,
    cookieName,
    cookieSameSite: 'Lax',
    crossDomainLinker: crossDomainLinkerFn,
    useExtendedCrossDomainLinker: true,
    contexts: {
      webPage: true,
      performanceTiming: true,
      gaCookies: true,
    },
  }

  try {
    const raw = Cookies.get('_ketch_consent_v1_')
    const ketchConsent = raw && JSON.parse(atob(decodeURIComponent(raw)))
    if (!ketchConsent || ketchConsent.analytics?.status !== 'granted') {
      trackerConfig.anonymousTracking = { withServerAnonymisation: true }
    }
  } catch {
    trackerConfig.anonymousTracking = { withServerAnonymisation: true }
  }

  return trackerConfig
}

const setupBrowserTracker = () => {
  newTracker(
    'snplow5',
    'https://collector.snowplow.io',
    createTrackerConfig(SP5_COOKIE_NAME)
  )
  newTracker('biz1', 'https://c.snowplow.io', createTrackerConfig(BIZ1_COOKIE_NAME))

  const selectedTabContext = () => {
    const data = pickBy({
      cloud: localStorage.getItem('docusaurus.tab.cloud'),
      data_warehouse: localStorage.getItem('docusaurus.tab.warehouse'),
    })
    if (!_.isEmpty(data))
      return {
        schema:
          'iglu:com.snowplowanalytics.docs/selected_tabs/jsonschema/1-0-0',
        data,
      }
  }
  addGlobalContexts([selectedTabContext])

  enableLinkClickTracking()
  enableActivityTracking({
    heartbeatDelay: 10,
    minimumVisitLength: 10,
  }) // precise tracking for the unified log

  enableButtonClickTracking()
  enableFormTracking()
}

if (ExecutionEnvironment.canUseDOM) {
  setupBrowserTracker()

  let consentInitialized = false

  window.ketch('on', 'consent', (consent) => {
    const analyticsEnabled = consent.purposes?.analytics === true

    if (!consentInitialized) {
      consentInitialized = true
      if (analyticsEnabled) {
        disableAnonymousTracking({
          stateStorageStrategy: 'cookieAndLocalStorage',
        })
        trackPageView()
      }
      return
    }

    if (analyticsEnabled) {
      disableAnonymousTracking({
        stateStorageStrategy: 'cookieAndLocalStorage',
      })
      trackPageView()
    } else {
      const cookieKeys = Object.keys(Cookies.get())
      const snowplowCookies = cookieKeys.filter((cookieKey) =>
        cookieKey.startsWith(SP5_COOKIE_NAME)
      )
      snowplowCookies.forEach((snowplowCookie) =>
        Cookies.remove(snowplowCookie)
      )
      Cookies.remove('sp')
      reloadOnce()
    }
  })
}

const module = {
  onRouteDidUpdate({ location, previousLocation }) {
    if (location.pathname !== previousLocation?.pathname) {
      // see https://github.com/facebook/docusaurus/pull/7424 regarding setTimeout
      setTimeout(() => {
        trackPageView()
        crossDomainLinker(crossDomainLinkerFn)
      })
    }
  },
}

export default module