chore: Remove several instances of WithLogger (influxdata#15996)

* chore: Remove several instances of WithLogger * chore: unexport Logger fields * chore: unexport some more Logger fields * chore: go fmt chore: fix test chore: s/logger/log chore: fix test chore: revert http.Handler.Handler constructor initialization * refactor: integrate review feedback, fix all test nop loggers * refactor: capitalize all log messages * refactor: rename two logger to log
xiaoruiguo · Dec 4, 2019 · 5f19c6c · 5f19c6c
1 parent 27e2531
commit 5f19c6c
Show file tree

Hide file tree

Showing 174 changed files with 1,331 additions and 1,336 deletions.
diff --git a/authorizer/task.go b/authorizer/task.go
@@ -35,15 +35,15 @@ var (
 
 type taskServiceValidator struct {
 	influxdb.TaskService
-	logger *zap.Logger
+	log *zap.Logger
 }
 
 // TaskService wraps ts and checks appropriate permissions before calling requested methods on ts.
 // Authorization failures are logged to the logger.
-func NewTaskService(logger *zap.Logger, ts influxdb.TaskService) influxdb.TaskService {
+func NewTaskService(log *zap.Logger, ts influxdb.TaskService) influxdb.TaskService {
 	return &taskServiceValidator{
 		TaskService: ts,
-		logger:      logger,
+		log:         log,
 	}
 }
 
@@ -79,7 +79,7 @@ func (ts *taskServiceValidator) FindTasks(ctx context.Context, filter influxdb.T
 	// We are getting a list of tasks that may be a superset of what the user is allowed to view.
 	auth, err := platcontext.GetAuthorizer(ctx)
 	if err != nil {
-		ts.logger.Info("Failed to retrieve authorizer from context", zap.String("method", "FindTasks"))
+		ts.log.Info("Failed to retrieve authorizer from context", zap.String("method", "FindTasks"))
 		return nil, 0, err
 	}
 
@@ -322,12 +322,12 @@ func (ts *taskServiceValidator) ForceRun(ctx context.Context, taskID influxdb.ID
 func (ts *taskServiceValidator) validatePermission(ctx context.Context, perm influxdb.Permission, loggerFields ...zap.Field) error {
 	auth, err := platcontext.GetAuthorizer(ctx)
 	if err != nil {
-		ts.logger.With(loggerFields...).Info("Failed to retrieve authorizer from context")
+		ts.log.With(loggerFields...).Info("Failed to retrieve authorizer from context")
 		return err
 	}
 
 	if !auth.Allowed(perm) {
-		ts.logger.With(loggerFields...).Info("Authorization failed",
+		ts.log.With(loggerFields...).Info("Authorization failed",
 			zap.String("user_id", auth.GetUserID().String()),
 			zap.String("auth_kind", auth.Kind()),
 			zap.String("auth_id", auth.Identifier().String()),

diff --git a/bolt/authorization_test.go b/bolt/authorization_test.go
@@ -10,7 +10,7 @@ import (
 )
 
 func initAuthorizationService(f platformtesting.AuthorizationFields, t *testing.T) (platform.AuthorizationService, string, func()) {
-	c, closeFn, err := NewTestClient()
+	c, closeFn, err := NewTestClient(t)
 	if err != nil {
 		t.Fatalf("failed to create new bolt client: %v", err)
 	}

diff --git a/bolt/bbolt.go b/bolt/bbolt.go
@@ -23,19 +23,19 @@ func getOp(op string) string {
 
 // Client is a client for the boltDB data store.
 type Client struct {
-	Path   string
-	db     *bolt.DB
-	Logger *zap.Logger
+	Path string
+	db   *bolt.DB
+	log  *zap.Logger
 
 	IDGenerator    platform.IDGenerator
 	TokenGenerator platform.TokenGenerator
 	platform.TimeGenerator
 }
 
 // NewClient returns an instance of a Client.
-func NewClient() *Client {
+func NewClient(log *zap.Logger) *Client {
 	return &Client{
-		Logger:         zap.NewNop(),
+		log:            log,
 		IDGenerator:    snowflake.NewIDGenerator(),
 		TokenGenerator: rand.NewTokenGenerator(64),
 		TimeGenerator:  platform.RealTimeGenerator{},
@@ -47,12 +47,6 @@ func (c *Client) DB() *bolt.DB {
 	return c.db
 }
 
-// WithLogger sets the logger an a client. It should not be called after
-// the client has been open.
-func (c *Client) WithLogger(l *zap.Logger) {
-	c.Logger = l
-}
-
 // Open / create boltDB file.
 func (c *Client) Open(ctx context.Context) error {
 	// Ensure the required directory structure exists.
@@ -75,7 +69,7 @@ func (c *Client) Open(ctx context.Context) error {
 		return err
 	}
 
-	c.Logger.Info("Resources opened", zap.String("path", c.Path))
+	c.log.Info("Resources opened", zap.String("path", c.Path))
 	return nil
 }
 

diff --git a/bolt/bbolt_test.go b/bolt/bbolt_test.go
@@ -9,15 +9,16 @@ import (
 	"testing"
 
 	"github.com/influxdata/influxdb/bolt"
+	"go.uber.org/zap/zaptest"
 	"golang.org/x/crypto/bcrypt"
 )
 
 func init() {
 	bolt.HashCost = bcrypt.MinCost
 }
 
-func NewTestClient() (*bolt.Client, func(), error) {
-	c, closeFn, err := newTestClient()
+func NewTestClient(t *testing.T) (*bolt.Client, func(), error) {
+	c, closeFn, err := newTestClient(t)
 	if err != nil {
 		return nil, nil, err
 	}
@@ -28,8 +29,8 @@ func NewTestClient() (*bolt.Client, func(), error) {
 	return c, closeFn, nil
 }
 
-func newTestClient() (*bolt.Client, func(), error) {
-	c := bolt.NewClient()
+func newTestClient(t *testing.T) (*bolt.Client, func(), error) {
+	c := bolt.NewClient(zaptest.NewLogger(t))
 
 	f, err := ioutil.TempFile("", "influxdata-platform-bolt-")
 	if err != nil {
@@ -61,7 +62,7 @@ func TestClientOpen(t *testing.T) {
 
 	boltFile := filepath.Join(tempDir, "test", "bolt.db")
 
-	c := bolt.NewClient()
+	c := bolt.NewClient(zaptest.NewLogger(t))
 	c.Path = boltFile
 
 	if err := c.Open(context.Background()); err != nil {
@@ -73,15 +74,15 @@ func TestClientOpen(t *testing.T) {
 	}
 }
 
-func NewTestKVStore() (*bolt.KVStore, func(), error) {
+func NewTestKVStore(t *testing.T) (*bolt.KVStore, func(), error) {
 	f, err := ioutil.TempFile("", "influxdata-platform-bolt-")
 	if err != nil {
 		return nil, nil, errors.New("unable to open temporary boltdb file")
 	}
 	f.Close()
 
 	path := f.Name()
-	s := bolt.NewKVStore(path)
+	s := bolt.NewKVStore(zaptest.NewLogger(t), path)
 	if err := s.Open(context.TODO()); err != nil {
 		return nil, nil, err
 	}

diff --git a/bolt/bucket_test.go b/bolt/bucket_test.go
@@ -10,7 +10,7 @@ import (
 )
 
 func initBucketService(f platformtesting.BucketFields, t *testing.T) (platform.BucketService, string, func()) {
-	c, closeFn, err := NewTestClient()
+	c, closeFn, err := NewTestClient(t)
 	if err != nil {
 		t.Fatalf("failed to create new bolt client: %v", err)
 	}

diff --git a/bolt/dashboard_test.go b/bolt/dashboard_test.go
@@ -10,7 +10,7 @@ import (
 )
 
 func initDashboardService(f platformtesting.DashboardFields, t *testing.T) (platform.DashboardService, string, func()) {
-	c, closeFn, err := NewTestClient()
+	c, closeFn, err := NewTestClient(t)
 	if err != nil {
 		t.Fatalf("failed to create new bolt client: %v", err)
 	}

diff --git a/bolt/id.go b/bolt/id.go
@@ -52,7 +52,7 @@ func (c *Client) ID() platform.ID {
 	})
 
 	if err != nil {
-		c.Logger.Error("unable to load id", zap.Error(err))
+		c.log.Error("Unable to load id", zap.Error(err))
 	}
 
 	return id

diff --git a/bolt/id_test.go b/bolt/id_test.go
@@ -8,7 +8,7 @@ import (
 )
 
 func TestID(t *testing.T) {
-	c, closeFn, err := newTestClient()
+	c, closeFn, err := newTestClient(t)
 	if err != nil {
 		t.Fatalf("failed to create new bolt client: %v", err)
 	}

diff --git a/bolt/keyvalue_log_test.go b/bolt/keyvalue_log_test.go
@@ -9,7 +9,7 @@ import (
 )
 
 func initKeyValueLog(f platformtesting.KeyValueLogFields, t *testing.T) (platform.KeyValueLog, func()) {
-	c, closeFn, err := NewTestClient()
+	c, closeFn, err := NewTestClient(t)
 	if err != nil {
 		t.Fatalf("failed to create new bolt client: %v", err)
 	}

diff --git a/bolt/kv.go b/bolt/kv.go
@@ -15,17 +15,17 @@ import (
 
 // KVStore is a kv.Store backed by boltdb.
 type KVStore struct {
-	path   string
-	db     *bolt.DB
-	logger *zap.Logger
+	path string
+	db   *bolt.DB
+	log  *zap.Logger
 }
 
 // NewKVStore returns an instance of KVStore with the file at
 // the provided path.
-func NewKVStore(path string) *KVStore {
+func NewKVStore(log *zap.Logger, path string) *KVStore {
 	return &KVStore{
-		path:   path,
-		logger: zap.NewNop(),
+		path: path,
+		log:  log,
 	}
 }
 
@@ -50,7 +50,7 @@ func (s *KVStore) Open(ctx context.Context) error {
 	}
 	s.db = db
 
-	s.logger.Info("Resources opened", zap.String("path", s.path))
+	s.log.Info("Resources opened", zap.String("path", s.path))
 	return nil
 }
 
@@ -89,11 +89,6 @@ func (s *KVStore) cleanBucket(tx *bolt.Tx, b *bolt.Bucket) {
 	}
 }
 
-// WithLogger sets the logger on the store.
-func (s *KVStore) WithLogger(l *zap.Logger) {
-	s.logger = l
-}
-
 // WithDB sets the boltdb on the store.
 func (s *KVStore) WithDB(db *bolt.DB) {
 	s.db = db

diff --git a/bolt/kv_test.go b/bolt/kv_test.go
@@ -9,7 +9,7 @@ import (
 )
 
 func initKVStore(f platformtesting.KVStoreFields, t *testing.T) (kv.Store, func()) {
-	s, closeFn, err := NewTestKVStore()
+	s, closeFn, err := NewTestKVStore(t)
 	if err != nil {
 		t.Fatalf("failed to create new kv store: %v", err)
 	}

diff --git a/bolt/lookup_service_test.go b/bolt/lookup_service_test.go
@@ -232,7 +232,7 @@ func TestClient_Name(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			c, done, err := NewTestClient()
+			c, done, err := NewTestClient(t)
 			if err != nil {
 				t.Fatalf("unable to create bolt test client: %v", err)
 			}

diff --git a/bolt/metrics_test.go b/bolt/metrics_test.go
@@ -7,16 +7,17 @@ import (
 	platform "github.com/influxdata/influxdb"
 	"github.com/influxdata/influxdb/kit/prom"
 	"github.com/influxdata/influxdb/kit/prom/promtest"
+	"go.uber.org/zap/zaptest"
 )
 
 func TestInitialMetrics(t *testing.T) {
-	client, teardown, err := NewTestClient()
+	client, teardown, err := NewTestClient(t)
 	if err != nil {
 		t.Fatalf("unable to setup bolt client: %v", err)
 	}
 	defer teardown()
 
-	reg := prom.NewRegistry()
+	reg := prom.NewRegistry(zaptest.NewLogger(t))
 	reg.MustRegister(client)
 
 	mfs, err := reg.Gather()
@@ -41,13 +42,13 @@ func TestInitialMetrics(t *testing.T) {
 }
 
 func TestMetrics_Onboarding(t *testing.T) {
-	client, teardown, err := NewTestClient()
+	client, teardown, err := NewTestClient(t)
 	if err != nil {
 		t.Fatalf("unable to setup bolt client: %v", err)
 	}
 	defer teardown()
 
-	reg := prom.NewRegistry()
+	reg := prom.NewRegistry(zaptest.NewLogger(t))
 	reg.MustRegister(client)
 
 	ctx := context.Background()

diff --git a/bolt/onboarding_test.go b/bolt/onboarding_test.go
@@ -9,7 +9,7 @@ import (
 )
 
 func initOnboardingService(f platformtesting.OnboardingFields, t *testing.T) (platform.OnboardingService, func()) {
-	c, closeFn, err := NewTestClient()
+	c, closeFn, err := NewTestClient(t)
 	if err != nil {
 		t.Fatalf("failed to create new bolt client: %v", err)
 	}

diff --git a/bolt/organization_test.go b/bolt/organization_test.go
@@ -10,7 +10,7 @@ import (
 )
 
 func initOrganizationService(f platformtesting.OrganizationFields, t *testing.T) (platform.OrganizationService, string, func()) {
-	c, closeFn, err := NewTestClient()
+	c, closeFn, err := NewTestClient(t)
 	if err != nil {
 		t.Fatalf("failed to create new bolt client: %v", err)
 	}

diff --git a/bolt/passwords_test.go b/bolt/passwords_test.go
@@ -9,7 +9,7 @@ import (
 )
 
 func initPasswordsService(f platformtesting.PasswordFields, t *testing.T) (platform.PasswordsService, func()) {
-	c, closeFn, err := NewTestClient()
+	c, closeFn, err := NewTestClient(t)
 	if err != nil {
 		t.Fatalf("failed to create new bolt client: %v", err)
 	}

diff --git a/bolt/scraper_test.go b/bolt/scraper_test.go
@@ -10,7 +10,7 @@ import (
 )
 
 func initScraperTargetStoreService(f platformtesting.TargetFields, t *testing.T) (platform.ScraperTargetStoreService, string, func()) {
-	c, closeFn, err := NewTestClient()
+	c, closeFn, err := NewTestClient(t)
 	if err != nil {
 		t.Fatalf("failed to create new bolt client: %v", err)
 	}

diff --git a/bolt/secret_test.go b/bolt/secret_test.go
@@ -9,7 +9,7 @@ import (
 )
 
 func initSecretService(f platformtesting.SecretServiceFields, t *testing.T) (platform.SecretService, func()) {
-	c, closeFn, err := NewTestClient()
+	c, closeFn, err := NewTestClient(t)
 	if err != nil {
 		t.Fatalf("failed to create new bolt client: %v", err)
 	}

diff --git a/bolt/session_test.go b/bolt/session_test.go
@@ -10,7 +10,7 @@ import (
 )
 
 func initSessionService(f platformtesting.SessionFields, t *testing.T) (platform.SessionService, string, func()) {
-	c, closeFn, err := NewTestClient()
+	c, closeFn, err := NewTestClient(t)
 	if err != nil {
 		t.Fatalf("failed to create new bolt client: %v", err)
 	}

diff --git a/bolt/source_test.go b/bolt/source_test.go
@@ -10,7 +10,7 @@ import (
 )
 
 func initSourceService(f platformtesting.SourceFields, t *testing.T) (platform.SourceService, string, func()) {
-	c, closeFn, err := NewTestClient()
+	c, closeFn, err := NewTestClient(t)
 	if err != nil {
 		t.Fatalf("failed to create new bolt client: %v", err)
 	}

diff --git a/bolt/telegraf_test.go b/bolt/telegraf_test.go
@@ -9,7 +9,7 @@ import (
 )
 
 func initTelegrafConfigStore(f platformtesting.TelegrafConfigFields, t *testing.T) (platform.TelegrafConfigStore, func()) {
-	c, closeFn, err := NewTestClient()
+	c, closeFn, err := NewTestClient(t)
 	if err != nil {
 		t.Fatalf("failed to create new bolt client: %v", err)
 	}

diff --git a/bolt/user_resource_mapping_test.go b/bolt/user_resource_mapping_test.go
@@ -9,7 +9,7 @@ import (
 )
 
 func initUserResourceMappingService(f platformtesting.UserResourceFields, t *testing.T) (platform.UserResourceMappingService, func()) {
-	c, closeFn, err := NewTestClient()
+	c, closeFn, err := NewTestClient(t)
 	if err != nil {
 		t.Fatalf("failed to create new bolt client: %v", err)
 	}

diff --git a/bolt/user_test.go b/bolt/user_test.go
@@ -10,7 +10,7 @@ import (
 )
 
 func initUserService(f influxdbtesting.UserFields, t *testing.T) (influxdb.UserService, string, func()) {
-	svc, closeFn, err := NewTestClient()
+	svc, closeFn, err := NewTestClient(t)
 	if err != nil {
 		t.Fatalf("failed to create new kv store: %v", err)
 	}