Server-Side flagd Provider

This provider is designed to use flagd's evaluation protocol, or locally evaluate flags defined in a flagd flag definition.
This repository and package provides the client code for interacting with it via the OpenFeature server-side JavaScript SDK.

Installation

$3

``sh
npm install @openfeature/flagd-provider
`

$3

`sh
yarn add @openfeature/server-sdk @grpc/grpc-js @openfeature/flagd-core
`

> [!NOTE]
> yarn requires manual installation of peer dependencies

Configurations and Usage

The FlagdProvider supports multiple configuration options and has the ability to resolve flags remotely over RPC or in-process.
Options can be defined in the constructor or as environment variables. Constructor options having the highest precedence.

$3

| Option name | Environment variable name | Type | Default | Supported values |
| -------------------------------------- | ------------------------------ | ------- |----------------------------------------------------------------| ---------------- |
| host | FLAGD_HOST | string | localhost | |
| port | FLAGD_PORT | number | resolver specific defaults | |
| tls | FLAGD_TLS | boolean | false | |
| socketPath | FLAGD_SOCKET_PATH | string | - | |
| resolverType | FLAGD_RESOLVER | string | rpc | rpc, in-process |
| offlineFlagSourcePath | FLAGD_OFFLINE_FLAG_SOURCE_PATH | string | - | |
| selector | FLAGD_SOURCE_SELECTOR | string | - | |
| cache | FLAGD_CACHE | string | lru | lru, disabled |
| maxCacheSize | FLAGD_MAX_CACHE_SIZE | int | 1000 | |
| defaultAuthority | FLAGD_DEFAULT_AUTHORITY | string | - | rpc, in-process |

#### Resolver type-specific Defaults

| Option name | Environment variable name | in-process | rpc | default |
| -------------------------------------- | ------------------------------ |-------------|------|---------|
| port | FLAGD_PORT | 8015 | 8013 | 8013 |

Below are examples of usage patterns.

$3

This is the default mode of operation of the provider.
In this mode, FlagdProvider communicates with flagd via the gRPC protocol.
Flag evaluations take place remotely on the connected flagd instance.

`ts
OpenFeature.setProvider(new FlagdProvider())
`

In the above example, the provider expects flagd to be available at localhost:8013 (default host and port).

Alternatively, you can use socket paths to connect to flagd.

`ts
OpenFeature.setProvider(new FlagdProvider({
socketPath: "/tmp/flagd.socks",
}))
`

$3

This mode performs flag evaluations locally (in-process).
Flag configurations for evaluation are obtained via gRPC protocol using sync protobuf schema service definition.

`ts
OpenFeature.setProvider(new FlagdProvider({
resolverType: 'in-process',
}))
`

In the above example, the provider expects a flag sync service implementation to be available at localhost:8015 (default host and port).

In-process resolver can also work in an offline mode.
To enable this mode, you should provide a valid flag configuration file with the option offlineFlagSourcePath.

`ts
OpenFeature.setProvider(new FlagdProvider({
resolverType: 'in-process',
offlineFlagSourcePath: './flags.json',
}))
`

Offline mode uses fs.watchFile and polls every 5 seconds for changes to the file.
This mode is useful for local development, test cases, and for offline applications.

$3

This is useful for complex routing or service-discovery use cases that involve a proxy (e.g., Envoy).
Please refer to this GitHub issue for more information.

`ts
OpenFeature.setProvider(new FlagdProvider({
resolverType: 'in-process',
defaultAuthority: 'b-target-api.service',
}))
`

$3

The flagd provider emits PROVIDER_READY, PROVIDER_ERROR and PROVIDER_CONFIGURATION_CHANGED events.

| SDK event | Originating action in flagd |
| -------------------------------- | ------------------------------------------------------------------------------- |
| PROVIDER_READY | The streaming connection with flagd has been established. |
| PROVIDER_ERROR | The streaming connection with flagd has been broken. |
| PROVIDER_CONFIGURATION_CHANGED | A flag configuration (default value, targeting rule, etc) in flagd has changed. |

For general information on events, see the official documentation.

$3

Flag metadata is a set of key-value pairs that can be associated with a flag.
The values come from the flag definition in flagd.

Building

Run nx package providers-flagd to build the library.

> NOTE: Buf must be installed to build locally.

Running Unit Tests

Run nx test providers-flagd` to execute the unit tests via Jest.