Skip to content

README.md

Latest commit

 

History

History
188 lines (130 loc) · 6.24 KB

README.md

File metadata and controls

188 lines (130 loc) · 6.24 KB

Reflag Browser OpenFeature Provider

The official OpenFeature Browser provider for Reflag.com flag management service.

It uses the Reflag Browser SDK internally and thus allow you to collect automated feedback surveys when people use your flag as well as tracking which customers use which features.

If you're using React, you'll be better off with the Reflag React SDK or the OpenFeature React SDK.

See the example folder for how to use the OpenFeature React SDK with Next.js.

Installation

The OpenFeature SDK is required as peer dependency.

The minimum required version of @openfeature/web-sdk currently is 1.0.

npm install @openfeature/web-sdk @reflag/openfeature-browser-provider

Migrating from Bucket OpenFeature SDK

If you have been using the Bucket SDKs, the following list will help you migrate to Reflag SDK:

  • Bucket* classes, and types have been renamed to Reflag* (e.g. BucketClient is now ReflagClient)
  • The fallbackFeatures property in client constructor and configuration files has been renamed to fallbackFlags
  • featureKey has been renamed to flagKey in all methods that accepts that argument
  • The SDKs will not emit evaluate and evaluate-config events anymore
  • The new cookies that are stored in the client's browser are now reflag-* prefixed instead og bucket-*

If you are running with strict Content Security Policies active on your website, you will need change them as follows:

  • connect-src https://front.bucket.co to connect-src https://front.reflag.com

Finally, if you have customized the look & feel of the Feedback component, update --bucket-feedback-* CSS classes to --reflag-feedback-*

Sample initialization

import { ReflagBrowserProvider } from "@reflag/openfeature-browser-provider";
import { OpenFeature } from "@openfeature/web-sdk";

// initialize provider
const publishableKey = "<your-reflag-publishable-key>";

const reflagProvider = new ReflagBrowserProvider({ publishableKey });

// set open feature provider and get client
await OpenFeature.setProviderAndWait(reflagProvider);
const client = OpenFeature.getClient();

// use client
const boolValue = client.getBooleanValue("huddles", false);

// use more complex, dynamic config-enabled functionality.
const feedbackConfig = client.getObjectValue("ask-feedback", {
  question: "How are you enjoying this feature?",
});

Initializing the Reflag Browser Provider will also initialize automatic feedback surveys.

Feature resolution methods

The Reflag OpenFeature Provider implements the OpenFeature evaluation interface for different value types. Each method handles the resolution of flags according to the OpenFeature specification.

Common behavior

All resolution methods share these behaviors:

  • Return default value with PROVIDER_NOT_READY if client is not initialized,
  • Return default value with FLAG_NOT_FOUND if flag doesn't exist,
  • Return default value with ERROR if there was a type mismatch,
  • Return evaluated value with TARGETING_MATCH on successful resolution.

Type-Specific Methods

Boolean Resolution

client.getBooleanValue("my-flag", false);

Returns the flag's enabled state. This is the most common use case for flags.

String Resolution

client.getStringValue("my-flag", "default");

Returns the flag's remote config key (also known as "variant"). Useful for multi-variate use cases.

Number Resolution

client.getNumberValue("my-flag", 0);

Not directly supported by Reflag. Use getObjectValue instead for numeric configurations.

Object Resolution

// works for any type:
client.getObjectValue("my-flag", { defaultValue: true });
client.getObjectValue("my-flag", "string-value");
client.getObjectValue("my-flag", 199);

Returns the flag's remote config payload with type validation. This is the most flexible method, allowing for complex configuration objects or simple types.

The object resolution performs runtime type checking between the default value and the flag payload to ensure type safety.

Context

To convert the OpenFeature context to a Reflag appropriate context pass a translation function along to the ReflagBrowserProvider constructor like so:

import { ReflagBrowserProvider } from "@reflag/openfeature-browser-provider";
import { EvaluationContext, OpenFeature } from "@openfeature/web-sdk";

// initialize provider
const publishableKey = "<your-reflag-publishable-key>";

// this converts the context to a Reflag compatible context
// adapt it to fit your need
const contextTranslator = (context?: EvaluationContext) => {
  return {
    user: {
      id: context.targetingKey ?? context["userId"],
      email: context["email"]?.toString(),
      name: context["name"]?.toString(),
      avatar: context["avatar"]?.toString(),
      country: context["country"]?.toString(),
    },
    company: {
      id: context["companyId"],
      name: context["companyName"]?.toString(),
      avatar: context["companyAvatar"]?.toString(),
      plan: context["companyPlan"]?.toString(),
    },
  };
};

const reflagOpenFeatureProvider = new ReflagBrowserProvider({
  publishableKey,
  contextTranslator,
});

To update the context, call OpenFeature.setContext(myNewContext);

await OpenFeature.setContext({ userId: "my-key" });

Tracking flag usage

The Reflag OpenFeature Provider supports the OpenFeature tracking API natively.

import { ReflagBrowserProvider } from "@reflag/openfeature-browser-provider";
import { OpenFeature } from "@openfeature/web-sdk";

// initialize provider
const publishableKey = "<your-reflag-publishable-key>";

const reflagProvider = new ReflagBrowserProvider({ publishableKey });

// set OpenFeature provider and get client
await OpenFeature.setProviderAndWait(reflagProvider);
const client = OpenFeature.getClient();

// use client to send an event when user uses a flag
client.track("huddles");

License

MIT License Copyright (c) 2025 Bucket ApS