feat!: engine evaluation context (#178)

* update engine test data

* fetch flags using eval ctx for env flags

* use context for identity flags

* store and use engine eval context instead of env doc

* use eval context for getidentity segments

* Refactor: Move evaluator to engine_eval

* rename

* remove makefile trigger

* misc

* squash!

* use the new schema

* Bump major version

* Add missing operators

* remove old interface

* update engine test data

* remove go get

* use go 1.24

* refactor: create a function for processing segments

* refac: create a diff function for processing features

* refac: squash

* Don't use pointer for feature context

* refac default priority

* refac splitoperator

* use stringArry for in operator

* more refac and add reason to mv

* misc

* use any

* use generic for segment operator

* Short-Circuit conditions

* review change

* use new integration tests

* fix percentage split operator

* rename some functions

* cleanup/refac

* feat: Add support for .jsonc test files with comments using hujson

- Added github.com/tailscale/hujson dependency for parsing JSON with comments
- Updated integration tests to discover and process both .json and .jsonc files
- JSONC files are automatically standardized to JSON before parsing
- Improved test file name extraction to handle multiple extensions

* fix: Configure misspell linter

* make matching condition more dry

* bump engine test data

* move trait to it's own package to avoid circular import

* clean mappers

* use segment metadata to filter identity segments

* use v2.1.0 tag

* get rid of ValueUnion

* compare segmes

* fix: handle JSONPath fallback for non-primitive values and invalid paths

- Update engine-test-data to v2.3.0 for new test cases
- Add isPrimitive() helper to detect non-primitive JSONPath results
- Fall back to trait lookup when JSONPath returns objects/arrays
- Fall back to trait lookup when JSONPath parsing fails
- Fixes edge cases with trait keys that look like JSONPath (e.g., '$.identity')

* feat: add priority sorting for multivariate feature variants

- Add Priority field to FeatureValue struct
- Sort variants by priority before weight-based selection
- Lower priority value = higher priority when variants overlap
- Fixes multivariate feature flag variant priority sorting

* Use feature value id as priority?

* compare segment metadata

* Add env name

* use feat/variant-priority-sorting

* fix non-deterministic map iteration order

* use big int for priority

* fix mapper

* use engine-test-data v2.4.0

* implement feature metadata and bump engine-test-data

Author: gagantrivedi

.github/workflows/go.yml

@@ -7,7 +7,6 @@ on:
 
 jobs:
   build:
-    if: github.event.pull_request.draft == false
     name: Build
     runs-on: ubuntu-latest
 
@@ -29,11 +28,7 @@ jobs:
       uses: actions/checkout@v4
       with:
         submodules: recursive
-
-    - name: Get dependencies
-      run: |
-        go get -v -t -d ./...
-
+        
     - name: Lint
       uses: golangci/golangci-lint-action@v6
 

.golangci.yml

@@ -1,6 +1,8 @@
 linters-settings:
   misspell:
     locale: UK
+    ignore-words:
+      - standardize  # hujson library uses US spelling
 linters:
   enable:
     - contextcheck

README.md

@@ -1,6 +1,6 @@
 [![Go](https://github.com/flagsmith/flagsmith-go-client/workflows/Go/badge.svg?branch=main)](https://github.com/flagsmith/flagsmith-go-client/actions)
 [![GoReportCard](https://goreportcard.com/badge/github.com/flagsmith/flagsmith-go-client)](https://goreportcard.com/report/github.com/flagsmith/flagsmith-go-client)
-[![GoDoc](https://godoc.org/github.com/flagsmith/flagsmith-go-client/v4?status.svg)](https://pkg.go.dev/github.com/Flagsmith/flagsmith-go-client/v4#section-documentation)
+[![GoDoc](https://godoc.org/github.com/flagsmith/flagsmith-go-client/v5?status.svg)](https://pkg.go.dev/github.com/Flagsmith/flagsmith-go-client/v5#section-documentation)
 
 # Flagsmith Go SDK
 

client.go

@@ -11,13 +11,11 @@ import (
 	"sync/atomic"
 	"time"
 
-	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine"
-	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/environments"
-	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/identities"
-	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/segments"
+	"github.com/Flagsmith/flagsmith-go-client/v5/flagengine"
+	"github.com/Flagsmith/flagsmith-go-client/v5/flagengine/engine_eval"
+	"github.com/Flagsmith/flagsmith-go-client/v5/flagengine/environments"
+	"github.com/Flagsmith/flagsmith-go-client/v5/flagengine/segments"
 	"github.com/go-resty/resty/v2"
-
-	enginetraits "github.com/Flagsmith/flagsmith-go-client/v4/flagengine/identities/traits"
 )
 
 type contextKey string
@@ -30,7 +28,7 @@ type Client struct {
 	config config
 
 	environment             atomic.Value
-	identitiesWithOverrides atomic.Value
+	engineEvaluationContext atomic.Value
 
 	analyticsProcessor *AnalyticsProcessor
 	realtime           *realtime
@@ -141,7 +139,10 @@ func NewClient(apiKey string, options ...Option) *Client {
 		panic("local evaluation and offline handler cannot be used together.")
 	}
 	if c.offlineHandler != nil {
-		c.environment.Store(c.offlineHandler.GetEnvironment())
+		env := c.offlineHandler.GetEnvironment()
+		c.environment.Store(env)
+		engineEvalCtx := engine_eval.MapEnvironmentDocumentToEvaluationContext(env)
+		c.engineEvaluationContext.Store(&engineEvalCtx)
 	}
 
 	if c.config.localEvaluation {
@@ -230,9 +231,10 @@ func (c *Client) GetIdentityFlags(ctx context.Context, identifier string, traits
 
 // Returns an array of segments that the given identity is part of.
 func (c *Client) GetIdentitySegments(identifier string, traits []*Trait) ([]*segments.SegmentModel, error) {
-	if env, ok := c.environment.Load().(*environments.EnvironmentModel); ok {
-		identity := c.getIdentityModel(identifier, env.APIKey, traits)
-		return flagengine.GetIdentitySegments(env, &identity), nil
+	if evalCtx, ok := c.engineEvaluationContext.Load().(*engine_eval.EngineEvaluationContext); ok {
+		engineEvalCtx := engine_eval.MapContextAndIdentityDataToContext(*evalCtx, identifier, traits)
+		result := flagengine.GetEvaluationResult(&engineEvalCtx)
+		return engine_eval.MapEvaluationResultSegmentsToSegmentModels(&result), nil
 	}
 	return nil, &FlagsmithClientError{msg: "flagsmith: Local evaluation required to obtain identity segments"}
 }
@@ -333,32 +335,22 @@ func (c *Client) GetIdentityFlagsFromAPI(ctx context.Context, identifier string,
 }
 
 func (c *Client) getIdentityFlagsFromEnvironment(identifier string, traits []*Trait) (Flags, error) {
-	env, ok := c.environment.Load().(*environments.EnvironmentModel)
+	evalCtx, ok := c.engineEvaluationContext.Load().(*engine_eval.EngineEvaluationContext)
 	if !ok {
 		return Flags{}, fmt.Errorf("flagsmith: local environment has not yet been updated")
 	}
-	identity := c.getIdentityModel(identifier, env.APIKey, traits)
-	featureStates := flagengine.GetIdentityFeatureStates(env, &identity)
-	flags := makeFlagsFromFeatureStates(
-		featureStates,
-		c.analyticsProcessor,
-		c.defaultFlagHandler,
-		identifier,
-	)
-	return flags, nil
+	engineEvalCtx := engine_eval.MapContextAndIdentityDataToContext(*evalCtx, identifier, traits)
+	result := flagengine.GetEvaluationResult(&engineEvalCtx)
+	return makeFlagsFromEngineEvaluationResult(&result, c.analyticsProcessor, c.defaultFlagHandler), nil
 }
 
 func (c *Client) getEnvironmentFlagsFromEnvironment() (Flags, error) {
-	env, ok := c.environment.Load().(*environments.EnvironmentModel)
+	evalCtx, ok := c.engineEvaluationContext.Load().(*engine_eval.EngineEvaluationContext)
 	if !ok {
 		return Flags{}, fmt.Errorf("flagsmith: local environment has not yet been updated")
 	}
-	return makeFlagsFromFeatureStates(
-		env.FeatureStates,
-		c.analyticsProcessor,
-		c.defaultFlagHandler,
-		"",
-	), nil
+	result := flagengine.GetEvaluationResult(evalCtx)
+	return makeFlagsFromEngineEvaluationResult(&result, c.analyticsProcessor, c.defaultFlagHandler), nil
 }
 
 func (c *Client) pollEnvironment(ctx context.Context, pollForever bool) {
@@ -461,35 +453,13 @@ func (c *Client) UpdateEnvironment(ctx context.Context) error {
 		isNew = true
 	}
 	c.environment.Store(&env)
-	identitiesWithOverrides := make(map[string]identities.IdentityModel)
-	for _, id := range env.IdentityOverrides {
-		identitiesWithOverrides[id.Identifier] = *id
-	}
-	c.identitiesWithOverrides.Store(identitiesWithOverrides)
+
+	engineEvalCtx := engine_eval.MapEnvironmentDocumentToEvaluationContext(&env)
+	c.engineEvaluationContext.Store(&engineEvalCtx)
 
 	if isNew {
 		c.log.Info("environment updated", "environment", env.APIKey, "updated_at", env.UpdatedAt)
 	}
 
 	return nil
 }
-
-func (c *Client) getIdentityModel(identifier string, apiKey string, traits []*Trait) identities.IdentityModel {
-	identityTraits := make([]*enginetraits.TraitModel, len(traits))
-	for i, trait := range traits {
-		identityTraits[i] = trait.ToTraitModel()
-	}
-
-	identitiesWithOverrides, _ := c.identitiesWithOverrides.Load().(map[string]identities.IdentityModel)
-	identity, ok := identitiesWithOverrides[identifier]
-	if ok {
-		identity.IdentityTraits = identityTraits
-		return identity
-	}
-
-	return identities.IdentityModel{
-		Identifier:        identifier,
-		IdentityTraits:    identityTraits,
-		EnvironmentAPIKey: apiKey,
-	}
-}

client_test.go

@@ -13,8 +13,8 @@ import (
 	"testing"
 	"time"
 
-	flagsmith "github.com/Flagsmith/flagsmith-go-client/v4"
-	"github.com/Flagsmith/flagsmith-go-client/v4/fixtures"
+	flagsmith "github.com/Flagsmith/flagsmith-go-client/v5"
+	"github.com/Flagsmith/flagsmith-go-client/v5/fixtures"
 	"github.com/go-resty/resty/v2"
 	"github.com/stretchr/testify/assert"
 )