snowplow.js

import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment'
import {
  newTracker,
  trackPageView,
  addGlobalContexts,
  enableActivityTracking,
  disableAnonymousTracking,
} from '@snowplow/browser-tracker'
import {
  LinkClickTrackingPlugin,
  enableLinkClickTracking,
  refreshLinkClickTracking,
} from '@snowplow/browser-plugin-link-click-tracking'
import { onPreferencesChanged } from 'cookie-though'
import Cookies from 'js-cookie'
import { COOKIE_PREF_KEY, DOCS_SITE_URLS } from './src/constants/config'
import { reloadOnce } from './src/helpers/reloadOnce'
import { isEmpty, pickBy } from 'lodash'

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()],
    cookieDomain: `.${domain[1]}.${domain[0]}`,
    cookieName,
    cookieSameSite: 'Lax',
    contexts: {
      webPage: true,
      performanceTiming: true,
      gaCookies: true,
    },
  }

  const cookiePreferences = Cookies.get(COOKIE_PREF_KEY)

  if (!cookiePreferences || cookiePreferences.includes('analytics:0')) {
    trackerConfig.anonymousTracking = {
      withServerAnonymisation: true,
    }
  }

  return trackerConfig
}

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

  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()
  refreshLinkClickTracking()
  enableActivityTracking({
    heartbeatDelay: 10,
    minimumVisitLength: 10,
  }) // precise tracking for the unified log
}

if (ExecutionEnvironment.canUseDOM) {
  setupBrowserTracker()

  onPreferencesChanged((preferences) => {
    preferences.cookieOptions.forEach(({ id, isEnabled }) => {
      if (id === 'analytics') {
        if (isEnabled) {
          disableAnonymousTracking({
            stateStorageStrategy: 'cookieAndLocalStorage',
          })
          // to now track it with all the extra data
          trackPageView()
        } else {
          const cookieKeys = document.cookie
            .split(';')
            .reduce((ac, str) => [...ac, str?.split('=')[0].trim()], [])
          const snowplowCookies = cookieKeys.filter((cookieKey) =>
            cookieKey.startsWith('_sp5_')
          )
          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()
        // we need to call it whenever a new link appears on the page
        // see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/javascript-tracker/javascript-tracker-v3/tracking-events/#refreshlinkclicktracking
        refreshLinkClickTracking()
      })
    }
  },
}

export default module