https://github.com/flipt-io/flipt-openfeature-provider-go
OpenFeature provider for Flipt (GRPC/HTTP) MOVED
https://github.com/flipt-io/flipt-openfeature-provider-go
go golang openfeature
Last synced: 5 months ago
JSON representation
OpenFeature provider for Flipt (GRPC/HTTP) MOVED
- Host: GitHub
- URL: https://github.com/flipt-io/flipt-openfeature-provider-go
- Owner: flipt-io
- License: apache-2.0
- Archived: true
- Created: 2022-09-21T15:45:21.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-15T18:06:26.000Z (over 2 years ago)
- Last Synced: 2025-04-01T09:03:54.442Z (about 1 year ago)
- Topics: go, golang, openfeature
- Language: Go
- Homepage: https://github.com/open-feature/go-sdk-contrib/tree/main/providers/flipt
- Size: 269 KB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Flipt OpenFeature Provider (Go)
## Moved :warning:
We have moved the Flipt OpenFeature Provider (Go) to the official [OpenFeature Go Contrib repository](https://github.com/open-feature/go-sdk-contrib). You can find the latest version of the Flipt OpenFeature Provider (Go) at: .
We will continue to maintain the Flipt OpenFeature Provider (Go) in the OpenFeature Go Contrib repository. Please open any issues or pull requests there.
In the future, we will be archiving this repository and eventually removing it.
## Overview
[](https://github.com/flipt-io/openfeature-provider-go/actions/workflows/ci.yml)
[](https://pkg.go.dev/go.flipt.io/flipt-openfeature-provider)
[](https://github.com/open-feature/spec/tree/v0.5.1)
[](https://github.com/open-feature/go-sdk)
This repository and package provides a [Flipt](https://github.com/flipt-io/flipt) [OpenFeature Provider](https://docs.openfeature.dev/docs/specification/sections/providers) for interacting with the Flipt service backend using the [OpenFeature Go SDK](https://github.com/open-feature/go-sdk).
From the [OpenFeature Specification](https://docs.openfeature.dev/docs/specification/sections/providers):
> Providers are the "translator" between the flag evaluation calls made in application code, and the flag management system that stores flags and in some cases evaluates flags.
## Requirements
- Go 1.20+
- A running instance of [Flipt](https://www.flipt.io/docs/installation)
## Breaking Changes
### v0.2.0
Version [v0.2.0](https://github.com/flipt-io/flipt-openfeature-provider-go/releases/tag/v0.2.0) of this client correlates Boolean flag evaluations to [Boolean flag types](https://www.flipt.io/docs/concepts#boolean-flags) on the Flipt server. Upgrading to this version will require you to convert your flags that were using Boolean evaluation to the Boolean flag type on the Flipt server.
:warning: Boolean flag evaluations were introduced in Flipt server (>= [v.1.24.0](https://github.com/flipt-io/flipt/releases/tag/v1.24.0)).
### v0.1.5
Version [v0.1.5](https://github.com/flipt-io/flipt-openfeature-provider-go/releases/tag/v0.1.5) of this client introduced a change to use a newer version of the Flipt API which requires use of the `namespace` parameter. This is to support the new namespace functionality added to [Flipt v1.20.0](https://www.flipt.io/docs/reference/overview#v1-20-0).
This client uses the `default` namespace by default. If you are using a different namespace, you will need to set the `namespace` parameter when creating the provider:
```go
provider := flipt.NewProvider(flipt.ForNamespace("my-namespace"))
```
:warning: If you are running an older version of Flipt server (< [v1.20.0](https://github.com/flipt-io/flipt/releases/tag/v1.20.0)), you should use a pre 0.1.5 version of this client.
## Usage
### Installation
```bash
go get go.flipt.io/flipt-openfeature-provider
```
### Example
```go
package main
import (
"context"
"go.flipt.io/flipt-openfeature-provider/pkg/provider/flipt"
"github.com/open-feature/go-sdk/pkg/openfeature"
)
func main() {
// http://localhost:8080 is the default Flipt address
openfeature.SetProvider(flipt.NewProvider())
client := openfeature.NewClient("my-app")
value, err := client.BooleanValue(context.Background(), "v2_enabled", false, openfeature.EvaluationContext{
TargetingKey: "tim@apple.com",
Attributes: map[string]interface{}{
"favorite_color": "blue",
},
})
if err != nil {
panic(err)
}
if value {
// do something
} else {
// do something else
}
}
```
## Configuration
The Flipt provider allows you to communicate with Flipt over either HTTP(S) or GRPC, depending on the address provided.
### HTTP(S)
```go
provider := flipt.NewProvider(flipt.WithAddress("https://localhost:443"))
```
#### Unix Socket
```go
provider := flipt.NewProvider(flipt.WithAddress("unix:///path/to/socket"))
```
### GRPC
#### HTTP/2
```go
type Token string
func (t Token) ClientToken() (string, error) {
return t, nil
}
provider := flipt.NewProvider(
flipt.WithAddress("grpc://localhost:9000"),
flipt.WithCertificatePath("/path/to/cert.pem"), // optional
flipt.WithClientProvider(Token("a-client-token")), // optional
)
```
#### Unix Socket
```go
provider := flipt.NewProvider(
flipt.WithAddress("unix:///path/to/socket"),
)
```