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.
Compatibility
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.
const OpenFeature = require('@openfeature/nodejs-sdk').OpenFeature;
const SplitFactory = require('@splitsoftware/splitio').SplitFactory;
const OpenFeatureSplitProvider = require('@splitsoftware/openfeature-nodejs-split-provider').OpenFeatureSplitProvider;
splitClient = SplitFactory({core: {authorizationKey: 'localhost'}}).client();
openFeature.setProvider(splitClient);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 client = openFeature.getClient('CLIENT_NAME');
const context: EvaluationContext = {
targetingKey: 'TARGETING_KEY',
};
const boolValue = await client.getBooleanValue('boolFlag', false, context);If the same targeting key is used repeatedly, the evaluation context may be set at the client level
const context: EvaluationContext = {
targetingKey: 'TARGETING_KEY',
};
client.setEvaluationContext(context)or at the OpenFeatureAPI level
const context: EvaluationContext = {
targetingKey: 'TARGETING_KEY',
};
OpenFeatureAPI.getInstance().setCtx(context)If the context was set at the client or api level, it is not required to provide it during flag evaluation.
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 hello@split.io, or get started with feature flags for free at https://www.split.io/signup.
Split has built and maintains SDKs for:
- Java Github Docs
- Javascript Github Docs
- Node Github Docs
- .NET Github Docs
- Ruby Github Docs
- PHP Github Docs
- Python Github Docs
- GO Github Docs
- Android Github Docs
- iOS 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.