Skip to main content

JavaScript On Device Evaluation

DEPRECATED

To get started with local Statsig evaluations in JS, you should use the new On Device Evalutions SDK.

This version of the JS SDK is deprecated and will only receive major bug fixes going forward.

Installation​

You can install the Statsig JS with Local Evaluation SDK via npm, yarn or jsdelivr:

Statsig is available from jsdelivr, an open source CDN.

To access the current primary JavaScript bundle, use:

https://cdn.jsdelivr.net/npm/statsig-js-local-eval/build/statsig-prod-web-sdk.min.js

To access specific files/versions:

http://cdn.jsdelivr.net/npm/statsig-js-local-eval@{version}/{file}

<script src="https://cdn.jsdelivr.net/npm/statsig-js-local-eval/build/statsig-prod-web-sdk.min.js"></script>

Initialize the SDK​

Initialize the SDK using a Client SDK key from the "API Keys" tab on the Statsig console. When creating the key, or using an existing key, you will need to add the "Allow Download Config Specs" scope. Client keys, by default, are not able to download the project definition to do on device evaluation. You must opt in to allow your client key to access your full project definition on our cdn.

When creating a new client key, select "Allow Download Config Specs"

Add DCS Scope to Existing Key

caution

Do NOT embed a Server Secret Key in client side applications.

import Statsig from "statsig-js-local-eval";

// initialize returns a promise which always resolves
await Statsig.initializeAsync(
  "client-sdk-key",
  { environment: { tier: "staging" } } // optional, pass options here if needed
);

Working with the SDK​

Checking a Feature Flag/Gate​

Now that your SDK is initialized, let's check a Feature Gate. Feature Gates can be used to create logic branches in code that can be rolled out to different users from the Statsig Console. Gates are always CLOSED or OFF (think return false;) by default.

if (Statsig.checkGate({userID: "123"}, "new_homepage_design")) {
  // Gate is on, show new home page
} else {
  // Gate is off, show old home page
}

// Check with different properties without a network request to update sdk state
Statsig.checkGate(
  {
    email: "docs@statsig.com",
    customIDs: {deviceID: "abc"}
  },
  "new_homepage_design",
)

The checkGate API takes an optional third parameter with a set of parameters for that check.

export type CheckGateOptions = {
  disableExposureLogging: boolean;
};

To check a gate with exposure logging disabled, you can set that field in the options. Exposure logging will be disabled for that check only

  • you must pass that parameter with every check you wish to disable exposure logging for.
Statsig.checkGate(User, "my_feature", { disableExposureLogging: true });

Reading a Dynamic Config​

Feature Gates can be very useful for simple on/off switches, with optional but advanced user targeting. However, if you want to be able send a different set of values (strings, numbers, and etc.) to your clients based on specific user attributes, e.g. country, Dynamic Configs can help you with that. The API is very similar to Feature Gates, but you get an entire json object you can configure on the server and you can fetch typed parameters from it. For example:

import type { DynamicConfig } from "statsig-js-local-eval";

const config: DynamicConfig = Statsig.getConfig({userID: "456"}, "awesome_product_details");

// The 2nd parameter is the default value to be used in case the given parameter name does not exist on
// the Dynamic Config object. This can happen when there is a typo, or when the user is offline and the
// value has not been cached on the client.
const itemName: string = config.get("product_name", "Awesome Product v1");
const price: number = config.get("price", 10.0);
const shouldDiscount: boolean = config.get("discount", false);

Getting an Layer/Experiment​

Then we have Layers/Experiments, which you can use to run A/B/n experiments. We offer two APIs, but we recommend the use of layers to enable quicker iterations with parameter reuse.

import type { Layer, DynamicConfig } from "statsig-js-local-eval";

// Values via getLayer

const layer: Layer = Statsig.getLayer({email: "test@statsig.com", customIDs: {pageID: "123"}}, "user_promo_experiments");
const promoTitle: string = layer.get("title", "Welcome to Statsig!");
const discount: number = layer.get("discount", 0.1);

// or, via getExperiment

const titleExperiment: DynamicConfig = Statsig.getExperiment(
  {email: "test@statsig.com", customIDs: {businessID: "abc"}},
  "new_user_promo_title"
);
const priceExperiment: DynamicConfig = Statsig.getExperiment(
  {email: "test@statsig.com"},
  "new_user_promo_price"
);

