prepare 2.3.0 release (#18)

Author: LaunchDarklyCI

ldreason/reason.go

@@ -64,6 +64,7 @@ type EvaluationReason struct {
 	ruleIndex       ldvalue.OptionalInt
 	ruleID          string
 	prerequisiteKey string
+	inExperiment    bool
 	errorKind       EvalErrorKind
 }
 
@@ -111,6 +112,13 @@ func (r EvaluationReason) GetPrerequisiteKey() string {
 	return r.prerequisiteKey
 }
 
+// IsInExperiment describes whether the evaluation was part of an experiment. It returns
+// true if the evaluation resulted in an experiment rollout *and* served one of the
+// variations in the experiment.  Otherwise it returns false.
+func (r EvaluationReason) IsInExperiment() bool {
+	return r.inExperiment
+}
+
 // GetErrorKind describes the general category of the error, if the Kind is EvalReasonError.
 // Otherwise it returns an empty string.
 func (r EvaluationReason) GetErrorKind() EvalErrorKind {
@@ -127,6 +135,13 @@ func NewEvalReasonFallthrough() EvaluationReason {
 	return EvaluationReason{kind: EvalReasonFallthrough}
 }
 
+// NewEvalReasonFallthroughExperiment returns an EvaluationReason whose Kind is
+// EvalReasonFallthrough. The inExperiment parameter represents whether the evaluation was
+// part of an experiment.
+func NewEvalReasonFallthroughExperiment(inExperiment bool) EvaluationReason {
+	return EvaluationReason{kind: EvalReasonFallthrough, inExperiment: inExperiment}
+}
+
 // NewEvalReasonTargetMatch returns an EvaluationReason whose Kind is EvalReasonTargetMatch.
 func NewEvalReasonTargetMatch() EvaluationReason {
 	return EvaluationReason{kind: EvalReasonTargetMatch}
@@ -138,6 +153,18 @@ func NewEvalReasonRuleMatch(ruleIndex int, ruleID string) EvaluationReason {
 		ruleIndex: ldvalue.NewOptionalInt(ruleIndex), ruleID: ruleID}
 }
 
+// NewEvalReasonRuleMatchExperiment returns an EvaluationReason whose Kind is
+// EvalReasonRuleMatch. The inExperiment parameter represents whether the evaluation was
+// part of an experiment.
+func NewEvalReasonRuleMatchExperiment(ruleIndex int, ruleID string, inExperiment bool) EvaluationReason {
+	return EvaluationReason{
+		kind:         EvalReasonRuleMatch,
+		ruleIndex:    ldvalue.NewOptionalInt(ruleIndex),
+		ruleID:       ruleID,
+		inExperiment: inExperiment,
+	}
+}
+
 // NewEvalReasonPrerequisiteFailed returns an EvaluationReason whose Kind is EvalReasonPrerequisiteFailed.
 func NewEvalReasonPrerequisiteFailed(prereqKey string) EvaluationReason {
 	return EvaluationReason{kind: EvalReasonPrerequisiteFailed, prerequisiteKey: prereqKey}
@@ -176,6 +203,8 @@ func (r *EvaluationReason) ReadFromJSONReader(reader *jreader.Reader) {
 			ret.errorKind = EvalErrorKind(reader.String())
 		case "prerequisiteKey":
 			ret.prerequisiteKey = reader.String()
+		case "inExperiment":
+			ret.inExperiment = reader.Bool()
 		}
 	}
 	if reader.Error() == nil {
@@ -198,6 +227,7 @@ func (r EvaluationReason) WriteToJSONWriter(w *jwriter.Writer) {
 		obj.Name("ruleIndex").Int(r.ruleIndex.OrElse(0))
 		obj.Maybe("ruleId", r.ruleID != "").String(r.ruleID)
 	}
+	obj.Maybe("inExperiment", r.inExperiment).Bool(r.inExperiment)
 	if r.kind == EvalReasonPrerequisiteFailed {
 		obj.Name("prerequisiteKey").String(r.prerequisiteKey)
 	}

ldreason/reason_test.go

@@ -15,17 +15,21 @@ func TestReasonIsDefined(t *testing.T) {
 	assert.False(t, EvaluationReason{}.IsDefined())
 	assert.True(t, NewEvalReasonOff().IsDefined())
 	assert.True(t, NewEvalReasonFallthrough().IsDefined())
+	assert.True(t, NewEvalReasonFallthroughExperiment(true).IsDefined())
 	assert.True(t, NewEvalReasonTargetMatch().IsDefined())
 	assert.True(t, NewEvalReasonRuleMatch(0, "").IsDefined())
+	assert.True(t, NewEvalReasonRuleMatchExperiment(0, "", true).IsDefined())
 	assert.True(t, NewEvalReasonPrerequisiteFailed("").IsDefined())
 	assert.True(t, NewEvalReasonError(EvalErrorFlagNotFound).IsDefined())
 }
 
 func TestReasonKind(t *testing.T) {
 	assert.Equal(t, EvalReasonOff, NewEvalReasonOff().GetKind())
 	assert.Equal(t, EvalReasonFallthrough, NewEvalReasonFallthrough().GetKind())
+	assert.Equal(t, EvalReasonFallthrough, NewEvalReasonFallthroughExperiment(true).GetKind())
 	assert.Equal(t, EvalReasonTargetMatch, NewEvalReasonTargetMatch().GetKind())
 	assert.Equal(t, EvalReasonRuleMatch, NewEvalReasonRuleMatch(0, "").GetKind())
+	assert.Equal(t, EvalReasonRuleMatch, NewEvalReasonRuleMatchExperiment(0, "", true).GetKind())
 	assert.Equal(t, EvalReasonPrerequisiteFailed, NewEvalReasonPrerequisiteFailed("").GetKind())
 	assert.Equal(t, EvalReasonError, NewEvalReasonError(EvalErrorFlagNotFound).GetKind())
 }
@@ -35,8 +39,12 @@ func TestReasonRuleProperties(t *testing.T) {
 	assert.Equal(t, 1, r.GetRuleIndex())
 	assert.Equal(t, "id", r.GetRuleID())
 
+	r = NewEvalReasonRuleMatchExperiment(1, "id", true)
+	assert.Equal(t, 1, r.GetRuleIndex())
+	assert.Equal(t, "id", r.GetRuleID())
+
 	for _, r := range []EvaluationReason{
-		NewEvalReasonOff(), NewEvalReasonFallthrough(), NewEvalReasonTargetMatch(),
+		NewEvalReasonOff(), NewEvalReasonFallthrough(), NewEvalReasonFallthroughExperiment(true), NewEvalReasonTargetMatch(),
 		NewEvalReasonPrerequisiteFailed(""), NewEvalReasonError(EvalErrorFlagNotFound),
 	} {
 		t.Run(string(r.GetKind()), func(t *testing.T) {
@@ -46,13 +54,31 @@ func TestReasonRuleProperties(t *testing.T) {
 	}
 }
 
+func TestReasonExperimentProperties(t *testing.T) {
+	r := NewEvalReasonFallthroughExperiment(true)
+	assert.Equal(t, true, r.IsInExperiment())
+
+	r = NewEvalReasonRuleMatchExperiment(1, "id", true)
+	assert.Equal(t, true, r.IsInExperiment())
+
+	for _, r := range []EvaluationReason{
+		NewEvalReasonOff(), NewEvalReasonFallthrough(), NewEvalReasonFallthroughExperiment(false), NewEvalReasonTargetMatch(),
+		NewEvalReasonRuleMatch(1, "id"),
+		NewEvalReasonRuleMatchExperiment(1, "id", false), NewEvalReasonPrerequisiteFailed(""), NewEvalReasonError(EvalErrorFlagNotFound),
+	} {
+		t.Run(string(r.GetKind()), func(t *testing.T) {
+			assert.Equal(t, false, r.IsInExperiment())
+		})
+	}
+}
+
 func TestReasonPrerequisiteFailedProperties(t *testing.T) {
 	r := NewEvalReasonPrerequisiteFailed("key")
 	assert.Equal(t, "key", r.GetPrerequisiteKey())
 
 	for _, r := range []EvaluationReason{
-		NewEvalReasonOff(), NewEvalReasonFallthrough(), NewEvalReasonTargetMatch(),
-		NewEvalReasonRuleMatch(0, "id"), NewEvalReasonError(EvalErrorFlagNotFound),
+		NewEvalReasonOff(), NewEvalReasonFallthrough(), NewEvalReasonFallthroughExperiment(true), NewEvalReasonTargetMatch(),
+		NewEvalReasonRuleMatch(0, "id"), NewEvalReasonRuleMatchExperiment(0, "id", true), NewEvalReasonError(EvalErrorFlagNotFound),
 	} {
 		t.Run(string(r.GetKind()), func(t *testing.T) {
 			assert.Equal(t, "", r.GetPrerequisiteKey())
@@ -65,8 +91,8 @@ func TestReasonErrorProperties(t *testing.T) {
 	assert.Equal(t, EvalErrorFlagNotFound, r.GetErrorKind())
 
 	for _, r := range []EvaluationReason{
-		NewEvalReasonOff(), NewEvalReasonFallthrough(), NewEvalReasonTargetMatch(),
-		NewEvalReasonRuleMatch(0, "id"), NewEvalReasonPrerequisiteFailed("key"),
+		NewEvalReasonOff(), NewEvalReasonFallthrough(), NewEvalReasonFallthroughExperiment(true), NewEvalReasonTargetMatch(),
+		NewEvalReasonRuleMatch(0, "id"), NewEvalReasonRuleMatchExperiment(0, "id", true), NewEvalReasonPrerequisiteFailed("key"),
 	} {
 		t.Run(string(r.GetKind()), func(t *testing.T) {
 			assert.Equal(t, EvalErrorKind(""), r.GetErrorKind())
@@ -83,8 +109,12 @@ func TestReasonSerializationAndDeserialization(t *testing.T) {
 		{EvaluationReason{}, "", "null"},
 		{NewEvalReasonOff(), "OFF", `{"kind":"OFF"}`},
 		{NewEvalReasonFallthrough(), "FALLTHROUGH", `{"kind":"FALLTHROUGH"}`},
+		{NewEvalReasonFallthroughExperiment(true), "FALLTHROUGH", `{"kind":"FALLTHROUGH","inExperiment":true}`},
+		{NewEvalReasonFallthroughExperiment(false), "FALLTHROUGH", `{"kind":"FALLTHROUGH"}`},
 		{NewEvalReasonTargetMatch(), "TARGET_MATCH", `{"kind":"TARGET_MATCH"}`},
 		{NewEvalReasonRuleMatch(1, "x"), "RULE_MATCH(1,x)", `{"kind":"RULE_MATCH","ruleIndex":1,"ruleId":"x"}`},
+		{NewEvalReasonRuleMatchExperiment(1, "x", true), "RULE_MATCH(1,x)", `{"kind":"RULE_MATCH","ruleIndex":1,"ruleId":"x","inExperiment":true}`},
+		{NewEvalReasonRuleMatchExperiment(1, "x", false), "RULE_MATCH(1,x)", `{"kind":"RULE_MATCH","ruleIndex":1,"ruleId":"x"}`},
 		{NewEvalReasonPrerequisiteFailed("x"), "PREREQUISITE_FAILED(x)", `{"kind":"PREREQUISITE_FAILED","prerequisiteKey":"x"} `},
 		{NewEvalReasonError(EvalErrorWrongType), "ERROR(WRONG_TYPE)", `{"kind":"ERROR","errorKind":"WRONG_TYPE"}`},
 	}