more logs + pass EnvironmentContext structs and not pointers

Author: rolodato

client.go

@@ -173,20 +173,21 @@ func (c *Client) UpdateEnvironment(ctx context.Context) error {
 		e := &FlagsmithAPIError{Msg: msg, Err: nil, ResponseStatusCode: resp.StatusCode(), ResponseStatus: resp.Status()}
 		return c.handleError(e)
 	}
-	c.environment.SetEnvironment(&env)
+	c.environment.SetEnvironment(env)
 
 	c.log.Info("environment updated", "environment", env.APIKey)
 	return nil
 }
 
 // GetIdentitySegments returns the segments that this evaluation context is a part of. It requires a local environment
 // provided by [WithLocalEvaluation] and/or [WithOfflineHandler].
-func (c *Client) GetIdentitySegments(ec EvaluationContext) ([]*segments.SegmentModel, error) {
-	if env := c.environment.GetEnvironment(); env != nil {
-		identity := c.getIdentityModel(ec.identifier, env.APIKey, ec.traits)
-		return flagengine.GetIdentitySegments(env, &identity), nil
+func (c *Client) GetIdentitySegments(ec EvaluationContext) (s []*segments.SegmentModel, err error) {
+	env, ok := c.environment.GetEnvironment()
+	if !ok {
+		return s, errors.New("GetIdentitySegments called with no local environment available")
 	}
-	return nil, &FlagsmithClientError{msg: "no local environment available to calculate identity segments"}
+	identity := c.getIdentityModel(ec.identifier, env.APIKey, ec.traits)
+	return flagengine.GetIdentitySegments(env, &identity), nil
 }
 
 // BulkIdentify can be used to create/overwrite identities(with traits) in bulk
@@ -283,8 +284,8 @@ func (c *Client) getIdentityFlagsFromAPI(ctx context.Context, identifier string,
 }
 
 func (c *Client) getEnvironmentFlagsFromEnvironment() (Flags, error) {
-	env := c.environment.GetEnvironment()
-	if env == nil {
+	env, ok := c.environment.GetEnvironment()
+	if !ok {
 		return Flags{}, fmt.Errorf("getEnvironmentFlagsFromEnvironment: no local environment is available")
 	}
 	return makeFlagsFromFeatureStates(
@@ -296,8 +297,8 @@ func (c *Client) getEnvironmentFlagsFromEnvironment() (Flags, error) {
 }
 
 func (c *Client) getIdentityFlagsFromEnvironment(identifier string, traits map[string]interface{}) (Flags, error) {
-	env := c.environment.GetEnvironment()
-	if env := c.environment.GetEnvironment(); env == nil {
+	env, ok := c.environment.GetEnvironment()
+	if !ok {
 		return Flags{}, fmt.Errorf("getIdentityFlagsFromDocument: no local environment is available")
 	}
 	identity := c.getIdentityModel(identifier, env.APIKey, traits)
@@ -360,14 +361,14 @@ func (c *Client) handleError(err *FlagsmithAPIError) *FlagsmithAPIError {
 
 type state struct {
 	mu                sync.RWMutex
-	environment       *environments.EnvironmentModel
+	environment       environments.EnvironmentModel
 	identityOverrides sync.Map
 }
 
-func (es *state) GetEnvironment() *environments.EnvironmentModel {
+func (es *state) GetEnvironment() (environments.EnvironmentModel, bool) {
 	es.mu.RLock()
 	defer es.mu.RUnlock()
-	return es.environment
+	return es.environment, es.environment.APIKey != ""
 }
 
 func (es *state) GetIdentityOverride(identifier string) (identities.IdentityModel, bool) {
@@ -378,7 +379,7 @@ func (es *state) GetIdentityOverride(identifier string) (identities.IdentityMode
 	return identities.IdentityModel{}, ok
 }
 
-func (es *state) SetEnvironment(env *environments.EnvironmentModel) {
+func (es *state) SetEnvironment(env environments.EnvironmentModel) {
 	es.mu.Lock()
 	defer es.mu.Unlock()
 	es.environment = env

flagengine/engine.go

@@ -9,7 +9,7 @@ import (
 )
 
 // GetEnvironmentFeatureStates returns a list of feature states for a given environment.
-func GetEnvironmentFeatureStates(environment *environments.EnvironmentModel) []*features.FeatureStateModel {
+func GetEnvironmentFeatureStates(environment environments.EnvironmentModel) []*features.FeatureStateModel {
 	if environment.Project.HideDisabledFlags {
 		var featureStates []*features.FeatureStateModel
 		for _, fs := range environment.FeatureStates {
@@ -23,7 +23,7 @@ func GetEnvironmentFeatureStates(environment *environments.EnvironmentModel) []*
 }
 
 // GetEnvironmentFeatureState returns a specific feature state for a given featureName in a given environment, or nil feature state is not found.
-func GetEnvironmentFeatureState(environment *environments.EnvironmentModel, featureName string) *features.FeatureStateModel {
+func GetEnvironmentFeatureState(environment environments.EnvironmentModel, featureName string) *features.FeatureStateModel {
 	for _, fs := range environment.FeatureStates {
 		if fs.Feature.Name == featureName {
 			return fs
@@ -34,7 +34,7 @@ func GetEnvironmentFeatureState(environment *environments.EnvironmentModel, feat
 
 // GetIdentityFeatureStates returns a list of feature states for a given identity in a given environment.
 func GetIdentityFeatureStates(
-	environment *environments.EnvironmentModel,
+	environment environments.EnvironmentModel,
 	identity *identities.IdentityModel,
 	overrideTraits ...*traits.TraitModel,
 ) []*features.FeatureStateModel {
@@ -52,7 +52,7 @@ func GetIdentityFeatureStates(
 }
 
 func GetIdentityFeatureState(
-	environment *environments.EnvironmentModel,
+	environment environments.EnvironmentModel,
 	identity *identities.IdentityModel,
 	featureName string,
 	overrideTraits ...*traits.TraitModel,
@@ -68,7 +68,7 @@ func GetIdentityFeatureState(
 }
 
 func GetIdentitySegments(
-	environment *environments.EnvironmentModel,
+	environment environments.EnvironmentModel,
 	identity *identities.IdentityModel,
 	overrideTraits ...*traits.TraitModel,
 ) []*segments.SegmentModel {
@@ -84,7 +84,7 @@ func GetIdentitySegments(
 }
 
 func getIdentityFeatureStatesMap(
-	environment *environments.EnvironmentModel,
+	environment environments.EnvironmentModel,
 	identity *identities.IdentityModel,
 	overrideTraits ...*traits.TraitModel,
 ) map[int]*features.FeatureStateModel {

flagengine/engine_test.go

@@ -153,7 +153,7 @@ func TestEnvironmentGetFeatureStateFeatureNotFound(t *testing.T) {
 	assert.Nil(t, fs)
 }
 
-func getEnvironmentFeatureStateForFeature(env *environments.EnvironmentModel, feature *features.FeatureModel) *features.FeatureStateModel {
+func getEnvironmentFeatureStateForFeature(env environments.EnvironmentModel, feature *features.FeatureModel) *features.FeatureStateModel {
 	for _, fs := range env.FeatureStates {
 		if fs.Feature == feature {
 			return fs

flagengine/flagengine_integration_test.go

@@ -43,7 +43,7 @@ func TestEngine(t *testing.T) {
 		t.Run(strconv.Itoa(i)+":"+c.Identity.CompositeKey(), func(t *testing.T) {
 			assert := assert.New(t)
 			require := require.New(t)
-			actual := flagengine.GetIdentityFeatureStates(&testData.Environment, &c.Identity)
+			actual := flagengine.GetIdentityFeatureStates(testData.Environment, &c.Identity)
 			expected := c.Response.Flags
 
 			sort.Slice(actual, func(i, j int) bool {

flagengine/utils/fixtures/fixtures.go

@@ -77,8 +77,8 @@ func Feature2() *features.FeatureModel {
 	}
 }
 
-func Environment(feature1, feature2 *features.FeatureModel, project *projects.ProjectModel) *environments.EnvironmentModel {
-	return &environments.EnvironmentModel{
+func Environment(feature1, feature2 *features.FeatureModel, project *projects.ProjectModel) environments.EnvironmentModel {
+	return environments.EnvironmentModel{
 		ID:      1,
 		APIKey:  "api-key",
 		Project: project,
@@ -89,7 +89,7 @@ func Environment(feature1, feature2 *features.FeatureModel, project *projects.Pr
 	}
 }
 
-func Identity(env *environments.EnvironmentModel) *identities.IdentityModel {
+func Identity(env environments.EnvironmentModel) *identities.IdentityModel {
 	return &identities.IdentityModel{
 		Identifier:        "identity_1",
 		EnvironmentAPIKey: env.APIKey,
@@ -104,7 +104,7 @@ func TraitMatchingSegment(segCond *segments.SegmentConditionModel) *traits.Trait
 	}
 }
 
-func IdentityInSegment(trait *traits.TraitModel, env *environments.EnvironmentModel) *identities.IdentityModel {
+func IdentityInSegment(trait *traits.TraitModel, env environments.EnvironmentModel) *identities.IdentityModel {
 	return &identities.IdentityModel{
 		Identifier:        "identity_2",
 		EnvironmentAPIKey: env.APIKey,
@@ -134,16 +134,16 @@ func MVFeatureStateValue() *features.MultivariateFeatureStateValueModel {
 }
 
 func EnvironmentWithSegmentOverride(
-	env *environments.EnvironmentModel,
+	env environments.EnvironmentModel,
 	featureState *features.FeatureStateModel,
 	segment *segments.SegmentModel,
-) *environments.EnvironmentModel {
+) environments.EnvironmentModel {
 	segment.FeatureStates = append(segment.FeatureStates, featureState)
 	env.Project.Segments = append(env.Project.Segments, segment)
 	return env
 }
 
-func GetFixtures() (*features.FeatureModel, *features.FeatureModel, *segments.SegmentModel, *environments.EnvironmentModel, *identities.IdentityModel) {
+func GetFixtures() (*features.FeatureModel, *features.FeatureModel, *segments.SegmentModel, environments.EnvironmentModel, *identities.IdentityModel) {
 	feature1 := Feature1()
 	feature2 := Feature2()
 	org := Organisation()

offline_handler.go

@@ -8,11 +8,11 @@ import (
 )
 
 type OfflineHandler interface {
-	GetEnvironment() *environments.EnvironmentModel
+	GetEnvironment() environments.EnvironmentModel
 }
 
 type LocalFileHandler struct {
-	environment *environments.EnvironmentModel
+	environment environments.EnvironmentModel
 }
 
 // NewLocalFileHandler creates a new LocalFileHandler with the given path.
@@ -29,12 +29,12 @@ func NewLocalFileHandler(environmentDocumentPath string) (*LocalFileHandler, err
 
 	// Create and initialise the LocalFileHandler
 	handler := &LocalFileHandler{
-		environment: &environment,
+		environment: environment,
 	}
 
 	return handler, nil
 }
 
-func (handler *LocalFileHandler) GetEnvironment() *environments.EnvironmentModel {
+func (handler *LocalFileHandler) GetEnvironment() environments.EnvironmentModel {
 	return handler.environment
 }

realtime.go

@@ -18,7 +18,7 @@ func (c *Client) startRealtimeUpdates(ctx context.Context) {
 		panic("Failed to fetch the environment while configuring real-time updates")
 	}
 
-	env := c.environment.GetEnvironment()
+	env, _ := c.environment.GetEnvironment()
 	envUpdatedAt := env.UpdatedAt
 	log := c.log.With("environment", env.APIKey, "current_updated_at", &envUpdatedAt)
 
@@ -40,37 +40,43 @@ func (c *Client) startRealtimeUpdates(ctx context.Context) {
 			}
 			defer resp.Body.Close()
 
+			log.Info("connected to realtime")
+
 			scanner := bufio.NewScanner(resp.Body)
 			for scanner.Scan() {
 				line := scanner.Text()
-				if strings.HasPrefix(line, "data: ") {
-					parsedTime, err := parseUpdatedAtFromSSE(line)
-					if err != nil {
-						log.Error("failed to parse realtime update event", "error", err, "raw_event", line)
-						continue
-					}
-					if parsedTime.After(envUpdatedAt) {
-						log.WithGroup("event").Info("received update event",
+				parsedTime, err := parseUpdatedAtFromSSE(line)
+				if err != nil {
+					log.Error("failed to parse realtime update event", "error", err, "raw_event", line)
+					continue
+				}
+				if parsedTime.After(envUpdatedAt) {
+					log.WithGroup("event").
+						Info("received update event",
 							slog.Duration("update_delay", parsedTime.Sub(envUpdatedAt)),
 							slog.Time("updated_at", parsedTime),
 							slog.String("environment", env.APIKey),
 						)
-						err = c.UpdateEnvironment(ctx)
-						if err != nil {
-							continue
-						}
-						envUpdatedAt = parsedTime
+					err = c.UpdateEnvironment(ctx)
+					if err != nil {
+						log.Error("realtime update failed", "error", err)
+						continue
 					}
+					envUpdatedAt = parsedTime
 				}
 			}
 			if err := scanner.Err(); err != nil {
-				c.log.Error("failed to read from realtime stream", "error", err, "stream_url", &resp.Request.URL)
+				log.Error("failed to read from realtime stream", "error", err)
 			}
 		}
 	}
 }
 
 func parseUpdatedAtFromSSE(line string) (time.Time, error) {
+	if !strings.HasPrefix(line, "data: ") {
+		return time.Time{}, nil
+	}
+
 	var eventData struct {
 		UpdatedAt float64 `json:"updated_at"`
 	}