const promoTitle: string = titleExperiment.get("title", "Welcome to Statsig!");
const discount: number = priceExperiment.get("discount", 0.1);

Logging an Event​

Now that you have a Feature Gate or an Experiment set up, you may want to track some custom events and see how your new features or different experiment groups affect these events. This is super easy with Statsig - simply call the Log Event API for the event, and you can additionally provide some value and/or an object of metadata to be logged together with the event:

Statsig.logEvent({userID: "123"}, "add_to_cart", "SKU_12345", {
  price: "9.99",
  item_name: "diet_coke_48_pack",
});

Learn more about identifying users, group analytics, and best practices for logging events in the logging events guide.

Statsig User​

You should provide a StatsigUser object whenever possible when initializing the SDK, passing as much information as possible in order to take advantage of advanced gate and config conditions (like country or OS/browser level checks).

Most of the time, the userID field is needed in order to provide a consistent experience for a given user (see logged-out experiments to understand how to correctly run experiments for logged-out users).

If the user is logged out at the SDK init time, you can leave the `userID` out for now, and we will use a stable device ID that we create and store in the local storage for targeting purposes.

Besides userID, we also have email, ip, userAgent, country, locale and appVersion as top-level fields on StatsigUser. In addition, you can pass any key-value pairs in an object/dictionary to the custom field and be able to create targeting based on them.

Private Attributes​

Have sensitive user PII data that should not be logged? No problem, we have a solution for it! On the StatsigUser object we also have a field called privateAttributes, which is a simple object/dictionary that you can use to set private user attributes. Any attribute set in privateAttributes will only be used for evaluation/targeting, and removed from any logs before they are sent to Statsig server.

For example, if you have feature gates that should only pass for users with emails ending in "@statsig.com", but do not want to log your users' email addresses to Statsig, you can simply add the key-value pair { email: "my_user@statsig.com" } to privateAttributes on the user and that's it!

Statsig Options​

statsig.initializeAsync() and statsig.initialize() takes an optional parameter options in addition to sdkKey and user that you can provide to customize the Statsig client. Here are the current options and we are always adding more to the list:

User properties​

  • environment: StatsigEnvironment, default null
    • An object you can use to set environment variables that apply to all of your users in the same session and will be used for targeting purposes.
    • The most common usage is to set the environment tier ('production', 'staging' or 'development'), e.g. { tier: 'staging' }, and have feature gates pass/fail for specific environments.
  • overrideStableID - string, default null
    • If you'd like to use your own ID in place of Statsig's stableID, then you can pass the ID as an option here.
    • Once a value is passed, the SDK will store this ID in the local storage for the browser for future use as well.
    • The SDK will automatically add an entry in customIDs in the user object for the current stableID

Endpoint Overrides​

  • configSpecAPI - default https://api.statsig.com/v1/
    • The endpoint to download the config spec definition for your project. You should likely not override this unless you are hosting your config spec on your own cdn. Defaults to https://api.statsigcdn.com/v1/download_config_specs/<client_key>.json, used for async initialization
  • eventLoggingApi? string, default 'https://events.statsigapi.net/v1/rgstr/
    • The SDK will hit different endpoints for downloading config definitions to evaluate gates and for rgstr|log_event to log event data. eventLoggingApi controls the event logging endpoint.

Event Logging Parameters​

  • disableCurrentPageLogging boolean, default false.
    • By default, the sdk appends the current page for log events to the event payload to generate user journey/funnel analytics
  • loggingIntervalMillis: number, default 5000 (5s), min 1000, max 60000
    • How frequently to flush logs to statsig (milliseconds)
  • loggingBufferMaxSize: number, default 10), min 2, max 500
    • Maximum number of events to buffer before flushing events to statsig

Initialization​

  • initializeValues? Record<string, any> | null, default null
    • Provide the download_config_specs values directly to the Javascript SDK to synchronously initialize the client
    • You may wish to fetch this from the default js snippet we provide on our cdn. See "Synchronous Initialization" for more details
    • Only used when calling statsig.initialize()
  • initTimeoutMs? number, default 3000
    • For asynchronous initialization, the time to wait for the project definition to be downloaded before falling back to cached or default values
    • Only used when calling statsig.initializeAsync()

