featureflag

package
v0.1.1 Latest Latest
Warning

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

 Go to latest Published: May 15, 2026 License: MIT Imports: 6 Imported by: 0

README

featureflag — wrapper around go-feature-flag

import "github.com/downsized-devs/sdk-go/featureflag"

Stability: Beta — no tests in package. See STABILITY.md.

Wraps go-feature-flag for user-targeted boolean and JSON flag evaluation.

Features

  • CheckUserFlags(ctx, user, defaults) — evaluate flags for a user.
  • GetAllUserFlags(ctx, user) — full flag snapshot.
  • Refresh() — pull updated rules from the configured retriever.

Installation

go get github.com/downsized-devs/sdk-go/featureflag

Quick Start

ff := featureflag.Init(featureflag.Config{
    Enabled: true,
    PollingInterval: 60,
    Retriever: featureflag.Retriever{ /* file/HTTP/S3 source */ },
}, log)
defer ff.Close()

flags := ff.CheckUserFlags(ctx, ffuser.NewUser("alice"), map[string]any{"newCheckout": false})

API Reference

Symbol Signature
Init func Init(cfg Config, log logger.Interface) Interface
Interface.CheckUserFlags (ctx, user, defaults) map[string]any
Interface.GetAllUserFlags (ctx, user) map[string]any
Interface.Refresh () error

Configuration

See Config in featureflag.go — fields cover enable toggle, polling interval, retriever source (file / HTTP / S3).

Dependencies

  • Internal: logger
  • External: github.com/thomaspoignant/go-feature-flag, .../ffuser, .../retriever

Testing

No tests yet. When adding them, mock the go-feature-flag client with gomock.

go test ./featureflag/...

Contributing

See CONTRIBUTING.md. Test coverage gates promotion to Stable.

  • logger — required at Init time.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config 

type Config struct {
	Enabled         bool
	PollingInterval time.Duration
}

type Interface 

type Interface interface {
	CheckUserFlags(flagKey, userKey, userType string, value map[string]interface{}) (bool, error)
	GetAllUserFlags(userKey, userType string, value map[string]interface{}) ([]byte, error)
	Refresh()
}

func Init 

func Init(cfg Config, log logger.Interface, ret retriever.Retriever) Interface

Source Files

View all Source files

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.