prepare 2.2.0 release (#14)

Author: LaunchDarklyCI

.circleci/config.yml

@@ -58,6 +58,11 @@ jobs:
             mkdir -p $CIRCLE_ARTIFACTS
             make test | tee $CIRCLE_ARTIFACTS/report.txt
     
+      - run:
+          name: Run tests (easyjson implementation)
+          command: |
+            make test-easyjson | tee -a $CIRCLE_ARTIFACTS/report.txt
+    
       - run:
           name: Process test results
           command: go-junit-report < $CIRCLE_ARTIFACTS/report.txt > $CIRCLE_TEST_REPORTS/junit.xml
@@ -109,6 +114,10 @@ jobs:
           command: |
             mkdir -p $CIRCLE_ARTIFACTS
             make benchmarks | tee $CIRCLE_ARTIFACTS/benchmarks.txt
+      - run:
+          name: Run benchmarks (easyjson implementation)
+          command: |
+            make benchmarks-easyjson | tee $CIRCLE_ARTIFACTS/benchmarks-easyjson.txt
 
       - store_artifacts:
           path: /tmp/circle-artifacts

Makefile

@@ -15,17 +15,27 @@ COVERAGE_ENFORCER_FLAGS=-skipcode "// COVERAGE" -packagestats -filestats -showco
 TEST_BINARY=./build/go-sdk-common.test
 ALLOCATIONS_LOG=./build/allocations.out
 
-.PHONY: build clean test test-coverage lint
+EASYJSON_TAG=launchdarkly_easyjson
+
+.PHONY: all build build-easyjson clean test test-easyjson test-coverage lint benchmarks benchmarks-easyjson benchmark-allocs
+
+all: build build-easyjson
 
 build:
 	go build ./...
 
+build-easyjson:
+	go build -tags $(EASYJSON_TAG) ./...
+
 clean:
 	go clean
 
 test: build
 	go test -race -v ./...
 
+test-easyjson: build-easyjson
+	go test -tags $(EASYJSON_TAG) -race -v ./...
+
 test-coverage: $(COVERAGE_PROFILE_RAW)
 	if [ -z "$(which go-coverage-enforcer)" ]; then go install github.com/launchdarkly-labs/go-coverage-enforcer; fi
 	go-coverage-enforcer $(COVERAGE_ENFORCER_FLAGS) -outprofile $(COVERAGE_PROFILE_FILTERED) $(COVERAGE_PROFILE_RAW)
@@ -41,6 +51,10 @@ benchmarks: build
 	go test -benchmem '-run=^$$' '-bench=.*' ./... | tee build/benchmarks.out
 	@if grep <build/benchmarks.out 'NoAlloc.*[1-9][0-9]* allocs/op'; then echo "Unexpected heap allocations detected in benchmarks!"; exit 1; fi
 
+benchmarks-easyjson: build
+	@mkdir -p ./build
+	go test -tags $(EASYJSON_TAG) -benchmem '-run=^$$' '-bench=.*' ./... | tee build/benchmarks.out
+
 # See CONTRIBUTING.md regarding the use of the benchmark-allocs target. Notes about this implementation:
 # 1. We precompile the test code because otherwise the allocation traces will include the actions of the compiler itself.
 # 2. "benchtime=3x" means the run count (b.N) is set to 3. Setting it to 1 would produce less redundant output, but the
@@ -50,7 +64,7 @@ benchmark-allocs:
 	@if [ -z "$$BENCHMARK" ]; then echo "must specify BENCHMARK=" && exit 1; fi
 	@mkdir -p ./build
 	@echo Precompiling test code to $(TEST_BINARY)
-	@go test -c -o $(TEST_BINARY) >/dev/null 2>&1
+	@go test -c -o $(TEST_BINARY) $(BENCHMARK_PACKAGE) >/dev/null 2>&1
 	@echo "Generating heap allocation traces in $(ALLOCATIONS_LOG) for benchmark(s): $$BENCHMARK"
 	@echo "You should see some benchmark result output; if you do not, you may have misspelled the benchmark name/regex"
 	@GODEBUG=allocfreetrace=1 $(TEST_BINARY) -test.run=none -test.bench=$$BENCHMARK -test.benchmem -test.benchtime=1x 2>$(ALLOCATIONS_LOG)

README.md

@@ -16,6 +16,12 @@ Also, unlike `go-server-sdk` this does not have `server` in the name, because no
 
 This version of the project has been tested with Go 1.14 and higher.
 
+## Integration with easyjson
+
+LaunchDarkly tools frequently read and write JSON data. By default, `go-sdk-common` uses LaunchDarkly's open-source JSON library [`go-jsonstream`](https://github.com/launchdarkly/go-jsonstream), which is considerably faster than Go's built-in `encoding/json` and does not depend on any third-party code. However, it can optionally integrate with the third-party library [`easyjson`](https://github.com/mailru/easyjson), which may be even faster in some cases, without requiring any changes in your code. To enable this, set the build tag `launchdarkly_easyjson` when you run `go build`, which both switches `go-jsonstream` to use `easyjson` internally and also generates `MarshalEasyJSON`/`UnmarshalEasyJSON` methods for each JSON-serializable type. The `easyjson` library is still under development and has some potential compatibility issues; see its documentation for more details.
+
+If you do not set the `launchdarkly_easyjson` build tag, `go-sdk-common` does not use any code from `easyjson`.
+
 ## Learn more
 
 Check out our [documentation](http://docs.launchdarkly.com) for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the [complete reference guide for the Go SDK](http://docs.launchdarkly.com/docs/go-sdk-reference), or the [generated API documentation](https://godoc.org/gopkg.in/launchdarkly/go-sdk-common.v2) for this project.

go.mod

@@ -4,5 +4,7 @@ go 1.13
 
 require (
 	github.com/launchdarkly/go-test-helpers/v2 v2.2.0
+	github.com/mailru/easyjson v0.7.6
 	github.com/stretchr/testify v1.6.1
+	gopkg.in/launchdarkly/go-jsonstream.v1 v1.0.0
 )

go.sum

@@ -2,17 +2,22 @@ github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/josharian/intern v1.0.0 h1:vlS4z54oSdjm0bgjRigI+G1HpF+tI+9rE5LLzOg8HmY=
+github.com/josharian/intern v1.0.0/go.mod h1:5DoeVV0s6jJacbCEi61lwdGj/aVlrQvzHFFd8Hwg//Y=
 github.com/launchdarkly/go-test-helpers/v2 v2.2.0 h1:L3kGILP/6ewikhzhdNkHy1b5y4zs50LueWenVF0sBbs=
 github.com/launchdarkly/go-test-helpers/v2 v2.2.0/go.mod h1:L7+th5govYp5oKU9iN7To5PgznBuIjBPn+ejqKR0avw=
+github.com/mailru/easyjson v0.7.6 h1:8yTIVnZgCoiM1TgqoeTl+LfU5Jg6/xL3QhGQnimLYnA=
+github.com/mailru/easyjson v0.7.6/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
 github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0=
 github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/launchdarkly/go-jsonstream.v1 v1.0.0 h1:YI6AtOY2+Q9pSdCWO99TnenKPzmpZftV/RFdsIJTw/I=
+gopkg.in/launchdarkly/go-jsonstream.v1 v1.0.0/go.mod h1:YefdBjfITIP8D9BJLVbssFctHkJnQXhv+TiRdTV0Jr4=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=

jsonstream/json_buffer_benchmark_test.go

@@ -228,7 +228,7 @@ func TestWriteDeeplyNestedStructures(t *testing.T) {
 	assert.Equal(t, expected, string(bytes))
 }
 
-func TestUsageErrors(t *testing.T) {
+func TestJSONBufferUsageErrors(t *testing.T) {
 	shouldFail := func(name string, expectedPartialOutput string, action func(j *JSONBuffer)) {
 		t.Run(name, func(t *testing.T) {
 			j := NewJSONBuffer()

jsonstream/json_buffer_test.go

@@ -0,0 +1,32 @@
+package jsonstream
+
+import (
+	"gopkg.in/launchdarkly/go-jsonstream.v1/jwriter"
+)
+
+type bufferAdapter struct {
+	jsonBuffer *JSONBuffer
+}
+
+func (b *bufferAdapter) Write(data []byte) (int, error) {
+	b.jsonBuffer.buf.Write(data)
+	if err := b.jsonBuffer.GetError(); err != nil {
+		return 0, err // COVERAGE: can't reproduce this condition in unit tests
+	}
+	return len(data), nil
+}
+
+// WriteToJSONBufferThroughWriter is a convenience method that allows marshaling logic written against
+// the newer jsonstream API to be used with this deprecated package.
+func WriteToJSONBufferThroughWriter(writable jwriter.Writable, jsonBuffer *JSONBuffer) {
+	jsonBuffer.beforeValue()
+	b := bufferAdapter{jsonBuffer}
+	w := jwriter.NewStreamingWriter(&b, 100)
+	writable.WriteToJSONWriter(&w)
+	_ = w.Flush()
+	err := w.Error()
+	if err != nil && jsonBuffer.err == nil {
+		jsonBuffer.err = err
+	}
+	jsonBuffer.afterValue()
+}

jsonstream/jwriter_adapter.go

@@ -0,0 +1,51 @@
+package jsonstream
+
+import (
+	"errors"
+	"fmt"
+	"testing"
+
+	"gopkg.in/launchdarkly/go-jsonstream.v1/jwriter"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+type testBufferAdapterFunc func(*jwriter.Writer)
+
+func TestWriteToJSONBufferThroughWriter(t *testing.T) {
+	marshalFunc := testBufferAdapterFunc(func(w *jwriter.Writer) {
+		arr := w.Array()
+		for i := 0; i < 100; i++ {
+			arr.String(fmt.Sprintf("value%d", i))
+		}
+		arr.End()
+	})
+
+	var jb JSONBuffer
+	WriteToJSONBufferThroughWriter(marshalFunc, &jb)
+	require.NoError(t, jb.GetError())
+
+	jw := jwriter.NewWriter()
+	marshalFunc(&jw)
+
+	bytes1, err := jb.Get()
+	require.NoError(t, err)
+	bytes2 := jw.Bytes()
+	assert.Equal(t, string(bytes1), string(bytes2))
+}
+
+func TestWriteToJSONBufferThroughWriterCopiesErrorState(t *testing.T) {
+	fakeError := errors.New("sorry")
+	marshalFunc := testBufferAdapterFunc(func(w *jwriter.Writer) {
+		w.AddError(fakeError)
+	})
+
+	var jb JSONBuffer
+	WriteToJSONBufferThroughWriter(marshalFunc, &jb)
+	require.Equal(t, fakeError, jb.GetError())
+}
+
+func (t testBufferAdapterFunc) WriteToJSONWriter(w *jwriter.Writer) {
+	t(w)
+}

jsonstream/jwriter_adapter_test.go

@@ -1,5 +1,5 @@
-// Package jsonstream provides a fast JSON encoder for manual generation of sequential output.
+// Package jsonstream is a deprecated implementation of sequential JSON encoding and tokenizing.
 //
-// This implementation is used by the LaunchDarkly Go SDK to avoid the overhead of reflection-based
-// marshalling.
+// Deprecated: this implementation is no longer used by the LaunchDarkly SDK, but is retained for backward
+// compatibility. It has been replaced by the go-jsonstream project: https://github.com/launchdarkly/go-jsonstream
 package jsonstream