Skip to content

feat: create structs representing Featurevisor instance and config manager #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib

# Test binary, built with `go test -c`
*.test

# Output of the go coverage tool, specifically when used with LiteIDE
*.out

# Dependency directories (remove the comment below to include it)
# vendor/

# Go workspace file
go.work

# Local IDE configuration
.idea/
14 changes: 14 additions & 0 deletions config/config.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package config

// Config represents a parsed datafile config.
type Config interface {
Copy link
Member

@fahad19 fahad19 Nov 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

idea is to keep the interfaces/API as similar as the original JS SDK: https://github.com/featurevisor/featurevisor/tree/main/packages/sdk/src

this is how we are approaching Swift and Kotlin SDKs as well, helping keep it relatively easy to port bug fixes everywhere continuously.

GetDatafile() []byte
GetRevision() string
// ...rest of the methods
}

// ConfigManager represents a configuration manager that reads and holds datafile config.
type ConfigManager interface {
GetConfig() (Config, error)
Sync() error
}
52 changes: 52 additions & 0 deletions config/static_config.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
package config

import (
"fmt"
"io"
"net/http"
"sync"
)

type StaticConfigManager struct {
datafileURL string
datafile []byte
client *http.Client
config Config
lock sync.Mutex
logger interface{}
}

func (configManager *StaticConfigManager) GetConfig() (Config, error) {
configManager.lock.Lock()
defer configManager.lock.Unlock()

return configManager.config, nil
}

func (configManager *StaticConfigManager) Sync() error {
configManager.lock.Lock()
defer configManager.lock.Unlock()

url := configManager.datafileURL
datafile, err := http.Get(url)
if err != nil {
return fmt.Errorf("error while loading datafile: %w", err)
}

// Read the body of the response into a byte array
defer datafile.Body.Close()
body, err := io.ReadAll(datafile.Body)
if err != nil {
return fmt.Errorf("error while reading datafile: %w", err)
}

configManager.datafile = body
return nil
}

func NewStaticConfigManager(datafileURL string) *StaticConfigManager {
return &StaticConfigManager{
datafileURL: datafileURL,
client: http.DefaultClient,
}
}
19 changes: 19 additions & 0 deletions examples/main.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
package main

import (
"fmt"
"github.com/featurevisor/featurevisor-go"
)

func main() {
datafileURL := "https://featurevisor.com/datafile.yml"

instance, err := featurevisor.NewInstance(datafileURL)
if err != nil {
fmt.Printf("Error creating Featurevisor: %s\n", err)
return
}

revision := instance.GetRevision()
fmt.Printf("Featurevisor datafile revision: %s\n", revision)
}
11 changes: 11 additions & 0 deletions featurevisor.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
package featurevisor

import "github.com/featurevisor/featurevisor-go/instance"

func NewInstance(datafileURL string) (*instance.Instance, error) {
factory := &instance.Factory{
DatafileURL: datafileURL,
}

return factory.NewInstance()
}
3 changes: 2 additions & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ module github.com/featurevisor/featurevisor-go
go 1.21.3

require (
github.com/blang/semver v3.5.1+incompatible // indirect
github.com/spaolacci/murmur3 v1.1.0 // indirect
github.com/blang/semver v3.5.1+incompatible // indirect
github.com/stretchr/testify v1.8.4 // indirect
)
1 change: 1 addition & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ github.com/blang/semver v3.5.1+incompatible h1:cQNTCjp13qL8KC3Nbxr/y2Bqb63oX6wdn
github.com/blang/semver v3.5.1+incompatible/go.mod h1:kRBLl5iJ+tD4TcOOxsy/0fnwebNt5EWlYSAyrTnjyyk=
github.com/spaolacci/murmur3 v1.1.0 h1:7c1g84S4BPRrfL5Xrdp6fOJ206sU9y293DDHaoy0bLI=
github.com/spaolacci/murmur3 v1.1.0/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA=
github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
19 changes: 19 additions & 0 deletions instance/factory.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
package instance

import "github.com/featurevisor/featurevisor-go/config"

type Factory struct {
DatafileURL string

logger interface{}
}

// Instance creates a new Featurevisor instance with passed datafile URL.
func (factory *Factory) NewInstance() (*Instance, error) {
configManager := config.NewStaticConfigManager(factory.DatafileURL)

instance := &Instance{
ConfigManager: configManager,
}
return instance, nil
}
24 changes: 24 additions & 0 deletions instance/instance.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package instance

import "github.com/featurevisor/featurevisor-go/config"

type Instance struct {
ConfigManager config.ConfigManager

logger interface{}
}

// GetRevision returns the revision of the datafile
func (instance *Instance) GetRevision() string {
return ""
}

// GetBucketKey returns the bucket key for the given feature name
func (instance *Instance) GetBucketKey(featureName string) string {
return ""
}

// Enabled returns true if the feature is enabled
func (instance *Instance) Enabled(featureName string) bool {
return false
}