sdk

package module
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 8, 2023 License: GPL-3.0 Imports: 8 Imported by: 7

README

Flipt Go SDK

Go Reference

The Flipt Go SDK supports developing applications in Go against Flipt. It also supports the ability to access the resource management APIs and other systems, such as authentication and metadata.

The SDK supports both Flipts gRPC and HTTP RPC APIs. A majority of this client is generated directly from Flipt's protobuf definitions. The Flipt SDK Generator can be found locally within this repository.

Dependencies

  • Go >= v1.20

Client / Server Version Compatibility

client ⌄ / server › <= 1.19.* >= 1.20.0
0.1.* ✓ ✓*
>= 0.2.* ✗ ✓

* Backwards compatible, but can only access the "default" namespace.

Get the SDK

go get go.flipt.io/flipt/sdk/go

Construct and Authenticate the SDK

Constructing an SDK client is easy.

  1. Pick your transport of choice. Bothgrpc or http are sub-packages with respective implementations.
  2. Pass a constructed Transport implementation to sdk.New(...).
  3. Optionally pass in a sdk.ClientTokenProvider to authenticate your RPC calls.
package main

import (
	sdk "go.flipt.io/flipt/sdk/go"
	sdkgrpc "go.flipt.io/flipt/sdk/go/grpc"
	grpc "google.golang.org/grpc"
)

func main() {
	token := sdk.StaticClientTokenProvider("a-flipt-client-token")

	conn := grpc.Dial("localhost:9090")
	transport := sdkgrpc.NewTransport(conn)

	client := sdk.New(transport, sdk.WithClientTokenProvider(token))
}

Documentation

Overview

Authenticating the SDK

The remote procedure calls mades by this SDK are authenticated via a ClientTokenProvider implementation. This can be supplied to New via the WithClientTokenProvider option.

Currently, there only exists a single implementation StaticClientTokenProvider: 

func main() {
    provider := sdk.StaticClientTokenProvider("some-flipt-token")
    client := sdk.New(transport, sdk.WithClientTokenProvider(provider))
}

SDK Services

The Flipt SDK is split into three sections Flipt, Auth and Meta. Each of which provides access to different parts of the Flipt system.

Flipt Service

The Flipt service is the core Flipt API service. This service provides access to evaluate flag configuration within your application. As well as exposing the Flipt resource CRUD APIs. 

client := sdk.New(transport).Flipt()

The following demonstrates how to evaluate the state of a flag. 

result, err := client.Evaluate(ctx, &flipt.EvaluationRequest{
    RequestId: uuid.NewV4().String(),
    NamespaceKey: sdk.DefaultNamespace,
    FlagKey: "my_flag_key",
    EntityId: userID,
    Context: map[string]string{
        "organization": orgName,
    },
})

Additionally, Flipt resources can be accessed and managed directly. 

flag, err := client.GetFlag(ctx, &flipt.GetFlagRequest{
    NamespaceKey: "my_namespace",
    Key: "my_flag_key",
})
if err != nil {
    panic(err)
}

fmt.Println(flag.Name)
fmt.Println(flag.Description)

Index

Examples

Constants

View Source 
const DefaultNamespace = "default"

DefaultNamespace is the default namespace created in Flipt. This namespace is protected and will always be present. Omitting a namespace key leads to this namespace being referenced.

Variables

This section is empty.

Functions

This section is empty.

Types

type Auth 

type Auth struct {
	// contains filtered or unexported fields
}

func (Auth) AuthenticationMethodKubernetesService 

func (s Auth) AuthenticationMethodKubernetesService() *AuthenticationMethodKubernetesService

func (Auth) AuthenticationMethodOIDCService 

func (s Auth) AuthenticationMethodOIDCService() *AuthenticationMethodOIDCService

func (Auth) AuthenticationMethodTokenService 

func (s Auth) AuthenticationMethodTokenService() *AuthenticationMethodTokenService

func (Auth) AuthenticationService 

func (s Auth) AuthenticationService() *AuthenticationService

func (Auth) PublicAuthenticationService 

func (s Auth) PublicAuthenticationService() *PublicAuthenticationService

type AuthClient 

