merge prerelease branch

Author: eli-darkly

.circleci/config.yml

@@ -6,20 +6,18 @@ orbs:
 workflows:
   workflow:
     jobs:
+      - go-test:
+          name: Go 1.18
+          docker-image: cimg/go:1.18
+          with-coverage: true
       - go-test:
           name: Go 1.17
           docker-image: cimg/go:1.17
-          run-lint: true
+          run-lint: true  # golangci-lint currently doesn't run in Go 1.18
           with-coverage: true
       - go-test:
           name: Go 1.16
           docker-image: cimg/go:1.16
-      - go-test:
-          name: Go 1.15
-          docker-image: cimg/go:1.15
-      - go-test:
-          name: Go 1.14
-          docker-image: cimg/go:1.14
       - go-test-windows:
           name: Windows
       - benchmarks
@@ -47,7 +45,7 @@ jobs:
 
       - run:
           name: install go-junit-report
-          command: go get -u github.com/jstemmer/go-junit-report
+          command: go install github.com/jstemmer/go-junit-report@latest
 
       - run: go build ./...
 
@@ -101,22 +99,22 @@ jobs:
     steps:
       - checkout
       - run: 
-          name: download Go 1.14.13
+          name: download Go 1.16.14
           command: |
             $ErrorActionPreference = "Stop"
-            $installerUrl = "https://golang.org/dl/go1.14.13.windows-amd64.msi"
-            (New-Object System.Net.WebClient).DownloadFile($installerUrl, "go1.14.13.windows-amd64.msi")
+            $installerUrl = "https://go.dev/dl/go1.16.14.windows-amd64.msi"
+            (New-Object System.Net.WebClient).DownloadFile($installerUrl, "go1.16.14.windows-amd64.msi")
       - run:
-          name: install Go 1.14.13
-          command: Start-Process msiexec.exe -Wait -ArgumentList "/I go1.14.13.windows-amd64.msi /quiet"
+          name: install Go 1.16.14
+          command: Start-Process msiexec.exe -Wait -ArgumentList "/I go1.16.14.windows-amd64.msi /quiet"
       - run: go version
       - run:
           name: build and test
           command: go test -race ./...
 
   benchmarks:
     docker:
-      - image: cimg/go:1.15
+      - image: cimg/go:1.16
         environment:
           CIRCLE_ARTIFACTS: /tmp/circle-artifacts
 

.golangci.yml

@@ -44,7 +44,7 @@ linters-settings:
   gofmt:
     simplify: false
   goimports:
-    local-prefixes: gopkg.in/launchdarkly,github.com/launchdarkly
+    local-prefixes: github.com/launchdarkly
 
 issues:
   exclude-use-default: false

.ldrelease/config.yml

@@ -6,18 +6,18 @@ repo:
 
 jobs:
   - docker:
-      image: golang:1.14-buster
+      image: golang:1.16-buster
     template:
       name: go
-    env:
-      LD_RELEASE_GO_IMPORT_PATH: gopkg.in/launchdarkly/go-sdk-common.v2
 
 branches:
+  - name: v3
+    description: 3.x - for Go SDK 6+
   - name: v2
     description: 2.x - for Go SDK 5+
   - name: v1
     description: 1.x - for Go SDK 4.x
 
 publications:
-  - url: https://godoc.org/gopkg.in/launchdarkly/go-sdk-common.v2
+  - url: https://godoc.org/github.com/launchdarkly/go-sdk-common/v3
     description: documentation

CONTRIBUTING.md

@@ -14,9 +14,7 @@ We encourage pull requests and other contributions from the community. Before su
 
 ### Prerequisites
 
-This project should be built against Go 1.13 or newer.
-
-Note that the base import path is `gopkg.in/launchdarkly/go-sdk-common.v2`, not `github.com/launchdarkly/go-sdk-common`; all references in this code to other packages within the repository must use that same base import path. This ensures that the package can be referenced not only as a Go module, but also by projects that use older tools like `dep` and `govendor`, because the 5.x release of the Go SDK supports either module or non-module usage. Future releases of this package, and of the Go SDK, may drop support for non-module usage.
+This project should be built against the lowest supported Go version as described in [README.md](./README.md).
 
 ### Building
 

