Enable Lint Rule: exported

.golangci.yml

@@ -222,9 +222,6 @@ linters-settings:
         # this is idiocy, promotes less readable code. Don't enable.
         - name: var-declaration
           disabled: true
-        # enable after cleanup: warns of stutter names
-        - name: exported
-          disabled: true
         # enable after cleanup
         - name: redefines-builtin-id
           disabled: true

cmd/jaeger/internal/extension/jaegerstorage/config.go

@@ -11,7 +11,7 @@ import (
 	memoryCfg "github.com/jaegertracing/jaeger/pkg/memory/config"
 	badgerCfg "github.com/jaegertracing/jaeger/plugin/storage/badger"
 	"github.com/jaegertracing/jaeger/plugin/storage/cassandra"
-	grpcCfg "github.com/jaegertracing/jaeger/plugin/storage/grpc/config"
+	grpcCfg "github.com/jaegertracing/jaeger/plugin/storage/grpc"
 )
 
 // Config has the configuration for jaeger-query,

cmd/jaeger/internal/extension/jaegerstorage/extension.go

@@ -20,7 +20,6 @@
 	"github.com/jaegertracing/jaeger/plugin/storage/cassandra"
 	"github.com/jaegertracing/jaeger/plugin/storage/es"
 	"github.com/jaegertracing/jaeger/plugin/storage/grpc"
-	grpcCfg "github.com/jaegertracing/jaeger/plugin/storage/grpc/config"
 	"github.com/jaegertracing/jaeger/plugin/storage/memory"
 	"github.com/jaegertracing/jaeger/storage"
 )
@@ -116,7 +115,7 @@
 		cfg:         s.config.Badger,
 		builder:     badger.NewFactoryWithConfig,
 	}