type AuthClient interface {
	PublicAuthenticationServiceClient() auth.PublicAuthenticationServiceClient
	AuthenticationServiceClient() auth.AuthenticationServiceClient
	AuthenticationMethodTokenServiceClient() auth.AuthenticationMethodTokenServiceClient
	AuthenticationMethodOIDCServiceClient() auth.AuthenticationMethodOIDCServiceClient
	AuthenticationMethodKubernetesServiceClient() auth.AuthenticationMethodKubernetesServiceClient
}

type AuthenticationMethodKubernetesService 

type AuthenticationMethodKubernetesService struct {
	// contains filtered or unexported fields
}

func (*AuthenticationMethodKubernetesService) VerifyServiceAccount 

func (x *AuthenticationMethodKubernetesService) VerifyServiceAccount(ctx context.Context, v *auth.VerifyServiceAccountRequest) (*auth.VerifyServiceAccountResponse, error)

type AuthenticationMethodOIDCService 

type AuthenticationMethodOIDCService struct {
	// contains filtered or unexported fields
}

func (*AuthenticationMethodOIDCService) AuthorizeURL 

func (x *AuthenticationMethodOIDCService) AuthorizeURL(ctx context.Context, v *auth.AuthorizeURLRequest) (*auth.AuthorizeURLResponse, error)

func (*AuthenticationMethodOIDCService) Callback 

func (x *AuthenticationMethodOIDCService) Callback(ctx context.Context, v *auth.CallbackRequest) (*auth.CallbackResponse, error)

type AuthenticationMethodTokenService 

type AuthenticationMethodTokenService struct {
	// contains filtered or unexported fields
}

func (*AuthenticationMethodTokenService) CreateToken 

func (x *AuthenticationMethodTokenService) CreateToken(ctx context.Context, v *auth.CreateTokenRequest) (*auth.CreateTokenResponse, error)

type AuthenticationService 

type AuthenticationService struct {
	// contains filtered or unexported fields
}

func (*AuthenticationService) DeleteAuthentication 

func (x *AuthenticationService) DeleteAuthentication(ctx context.Context, v *auth.DeleteAuthenticationRequest) error

func (*AuthenticationService) ExpireAuthenticationSelf 

func (x *AuthenticationService) ExpireAuthenticationSelf(ctx context.Context, v *auth.ExpireAuthenticationSelfRequest) error

func (*AuthenticationService) GetAuthentication 

func (x *AuthenticationService) GetAuthentication(ctx context.Context, v *auth.GetAuthenticationRequest) (*auth.Authentication, error)

func (*AuthenticationService) GetAuthenticationSelf 

func (x *AuthenticationService) GetAuthenticationSelf(ctx context.Context) (*auth.Authentication, error)

func (*AuthenticationService) ListAuthentications 

func (x *AuthenticationService) ListAuthentications(ctx context.Context, v *auth.ListAuthenticationsRequest) (*auth.ListAuthenticationsResponse, error)

type ClientTokenProvider 

type ClientTokenProvider interface {
	ClientToken() (string, error)
}

ClientTokenProvider is a type which when requested provides a client token which can be used to authenticate RPC/API calls invoked through the SDK.

type Evaluation added in v0.4.0 

type Evaluation struct {
	// contains filtered or unexported fields
}

func (*Evaluation) Batch added in v0.4.0 

func (x *Evaluation) Batch(ctx context.Context, v *evaluation.BatchEvaluationRequest) (*evaluation.BatchEvaluationResponse, error)

func (*Evaluation) Boolean added in v0.4.0 

func (x *Evaluation) Boolean(ctx context.Context, v *evaluation.EvaluationRequest) (*evaluation.BooleanEvaluationResponse, error)

func (*Evaluation) Variant added in v0.4.0 

func (x *Evaluation) Variant(ctx context.Context, v *evaluation.EvaluationRequest) (*evaluation.VariantEvaluationResponse, error)

type Flipt 

type Flipt struct {
	// contains filtered or unexported fields
}

func (*Flipt) BatchEvaluate 

func (x *Flipt) BatchEvaluate(ctx context.Context, v *flipt.BatchEvaluationRequest) (*flipt.BatchEvaluationResponse, error)

func (*Flipt) CreateConstraint 

func (x *Flipt) CreateConstraint(ctx context.Context, v *flipt.CreateConstraintRequest) (*flipt.Constraint, error)

func (*Flipt) CreateDistribution 

func (x *Flipt) CreateDistribution(ctx context.Context, v *flipt.CreateDistributionRequest) (*flipt.Distribution, error)

func (*Flipt) CreateFlag 

