OpenFeature Server SDK JavaScript Confidence Provider

JavaScript implementation of the Confidence OpenFeature server provider, to be used in conjunction with the OpenFeature Server SDK. This implements the dynamic paradigm of OpenFeature.

Usage

Adding the dependencies

To add the packages to your dependencies run:

yarn add @openfeature/server-sdk @openfeature/core @spotify-confidence/sdk @spotify-confidence/openfeature-server-provider

Enabling the provider, setting the evaluation context and resolving flags

import { createConfidenceServerProvider } from '@spotify-confidence/openfeature-server-provider';
import { OpenFeature } from '@openfeature/server-sdk';

const provider = createConfidenceServerProvider({
  clientSecret: 'your-client-secret',
  fetchImplementation: fetch,
  timeout: 1000,
});

OpenFeature.setProvider(provider);

const client = OpenFeature.getClient();

client
  .getBooleanValue('flagName.bool', false, {
    targetingKey: `your targeting key`,
  })
  .then(result => {
    console.log('result:', result);
  });

Tracking

With @openfeature/server-sdk 1.16.0 or later, events can be tracked with a request-specific evaluation context:

client.track(
  'checkout',
  { targetingKey: 'your targeting key' },
  {
    value: 42,
    currency: 'SEK',
  },
);

Tracking details are added to the Confidence event payload. context is reserved for the evaluation context and is ignored when used as a tracking detail key.

Region

The region option is used to set the region for the network request to the Confidence backend. When the region is not set, the default (global) region will be used. The current regions are: eu and us, the region can be set as follows:

const provider = createConfidenceServerProvider({
  region: 'eu', // or 'us'
  // ... other options
});

Custom base URLs

Set baseUrl to route flag resolution, apply, events, and telemetry through one origin. The endpoint-specific resolveBaseUrl, applyBaseUrl, and eventBaseUrl options take precedence when both are set.

Timeout

The timeout option is used to set the timeout for the network request to the Confidence backend. When the timeout is reached, default values will be returned.

Configuring Apply

See apply concept.

Backend apply is the only supported method in the ConfidenceServerProvider.