Merge branch 'main' into fix/release-please-artifact-upload

open-feature · Sep 23, 2022 · 8a9849c · 8a9849c · github-actions · Sep 23, 2022
2 parents ea63833 + 7559754
commit 8a9849c
Show file tree

Hide file tree

Showing 11 changed files with 63 additions and 51 deletions.
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0"
+  ".": "0.1.1"
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,9 @@
+# Changelog
+
+## [0.1.1](https://github.com/open-feature/flagd/compare/v0.1.0...v0.1.1) (2022-09-23)
+
+
+### Bug Fixes
+
+* bubbles up unclean error exits ([#170](https://github.com/open-feature/flagd/issues/170)) ([9f7db02](https://github.com/open-feature/flagd/commit/9f7db0259d2d24cb880eeddaebd3b8f48758248a))
+* upgrade package containing vulnerability ([#162](https://github.com/open-feature/flagd/issues/162)) ([82278c7](https://github.com/open-feature/flagd/commit/82278c7cf08cc6b50f49ab500caf6f9003fc0823))
diff --git a/README.md b/README.md
@@ -42,7 +42,7 @@ curl -X POST "localhost:8013/flags/myBoolFlag/resolve/boolean"
 Result:
 
 ```sh
-{"value":true,"reason":"STATIC","variant":"on"}
+{"value":true,"reason":"DEFAULT","variant":"on"}
 ```
 
 <br />
@@ -58,7 +58,7 @@ curl -X POST "localhost:8013/flags/myStringFlag/resolve/string"
 Result:
 
 ```sh
-{"value":"val1","reason":"STATIC","variant":"key1"}
+{"value":"val1","reason":"DEFAULT","variant":"key1"}
 ```
 
 <br />
@@ -74,7 +74,7 @@ curl -X POST "localhost:8013/flags/myIntFlag/resolve/int"
 Result:
 
 ```sh
-{"value":"1","reason":"STATIC","variant":"one"}
+{"value":"1","reason":"DEFAULT","variant":"one"}
 ```
 
 [Why is this `int` response a `string`?](./docs/http_int_response.md)
@@ -92,7 +92,7 @@ curl -X POST "localhost:8013/flags/myFloatFlag/resolve/float"
 Result:
 
 ```sh
-{"value":1.23,"reason":"STATIC","variant":"one"}
+{"value":1.23,"reason":"DEFAULT","variant":"one"}
 ```
 
 <br />
@@ -108,7 +108,7 @@ curl -X POST "localhost:8013/flags/myObjectFlag/resolve/object"
 Result:
 
 ```sh
-{"value":{"key":"val"},"reason":"STATIC","variant":"object1"}
+{"value":{"key":"val"},"reason":"DEFAULT","variant":"object1"}
 ```
 
 <br />
@@ -173,7 +173,7 @@ This enables you to use an upgraded connection for the previous example requests
 
 ```
 curl -X POST "https://localhost:8013/flags/myBoolFlag/resolve/boolean"
-// {"value":true,"reason":"STATIC","variant":"on"}
+// {"value":true,"reason":"DEFAULT","variant":"on"}
 ```
 
 ## Multiple source example

diff --git a/cmd/start.go b/cmd/start.go
@@ -93,8 +93,12 @@ var startCmd = &cobra.Command{
 		})
 		if err != nil {
 			log.Error(err)
+			os.Exit(1)
 		}
 
-		rt.Start()
+		if err := rt.Start(); err != nil {
+			log.Error(err)
+			os.Exit(1)
+		}
 	},
 }
diff --git a/docs/http_int_response.md b/docs/http_int_response.md
@@ -8,7 +8,7 @@ curl -X POST "localhost:8013/flags/myIntFlag/resolve/int"
 ```
 Result:
 ```sh
-{"value":"1","reason":"STATIC","variant":"one"}
+{"value":"1","reason":"DEFAULT","variant":"one"}
 ```
 When interacting directly with the flagD http(s) api and requesting an `int` the response type will be a `string`. This behaviour is introduced by [grpc-gateway](https://github.com/grpc-ecosystem/grpc-gateway), which uses [proto3 json mapping](https://developers.google.com/protocol-buffers/docs/proto3#json) to build the response object. If a number value is required, and none of the provided SDK's can be used, then it is recommended to use the `float64` endpoint instead:  
 <br />
@@ -18,5 +18,5 @@ curl -X POST "localhost:8013/flags/myIntFlag/resolve/float"
 ```
 Result:
 ```sh
-{"value":1.23,"reason":"STATIC","variant":"one"}
+{"value":1.23,"reason":"DEFAULT","variant":"one"}
 ```
diff --git a/pkg/eval/fractional_evaluation_test.go b/pkg/eval/fractional_evaluation_test.go
@@ -202,7 +202,7 @@ func TestFractionalEvaluation(t *testing.T) {
 			context:         &structpb.Struct{},
 			expectedVariant: "red",
 			expectedValue:   "#FF0000",
-			expectedReason:  model.StaticReason,
+			expectedReason:  model.DefaultReason,
 		},
 		"fallback to default variant if invalid variant as result of fractional evaluation": {
 			flags: Flags{
@@ -236,7 +236,7 @@ func TestFractionalEvaluation(t *testing.T) {
 			}},
 			expectedVariant: "red",
 			expectedValue:   "#FF0000",
-			expectedReason:  model.StaticReason,
+			expectedReason:  model.DefaultReason,
 		},
 		"fallback to default variant if percentages don't sum to 100": {
 			flags: Flags{
@@ -274,7 +274,7 @@ func TestFractionalEvaluation(t *testing.T) {
 			}},
 			expectedVariant: "red",
 			expectedValue:   "#FF0000",
-			expectedReason:  model.StaticReason,
+			expectedReason:  model.DefaultReason,
 		},
 	}
 

