Fixing lint issue

keelerm84 · keelerm84 · commit 1720df144110 · 2024-09-17T17:18:10.000-04:00
diff --git a/framework/helpers/channels_test.go b/framework/helpers/channels_test.go
@@ -4,8 +4,9 @@ import (
 	"testing"
 	"time"
 
-	"github.com/launchdarkly/sdk-test-harness/v2/framework/opt"
 	"github.com/stretchr/testify/assert"
+
+	"github.com/launchdarkly/sdk-test-harness/v2/framework/opt"
 )
 
 func TestNonBlockingSend(t *testing.T) {
diff --git a/framework/ldtest/errors_test.go b/framework/ldtest/errors_test.go
@@ -3,9 +3,10 @@ package ldtest
 import (
 	"testing"
 
-	"github.com/launchdarkly/sdk-test-harness/v2/framework/ldtest/internal"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+
+	"github.com/launchdarkly/sdk-test-harness/v2/framework/ldtest/internal"
 )
 
 func TestStacktrace(t *testing.T) {
diff --git a/framework/types.go b/framework/types.go
@@ -49,6 +49,7 @@ type PayloadTransferred struct {
 	Version int    `json:"version"`
 }
 
+//nolint:godox
 // TODO: Todd doesn't have this in his spec. What are we going to do here?
 
 type ErrorEvent struct {
diff --git a/mockld/polling_service.go b/mockld/polling_service.go
@@ -171,7 +171,9 @@ func (p *PollingService) standardPollingHandler() http.Handler {
 		}
 
 		payloadTransferred := framework.PayloadTransferred{
-			State:   "state", // TODO: Need to replace this with a valid state value
+			//nolint:godox
+			// TODO: Need to replace this with a valid state value
+			State:   "state",
 			Version: 1,
 		}
 
@@ -207,6 +209,7 @@ func (p *PollingService) standardPollingHandler() http.Handler {
 
 func (p *PollingService) phpFlagHandler() http.Handler {
 	return p.pollingHandler(func(p *PollingService, r *http.Request) []byte {
+		//nolint:godox
 		// TODO: Update this logic
 		return []byte("UNSUPPORTED")
 		// data, _ := p.currentData.(ServerSDKData)
@@ -216,6 +219,7 @@ func (p *PollingService) phpFlagHandler() http.Handler {
 
 func (p *PollingService) phpSegmentHandler() http.Handler {
 	return p.pollingHandler(func(p *PollingService, r *http.Request) []byte {
+		//nolint:godox
 		// TODO: Update this logic
 		return []byte("UNSUPPORTED")
 		// data, _ := p.currentData.(ServerSDKData)
@@ -225,6 +229,7 @@ func (p *PollingService) phpSegmentHandler() http.Handler {
 
 func (p *PollingService) phpAllFlagsHandler() http.Handler {
 	return p.pollingHandler(func(p *PollingService, r *http.Request) []byte {
+		//nolint:godox
 		// TODO: Update this logic
 		return []byte("UNSUPPORTED")
 		// data, _ := p.currentData.(ServerSDKData)
diff --git a/mockld/sdk_data.go b/mockld/sdk_data.go
@@ -71,10 +71,10 @@ func (b blockingUnavailableSDKData) Serialize() []byte { return nil }
 // We use this for both regular server-side SDKs and the PHP SDK.
 type ServerSDKData map[DataItemKind]map[string]json.RawMessage
 
-func (s ServerSDKData) ConvertToFDv2SDKData(t *ldtest.T) FDv2SDKData {
+func (d ServerSDKData) ConvertToFDv2SDKData(t *ldtest.T) FDv2SDKData {
 	payloadObjects := make([]framework.BaseObject, 0)
 
-	for kind, items := range s {
+	for kind, items := range d {
 		for key, item := range items {
 			payloadObjects = append(payloadObjects, framework.BaseObject{
 				Kind:    string(kind),
@@ -222,7 +222,9 @@ func (b *ServerSDKDataBuilder) Build() FDv2SDKData {
 	events := make([]framework.BaseObject, 0, len(flags)+len(segments))
 	for key, flag := range flags {
 		events = append(events, framework.BaseObject{
-			Version: 1, // TODO: We have to deal with this version at some point
+			//nolint:godox
+			// TODO: We have to deal with this version at some point
+			Version: 1,
 			Kind:    "flag",
 			Key:     key,
 			Object:  flag,
@@ -231,7 +233,9 @@ func (b *ServerSDKDataBuilder) Build() FDv2SDKData {
 
 	for key, segment := range segments {
 		events = append(events, framework.BaseObject{
-			Version: 1, // TODO: We have to deal with this version at some point
+			//nolint:godox
+			// TODO: We have to deal with this version at some point
+			Version: 1,
 			Kind:    "segment",
 			Key:     key,
 			Object:  segment,
diff --git a/mockld/streaming_service.go b/mockld/streaming_service.go
@@ -143,7 +143,9 @@ func (s *StreamingService) makeXferFull() []eventsource.Event {
 
 	// QUESTION: How dynamic do we need to bother making this?
 	payloadTransferred := framework.PayloadTransferred{
-		State:   "state", // TODO: Need to replace this with a valid state value
+		//nolint:godox
+		// TODO: Need to replace this with a valid state value
+		State:   "state",
 		Version: 1,
 	}
 
@@ -236,6 +238,7 @@ func (s *StreamingService) PushDelete(namespace, key string, version int) {
 			panic(errClientSideStreamCanOnlyUseFlags)
 		}
 
+		//nolint:godox
 		// TODO: Update this to match whatever the client fdv2 format should look like
 		eventData = map[string]interface{}{
 			"key":     key,
diff --git a/sdktests/client_side_events_eval.go b/sdktests/client_side_events_eval.go
@@ -3,12 +3,13 @@ package sdktests
 import (
 	"time"
 
+	"github.com/stretchr/testify/require"
+
 	"github.com/launchdarkly/sdk-test-harness/v2/data"
 	h "github.com/launchdarkly/sdk-test-harness/v2/framework/helpers"
 	"github.com/launchdarkly/sdk-test-harness/v2/framework/ldtest"
 	"github.com/launchdarkly/sdk-test-harness/v2/mockld"
 	"github.com/launchdarkly/sdk-test-harness/v2/servicedef"
-	"github.com/stretchr/testify/require"
 
 	"github.com/launchdarkly/go-sdk-common/v3/ldcontext"
 	"github.com/launchdarkly/go-sdk-common/v3/ldreason"
diff --git a/sdktests/common_tests_eval.go b/sdktests/common_tests_eval.go
@@ -1,13 +1,14 @@
 package sdktests
 
 import (
+	"github.com/stretchr/testify/require"
+
 	"github.com/launchdarkly/sdk-test-harness/v2/data"
 	"github.com/launchdarkly/sdk-test-harness/v2/data/testmodel"
 	"github.com/launchdarkly/sdk-test-harness/v2/framework/ldtest"
 	o "github.com/launchdarkly/sdk-test-harness/v2/framework/opt"
 	"github.com/launchdarkly/sdk-test-harness/v2/mockld"
 	"github.com/launchdarkly/sdk-test-harness/v2/servicedef"
-	"github.com/stretchr/testify/require"
 
 	"github.com/launchdarkly/go-sdk-common/v3/ldcontext"
 	"github.com/launchdarkly/go-sdk-common/v3/ldreason"
diff --git a/sdktests/common_tests_hooks.go b/sdktests/common_tests_hooks.go
@@ -10,12 +10,13 @@ import (
 	"github.com/launchdarkly/go-server-sdk-evaluation/v3/ldbuilders"
 	"github.com/launchdarkly/go-server-sdk-evaluation/v3/ldmodel"
 
+	"github.com/stretchr/testify/assert"
+
 	"github.com/launchdarkly/sdk-test-harness/v2/data"
 	"github.com/launchdarkly/sdk-test-harness/v2/framework/ldtest"
 	o "github.com/launchdarkly/sdk-test-harness/v2/framework/opt"
 	"github.com/launchdarkly/sdk-test-harness/v2/mockld"
 	"github.com/launchdarkly/sdk-test-harness/v2/servicedef"
-	"github.com/stretchr/testify/assert"
 )
 
 func doCommonHooksTests(t *ldtest.T) {
diff --git a/sdktests/common_tests_stream_updates.go b/sdktests/common_tests_stream_updates.go
@@ -133,7 +133,8 @@ func (c CommonStreamingTests) Updates(t *ldtest.T) {
 					if isDelete {
 						stream.StreamingService().PushDelete("segment", segmentKey, versionAfter)
 					} else {
-						stream.StreamingService().PushUpdate("segment", segmentKey, segmentAfter.Version, jsonhelpers.ToJSON(segmentAfter))
+						stream.StreamingService().PushUpdate(
+							"segment", segmentKey, segmentAfter.Version, jsonhelpers.ToJSON(segmentAfter))
 					}
 					stateVersion++
 					stream.StreamingService().PushPayloadTransferred("state", stateVersion)
diff --git a/sdktests/custom_matchers_contexts_test.go b/sdktests/custom_matchers_contexts_test.go
@@ -4,9 +4,10 @@ import (
 	"encoding/json"
 	"testing"
 
+	"github.com/stretchr/testify/require"
+
 	"github.com/launchdarkly/go-sdk-common/v3/ldcontext"
 	m "github.com/launchdarkly/go-test-helpers/v2/matchers"
-	"github.com/stretchr/testify/require"
 )
 
 func TestJSONMatchesContext(t *testing.T) {
diff --git a/sdktests/server_side_events_summary.go b/sdktests/server_side_events_summary.go
@@ -451,6 +451,7 @@ func doServerSideSummaryEventVersionTest(t *ldtest.T) {
 	m.In(t).Require(initialValue, m.JSONEqual(valueBefore))
 
 	dataSource.StreamingService().PushUpdate("flag", flagKey, flagAfter.Version, jsonhelpers.ToJSON(flagAfter))
+	//nolint:godox
 	// TODO: Need to determine which version this should be, and also what the state should be
 	dataSource.StreamingService().PushPayloadTransferred("state", 2)
 
diff --git a/sdktests/server_side_stream_validation.go b/sdktests/server_side_stream_validation.go
@@ -59,16 +59,19 @@ func doServerSideStreamValidationTests(t *ldtest.T) {
 			shouldDropAndReconnectAfterEvent(t, "server-intent", []byte(`{sorry`))
 		})
 
+		//nolint:godox
 		// TODO: Update these tests. We aren't decoding the JSON as early, so the behavior might not be right here, or it might not be right in the SDK. need to investigatright in the SDK. Need to investigate.
 		// t.Run("put-object event", func(t *ldtest.T) {
 		// 	shouldDropAndReconnectAfterEvent(t, "put-object", []byte(`{sorry`))
 		// })
 
+		//nolint:godox
 		// TODO: Update these tests. We aren't decoding the JSON as early, so the behavior might not be right here, or it might not be right in the SDK. need to investigatright in the SDK. Need to investigate.
 		// t.Run("delete event", func(t *ldtest.T) {
 		// 	shouldDropAndReconnectAfterEvent(t, "delete-object", []byte(`{sorry`))
 		// })
 
+		//nolint:godox
 		// TODO: Add more fdv2 event types
 	})
 
@@ -77,16 +80,19 @@ func doServerSideStreamValidationTests(t *ldtest.T) {
 			shouldDropAndReconnectAfterEvent(t, "server-intent", []byte(`{"data":{"flags": true, "segments":{}}}`))
 		})
 
+		//nolint:godox
 		// TODO: Update these tests. We aren't decoding the JSON as early, so the behavior might not be right here, or it might not be right in the SDK. need to investigatright in the SDK. Need to investigate.
 		// t.Run("put event", func(t *ldtest.T) {
 		// 	shouldDropAndReconnectAfterEvent(t, "put-object", []byte(`{"path":"/flags/x","data":true}`))
 		// })
 
+		//nolint:godox
 		// TODO: Update these tests. We aren't decoding the JSON as early, so the behavior might not be right here, or it might not be right in the SDK. need to investigatright in the SDK. Need to investigate.
 		// t.Run("delete event", func(t *ldtest.T) {
 		// 	shouldDropAndReconnectAfterEvent(t, "delete-object", []byte(`{"path":"/flags/x","version":"no"`))
 		// })
 
+		//nolint:godox
 		// TODO: Add more fdv2 event types
 	})
 
@@ -107,6 +113,7 @@ func doServerSideStreamValidationTests(t *ldtest.T) {
 
 		// Then, push a patch event, so we can detect if the SDK continued processing the stream as it should
 		dataSource.StreamingService().PushUpdate("flag", flagKey, flagV2.Version, jsonhelpers.ToJSON(flagV2))
+		//nolint:godox
 		// TODO: Need to determine which version this should be, and also what the state should be
 		dataSource.StreamingService().PushPayloadTransferred("state", 2)
 
diff --git a/sdktests/testapi_sdk_data.go b/sdktests/testapi_sdk_data.go
@@ -5,13 +5,14 @@ import (
 	"errors"
 	"net/http"
 
+	"github.com/stretchr/testify/require"
+
 	"github.com/launchdarkly/sdk-test-harness/v2/framework/harness"
 	"github.com/launchdarkly/sdk-test-harness/v2/framework/helpers"
 	"github.com/launchdarkly/sdk-test-harness/v2/framework/ldtest"
 	o "github.com/launchdarkly/sdk-test-harness/v2/framework/opt"
 	"github.com/launchdarkly/sdk-test-harness/v2/mockld"
 	"github.com/launchdarkly/sdk-test-harness/v2/servicedef"
-	"github.com/stretchr/testify/require"
 )
 
 // SDKDataSource is a test fixture that provides a callback endpoint for SDK clients to connect to,

Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,9 @@ import (`
`4`	`4`	`"testing"`
`5`	`5`	`"time"`
`6`	`6`
`7`		`- "github.com/launchdarkly/sdk-test-harness/v2/framework/opt"`
`8`	`7`	`"github.com/stretchr/testify/assert"`
	`8`	`+`
	`9`	`+ "github.com/launchdarkly/sdk-test-harness/v2/framework/opt"`
`9`	`10`	`)`
`10`	`11`
`11`	`12`	`func TestNonBlockingSend(t *testing.T) {`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,7 @@ type PayloadTransferred struct {`
`49`	`49`	Version int `json:"version"`
`50`	`50`	`}`
`51`	`51`
	`52`	`+//nolint:godox`
`52`	`53`	`// TODO: Todd doesn't have this in his spec. What are we going to do here?`
`53`	`54`
`54`	`55`	`type ErrorEvent struct {`