GrowthBook

Use GrowthBook with the Flags SDK

GrowthBook can be used with the Flags SDK through OpenFeature. Set up the Flags SDK adapter for OpenFeature, along with the GrowthBook OpenFeature provider to get started.

This provider has a native adapter available at @flags-sdk/growthbook, which you should use instead.

Install the following packages:

npm install flags @flags-sdk/openfeature @growthbook/growthbook @openfeature/growthbook-provider

Set up your GrowthBook OpenFeature provider as a Flags SDK adapter.

// adapter.ts
import { OpenFeature } from "@openfeature/server-sdk";
import { createOpenFeatureAdapter } from "@flags-sdk/openfeature";
import { GrowthBookClient, ClientOptions, InitOptions } from '@growthbook/growthbook';
import { GrowthbookProvider } from '@openfeature/growthbook-provider';

export const openFeatureAdapter = createOpenFeatureAdapter(async () => {
  /*
  * Configure your GrowthBook instance with GrowthBook context
  * @see https://docs.growthbook.io/lib/js#step-1-configure-your-app
  */
  const gbClientOptions: ClientOptions = {
    apiHost: 'https://cdn.growthbook.io',
    clientKey: 'sdk-abc123',
    // Only required if you have feature encryption enabled in GrowthBook
    decryptionKey: 'key_abc123',
  };

  /*
  * optional init options
  * @see https://docs.growthbook.io/lib/js#switching-to-init
  */
  const initOptions: InitOptions = {
    timeout: 2000,
    streaming: true,
  };

  const provider = new GrowthbookProvider(gbClientOptions, initOptions);

  await OpenFeature.setProviderAndWait(provider);
  return OpenFeature.getClient();
});

See the OpenFeature adapter for more details.

Use your newly configured adapter when declaring flags.

// flags.ts
import { flag } from "flags/next";
import type { EvaluationContext } from "@openfeature/server-sdk";
import { openFeatureAdapter } from "./adapter";

export const exampleFlag = flag<boolean, EvaluationContext>({
  key: "example-flag",
  defaultValue: false,
  adapter: openFeatureAdapter.booleanValue(),
});

Flags SDK adapter for OpenFeature

GrowthBook OpenFeature Provider

Note that OpenFeature providers may require additional configuration for optimal performance and compatibility. Setup instructions are provided on a best effort basis. Refer to each provider's own documentation.

If there is a native Flags SDK adapter for your provider, we recommend using that instead. Native Flags SDK adapters tune your flag provider's SDK for optimal performance and integrate with Flags Explorer and Edge Config. See available adapters.

If you are a feature flag provider interested in developing a native adapter please open a GitHub issue to get in touch.

推荐订阅源

Flags SDK Documentation