Makefile

@@ -31,10 +31,12 @@ clean:
 	go clean
 
 test: build
-	go test -race -v ./...
+	go test -run=not-a-real-test ./...  # just ensures that the tests compile
+	go test -race ./...
 
 test-easyjson: build-easyjson
-	go test -tags $(EASYJSON_TAG) -race -v ./...
+	go test -run=not-a-real-test -tags $(EASYJSON_TAG) ./...  # just ensures that the tests compile
+	go test -tags $(EASYJSON_TAG) -race ./...
 
 test-coverage: $(COVERAGE_PROFILE_RAW)
 	go run github.com/launchdarkly-labs/go-coverage-enforcer@latest $(COVERAGE_ENFORCER_FLAGS) -outprofile $(COVERAGE_PROFILE_FILTERED) $(COVERAGE_PROFILE_RAW)
@@ -70,7 +72,7 @@ benchmark-allocs:
 
 $(LINTER_VERSION_FILE):
 	rm -f $(LINTER)
-	curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | bash -s $(GOLANGCI_LINT_VERSION)
+	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s $(GOLANGCI_LINT_VERSION)
 	touch $(LINTER_VERSION_FILE)
 
 lint: $(LINTER_VERSION_FILE)

README.md

@@ -1,20 +1,16 @@
 # LaunchDarkly Go SDK Core Packages
 