func (x *Flipt) CreateFlag(ctx context.Context, v *flipt.CreateFlagRequest) (*flipt.Flag, error)

func (*Flipt) CreateNamespace added in v0.2.0 

func (x *Flipt) CreateNamespace(ctx context.Context, v *flipt.CreateNamespaceRequest) (*flipt.Namespace, error)

func (*Flipt) CreateRollout added in v0.4.0 

func (x *Flipt) CreateRollout(ctx context.Context, v *flipt.CreateRolloutRequest) (*flipt.Rollout, error)

func (*Flipt) CreateRule 

func (x *Flipt) CreateRule(ctx context.Context, v *flipt.CreateRuleRequest) (*flipt.Rule, error)

func (*Flipt) CreateSegment 

func (x *Flipt) CreateSegment(ctx context.Context, v *flipt.CreateSegmentRequest) (*flipt.Segment, error)

func (*Flipt) CreateVariant 

func (x *Flipt) CreateVariant(ctx context.Context, v *flipt.CreateVariantRequest) (*flipt.Variant, error)

func (*Flipt) DeleteConstraint 

func (x *Flipt) DeleteConstraint(ctx context.Context, v *flipt.DeleteConstraintRequest) error

func (*Flipt) DeleteDistribution 

func (x *Flipt) DeleteDistribution(ctx context.Context, v *flipt.DeleteDistributionRequest) error

func (*Flipt) DeleteFlag 

func (x *Flipt) DeleteFlag(ctx context.Context, v *flipt.DeleteFlagRequest) error

func (*Flipt) DeleteNamespace added in v0.2.0 

func (x *Flipt) DeleteNamespace(ctx context.Context, v *flipt.DeleteNamespaceRequest) error

func (*Flipt) DeleteRollout added in v0.4.0 

func (x *Flipt) DeleteRollout(ctx context.Context, v *flipt.DeleteRolloutRequest) error

func (*Flipt) DeleteRule 

func (x *Flipt) DeleteRule(ctx context.Context, v *flipt.DeleteRuleRequest) error

func (*Flipt) DeleteSegment 

func (x *Flipt) DeleteSegment(ctx context.Context, v *flipt.DeleteSegmentRequest) error

func (*Flipt) DeleteVariant 

func (x *Flipt) DeleteVariant(ctx context.Context, v *flipt.DeleteVariantRequest) error

func (*Flipt) Evaluate 

func (x *Flipt) Evaluate(ctx context.Context, v *flipt.EvaluationRequest) (*flipt.EvaluationResponse, error)

func (*Flipt) GetFlag 

func (x *Flipt) GetFlag(ctx context.Context, v *flipt.GetFlagRequest) (*flipt.Flag, error)

func (*Flipt) GetNamespace added in v0.2.0 

func (x *Flipt) GetNamespace(ctx context.Context, v *flipt.GetNamespaceRequest) (*flipt.Namespace, error)

func (*Flipt) GetRollout added in v0.4.0 

func (x *Flipt) GetRollout(ctx context.Context, v *flipt.GetRolloutRequest) (*flipt.Rollout, error)

func (*Flipt) GetRule 

func (x *Flipt) GetRule(ctx context.Context, v *flipt.GetRuleRequest) (*flipt.Rule, error)

func (*Flipt) GetSegment 

func (x *Flipt) GetSegment(ctx context.Context, v *flipt.GetSegmentRequest) (*flipt.Segment, error)

func (*Flipt) ListFlags 

func (x *Flipt) ListFlags(ctx context.Context, v *flipt.ListFlagRequest) (*flipt.FlagList, error)

func (*Flipt) ListNamespaces added in v0.2.0 

func (x *Flipt) ListNamespaces(ctx context.Context, v *flipt.ListNamespaceRequest) (*flipt.NamespaceList, error)

func (*Flipt) ListRollouts added in v0.4.0 

func (x *Flipt) ListRollouts(ctx context.Context, v *flipt.ListRolloutRequest) (*flipt.RolloutList, error)

func (*Flipt) ListRules 

func (x *Flipt) ListRules(ctx context.Context, v *flipt.ListRuleRequest) (*flipt.RuleList, error)

func (*Flipt) ListSegments 

func (x *Flipt) ListSegments(ctx context.Context, v *flipt.ListSegmentRequest) (*flipt.SegmentList, error)

func (*Flipt) OrderRollouts added in v0.4.0 