diff --git a/pkg/eval/json_evaluator.go b/pkg/eval/json_evaluator.go
@@ -187,8 +187,8 @@ func (je *JSONEvaluator) evaluateVariant(
 		return variant, model.TargetingMatchReason, nil
 	}
 
-	// if it's not a valid variant, use the default (static) value
-	return je.state.Flags[flagKey].DefaultVariant, model.StaticReason, nil
+	// if it's not a valid variant, use the default value
+	return je.state.Flags[flagKey].DefaultVariant, model.DefaultReason, nil
 }
 
 // validateDefaultVariants returns an error if any of the default variants aren't valid

diff --git a/pkg/eval/json_evaluator_test.go b/pkg/eval/json_evaluator_test.go
@@ -326,7 +326,7 @@ func TestResolveBooleanValue(t *testing.T) {
 		reason    string
 		errorCode string
 	}{
-		{StaticBoolFlag, nil, StaticBoolValue, model.StaticReason, ""},
+		{StaticBoolFlag, nil, StaticBoolValue, model.DefaultReason, ""},
 		{DynamicBoolFlag, map[string]interface{}{ColorProp: ColorValue}, StaticBoolValue, model.TargetingMatchReason, ""},
 		{StaticObjectFlag, nil, StaticBoolValue, model.ErrorReason, model.TypeMismatchErrorCode},
 		{MissingFlag, nil, StaticBoolValue, model.ErrorReason, model.FlagNotFoundErrorCode},
@@ -365,7 +365,7 @@ func TestResolveStringValue(t *testing.T) {
 		reason    string
 		errorCode string
 	}{
-		{StaticStringFlag, nil, StaticStringValue, model.StaticReason, ""},
+		{StaticStringFlag, nil, StaticStringValue, model.DefaultReason, ""},
 		{DynamicStringFlag, map[string]interface{}{ColorProp: ColorValue}, DynamicStringValue, model.TargetingMatchReason, ""},
 		{StaticObjectFlag, nil, "", model.ErrorReason, model.TypeMismatchErrorCode},
 		{MissingFlag, nil, "", model.ErrorReason, model.FlagNotFoundErrorCode},
@@ -405,7 +405,7 @@ func TestResolveFloatValue(t *testing.T) {
 		reason    string
 		errorCode string
 	}{
-		{StaticFloatFlag, nil, StaticFloatValue, model.StaticReason, ""},
+		{StaticFloatFlag, nil, StaticFloatValue, model.DefaultReason, ""},
 		{DynamicFloatFlag, map[string]interface{}{ColorProp: ColorValue}, DynamicFloatValue, model.TargetingMatchReason, ""},
 		{StaticObjectFlag, nil, 13, model.ErrorReason, model.TypeMismatchErrorCode},
 		{MissingFlag, nil, 13, model.ErrorReason, model.FlagNotFoundErrorCode},
@@ -445,7 +445,7 @@ func TestResolveIntValue(t *testing.T) {
 		reason    string
 		errorCode string
 	}{
-		{StaticIntFlag, nil, StaticIntValue, model.StaticReason, ""},
+		{StaticIntFlag, nil, StaticIntValue, model.DefaultReason, ""},
 		{DynamicIntFlag, map[string]interface{}{ColorProp: ColorValue}, DynamicIntValue, model.TargetingMatchReason, ""},
 		{StaticObjectFlag, nil, 13, model.ErrorReason, model.TypeMismatchErrorCode},
 		{MissingFlag, nil, 13, model.ErrorReason, model.FlagNotFoundErrorCode},
@@ -485,7 +485,7 @@ func TestResolveObjectValue(t *testing.T) {
 		reason    string
 		errorCode string
 	}{
-		{StaticObjectFlag, nil, StaticObjectValue, model.StaticReason, ""},
+		{StaticObjectFlag, nil, StaticObjectValue, model.DefaultReason, ""},
 		{DynamicObjectFlag, map[string]interface{}{ColorProp: ColorValue}, DynamicObjectValue, model.TargetingMatchReason, ""},
 		{StaticBoolFlag, nil, "{}", model.ErrorReason, model.TypeMismatchErrorCode},
 		{MissingFlag, nil, "{}", model.ErrorReason, model.FlagNotFoundErrorCode},

diff --git a/pkg/model/reason.go b/pkg/model/reason.go
@@ -5,7 +5,6 @@ const (
 	SplitReason          = "SPLIT"
 	DisabledReason       = "DISABLED"
 	DefaultReason        = "DEFAULT"
-	StaticReason         = "STATIC"
 	UnknownReason        = "UNKNOWN"
 	ErrorReason          = "ERROR"
 )
diff --git a/pkg/runtime/start.go b/pkg/runtime/start.go
@@ -2,25 +2,23 @@ package runtime
 
 import (
 	"context"
+	"errors"
 	"os"
 	"os/signal"
 	"syscall"
 
 	"golang.org/x/sync/errgroup"
 )
 
-func (r *Runtime) Start() {
+func (r *Runtime) Start() error {
 	if r.Service == nil {
-		r.Logger.Error("no Service set")
-		return
+		return errors.New("no Service set")
 	}
 	if len(r.SyncImpl) == 0 {
-		r.Logger.Error("no SyncImplementation set")
-		return
+		return errors.New("no SyncImplementation set")
 	}
 	if r.Evaluator == nil {
-		r.Logger.Error("no Evaluator set")
-		return
+		return errors.New("no Evaluator set")
 	}
 
 	ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
@@ -40,6 +38,7 @@ func (r *Runtime) Start() {
 
 	<-gCtx.Done()
 	if err := g.Wait(); err != nil {
-		r.Logger.Error(err)
+		return err
 	}
+	return nil
 }
Benchmark suite	Current: `8a9849c`	Previous: `b655e88`	Ratio
`BenchmarkGRPCService_ResolveBoolean/eval_returns_error`	`10167` ns/op 1192 B/op 37 allocs/op	`6441` ns/op 1192 B/op 37 allocs/op	`1.58`
`BenchmarkGRPCService_ResolveBoolean/happy_path`	`3088` ns/op 240 B/op 5 allocs/op	`2219` ns/op 240 B/op 5 allocs/op	`1.39`
`BenchmarkGRPCService_ResolveString/happy_path`	`3045` ns/op 256 B/op 5 allocs/op	`2221` ns/op 256 B/op 5 allocs/op	`1.37`
`BenchmarkGRPCService_ResolveString/eval_returns_error`	`9866` ns/op 1208 B/op 37 allocs/op	`6478` ns/op 1208 B/op 37 allocs/op	`1.52`
`BenchmarkGRPCService_ResolveFloat/happy_path`	`3033` ns/op 240 B/op 5 allocs/op	`2214` ns/op 240 B/op 5 allocs/op	`1.37`
`BenchmarkGRPCService_ResolveFloat/eval_returns_error`	`10009` ns/op 1192 B/op 37 allocs/op	`6423` ns/op 1192 B/op 37 allocs/op	`1.56`
`BenchmarkGRPCService_ResolveInt/happy_path`	`2895` ns/op 240 B/op 5 allocs/op	`2216` ns/op 240 B/op 5 allocs/op	`1.31`
`BenchmarkGRPCService_ResolveInt/eval_returns_error`	`9761` ns/op 1192 B/op 37 allocs/op	`6415` ns/op 1192 B/op 37 allocs/op	`1.52`
`BenchmarkGRPCService_ResolveObject/happy_path`	`4731` ns/op 1400 B/op 20 allocs/op	`3485` ns/op 1400 B/op 20 allocs/op	`1.36`
`BenchmarkGRPCService_ResolveObject/eval_returns_error`	`9605` ns/op 1288 B/op 39 allocs/op	`6213` ns/op 1288 B/op 39 allocs/op	`1.55`