-	grpcStarter := &starter[grpcCfg.ConfigV2, *grpc.Factory]{
+	grpcStarter := &starter[grpc.ConfigV2, *grpc.Factory]{
 		ext:         s,
 		storageKind: "grpc",
 		cfg:         s.config.GRPC,

plugin/storage/es/dependencystore/storage.go

@@ -47,7 +47,7 @@ type DependencyStore struct {
 }
 
 // DependencyStoreParams holds constructor parameters for NewDependencyStore
-type DependencyStoreParams struct {
+type Params struct {
 	Client              func() es.Client
 	Logger              *zap.Logger
 	IndexPrefix         string
@@ -57,7 +57,7 @@ type DependencyStoreParams struct {
 }
 
 // NewDependencyStore returns a DependencyStore
-func NewDependencyStore(p DependencyStoreParams) *DependencyStore {
+func NewDependencyStore(p Params) *DependencyStore {
 	return &DependencyStore{
 		client:                p.Client,
 		logger:                p.Logger,

plugin/storage/es/dependencystore/storage_test.go

@@ -52,7 +52,7 @@ func withDepStorage(indexPrefix, indexDateLayout string, maxDocCount int, fn fun
 		client:    client,
 		logger:    logger,
 		logBuffer: logBuffer,
-		storage: NewDependencyStore(DependencyStoreParams{
+		storage: NewDependencyStore(Params{
 			Client:          func() es.Client { return client },
 			Logger:          logger,
 			IndexPrefix:     indexPrefix,
@@ -79,7 +79,7 @@ func TestNewSpanReaderIndexPrefix(t *testing.T) {
 	}
 	for _, testCase := range testCases {
 		client := &mocks.Client{}
-		r := NewDependencyStore(DependencyStoreParams{
+		r := NewDependencyStore(Params{
 			Client:          func() es.Client { return client },
 			Logger:          zap.NewNop(),
 			IndexPrefix:     testCase.prefix,
@@ -216,40 +216,40 @@ func TestGetReadIndices(t *testing.T) {
 	testCases := []struct {
 		indices  []string
 		lookback time.Duration
-		params   DependencyStoreParams
+		params   Params
 	}{
 		{
-			params:   DependencyStoreParams{IndexPrefix: "", IndexDateLayout: "2006-01-02", UseReadWriteAliases: true},
+			params:   Params{IndexPrefix: "", IndexDateLayout: "2006-01-02", UseReadWriteAliases: true},
 			lookback: 23 * time.Hour,
 			indices: []string{
 				dependencyIndex + "read",
 			},
 		},
 		{
-			params:   DependencyStoreParams{IndexPrefix: "", IndexDateLayout: "2006-01-02"},
+			params:   Params{IndexPrefix: "", IndexDateLayout: "2006-01-02"},
 			lookback: 23 * time.Hour,
 			indices: []string{
 				dependencyIndex + fixedTime.Format("2006-01-02"),
 				dependencyIndex + fixedTime.Add(-23*time.Hour).Format("2006-01-02"),
 			},
 		},
 		{
-			params:   DependencyStoreParams{IndexPrefix: "", IndexDateLayout: "2006-01-02"},
+			params:   Params{IndexPrefix: "", IndexDateLayout: "2006-01-02"},
 			lookback: 13 * time.Hour,
 			indices: []string{
 				dependencyIndex + fixedTime.UTC().Format("2006-01-02"),
 				dependencyIndex + fixedTime.Add(-13*time.Hour).Format("2006-01-02"),
 			},
 		},
 		{
-			params:   DependencyStoreParams{IndexPrefix: "foo:", IndexDateLayout: "2006-01-02"},
+			params:   Params{IndexPrefix: "foo:", IndexDateLayout: "2006-01-02"},
 			lookback: 1 * time.Hour,
 			indices: []string{
 				"foo:" + indexPrefixSeparator + dependencyIndex + fixedTime.Format("2006-01-02"),
 			},
 		},
 		{
-			params:   DependencyStoreParams{IndexPrefix: "foo-", IndexDateLayout: "2006-01-02"},
+			params:   Params{IndexPrefix: "foo-", IndexDateLayout: "2006-01-02"},
 			lookback: 0,
 			indices: []string{
 				"foo-" + indexPrefixSeparator + dependencyIndex + fixedTime.Format("2006-01-02"),
@@ -267,14 +267,14 @@ func TestGetWriteIndex(t *testing.T) {
 	testCases := []struct {
 		writeIndex string
 		lookback   time.Duration
-		params     DependencyStoreParams
+		params     Params
 	}{
 		{
-			params:     DependencyStoreParams{IndexPrefix: "", IndexDateLayout: "2006-01-02", UseReadWriteAliases: true},
+			params:     Params{IndexPrefix: "", IndexDateLayout: "2006-01-02", UseReadWriteAliases: true},
 			writeIndex: dependencyIndex + "write",
 		},
 		{
-			params:     DependencyStoreParams{IndexPrefix: "", IndexDateLayout: "2006-01-02", UseReadWriteAliases: false},
+			params:     Params{IndexPrefix: "", IndexDateLayout: "2006-01-02", UseReadWriteAliases: false},
 			writeIndex: dependencyIndex + fixedTime.Format("2006-01-02"),
 		},
 	}

plugin/storage/es/factory.go

@@ -297,7 +297,7 @@ func createSpanWriter(
 }
 
 func (f *Factory) CreateSamplingStore(maxBuckets int) (samplingstore.Store, error) {
-	params := esSampleStore.SamplingStoreParams{
+	params := esSampleStore.Params{
 		Client:                 f.getPrimaryClient,
 		Logger:                 f.logger,
 		IndexPrefix:            f.primaryConfig.IndexPrefix,
@@ -341,7 +341,7 @@ func createDependencyReader(
 	cfg *config.Configuration,
 	logger *zap.Logger,
 ) (dependencystore.Reader, error) {
-	reader := esDepStore.NewDependencyStore(esDepStore.DependencyStoreParams{
+	reader := esDepStore.NewDependencyStore(esDepStore.Params{
 		Client:              clientFn,
 		Logger:              logger,
 		IndexPrefix:         cfg.IndexPrefix,

plugin/storage/es/samplingstore/storage.go

@@ -45,7 +45,7 @@ type SamplingStore struct {
 	lookback               time.Duration
 }
 
-type SamplingStoreParams struct {
+type Params struct {
 	Client                 func() es.Client
 	Logger                 *zap.Logger
 	IndexPrefix            string
@@ -55,7 +55,7 @@ type SamplingStoreParams struct {
 	MaxDocCount            int
 }
 
-func NewSamplingStore(p SamplingStoreParams) *SamplingStore {
+func NewSamplingStore(p Params) *SamplingStore {
 	return &SamplingStore{
 		client:                 p.Client,
 		logger:                 p.Logger,
@@ -195,7 +195,7 @@ func getReadIndices(indexName, indexDateLayout string, startTime time.Time, endT
 	return indices
 }
 
-func (p *SamplingStoreParams) PrefixedIndexName() string {
+func (p *Params) PrefixedIndexName() string {
 	if p.IndexPrefix != "" {
 		return p.IndexPrefix + indexPrefixSeparator + samplingIndex
 	}

plugin/storage/es/samplingstore/storage_test.go

@@ -50,7 +50,7 @@ func withEsSampling(indexPrefix, indexDateLayout string, maxDocCount int, fn fun
 		client:    client,
 		logger:    logger,
 		logBuffer: logBuffer,
-		storage: NewSamplingStore(SamplingStoreParams{
+		storage: NewSamplingStore(Params{
 			Client:          func() es.Client { return client },
 			Logger:          logger,
 			IndexPrefix:     indexPrefix,
@@ -81,7 +81,7 @@ func TestNewIndexPrefix(t *testing.T) {
 	for _, test := range tests {
 		t.Run(test.name, func(t *testing.T) {
 			client := &mocks.Client{}
-			r := NewSamplingStore(SamplingStoreParams{
+			r := NewSamplingStore(Params{
 				Client:          func() es.Client { return client },
 				Logger:          zap.NewNop(),
 				IndexPrefix:     test.prefix,

plugin/storage/grpc/config/config.go → plugin/storage/grpc/config.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package config
+package grpc
 
 import (
 	"context"

plugin/storage/grpc/config/config_test.go → plugin/storage/grpc/config_test.go

@@ -1,7 +1,7 @@
 // Copyright (c) 2024 The Jaeger Authors.
 // SPDX-License-Identifier: Apache-2.0
 
-package config
+package grpc
 
 import (
 	"errors"

plugin/storage/grpc/factory.go

@@ -27,7 +27,6 @@ import (
 
 	"github.com/jaegertracing/jaeger/pkg/metrics"
 	"github.com/jaegertracing/jaeger/plugin"
-	"github.com/jaegertracing/jaeger/plugin/storage/grpc/config"
 	"github.com/jaegertracing/jaeger/storage"
 	"github.com/jaegertracing/jaeger/storage/dependencystore"
 	"github.com/jaegertracing/jaeger/storage/spanstore"
@@ -46,10 +45,10 @@ type Factory struct {
 	logger         *zap.Logger
 	tracerProvider trace.TracerProvider
 
-	configV1 config.Configuration
-	configV2 *config.ConfigV2
+	configV1 Configuration
+	configV2 *ConfigV2
 
-	services *config.ClientPluginServices
+	services *ClientPluginServices
 }
 
 // NewFactory creates a new Factory.
@@ -59,7 +58,7 @@ func NewFactory() *Factory {
 
 // NewFactoryWithConfig is used from jaeger(v2).
 func NewFactoryWithConfig(
-	cfg config.ConfigV2,
+	cfg ConfigV2,
 	metricsFactory metrics.Factory,
 	logger *zap.Logger,
 ) (*Factory, error) {

plugin/storage/grpc/factory_test.go

@@ -34,7 +34,6 @@ import (
 
 	"github.com/jaegertracing/jaeger/pkg/config"
 	"github.com/jaegertracing/jaeger/pkg/metrics"
-	grpcConfig "github.com/jaegertracing/jaeger/plugin/storage/grpc/config"
 	"github.com/jaegertracing/jaeger/plugin/storage/grpc/mocks"
 	"github.com/jaegertracing/jaeger/plugin/storage/grpc/shared"
 	"github.com/jaegertracing/jaeger/storage"
@@ -74,8 +73,8 @@ func (s *store) StreamingSpanWriter() spanstore.Writer {
 	return s.writer
 }
 
-func makeMockServices() *grpcConfig.ClientPluginServices {
-	return &grpcConfig.ClientPluginServices{
+func makeMockServices() *ClientPluginServices {
+	return &ClientPluginServices{
 		PluginServices: shared.PluginServices{
 			Store: &store{
 				writer: new(spanStoreMocks.Writer),
@@ -110,7 +109,7 @@ func makeFactory(t *testing.T) *Factory {
 }
 
 func TestNewFactoryError(t *testing.T) {
-	cfg := &grpcConfig.ConfigV2{
+	cfg := &ConfigV2{
 		ClientConfig: configgrpc.ClientConfig{
 			// non-empty Auth is currently not supported
 			Auth: &configauth.Authentication{},
@@ -161,7 +160,7 @@ func TestGRPCStorageFactoryWithConfig(t *testing.T) {
 	}()
 	defer s.Stop()
 
-	cfg := grpcConfig.ConfigV2{
+	cfg := ConfigV2{
 		ClientConfig: configgrpc.ClientConfig{
 			Endpoint: lis.Addr().String(),
 		},

plugin/storage/grpc/options.go

@@ -23,7 +23,6 @@ import (
 
 	"github.com/jaegertracing/jaeger/pkg/config/tlscfg"
 	"github.com/jaegertracing/jaeger/pkg/tenancy"
-	"github.com/jaegertracing/jaeger/plugin/storage/grpc/config"
 )
 
 const (
@@ -47,7 +46,7 @@ func v1AddFlags(flagSet *flag.FlagSet) {
 	flagSet.Duration(remoteConnectionTimeout, defaultConnectionTimeout, "The remote storage gRPC server connection timeout")
 }
 
-func v1InitFromViper(cfg *config.Configuration, v *viper.Viper) error {
+func v1InitFromViper(cfg *Configuration, v *viper.Viper) error {
 	cfg.RemoteServerAddr = v.GetString(remoteServer)
 	var err error
 	cfg.RemoteTLS, err = tlsFlagsConfig().InitFromViper(v)

plugin/storage/grpc/options_test.go

@@ -23,7 +23,6 @@ import (
 
 	"github.com/jaegertracing/jaeger/pkg/config"
 	"github.com/jaegertracing/jaeger/pkg/tenancy"
-	grpccfg "github.com/jaegertracing/jaeger/plugin/storage/grpc/config"
 )
 
 func TestOptionsWithFlags(t *testing.T) {
@@ -33,7 +32,7 @@ func TestOptionsWithFlags(t *testing.T) {
 		"--multi-tenancy.header=x-scope-orgid",
 	})
 	require.NoError(t, err)
-	var cfg grpccfg.Configuration
+	var cfg Configuration
 	require.NoError(t, v1InitFromViper(&cfg, v))
 
 	assert.Equal(t, "foo:12345", cfg.RemoteServerAddr)
@@ -49,7 +48,7 @@ func TestRemoteOptionsWithFlags(t *testing.T) {
 		"--grpc-storage.connection-timeout=60s",
 	})
 	require.NoError(t, err)
-	var cfg grpccfg.Configuration
+	var cfg Configuration
 	require.NoError(t, v1InitFromViper(&cfg, v))
 
 	assert.Equal(t, "localhost:2001", cfg.RemoteServerAddr)
@@ -65,7 +64,7 @@ func TestRemoteOptionsNoTLSWithFlags(t *testing.T) {
 		"--grpc-storage.connection-timeout=60s",
 	})
 	require.NoError(t, err)
-	var cfg grpccfg.Configuration
+	var cfg Configuration
 	require.NoError(t, v1InitFromViper(&cfg, v))
 
 	assert.Equal(t, "localhost:2001", cfg.RemoteServerAddr)
@@ -80,7 +79,7 @@ func TestFailedTLSFlags(t *testing.T) {
 		"--grpc-storage.tls.cert=blah", // invalid unless tls.enabled=true
 	})
 	require.NoError(t, err)
-	var cfg grpccfg.Configuration
+	var cfg Configuration
 	err = v1InitFromViper(&cfg, v)
 	require.Error(t, err)
 	assert.Contains(t, err.Error(), "failed to parse gRPC storage TLS options")