[common/log] Unify logger package

bench/lib/context.go

@@ -24,7 +24,7 @@ import (
 	"github.com/uber-go/tally"
 	"go.uber.org/zap"
 
-	"github.com/uber/cadence/common/log/loggerimpl"
+	"github.com/uber/cadence/common/log"
 )
 
 const (
@@ -59,7 +59,7 @@ func NewRuntimeContext(cfg *Config) (*RuntimeContext, error) {
 		return nil, err
 	}
 
-	metricsScope := cfg.Metrics.NewScope(loggerimpl.NewLogger(logger), cfg.Bench.Name)
+	metricsScope := cfg.Metrics.NewScope(log.NewLogger(logger), cfg.Bench.Name)
 
 	if cfg.Cadence.ServiceName == "" {
 		cfg.Cadence.ServiceName = defaultCadenceServiceName

canary/runner.go

@@ -40,7 +40,7 @@ import (
 	"go.uber.org/zap"
 	"google.golang.org/grpc/credentials"
 
-	"github.com/uber/cadence/common/log/loggerimpl"
+	"github.com/uber/cadence/common/log"
 )
 
 type canaryRunner struct {
@@ -56,7 +56,7 @@ func NewCanaryRunner(cfg *Config) (Runnable, error) {
 		return nil, fmt.Errorf("failed to create logger: %v", err)
 	}
 
-	metricsScope := cfg.Metrics.NewScope(loggerimpl.NewLogger(logger), "cadence-canary")
+	metricsScope := cfg.Metrics.NewScope(log.NewLogger(logger), "cadence-canary")
 
 	if cfg.Cadence.ServiceName == "" {
 		cfg.Cadence.ServiceName = CadenceServiceName

cmd/server/cadence/server.go

@@ -49,7 +49,6 @@ import (
 	"github.com/uber/cadence/common/elasticsearch"
 	"github.com/uber/cadence/common/isolationgroup/isolationgroupapi"
 	cadencelog "github.com/uber/cadence/common/log"
-	"github.com/uber/cadence/common/log/loggerimpl"
 	"github.com/uber/cadence/common/log/tag"
 	"github.com/uber/cadence/common/membership"
 	"github.com/uber/cadence/common/messaging/kafka"
@@ -129,7 +128,7 @@ func (s *server) startService() common.Daemon {
 	if err != nil {
 		log.Fatal("failed to create the zap logger, err: ", err.Error())
 	}
-	params.Logger = loggerimpl.NewLogger(zapLogger).WithTags(tag.Service(params.Name))
+	params.Logger = cadencelog.NewLogger(zapLogger).WithTags(tag.Service(params.Name))
 
 	params.PersistenceConfig = s.cfg.Persistence
 

cmd/server/cadence/server_test.go

@@ -24,7 +24,6 @@
 package cadence
 
 import (
-	"log"
 	"os"
 	"testing"
 	"time"
@@ -37,7 +36,9 @@ import (
 	"github.com/uber/cadence/common"
 	"github.com/uber/cadence/common/config"
 	"github.com/uber/cadence/common/dynamicconfig"
-	"github.com/uber/cadence/common/log/loggerimpl"
+	"github.com/uber/cadence/common/log"
+	"github.com/uber/cadence/common/log/tag"
+	"github.com/uber/cadence/common/log/testlogger"
 	"github.com/uber/cadence/common/persistence/nosql/nosqlplugin/cassandra/gocql"
 	"github.com/uber/cadence/common/resource"
 	"github.com/uber/cadence/common/service"
@@ -51,6 +52,8 @@ import (
 type ServerSuite struct {
 	*require.Assertions
 	suite.Suite
+
+	logger log.Logger
 }
 
 func TestServerSuite(t *testing.T) {
@@ -60,6 +63,7 @@ func TestServerSuite(t *testing.T) {
 
 func (s *ServerSuite) SetupTest() {
 	s.Assertions = require.New(s.T())
+	s.logger = testlogger.New(s.T())
 }
 
 /*
@@ -77,7 +81,7 @@ func (s *ServerSuite) TestServerStartup() {
 	var cfg config.Config
 	err := config.Load(env, configDir, zone, &cfg)
 	if err != nil {
-		log.Fatal("Config file corrupted.", err)
+		s.logger.Fatal("Config file corrupted.", tag.Error(err))
 	}
 
 	if os.Getenv("CASSANDRA_SEEDS") == "cassandra" {
@@ -97,11 +101,11 @@ func (s *ServerSuite) TestServerStartup() {
 	cfg.DynamicConfig.FileBased.Filepath = constructPathIfNeed(rootDir, cfg.DynamicConfig.FileBased.Filepath)
 
 	if err := cfg.ValidateAndFillDefaults(); err != nil {
-		log.Fatalf("config validation failed: %v", err)
+		s.logger.Fatal("config validation failed", tag.Error(err))
 	}
 	// cassandra schema version validation
 	if err := cassandra.VerifyCompatibleVersion(cfg.Persistence, gocql.All); err != nil {
-		log.Fatal("cassandra schema version compatibility check failed: ", err)
+		s.logger.Fatal("cassandra schema version compatibility check failed", tag.Error(err))
 	}
 
 	var daemons []common.Daemon
@@ -128,11 +132,11 @@ func TestSettingGettingZonalIsolationGroupsFromIG(t *testing.T) {
 		"zone-1", "zone-2",
 	}, nil)
 
-	dc := dynamicconfig.NewCollection(client, loggerimpl.NewNopLogger())
+	dc := dynamicconfig.NewCollection(client, log.NewNoop())
 
 	assert.NotPanics(t, func() {
 		fn := getFromDynamicConfig(resource.Params{
-			Logger: loggerimpl.NewNopLogger(),
+			Logger: log.NewNoop(),
 		}, dc)
 		out := fn()
 		assert.Equal(t, []string{"zone-1", "zone-2"}, out)
@@ -143,11 +147,11 @@ func TestSettingGettingZonalIsolationGroupsFromIGError(t *testing.T) {
 	ctrl := gomock.NewController(t)
 	client := dynamicconfig.NewMockClient(ctrl)
 	client.EXPECT().GetListValue(dynamicconfig.AllIsolationGroups, gomock.Any()).Return(nil, assert.AnError)
-	dc := dynamicconfig.NewCollection(client, loggerimpl.NewNopLogger())
+	dc := dynamicconfig.NewCollection(client, log.NewNoop())
 
 	assert.NotPanics(t, func() {
 		getFromDynamicConfig(resource.Params{
-			Logger: loggerimpl.NewNopLogger(),
+			Logger: log.NewNoop(),
 		}, dc)()
 	})
 }

common/cluster/metadata_test.go

@@ -31,7 +31,7 @@ import (
 	"github.com/stretchr/testify/require"
 
 	"github.com/uber/cadence/common/config"
-	"github.com/uber/cadence/common/log/loggerimpl"
+	"github.com/uber/cadence/common/log"
 	"github.com/uber/cadence/common/log/testlogger"
 	"github.com/uber/cadence/common/metrics"
 )
@@ -226,7 +226,7 @@ func TestResolvingClusterVersion(t *testing.T) {
 			initialFailoverVersionC2: clusterName2,
 		},
 		metrics: metrics.NewNoopMetricsClient().Scope(0),
-		log:     loggerimpl.NewNopLogger(),
+		log:     log.NewNoop(),
 	}
 
 	for name, td := range tests {
@@ -290,7 +290,7 @@ func TestIsPartOfTheSameCluster(t *testing.T) {
 					initialFailoverVersionC1: clusterName1,
 					initialFailoverVersionC2: clusterName2,
 				},
-				log:     loggerimpl.NewNopLogger(),
+				log:     log.NewNoop(),
 				metrics: metrics.NewNoopMetricsClient().Scope(0),
 			}
 
@@ -532,7 +532,7 @@ func TestIsPartOfTheSameClusterAPIFixing(t *testing.T) {
 		},
 		useNewFailoverVersionOverride: func(domain string) bool { return false },
 		metrics:                       metrics.NewNoopMetricsClient().Scope(0),
-		log:                           loggerimpl.NewNopLogger(),
+		log:                           log.NewNoop(),
 	}
 
 	for i := range tests {
@@ -774,7 +774,7 @@ func TestClusterNameForFailoverVersion(t *testing.T) {
 		},
 		metrics:                       metrics.NewNoopMetricsClient().Scope(0),
 		useNewFailoverVersionOverride: func(domain string) bool { return false },
-		log:                           loggerimpl.NewNopLogger(),
+		log:                           log.NewNoop(),
 	}
 
 	for i := range tests {
@@ -811,7 +811,7 @@ func TestServerResolution(t *testing.T) {
 		},
 		metrics:                       metrics.NewNoopMetricsClient().Scope(0),
 		useNewFailoverVersionOverride: func(domain string) bool { return domain == domainToMigrate },
-		log:                           loggerimpl.NewNopLogger(),
+		log:                           log.NewNoop(),
 	}
 
 	err := quick.Check(func(currentFOVersion int64, migrateDomain bool) bool {
@@ -876,7 +876,7 @@ func TestNoChangesInUnmigratedState(t *testing.T) {
 		},
 		metrics:                       metrics.NewNoopMetricsClient().Scope(0),
 		useNewFailoverVersionOverride: func(domain string) bool { return false },
-		log:                           loggerimpl.NewNopLogger(),
+		log:                           log.NewNoop(),
 	}
 
 	err := quick.CheckEqual(func(currVersion int64) int64 {
@@ -920,7 +920,7 @@ func TestFailoverVersionResolution(t *testing.T) {
 		},
 		metrics:                       metrics.NewNoopMetricsClient().Scope(0),
 		useNewFailoverVersionOverride: func(domain string) bool { return false },
-		log:                           loggerimpl.NewNopLogger(),
+		log:                           log.NewNoop(),
 	}
 
 	tests := map[string]struct {

common/cluster/metadata_test_utils.go

@@ -22,7 +22,7 @@ package cluster
 
 import (
 	"github.com/uber/cadence/common/config"
-	"github.com/uber/cadence/common/log/loggerimpl"
+	"github.com/uber/cadence/common/log"
 	commonMetrics "github.com/uber/cadence/common/metrics"
 	"github.com/uber/cadence/common/service"
 )
@@ -96,7 +96,7 @@ var (
 		TestAllClusterInfo,
 		func(d string) bool { return false },
 		commonMetrics.NewNoopMetricsClient(),
-		loggerimpl.NewNopLogger(),
+		log.NewNoop(),
 	)
 
 	// TestPassiveClusterMetadata is metadata for a passive cluster
@@ -107,7 +107,7 @@ var (
 		TestAllClusterInfo,
 		func(d string) bool { return false },
 		commonMetrics.NewNoopMetricsClient(),
-		loggerimpl.NewNopLogger(),
+		log.NewNoop(),
 	)
 )
 
@@ -125,6 +125,6 @@ func GetTestClusterMetadata(isPrimaryCluster bool) Metadata {
 		TestAllClusterInfo,
 		func(d string) bool { return false },
 		commonMetrics.NewNoopMetricsClient(),
-		loggerimpl.NewNopLogger(),
+		log.NewNoop(),
 	)
 }

common/quotas/dynamicratelimiterfactory.go → common/dynamicconfig/quotas/dynamicratelimiterfactory.go

@@ -20,23 +20,16 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
-//go:generate mockgen -package=$GOPACKAGE -destination=limiterfactory_mock.go github.com/uber/cadence/common/quotas LimiterFactory
-
 package quotas
 
 import (
 	"github.com/uber/cadence/common/dynamicconfig"
+	"github.com/uber/cadence/common/quotas"
 )
 
-// LimiterFactory is used to create a Limiter for a given domain
-type LimiterFactory interface {
-	// GetLimiter returns a new Limiter for the given domain
-	GetLimiter(domain string) Limiter
-}
-
 // NewSimpleDynamicRateLimiterFactory creates a new LimiterFactory which creates
 // a new DynamicRateLimiter for each domain, the RPS for the DynamicRateLimiter is given by the dynamic config
-func NewSimpleDynamicRateLimiterFactory(rps dynamicconfig.IntPropertyFnWithDomainFilter) LimiterFactory {
+func NewSimpleDynamicRateLimiterFactory(rps dynamicconfig.IntPropertyFnWithDomainFilter) quotas.LimiterFactory {
 	return dynamicRateLimiterFactory{
 		rps: rps,
 	}
@@ -47,6 +40,6 @@ type dynamicRateLimiterFactory struct {
 }
 
 // GetLimiter returns a new Limiter for the given domain
-func (f dynamicRateLimiterFactory) GetLimiter(domain string) Limiter {
-	return NewDynamicRateLimiter(func() float64 { return float64(f.rps(domain)) })
+func (f dynamicRateLimiterFactory) GetLimiter(domain string) quotas.Limiter {
+	return quotas.NewDynamicRateLimiter(func() float64 { return float64(f.rps(domain)) })
 }

common/dynamicconfig/quotas/dynamicratelimiterfactory_test.go

@@ -0,0 +1,43 @@
+// The MIT License (MIT)
+
+// Copyright (c) 2017-2020 Uber Technologies Inc.
+
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+package quotas
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"golang.org/x/time/rate"
+)
+
+func TestNewSimpleDynamicRateLimiterFactory(t *testing.T) {
+	const _testDomain = "test-domain"
+
+	factory := NewSimpleDynamicRateLimiterFactory(func(domain string) int {
+		assert.Equal(t, _testDomain, domain)
+		return 100
+	})
+
+	limiter := factory.GetLimiter(_testDomain)
+
+	assert.Equal(t, rate.Limit(100), limiter.Limit())
+}

common/quotas/fallbackdynamicratelimiterfactory.go → common/dynamicconfig/quotas/fallbackdynamicratelimiterfactory.go

@@ -22,15 +22,18 @@
 
 package quotas
 
-import "github.com/uber/cadence/common/dynamicconfig"
+import (
+	"github.com/uber/cadence/common/dynamicconfig"
+	"github.com/uber/cadence/common/quotas"
+)
 
-// LimiterFactory is used to create a Limiter for a given domain
+// NewFallbackDynamicRateLimiterFactory is used to create a Limiter for a given domain
 // the created Limiter will use the primary dynamic config if it is set
 // otherwise it will use the secondary dynamic config
 func NewFallbackDynamicRateLimiterFactory(
 	primary dynamicconfig.IntPropertyFnWithDomainFilter,
 	secondary dynamicconfig.IntPropertyFn,
-) LimiterFactory {
+) quotas.LimiterFactory {
 	return fallbackDynamicRateLimiterFactory{
 		primary:   primary,
 		secondary: secondary,
@@ -44,8 +47,8 @@ type fallbackDynamicRateLimiterFactory struct {
 }
 
 // GetLimiter returns a new Limiter for the given domain
-func (f fallbackDynamicRateLimiterFactory) GetLimiter(domain string) Limiter {
-	return NewDynamicRateLimiter(func() float64 {
+func (f fallbackDynamicRateLimiterFactory) GetLimiter(domain string) quotas.Limiter {
+	return quotas.NewDynamicRateLimiter(func() float64 {
 		return limitWithFallback(
 			float64(f.primary(domain)),
 			float64(f.secondary()))

common/isolationgroup/defaultisolationgroupstate/state_test.go

@@ -34,7 +34,7 @@ import (
 	"github.com/uber/cadence/common/cache"
 	"github.com/uber/cadence/common/dynamicconfig"
 	"github.com/uber/cadence/common/isolationgroup/isolationgroupapi"
-	"github.com/uber/cadence/common/log/loggerimpl"
+	"github.com/uber/cadence/common/log"
 	"github.com/uber/cadence/common/log/testlogger"
 	"github.com/uber/cadence/common/metrics"
 	"github.com/uber/cadence/common/persistence"
@@ -326,7 +326,7 @@ func TestNewDefaultIsolationGroupStateWatcherWithConfigStoreClient(t *testing.T)
 	client := metrics.NewNoopMetricsClient()
 	ig := func() []string { return nil }
 	NewDefaultIsolationGroupStateWatcherWithConfigStoreClient(
-		loggerimpl.NewNopLogger(),
+		log.NewNoop(),
 		dc,
 		domainCache,
 		nil,