@splitsoftware/openfeature-web-split-provider

Split OpenFeature Provider for NodeJS

Overview

This Provider is designed to allow the use of OpenFeature with Split, the platform for controlled rollouts, serving features to your users via the Split feature flag to manage your complete customer experience.

Getting started

Below is a simple example that describes the instantiation of the Split Provider. Please see the OpenFeature Documentation for details on how to use the OpenFeature SDK.

Add the Split provider

npm install @splitsoftware/openfeature-web-split-provider

Confirm peer dependencies are installed

npm install @splitsoftware/splitio-browserjs
npm install @openfeature/web-sdk

Register the Split provider with OpenFeature using splitFactory

import { OpenFeature } from '@openfeature/web-sdk';
import { SplitFactory } from '@splitsoftware/splitio-browserjs';
import { OpenFeatureSplitProvider } from '@splitsoftware/openfeature-web-split-provider';

const splitFactory = SplitFactory({
  core: {
    authorizationKey: 'your auth key' 
  }
});
const provider = new OpenFeatureSplitProvider(splitFactory);
OpenFeature.setProvider(provider);

Use of OpenFeature with Split

After the initial setup you can use OpenFeature according to their documentation.

One important note is that the Split Provider requires a targeting key to be set. Often times this should be set when evaluating the value of a flag by setting an EvaluationContext which contains the targeting key. An example flag evaluation is

const context: EvaluationContext = {
  targetingKey: 'TARGETING_KEY',
  trafficType: 'account'
};
OpenFeature.setContext(context)

Evaluate with details

Use the get*Details(...) APIs to get the value and rich context (variant, reason, error code, metadata). This provider includes the Split treatment config as a raw JSON string under flagMetadata["config"]

const booleanTreatment = client.getBooleanDetails('boolFlag', false);

const config = booleanTreatment.flagMetadata.config;

Evaluate with attributes

Evaluation attributes must be set in context before evaluation

const context: EvaluationContext = {
  targetingKey: 'TARGETING_KEY',
  trafficType: 'account',
  plan: 'premium',
  couppon: 'WELCOME10'
};
OpenFeature.setContext(context);
const booleanTreatment = client.getBooleanDetails('boolFlag', false);

Tracking

To use track(eventName, context, details) you must provide:

• A non-blank eventName.
• A context with:
  • targetingKey (non-blank).
  • trafficType (string, e.g. "user" or "account", "user" by default).

Optional:

• details with:
  • value: numeric event value (defaults to 0).
  • properties: map of attributes (prefer primitives: string/number/boolean/null).

Example:

const context = { targetingKey: 'user-123', trafficType: 'account' }
const details = { value: 19.99, properties: { plan: 'pro', coupon: 'WELCOME10' }}

client.setEvaluationContext(context)
client.track('checkout.completed', details)

Submitting issues

The Split team monitors all issues submitted to this issue tracker. We encourage you to use this issue tracker to submit any bug reports, feedback, and feature enhancements. We'll do our best to respond in a timely manner.

Contributing

Please see Contributors Guide to find all you need to submit a Pull Request (PR).

License

Licensed under the Apache License, Version 2.0. See: Apache License.

About Split

Split is the leading Feature Delivery Platform for engineering teams that want to confidently deploy features as fast as they can develop them. Split’s fine-grained management, real-time monitoring, and data-driven experimentation ensure that new features will improve the customer experience without breaking or degrading performance. Companies like Twilio, Salesforce, GoDaddy and WePay trust Split to power their feature delivery.

To learn more about Split, contact [e-mail], or get started with feature flags for free at https://www.split.io/signup.

Split has built and maintains SDKs for:

• .NET Github Docs
• Android Github Docs
• Angular Github Docs
• Elixir thin-client Github Docs
• Flutter Github Docs
• GO Github Docs
• iOS Github Docs
• Java Github Docs
• JavaScript Github Docs
• JavaScript for Browser Github Docs
• Node.js Github Docs
• PHP Github Docs
• PHP thin-client Github Docs
• Python Github Docs
• React Github Docs
• React Native Github Docs
• Redux Github Docs
• Ruby Github Docs

For a comprehensive list of open source projects visit our Github page.

Learn more about Split:

Visit split.io/product for an overview of Split, or visit our documentation at help.split.io for more detailed information.