supabase/apps/studio/lib/telemetry.ts

import { post } from 'lib/common/fetch'
import { API_URL, IS_PLATFORM, LOCAL_STORAGE_KEYS } from 'lib/constants'
import type { NextRouter } from 'next/router'
import type { User } from 'types'

export interface TelemetryProps {
  screenResolution?: string
  language: string
}

/**
 * Sends a telemetry event to Logflare for tracking by the product team.
 */
const sendEvent = (
  event: {
    category: string
    action: string
    label: string
    value?: string
  },
  gaProps: TelemetryProps,
  router: NextRouter
) => {
  if (!IS_PLATFORM) return

  const consent =
    typeof window !== 'undefined'
      ? localStorage.getItem(LOCAL_STORAGE_KEYS.TELEMETRY_CONSENT)
      : null
  if (consent !== 'true') return

  const { category, action, label, value } = event

  // remove # section from router.asPath as it
  // often includes sensitive information
  // such as access/refresh tokens
  const page_location = router.asPath.split('#')[0]

  return post(`${API_URL}/telemetry/event`, {
    action: action,
    category: category,
    label: label,
    value: value,
    page_referrer: document?.referrer,
    page_title: document?.title,
    page_location,
    ga: {
      screen_resolution: gaProps?.screenResolution,
      language: gaProps?.language,
    },
  })
}

/**
 * TODO: GA4 doesn't have identify method.
 * We may or may not need gaClientId here. Confirm later
 */
const sendIdentify = (user: User, gaProps?: TelemetryProps) => {
  if (!IS_PLATFORM) return

  const consent =
    typeof window !== 'undefined'
      ? localStorage.getItem(LOCAL_STORAGE_KEYS.TELEMETRY_CONSENT)
      : null
  if (consent !== 'true') return

  return post(`${API_URL}/telemetry/identify`, {
    user,
    ga: {
      screen_resolution: gaProps?.screenResolution,
      language: gaProps?.language,
    },
  })
}

/**
 * @deprecated use sendEvent instead.
 */
const sendActivity = (
  event: {
    activity: string
    source: string
    projectRef?: string
    orgSlug?: string
    data?: object
  },
  router: NextRouter
) => {
  if (!IS_PLATFORM) return

  const consent =
    typeof window !== 'undefined'
      ? localStorage.getItem(LOCAL_STORAGE_KEYS.TELEMETRY_CONSENT)
      : null
  if (consent !== 'true') return

  const { activity, source, projectRef, orgSlug, data } = event

  const properties = {
    activity,
    source,
    page: {
      path: router.route,
      location: router.asPath,
      referrer: document?.referrer || '',
      title: document?.title || '',
    },
    ...(data && { data }),
    ...(projectRef && { projectRef }),
    ...(orgSlug && { orgSlug }),
  }
  return post(`${API_URL}/telemetry/activity`, properties)
}

const Telemetry = {
  sendEvent,
  sendIdentify,
  sendActivity,
}

export default Telemetry