Networking and Local Storage​

  • localMode - boolean, default false
    • Pass true to this option to turn on Local Mode for the SDK, which will stop the SDK from issuing any network requests and make it only operate with only local overrides (If supported) and cache.
      Note: Since no network requests will be made, a dummy SDK key starting with "client-" can be used. (eg "client-key")
  • ignoreWindowUndefined? boolean, default false
    • By default, the SDK will not issue network requests when the global window is undefined. If you are trying to execute in a server environment for SSR, you may wish to override this. A better approach would be to bootstrap the sdk from the server rather than issuing a network request, but this can be used to unblock testing
  • disableLocalStorage? boolean, default false
    • Completely disable the use of local storage for the lifecycle of this initialize -> shutdown. The only access to local storage will be to clear out existing keys when statsig is shutdown
  • disableNetworkKeepalive: boolean, default false. sdk
    • Entirely disables the keepalive flag from being appended to network requests issued by the SDK
  • userPersistentStorage? UserPersistentStorageInterface, default null
    • A persistent storage adapter for running sticky experiments.

Shutting Statsig Down​

In order to save users' data and battery usage, as well as prevent logged events from being dropped, we keep event logs in client cache and flush periodically. Because of this, some events may not have been sent when your app shuts down.

To make sure all logged events are properly flushed or saved locally, you should tell Statsig to shutdown when your app is closing:

Statsig.shutdown();

stableID​

Each client SDK has the notion of stableID, and identifier that is generated the first time the SDK is initialized and is stored locally for all future sessions. Unless storage is wiped (or app deleted), the stableID will not change. This allows us to run device level experiments and experiments when other user identifiable information is unavailable (Logged out users).

You can get the stableID for the current device with:

Statsig.getStableID();

If you have your own form of stableID and would prefer to use it instead of the Statsig generated ID, you can override it through StatsigOptions:

const opts: StatsigOptions = { overrideStableID: "my_stable_id" };
await Statsig.initialize("client-xyx", null, opts);

User Persistent Storage​

A custom storage adapter that allows the SDK the persist values for users in active experiments. In other words, allowing you to run experiments with sticky bucketing. You can provide a persistent storage adapter via StatsigOptions.UserPersistentStorage.

You can read more about the concept here.

Storage Interface​

You can write you own custom storage that implements the following interface:

type UserPersistedValues = Record<string, Record<string, unknown>>;

interface UserPersistentStorageInterface {
  delete(key: string, experiment: string): void
  load(key: string): UserPersistedValues
  save(key: string, experiment: string, data: string): void
  loadAsync(key: string): Promise<UserPersistedValues>
}

Example Implementation​

class TestStickyAdapter implements UserPersistentStorageInterface {
  public store: Record<string, UserPersistedValues> = {};

  delete(key: string, experimentName: string): void {
    delete this.store[key][experimentName];
  }

  load(key: string): UserPersistedValues {
    return this.store[key];
  }

  save(key: string, experimentName: string, data: string): void {
    let updatedValue: UserPersistedValues = this.store[key];
    if (updatedValue == null) {
      updatedValue = {};
    }
    updatedValue[experimentName] = JSON.parse(data);
    this.store[key] = updatedValue;
  }

  loadAsync(key: string): Promise<UserPersistedValues> {
    return new Promise((resolve, reject) => {
      setTimeout(() => {
        resolve(this.load(key));
      }, 10);
    });
  }
}

FAQ​

How do I run experiments for logged out users?​

See the guide on device level experiments

How can I mock the SDK/override gates in tests?​

The SDK has a few key features to make testing easier:

  • localMode - a parameter in StatsigOptions which disables all network requests to Statsig servers. This makes the SDK operate only locally, so your tests don't need network access

We recommend mocking results for your gates and experiments for programmatic testing, via jest or your test framework of choice.

What kind of browser support can I expect from the SDK?​

We strive to keep the SDK as lightweight as possible, while supporting as many browsers as possible. The primary feature that our SDK relies on which may not be supported by all browsers is a javascript Promise. You may wish to polyfill a Promise library to ensure maximum browser compatibility. We recommend taylorhakes/promise-polyfill for its small size and compatibility.

The SDK has not been tested on IE. Note that Microsoft retired IE11 in June, 2022

Does the SDK use the browser local storage or cookies? If so, for what purposes?​

The SDK does not use any cookies.

It does use the local storage for feature targeting and experimentation purposes only. Values for feature gates, dynamic configs and experiments are cached in the local storage, which are used as a backup in the event that your website/app cannot reach the Statsig server to fetch the latest values. If any events were logged but could not be sent to Statsig server due to issues like network failure, we also save them in the local storage to be sent again when network restores.