prepare 2.0.0-beta.4 release (#10)

Author: eli-darkly

ldlogtest/mock_log.go

@@ -2,6 +2,8 @@ package ldlogtest
 
 import (
 	"fmt"
+	"io"
+	"os"
 	"regexp"
 	"strings"
 	"sync"
@@ -98,6 +100,30 @@ func (ml *MockLog) AssertMessageMatch(t *testing.T, shouldMatch bool, level ldlo
 	}
 }
 
+// Dump is a shortcut for writing all captured log lines to a Writer.
+func (ml *MockLog) Dump(w io.Writer) {
+	for _, line := range ml.GetAllOutput() {
+		fmt.Fprintln(w, line.Level.Name()+": "+line.Message)
+	}
+}
+
+// DumpIfTestFailed is a shortcut for writing all captured log lines to standard output only if
+// t.Failed() is true.
+//
+// This is useful in tests where you normally don't want to see the log output, but you do want to see it
+// if there was a failure. The simplest way to do this is to use defer:
+//
+//     func TestSomething(t *testing.T) {
+//         ml := ldlogtest.NewMockLog()
+//         defer ml.DumpIfTestFailed(t)
+//         // ... do some test things that may generate log output and/or cause a failure
+//     }
+func (ml *MockLog) DumpIfTestFailed(t *testing.T) {
+	if t.Failed() { // COVERAGE: there's no way to test this in unit tests
+		ml.Dump(os.Stdout)
+	}
+}
+
 func (ml *MockLog) logLine(level ldlog.LogLevel, line string) {
 	ml.lock.Lock()
 	defer ml.lock.Unlock()

ldlogtest/mock_log_test.go

@@ -1,6 +1,7 @@
 package ldlogtest
 
 import (
+	"bytes"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -74,3 +75,12 @@ func TestMessageMatching(t *testing.T) {
 	shouldNotMatch(t, ldlog.Info, "third")
 	shouldNotMatch(t, ldlog.Error, ".")
 }
+
+func TestDump(t *testing.T) {
+	buf := bytes.NewBuffer(nil)
+	m := NewMockLog()
+	m.Loggers.Info("first")
+	m.Loggers.Warn("second")
+	m.Dump(buf)
+	assert.Equal(t, "Info: first\nWarn: second\n", string(buf.Bytes()))
+}

ldreason/detail.go

@@ -11,9 +11,11 @@ type EvaluationDetail struct {
 	// the default value that was passed to the Variation method.
 	Value ldvalue.Value
 	// VariationIndex is the index of the returned value within the flag's list of variations, e.g.
-	// 0 for the first variation. A negative number indicates that the application default value was
-	// returned because the flag could not be evaluated.
-	VariationIndex int
+	// 0 for the first variation. This is an ldvalue.OptionalInt rather than an int, because it is
+	// possible for the value to be undefined (there is no variation index if the application default
+	// value was returned due to an error in evaluation) which is different from a value of 0. See
+	// ldvalue.OptionalInt for more about how to use this type.
+	VariationIndex ldvalue.OptionalInt
 	// Reason is an EvaluationReason object describing the main factor that influenced the flag
 	// evaluation value.
 	Reason EvaluationReason
@@ -23,15 +25,21 @@ type EvaluationDetail struct {
 // This means that an error prevented the flag from being evaluated; the Reason field should contain
 // an error value such as NewEvalReasonError(EvalErrorFlagNotFound).
 func (d EvaluationDetail) IsDefaultValue() bool {
-	return d.VariationIndex < 0
+	return !d.VariationIndex.IsDefined()
 }
 
-// NewEvaluationDetail constructs an EvaluationDeteail, specifying all fields.
-func NewEvaluationDetail(value ldvalue.Value, variationIndex int, reason EvaluationReason) EvaluationDetail {
-	return EvaluationDetail{Value: value, VariationIndex: variationIndex, Reason: reason}
+// NewEvaluationDetail constructs an EvaluationDetail, specifying all fields. This assumes that there
+// is a defined value for variationIndex; if variationIndex is undefined, use NewEvaluationDetailForError
+// or set the struct fields directly.
+func NewEvaluationDetail(
+	value ldvalue.Value,
+	variationIndex int,
+	reason EvaluationReason,
+) EvaluationDetail {
+	return EvaluationDetail{Value: value, VariationIndex: ldvalue.NewOptionalInt(variationIndex), Reason: reason}
 }
 
 // NewEvaluationDetailForError constructs an EvaluationDetail for an error condition.
 func NewEvaluationDetailForError(errorKind EvalErrorKind, defaultValue ldvalue.Value) EvaluationDetail {
-	return EvaluationDetail{Value: defaultValue, VariationIndex: -1, Reason: NewEvalReasonError(errorKind)}
+	return EvaluationDetail{Value: defaultValue, Reason: NewEvalReasonError(errorKind)}
 }

ldreason/detail_test.go

@@ -11,15 +11,15 @@ import (
 func TestDetailConstructor(t *testing.T) {
 	detail := NewEvaluationDetail(ldvalue.Bool(true), 1, NewEvalReasonFallthrough())
 	assert.Equal(t, ldvalue.Bool(true), detail.Value)
-	assert.Equal(t, 1, detail.VariationIndex)
+	assert.Equal(t, ldvalue.NewOptionalInt(1), detail.VariationIndex)
 	assert.Equal(t, NewEvalReasonFallthrough(), detail.Reason)
 	assert.False(t, detail.IsDefaultValue())
 }
 
 func TestDetailErrorConstructor(t *testing.T) {
 	detail := NewEvaluationDetailForError(EvalErrorFlagNotFound, ldvalue.Bool(false))
 	assert.Equal(t, ldvalue.Bool(false), detail.Value)
-	assert.Equal(t, -1, detail.VariationIndex)
+	assert.Equal(t, ldvalue.OptionalInt{}, detail.VariationIndex)
 	assert.Equal(t, NewEvalReasonError(EvalErrorFlagNotFound), detail.Reason)
 	assert.True(t, detail.IsDefaultValue())
 }

lduser/user.go

@@ -57,7 +57,7 @@ type User struct {
 	lastName          ldvalue.OptionalString
 	avatar            ldvalue.OptionalString
 	name              ldvalue.OptionalString
-	anonymous         ldvalue.Value
+	anonymous         ldvalue.OptionalBool
 	custom            ldvalue.Value
 	privateAttributes map[UserAttribute]struct{}
 }
@@ -90,7 +90,7 @@ func (u User) GetAttribute(attribute UserAttribute) ldvalue.Value {
 	case NameAttribute:
 		return u.name.AsValue()
 	case AnonymousAttribute:
-		return u.anonymous
+		return u.anonymous.AsValue()
 	default:
 		value, _ := u.GetCustom(string(attribute))
 		return value
@@ -157,7 +157,7 @@ func (u User) GetAnonymous() bool {
 // GetAnonymousOptional returns the anonymous attribute of the user, with a second value indicating
 // whether that attribute was defined for the user or not.
 func (u User) GetAnonymousOptional() (bool, bool) {
-	return u.anonymous.BoolValue(), !u.anonymous.IsNull()
+	return u.anonymous.Get()
 }
 
 // GetCustom returns a custom attribute of the user by name. The boolean second return value indicates
@@ -207,7 +207,7 @@ func (u User) Equal(other User) bool {
 		u.lastName != other.lastName ||
 		u.avatar != other.avatar ||
 		u.name != other.name ||
-		!u.anonymous.Equal(other.anonymous) {
+		u.anonymous != other.anonymous {
 		return false
 	}
 	if !u.custom.Equal(other.custom) {

lduser/user_builder.go

@@ -9,7 +9,7 @@ func NewUser(key string) User {
 
 // NewAnonymousUser creates a new anonymous user identified by the given key.
 func NewAnonymousUser(key string) User {
-	return User{key: key, anonymous: ldvalue.Bool(true)}
+	return User{key: key, anonymous: ldvalue.NewOptionalBool(true)}
 }
 
 // UserBuilder is a mutable object that uses the Builder pattern to specify properties for a User.
@@ -150,7 +150,7 @@ type userBuilderImpl struct {
 	lastName                    ldvalue.OptionalString
 	avatar                      ldvalue.OptionalString
 	name                        ldvalue.OptionalString
-	anonymous                   ldvalue.Value
+	anonymous                   ldvalue.OptionalBool
 	custom                      ldvalue.ObjectBuilder
 	privateAttrs                map[UserAttribute]struct{}
 	lastAttributeCanMakePrivate UserAttribute
@@ -246,7 +246,7 @@ func (b *userBuilderImpl) Name(value string) UserBuilderCanMakeAttributePrivate
 }
 
 func (b *userBuilderImpl) Anonymous(value bool) UserBuilder {
-	b.anonymous = ldvalue.Bool(value)
+	b.anonymous = ldvalue.NewOptionalBool(value)
 	return b
 }
 
@@ -293,8 +293,11 @@ func (b *userBuilderImpl) SetAttribute(
 	case NameAttribute:
 		setOptString(&b.name)
 	case AnonymousAttribute:
-		if value.IsBool() || value.IsNull() {
-			b.anonymous = value
+		switch {
+		case value.IsNull():
+			b.anonymous = ldvalue.OptionalBool{}
+		case value.IsBool():
+			b.anonymous = ldvalue.NewOptionalBool(value.BoolValue())
 		}
 		okPrivate = false
 	default:

lduser/user_serialization.go

@@ -35,7 +35,7 @@ type userForDeserialization struct {
 	LastName              ldvalue.OptionalString `json:"lastName"`
 	Avatar                ldvalue.OptionalString `json:"avatar"`
 	Name                  ldvalue.OptionalString `json:"name"`
-	Anonymous             ldvalue.Value          `json:"anonymous"`
+	Anonymous             ldvalue.OptionalBool   `json:"anonymous"`
 	Custom                ldvalue.Value          `json:"custom"`
 	PrivateAttributeNames []UserAttribute        `json:"privateAttributeNames"`
 }
@@ -122,7 +122,7 @@ func (u User) WriteToJSONBuffer(j *jsonstream.JSONBuffer) {
 	maybeWriteStringProperty(j, "lastName", u.lastName)
 	maybeWriteStringProperty(j, "avatar", u.avatar)
 	maybeWriteStringProperty(j, "name", u.name)
-	if !u.anonymous.IsNull() {
+	if u.anonymous.IsDefined() {
 		j.WriteName("anonymous")
 		j.WriteBool(u.anonymous.BoolValue())
 	}

ldvalue/benchmark_data_test.go

@@ -1,6 +1,12 @@
 package ldvalue
 
 var (
+	benchmarkBoolValue          = true
+	benchmarkBoolPointer        = &benchmarkBoolValue
+	benchmarkOptBoolWithValue   = NewOptionalBool(benchmarkBoolValue)
+	benchmarkIntValue           = 3333
+	benchmarkIntPointer         = &benchmarkIntValue
+	benchmarkOptIntWithValue    = NewOptionalInt(benchmarkIntValue)
 	benchmarkStringValue        = "value"
 	benchmarkStringPointer      = &benchmarkStringValue
 	benchmarkOptStringWithValue = NewOptionalString(benchmarkStringValue)
@@ -13,6 +19,8 @@ var (
 	benchmarkSerializeArrayValue  = ArrayOf(String("a"), String("b"), String("c"))
 	benchmarkSerializeObjectValue = ObjectBuild().Set("a", Int(1)).Set("b", Int(2)).Set("c", Int(3)).Build()
 
+	benchmarkOptBoolResult   OptionalBool
+	benchmarkOptIntResult    OptionalInt
 	benchmarkOptStringResult OptionalString
 	benchmarkStringResult    string
 	benchmarkValueResult     Value

ldvalue/constants.go

@@ -2,7 +2,12 @@ package ldvalue
 
 // string literals should be defined here if they are referenced in multiple files
 
-const nullAsJSON = "null"
+const (
+	trueString      = "true"
+	falseString     = "false"
+	nullAsJSON      = "null"
+	noneDescription = "[none]"
+)
 
 // ValueType is defined in value_base.go