chore: Bump major version, add evaluation context codegen to CI (#142)

* chore: Bump major version, add evaluation context codegen to CI
Flagsmith · Oct 23, 2024 · c454725 · c454725
1 parent ec6639a
commit c454725
Show file tree

Hide file tree

Showing 28 changed files with 97 additions and 108 deletions.
diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml
@@ -30,6 +30,9 @@ jobs:
       with:
         submodules: recursive
 
+    - name: Build evaluation context struct
+      run: make generate-evaluation-context
+
     - name: Get dependencies
       run: |
         go get -v -t -d ./...

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,14 +1,5 @@
 repos:
-    - repo: https://github.com/dnephin/pre-commit-golang
-      rev: v0.5.0
-
-      hooks:
-        - id: go-fmt
-        - id: go-vet
-        - id: go-imports
-        - id: golangci-lint
-        - id: go-build
-        - id: go-critic
-        - id: go-mod-tidy
-
-
+  - repo: https://github.com/golangci/golangci-lint
+    rev: v1.61.0
+    hooks:
+      - id: golangci-lint
diff --git a/Makefile b/Makefile
@@ -5,4 +5,10 @@ EVALUATION_CONTEXT_SCHEMA_URL ?= https://raw.githubusercontent.com/Flagsmith/fla
 
 .PHONY: generate-evaluation-context
 generate-evaluation-context:
-	npx quicktype ${EVALUATION_CONTEXT_SCHEMA_URL} --src-lang schema --lang go --package flagsmith --omit-empty --just-types-and-package > evaluationcontext.go
+	npx quicktype ${EVALUATION_CONTEXT_SCHEMA_URL} \
+		--src-lang schema \
+		--lang go \
+		--package flagsmith \
+		--omit-empty \
+		--just-types-and-package \
+		> evaluationcontext.go
diff --git a/client.go b/client.go
@@ -7,13 +7,13 @@ import (
 	"sync/atomic"
 	"time"
 
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/environments"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/identities"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/segments"
+	"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/go-resty/resty/v2"
 
-	enginetraits "github.com/Flagsmith/flagsmith-go-client/v3/flagengine/identities/traits"
+	enginetraits "github.com/Flagsmith/flagsmith-go-client/v4/flagengine/identities/traits"
 )
 
 type contextKey string
@@ -117,7 +117,7 @@ func (c *Client) GetFlags(ctx context.Context, ec *EvaluationContext) (f Flags,
 	if ec != nil {
 		ctx = WithEvaluationContext(ctx, *ec)
 		if ec.Identity != nil {
-			return c.GetIdentityFlags(ctx, ec.Identity.Identifier, mapIdentityEvaluationContextToTraits(*ec.Identity))
+			return c.GetIdentityFlags(ctx, *ec.Identity.Identifier, mapIdentityEvaluationContextToTraits(*ec.Identity))
 		}
 	}
 	return c.GetEnvironmentFlags(ctx)
@@ -263,7 +263,7 @@ func (c *Client) GetIdentityFlagsFromAPI(ctx context.Context, identifier string,
 		idCtx := ec.Identity
 		if idCtx != nil {
 			// `Identifier` and `Traits` had been set by `GetFlags` earlier.
-			body.Transient = &idCtx.Transient
+			body.Transient = idCtx.Transient
 		}
 	}
 	resp, err := req.

diff --git a/client_test.go b/client_test.go
@@ -11,8 +11,8 @@ import (
 	"testing"
 	"time"
 
-	flagsmith "github.com/Flagsmith/flagsmith-go-client/v3"
-	"github.com/Flagsmith/flagsmith-go-client/v3/fixtures"
+	flagsmith "github.com/Flagsmith/flagsmith-go-client/v4"
+	"github.com/Flagsmith/flagsmith-go-client/v4/fixtures"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -204,6 +204,8 @@ func TestGetFlags(t *testing.T) {
 
 func TestGetFlagsTransientIdentity(t *testing.T) {
 	// Given
+	identifier := "transient"
+	transient := true
 	ctx := context.Background()
 	expectedRequestBody := `{"identifier":"transient","transient":true}`
 	server := getTestHttpServer(t, "/api/v1/identities/", fixtures.EnvironmentAPIKey, &expectedRequestBody, fixtures.IdentityResponseJson)
@@ -212,7 +214,7 @@ func TestGetFlagsTransientIdentity(t *testing.T) {
 	// When
 	client := flagsmith.NewClient(fixtures.EnvironmentAPIKey, flagsmith.WithBaseURL(server.URL+"/api/v1/"))
 
-	flags, err := client.GetFlags(ctx, &flagsmith.EvaluationContext{Identity: &flagsmith.IdentityEvaluationContext{Identifier: "transient", Transient: true}})
+	flags, err := client.GetFlags(ctx, &flagsmith.EvaluationContext{Identity: &flagsmith.IdentityEvaluationContext{Identifier: &identifier, Transient: &transient}})
 
 	// Then
 	assert.NoError(t, err)
@@ -228,11 +230,13 @@ func TestGetFlagsTransientIdentity(t *testing.T) {
 
 func TestGetFlagsTransientTraits(t *testing.T) {
 	// Given
+	identifier := "test_identity"
+	transient := true
 	ctx := context.Background()
 	expectedRequestBody := `{"identifier":"test_identity","traits":` +
 		`[{"trait_key":"NullTrait","trait_value":null},` +
 		`{"trait_key":"StringTrait","trait_value":"value"},` +
-		`{"trait_key":"TransientTrait","trait_value":"value","transient":true}],"transient":false}`
+		`{"trait_key":"TransientTrait","trait_value":"value","transient":true}]}`
 	server := getTestHttpServer(t, "/api/v1/identities/", fixtures.EnvironmentAPIKey, &expectedRequestBody, fixtures.IdentityResponseJson)
 	defer server.Close()
 
@@ -243,13 +247,13 @@ func TestGetFlagsTransientTraits(t *testing.T) {
 		ctx,
 		&flagsmith.EvaluationContext{
 			Identity: &flagsmith.IdentityEvaluationContext{
-				Identifier: "test_identity",
+				Identifier: &identifier,
 				Traits: map[string]*flagsmith.TraitEvaluationContext{
 					"NullTrait":   nil,
 					"StringTrait": {Value: "value"},
 					"TransientTrait": {
 						Value:     "value",
-						Transient: true,
+						Transient: &transient,
 					},
 				},
 			},
@@ -289,6 +293,7 @@ func TestGetFlagsEnvironmentEvaluationContextFlags(t *testing.T) {
 
 func TestGetFlagsEnvironmentEvaluationContextIdentity(t *testing.T) {
 	// Given
+	identifier := "test_identity"
 	ctx := context.Background()
 	expectedEnvKey := "different"
 	server := getTestHttpServer(t, "/api/v1/identities/", expectedEnvKey, nil, fixtures.IdentityResponseJson)
@@ -301,7 +306,7 @@ func TestGetFlagsEnvironmentEvaluationContextIdentity(t *testing.T) {
 		ctx,
 		&flagsmith.EvaluationContext{
 			Environment: &flagsmith.EnvironmentEvaluationContext{APIKey: expectedEnvKey},
-			Identity:    &flagsmith.IdentityEvaluationContext{Identifier: "test_identity"},
+			Identity:    &flagsmith.IdentityEvaluationContext{Identifier: &identifier},
 		})
 
 	// Then

diff --git a/evaluationcontext.go b/evaluationcontext.go
@@ -15,12 +15,12 @@ type FeatureEvaluationContext struct {
 }
 
 type IdentityEvaluationContext struct {
-	Identifier string                             `json:"identifier,omitempty"`
+	Identifier *string                            `json:"identifier,omitempty"`
 	Traits     map[string]*TraitEvaluationContext `json:"traits,omitempty"`
-	Transient  bool                               `json:"transient,omitempty"`
+	Transient  *bool                              `json:"transient,omitempty"`
 }
 
 type TraitEvaluationContext struct {
-	Transient bool        `json:"transient,omitempty"`
+	Transient *bool       `json:"transient,omitempty"`
 	Value     interface{} `json:"value"`
 }
diff --git a/evaluationcontext_static.go b/evaluationcontext_static.go
@@ -9,7 +9,7 @@ func getTraitEvaluationContext(v interface{}) TraitEvaluationContext {
 }
 
 func NewTraitEvaluationContext(value interface{}, transient bool) TraitEvaluationContext {
-	return TraitEvaluationContext{Value: value, Transient: transient}
+	return TraitEvaluationContext{Value: value, Transient: &transient}
 }
 
 func NewEvaluationContext(identifier string, traits map[string]interface{}) EvaluationContext {
@@ -20,14 +20,15 @@ func NewEvaluationContext(identifier string, traits map[string]interface{}) Eval
 		traitsCtx[tKey] = &tCtx
 	}
 	ec.Identity = &IdentityEvaluationContext{
-		Identifier: identifier,
+		Identifier: &identifier,
 		Traits:     traitsCtx,
 	}
 	return ec
 }
 
 func NewTransientEvaluationContext(identifier string, traits map[string]interface{}) EvaluationContext {
 	ec := NewEvaluationContext(identifier, traits)
-	ec.Identity.Transient = true
+	var transient = true
+	ec.Identity.Transient = &transient
 	return ec
 }
diff --git a/flagengine/engine.go b/flagengine/engine.go
@@ -1,11 +1,11 @@
 package flagengine
 
 import (
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/environments"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/features"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/identities"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/identities/traits"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/segments"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/environments"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/features"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/identities"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/identities/traits"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/segments"
 )
 
 // GetEnvironmentFeatureStates returns a list of feature states for a given environment.

diff --git a/flagengine/engine_test.go b/flagengine/engine_test.go
@@ -3,11 +3,11 @@ package flagengine_test
 import (
 	"testing"
 
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/environments"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/features"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/identities/traits"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/utils/fixtures"
+	"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/features"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/identities/traits"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/utils/fixtures"
 	"github.com/stretchr/testify/assert"
 )
 

diff --git a/flagengine/environments/models.go b/flagengine/environments/models.go
@@ -1,9 +1,9 @@
 package environments
 
 import (
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/features"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/identities"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/projects"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/features"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/identities"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/projects"
 )
 
 type EnvironmentModel struct {

diff --git a/flagengine/features/models.go b/flagengine/features/models.go
@@ -5,7 +5,7 @@ import (
 	"sort"
 	"strconv"
 
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/utils"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/utils"
 )
 
 type FeatureModel struct {

diff --git a/flagengine/features/models_test.go b/flagengine/features/models_test.go
@@ -3,7 +3,7 @@ package features_test
 import (
 	"testing"
 
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/features"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/features"
 	"github.com/stretchr/testify/assert"
 )
 

diff --git a/flagengine/flagengine_integration_test.go b/flagengine/flagengine_integration_test.go
@@ -10,11 +10,11 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/environments"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/features"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/identities"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/identities/traits"
+	"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/features"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/identities"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/identities/traits"
 )
 
 const TestData = "./engine-test-data/data/environment_n9fbf9h3v4fFgH3U3ngWhb.json"

diff --git a/flagengine/identities/models.go b/flagengine/identities/models.go
@@ -1,9 +1,9 @@
 package identities
 
 import (
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/features"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/identities/traits"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/utils"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/features"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/identities/traits"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/utils"
 )
 
 type IdentityModel struct {

diff --git a/flagengine/projects/models.go b/flagengine/projects/models.go
@@ -1,8 +1,8 @@
 package projects
 
 import (
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/organisations"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/segments"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/organisations"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/segments"
 )
 
 type ProjectModel struct {

diff --git a/flagengine/segments/evaluator.go b/flagengine/segments/evaluator.go
@@ -4,9 +4,9 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/identities"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/identities/traits"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/utils"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/identities"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/identities/traits"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/utils"
 	"github.com/blang/semver/v4"
 	"golang.org/x/exp/slices"
 )

diff --git a/flagengine/segments/evaluator_test.go b/flagengine/segments/evaluator_test.go
@@ -7,11 +7,11 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/identities"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/identities/traits"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/segments"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/utils"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/utils/fixtures"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/identities"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/identities/traits"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/segments"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/utils"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/utils/fixtures"
 )
 
 const (

diff --git a/flagengine/segments/models.go b/flagengine/segments/models.go
@@ -6,8 +6,8 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/features"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/utils"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/features"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/utils"
 )
 
 type SegmentConditionModel struct {

diff --git a/flagengine/utils/fixtures/fixtures.go b/flagengine/utils/fixtures/fixtures.go
@@ -3,14 +3,14 @@ package fixtures
 import (
 	"time"
 
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/environments"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/features"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/identities"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/identities/traits"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/organisations"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/projects"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/segments"
-	"github.com/Flagsmith/flagsmith-go-client/v3/flagengine/utils"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/environments"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/features"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/identities"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/identities/traits"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/organisations"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/projects"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/segments"
+	"github.com/Flagsmith/flagsmith-go-client/v4/flagengine/utils"
 )
 
 const (