-[![Circle CI](https://circleci.com/gh/launchdarkly/go-sdk-common.svg?style=shield)](https://circleci.com/gh/launchdarkly/go-sdk-common) [![Documentation](https://img.shields.io/static/v1?label=go.dev&message=reference&color=00add8)](https://pkg.go.dev/gopkg.in/launchdarkly/go-sdk-common.v2)
+[![Circle CI](https://circleci.com/gh/launchdarkly/go-sdk-common.svg?style=shield)](https://circleci.com/gh/launchdarkly/go-sdk-common) [![Documentation](https://img.shields.io/static/v1?label=go.dev&message=reference&color=00add8)](https://pkg.go.dev/github.com/launchdarkly/go-sdk-common/v3)
 
 ## Overview
 
 This repository contains packages and types that are shared between the [LaunchDarkly Go SDK](https://github.com/launchdarkly/go-server-sdk) and other LaunchDarkly Go components.
 
-Applications using the LaunchDarkly Go SDK will generally use the `lduser` subpackage, which contains the `User` type, and may also use the `ldvalue` package, which contains the `Value` type that represents arbitrary JSON values. Other packages are less frequently used.
-
-Note that the base import path is `gopkg.in/launchdarkly/go-sdk-common.v2`, not `github.com/launchdarkly/go-sdk-common`. This ensures that the package can be referenced not only as a Go module, but also by projects that use older tools like `dep` and `govendor`, because the 5.x release of the Go SDK supports either module or non-module usage. Future releases of this package, and of the Go SDK, may drop support for non-module usage.
-
-Also, unlike `go-server-sdk` this does not have `server` in the name, because nothing in this repository is specific to the LaunchDarkly server-side model; it could be used in a client-side context.
+Applications using the LaunchDarkly Go SDK will generally use the `ldcontext` subpackage, which contains the `Context` type, and may also use the `ldvalue` package, which contains the `Value` type that represents arbitrary JSON values. Other packages are less frequently used.
 
 ## Supported Go versions
 
-This version of the project has been tested with Go 1.14 and higher.
+This version of the project has been tested with Go 1.16 and higher.
 
 ## Integration with easyjson
 
@@ -24,7 +20,7 @@ If you do not set the `launchdarkly_easyjson` build tag, `go-sdk-common` does no
 
 ## 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.
+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/github.com/launchdarkly/go-sdk-common/v3) for this project.
 
 ## Contributing
 

go.mod

@@ -1,10 +1,10 @@
-module gopkg.in/launchdarkly/go-sdk-common.v2
+module github.com/launchdarkly/go-sdk-common/v3
 
-go 1.13
+go 1.16
 
 require (
-	github.com/launchdarkly/go-test-helpers/v2 v2.2.0
+	github.com/launchdarkly/go-jsonstream/v2 v2.0.0
+	github.com/launchdarkly/go-test-helpers/v2 v2.3.1
 	github.com/mailru/easyjson v0.7.6
 	github.com/stretchr/testify v1.6.1
-	gopkg.in/launchdarkly/go-jsonstream.v1 v1.0.1
 )

go.sum

@@ -1,11 +1,12 @@
-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/launchdarkly/go-jsonstream/v2 v2.0.0 h1:5NBbJmQAiUVVfAGR6tPuMITGO2+8mxLD0Azyeqgq5Yw=
+github.com/launchdarkly/go-jsonstream/v2 v2.0.0/go.mod h1:8WhgeCtJdsc7VXg7tSzQmCYnw+nRAo5ReOLhVYcLiJk=
+github.com/launchdarkly/go-test-helpers/v2 v2.3.1 h1:KXUAQVTeHNcWVDVQ94uEkybI+URXI9rEd7E553EsZFw=
+github.com/launchdarkly/go-test-helpers/v2 v2.3.1/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=
@@ -16,8 +17,6 @@ github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd
 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.1 h1:aZHvMDAS+M6/0sRMkDBQ8MyLGsTQrNgN5evu5e8UYpQ=
-gopkg.in/launchdarkly/go-jsonstream.v1 v1.0.1/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=

internal/sharedtest/custom_attributes.go

@@ -0,0 +1,25 @@
+package sharedtest
+
+import (
+	"fmt"
+
+	"github.com/launchdarkly/go-sdk-common/v3/ldvalue"
+)
+
+const (
+	SmallNumberOfCustomAttributes = 2  //nolint:revive
+	LargeNumberOfCustomAttributes = 20 //nolint:revive
+)
+
+type NameAndLDValue struct { //nolint:revive
+	Name  string
+	Value ldvalue.Value
+}
+
+func MakeCustomAttributeNamesAndValues(count int) []NameAndLDValue { //nolint:revive
+	ret := make([]NameAndLDValue, 0, count)
+	for i := 1; i <= count; i++ {
+		ret = append(ret, NameAndLDValue{fmt.Sprintf("attr%d", i), ldvalue.String(fmt.Sprintf("value%d", i))})
+	}
+	return ret
+}

internal/sharedtest/old_user_test_data.go

@@ -0,0 +1,30 @@
+package sharedtest
+
+// These functions return standardized test inputs for unmarshaling JSON user data in the old user schema.
+
+type UnmarshalingTestParams struct { //nolint:revive
+	Name string
+	Data []byte
+}
+
+func MakeOldUserUnmarshalingTestParams() []UnmarshalingTestParams { //nolint:revive
+	return []UnmarshalingTestParams{
+		{"old user with key only", MakeOldUserWithKeyOnlyJSON()},
+		{"old user with few attrs", MakeOldUserWithFewAttributesJSON()},
+		{"old user with all attrs", MakeOldUserWithAllAttributesJSON()},
+	}
+}
+
+func MakeOldUserWithKeyOnlyJSON() []byte { //nolint:revive
+	return []byte(`{"key":"user-key"}`)
+}
+
+func MakeOldUserWithFewAttributesJSON() []byte { //nolint:revive
+	return []byte(`{"key":"user-key","name":"Name","email":"test@example.com","custom":{"attr":"value"}}`)
+}
+
+func MakeOldUserWithAllAttributesJSON() []byte { //nolint:revive
+	return []byte(`{"key":"user-key","secondary":"secondary-value","name":"Name","ip":"ip-value","country":"us",` +
+		`"email":"test@example.com","firstName":"First","lastName":"Last","avatar":"avatar-value","anonymous":true,` +
+		`"custom":{"attr":"value"}}`)
+}