@exodus/analytics

Exodus analytics

A base class encapsulating analytics integration.

API Reference

Property name	Description
setPermanentUserId	Use this to set the permanent user id, i.e. the seed derived id fetched from analyticsUserIdAtom
flush	Use this to send persisted events to segment. Events that are tracked before setPermanentUserId is set will need to be flushed
getAnonymousId	Gets the anonymousId associated with the tracker. This is a UUID until setPermanentUserId is called with the userId
track	Use this method to send events to segment. If setPermanentUserId has not been called, you must use force: true.
identify	Used primarily to identify a user with the onboarding UUID and to set global "traits". Should be used sparingly -- on seed import or seed create for example.
setDefaultProperties	Pretty much as it sounds. This sets persistent properties to be sent with every call to segment via track
trackInstall	sets a persisted event that can be sent with flush postinstall

Usage

import createStorage from '@exodus/storage-memory' // use the relevant platform-specific implementation
import analyticsDefinition from '@exodus/analytics'
import Tracker from '@exodus/segment-metrics'

const analytics = analyticsDefinition.factory({
  storage: storage.namespace('analytics'),
  shareActivityAtom,
  tracker: new Tracker(segmentApiKey),
  // optional
  config: {
    installEventReportingUrl,
  },
  logger,
})

/*
 *  during onboarding, we don't need to set the permanent user id
 *  segment + analytics will automatically generate a UUID to track onboarding
 *  so that we can call .track({ event, properties }) without first being
 *  "connected" or having .setPermanentUserId()
 *
 *  using force: true, you can send the event right away associated w/ the UUID
 *  force: false (default) will simply persist the event until you call .flush()
 */

analytics.track({ ...onboardingEvent, force: true }) // we can use force: true to send the event to segment
analytics.track({ ...anotherEvent }) // without force: true, this event is persisted and can be sent by using .flush()

const userId = await analyticsUserIdAtom.get() // should come from the IOC container

analytics.setPermanentUserId(userId)
analytics.flush() // any persisted event can now be sent
analytics.track({
  event: 'hello world',
})

Constructor Options

Property name	Required	Description
tracker	yes	A Tracker class instance.
storage	yes	An object implementing the Storage interface (see below). Needed if you need to persist events (e.g. when a consumer application can be temporarily locked).
shareActivityAtom	yes	An atom returning a boolean value indicating if a consumer application is ready to send events.
trackUnvalidated	no	A boolean flag indicating if not validated events should be still submitted to Segment API. false by default
config	no	Static configuration options
config.installEventReportingUrl	no	Url to which to post app install events

type SerializedEvent = 'string'

interface Storage {
  set: (key: string, events: SerializedEvent[]) => Promise<undefined>
  get: (key: string) => Promise<SerializedEvent[]>
}