func (x *Flipt) OrderRollouts(ctx context.Context, v *flipt.OrderRolloutsRequest) error

func (*Flipt) OrderRules 

func (x *Flipt) OrderRules(ctx context.Context, v *flipt.OrderRulesRequest) error

func (*Flipt) UpdateConstraint 

func (x *Flipt) UpdateConstraint(ctx context.Context, v *flipt.UpdateConstraintRequest) (*flipt.Constraint, error)

func (*Flipt) UpdateDistribution 

func (x *Flipt) UpdateDistribution(ctx context.Context, v *flipt.UpdateDistributionRequest) (*flipt.Distribution, error)

func (*Flipt) UpdateFlag 

func (x *Flipt) UpdateFlag(ctx context.Context, v *flipt.UpdateFlagRequest) (*flipt.Flag, error)

func (*Flipt) UpdateNamespace added in v0.2.0 

func (x *Flipt) UpdateNamespace(ctx context.Context, v *flipt.UpdateNamespaceRequest) (*flipt.Namespace, error)

func (*Flipt) UpdateRollout added in v0.4.0 

func (x *Flipt) UpdateRollout(ctx context.Context, v *flipt.UpdateRolloutRequest) (*flipt.Rollout, error)

func (*Flipt) UpdateRule 

func (x *Flipt) UpdateRule(ctx context.Context, v *flipt.UpdateRuleRequest) (*flipt.Rule, error)

func (*Flipt) UpdateSegment 

func (x *Flipt) UpdateSegment(ctx context.Context, v *flipt.UpdateSegmentRequest) (*flipt.Segment, error)

func (*Flipt) UpdateVariant 

func (x *Flipt) UpdateVariant(ctx context.Context, v *flipt.UpdateVariantRequest) (*flipt.Variant, error)

type Meta 

type Meta struct {
	// contains filtered or unexported fields
}

func (*Meta) GetConfiguration 

func (x *Meta) GetConfiguration(ctx context.Context) (*httpbody.HttpBody, error)

func (*Meta) GetInfo 

func (x *Meta) GetInfo(ctx context.Context) (*httpbody.HttpBody, error)

type Option 

type Option func(*SDK)

Option is a functional option which configures the Flipt SDK.

func WithClientTokenProvider 

func WithClientTokenProvider(p ClientTokenProvider) Option

WithClientTokenProviders returns an Option which configures any supplied SDK with the provided ClientTokenProvider.

type PublicAuthenticationService 

type PublicAuthenticationService struct {
	// contains filtered or unexported fields
}

func (*PublicAuthenticationService) ListAuthenticationMethods 

func (x *PublicAuthenticationService) ListAuthenticationMethods(ctx context.Context) (*auth.ListAuthenticationMethodsResponse, error)

type SDK 

type SDK struct {
	// contains filtered or unexported fields
}

SDK is the definition of Flipt's Go SDK. It depends on a pluggable transport implementation and exposes a consistent API surface area across both transport implementations. It also provides consistent client-side instrumentation and authentication lifecycle support.

func New 

func New(t Transport, opts ...Option) SDK

New constructs and configures a Flipt SDK instance from the provided Transport implementation and options.

Example 
// see the following subpackages for transport implementations:
// - grpc
// - http
var transport Transport

client := New(transport)

client.Flipt().GetFlag(context.Background(), &flipt.GetFlagRequest{
	NamespaceKey: "my_namespace",
	Key:          "my_flag",
})

Output:

func (SDK) Auth 

func (s SDK) Auth() *Auth

func (SDK) Evaluation added in v0.4.0 

func (s SDK) Evaluation() *Evaluation

func (SDK) Flipt 

func (s SDK) Flipt() *Flipt

func (SDK) Meta 

func (s SDK) Meta() *Meta

type StaticClientTokenProvider 

type StaticClientTokenProvider string

StaticClientTokenProvider is a string which is supplied as a static client token on each RPC which requires authentication.

func (StaticClientTokenProvider) ClientToken 

func (p StaticClientTokenProvider) ClientToken() (string, error)

ClientToken returns the underlying string that is the StaticClientTokenProvider.

type Transport 

type Transport interface {
	AuthClient() AuthClient
	EvaluationClient() evaluation.EvaluationServiceClient
	FliptClient() flipt.FliptClient
	MetaClient() meta.MetadataServiceClient
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.