Update OptimizelyLogConsumer implementation. (#50)

* Update LogConsumer to use new fields map[string]interface{} parameter
* Add log.pretty option within cmd/sidedoor/main.go
* Use default zerolog Logger within the Optimizely SDK.
* Ran go fmt to get formatting back in line
* Ran go mod tidy to get go.mod go.sum back in check

Author: Mike Davis

cmd/sidedoor/main.go

@@ -16,51 +16,57 @@
 package main
 
 import (
-	"github.com/optimizely/sidedoor/pkg/optimizely"
-	"github.com/optimizely/sidedoor/pkg/webhook/models"
+	"os"
 	"strings"
 	"sync"
 
+	"github.com/optimizely/sidedoor/pkg/optimizely"
+	"github.com/optimizely/sidedoor/pkg/webhook/models"
+
 	"github.com/optimizely/sidedoor/pkg/admin"
 	"github.com/optimizely/sidedoor/pkg/admin/handlers"
 	"github.com/optimizely/sidedoor/pkg/api"
 	"github.com/optimizely/sidedoor/pkg/service"
 	"github.com/optimizely/sidedoor/pkg/webhook"
 
+	"github.com/rs/zerolog"
 	"github.com/rs/zerolog/log"
 	"github.com/spf13/viper"
 )
 
-func loadConfig() {
+func loadConfig() error {
+
+	// Set defaults
+	viper.SetDefault("api.enabled", true)     // Property to turn api service on/off
+	viper.SetDefault("api.port", "8080")      // Port for serving Optimizely APIs
+	viper.SetDefault("webhook.enabled", true) // Property to turn webhook service on/off
+	viper.SetDefault("webhook.port", "8085")  // Port for webhook service
+	viper.SetDefault("admin.port", "8088")    // Port for admin service
+
+	// Configure environment variables
 	viper.SetEnvPrefix("sidedoor")
 	viper.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))
+	viper.AutomaticEnv()
 
-	// Set config file
+	// Read configuration from file
 	viper.SetConfigName("config")
 	viper.AddConfigPath(".")
 	viper.SetConfigType("yaml")
-	if err := viper.ReadInConfig(); err != nil {
-		log.Info().Msg("No config file found or config file may have invalid format.")
-	}
-
-	viper.AutomaticEnv()
-
-	// Property to turn api service on/off
-	viper.SetDefault("api.enabled", true)
-	// Port for serving Optimizely APIs
-	viper.SetDefault("api.port", "8080")
-	// Property to turn webhook service on/off
-	viper.SetDefault("webhook.enabled", true)
-	// Port for webhook service
-	viper.SetDefault("webhook.port", "8085")
-
-	// Port for admin service
-	viper.SetDefault("admin.port", "8088")
+	return viper.ReadInConfig()
 }
 
 func main() {
 
-	loadConfig()
+	err := loadConfig()
+
+	if viper.GetBool("log.pretty") {
+		log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stderr})
+	}
+
+	if err != nil {
+		log.Info().Err(err).Msg("Ignoring error, skip loading configuration from config.yaml.")
+	}
+
 	var wg sync.WaitGroup
 
 	optlyCache := optimizely.NewCache()

go.mod

@@ -5,14 +5,14 @@ go 1.12
 require (
 	github.com/go-chi/chi v4.0.2+incompatible
 	github.com/go-chi/render v1.0.1
-	github.com/golangci/golangci-lint v1.18.0 // indirect
 	github.com/google/uuid v1.1.1
 	github.com/nsqio/nsq v1.2.0
-	github.com/optimizely/go-sdk v1.0.0-beta3
+	github.com/optimizely/go-sdk v1.0.0-beta3.0.20191018225745-33701145d1ba
 	github.com/orcaman/concurrent-map v0.0.0-20190826125027-8c72a8bb44f6
 	github.com/rs/zerolog v1.15.0
 	github.com/segmentio/nsq-go v1.2.2
 	github.com/spf13/viper v1.4.0
 	github.com/stretchr/testify v1.4.0
-	gopkg.in/yaml.v2 v2.2.2
+	golang.org/x/net v0.0.0-20190620200207-3b0461eec859 // indirect
+	golang.org/x/sys v0.0.0-20190312061237-fead79001313 // indirect
 )

go.sum

@@ -54,7 +54,7 @@ func ParseRequestBody(r *http.Request, v interface{}) error {
 	if err != nil {
 		msg := "error parsing request body"
 		log.Error().Err(err).Msg(msg)
-		return fmt.Errorf(msg)	
+		return fmt.Errorf(msg)
 	}
 
 	return nil

pkg/api/handlers/utils.go

@@ -18,26 +18,28 @@
 package optimizely
 
 import (
-	"os"
-
 	"github.com/rs/zerolog"
 	"github.com/rs/zerolog/log"
 
 	"github.com/optimizely/go-sdk/pkg/logging"
 )
 
-var levelMap = make(map[logging.LogLevel]zerolog.Level)
+var levelMap = map[logging.LogLevel]zerolog.Level{
+	logging.LogLevelDebug:   zerolog.DebugLevel,
+	logging.LogLevelInfo:    zerolog.InfoLevel,
+	logging.LogLevelWarning: zerolog.WarnLevel,
+	logging.LogLevelError:   zerolog.ErrorLevel,
+}
 
-// init overrides the Optimizely SDK logger with a logrus implementation.
+// init overrides the Optimizely SDK logger with the default zerolog logger.
 func init() {
-	levelMap[logging.LogLevelDebug] = zerolog.DebugLevel
-	levelMap[logging.LogLevelInfo] = zerolog.InfoLevel
-	levelMap[logging.LogLevelWarning] = zerolog.WarnLevel
-	levelMap[logging.LogLevelError] = zerolog.ErrorLevel
+	SetLogger(&log.Logger)
+}
 
-	logger := log.Output(zerolog.ConsoleWriter{Out: os.Stderr})
+// SetLogger explicitly overwrites the zerolog used by the SDK with the provided zerolog logger.
+func SetLogger(logger *zerolog.Logger) {
 	logConsumer := &LogConsumer{
-		logger: &logger,
+		logger: logger,
 	}
 
 	logging.SetLogger(logConsumer)
@@ -49,8 +51,8 @@ type LogConsumer struct {
 }
 
 // Log logs the message if it's log level is higher than or equal to the logger's set level
-func (l *LogConsumer) Log(level logging.LogLevel, message string) {
-	l.logger.WithLevel(levelMap[level]).Msg(message)
+func (l *LogConsumer) Log(level logging.LogLevel, message string, fields map[string]interface{}) {
+	l.logger.WithLevel(levelMap[level]).Fields(fields).Msg(message)
 }
 
 // SetLogLevel changes the log level to the given level

pkg/optimizely/logger.go

@@ -32,19 +32,19 @@ func TestLog(t *testing.T) {
 	logger := zerolog.New(out).Level(zerolog.DebugLevel)
 	logConsumer := &LogConsumer{logger: &logger}
 
-	logConsumer.Log(logging.LogLevelDebug, "debug")
+	logConsumer.Log(logging.LogLevelDebug, "debug", map[string]interface{}{})
 	assert.Equal(t, "{\"level\":\"debug\",\"message\":\"debug\"}\n", out.String())
 	out.Reset()
 
-	logConsumer.Log(logging.LogLevelInfo, "info")
+	logConsumer.Log(logging.LogLevelInfo, "info", map[string]interface{}{})
 	assert.Equal(t, "{\"level\":\"info\",\"message\":\"info\"}\n", out.String())
 	out.Reset()
 
-	logConsumer.Log(logging.LogLevelWarning, "warn")
+	logConsumer.Log(logging.LogLevelWarning, "warn", map[string]interface{}{})
 	assert.Equal(t, "{\"level\":\"warn\",\"message\":\"warn\"}\n", out.String())
 	out.Reset()
 
-	logConsumer.Log(logging.LogLevelError, "error")
+	logConsumer.Log(logging.LogLevelError, "error", map[string]interface{}{})
 	assert.Equal(t, "{\"level\":\"error\",\"message\":\"error\"}\n", out.String())
 	out.Reset()
 }

pkg/optimizely/logger_test.go

@@ -24,7 +24,7 @@ import (
 
 // TestCache implements the Cache interface and is used in testing.
 type TestCache struct {
-	testClient		*optimizelytest.TestClient
+	testClient *optimizelytest.TestClient
 }
 
 // NewCache returns a new implementation of TestCache

pkg/optlytest/cache.go

@@ -46,7 +46,7 @@ func TestHandleWebhookNoWebhookForProject(t *testing.T) {
 		ProjectID: 43,
 		Timestamp: 43434343,
 		Event:     "project.datafile_updated",
-		Data:      models.DatafileUpdateData{
+		Data: models.DatafileUpdateData{
 			Revision:    101,
 			OriginURL:   "origin.optimizely.com/datafiles/myDatafile",
 			CDNUrl:      "cdn.optimizely.com/datafiles/myDatafile",
@@ -66,19 +66,19 @@ func TestHandleWebhookNoWebhookForProject(t *testing.T) {
 }
 
 func TestHandleWebhookValidMessageInvalidSignature(t *testing.T) {
-	var testWebhookConfigs = []models.OptlyWebhookConfig {
+	var testWebhookConfigs = []models.OptlyWebhookConfig{
 		{
 			ProjectID: 42,
-			SDKKeys: []string{"myDatafile"},
-			Secret:  "I am secret",
+			SDKKeys:   []string{"myDatafile"},
+			Secret:    "I am secret",
 		},
 	}
 	optlyHandler := NewWebhookHandler(nil, testWebhookConfigs)
 	webhookMsg := models.OptlyMessage{
 		ProjectID: 42,
 		Timestamp: 42424242,
 		Event:     "project.datafile_updated",
-		Data:      models.DatafileUpdateData{
+		Data: models.DatafileUpdateData{
 			Revision:    101,
 			OriginURL:   "origin.optimizely.com/datafiles/myDatafile",
 			CDNUrl:      "cdn.optimizely.com/datafiles/myDatafile",
@@ -99,22 +99,21 @@ func TestHandleWebhookValidMessageInvalidSignature(t *testing.T) {
 	assert.Regexp(t, "Computed signature does not match signature in request. Ignoring message.", rec.Body.String())
 }
 
-
 func TestHandleWebhookValidMessage(t *testing.T) {
 	testCache := optlytest.NewCache()
-	var testWebhookConfigs = []models.OptlyWebhookConfig {
+	var testWebhookConfigs = []models.OptlyWebhookConfig{
 		{
 			ProjectID: 42,
-			SDKKeys: []string{"myDatafile"},
-			Secret:  "I am secret",
+			SDKKeys:   []string{"myDatafile"},
+			Secret:    "I am secret",
 		},
 	}
 	optlyHandler := NewWebhookHandler(testCache, testWebhookConfigs)
 	webhookMsg := models.OptlyMessage{
 		ProjectID: 42,
 		Timestamp: 42424242,
 		Event:     "project.datafile_updated",
-		Data:      models.DatafileUpdateData{
+		Data: models.DatafileUpdateData{
 			Revision:    101,
 			OriginURL:   "origin.optimizely.com/datafiles/myDatafile",
 			CDNUrl:      "cdn.optimizely.com/datafiles/myDatafile",

pkg/webhook/handlers/optimizely_test.go

@@ -19,23 +19,23 @@ package models
 
 // DatafileUpdateData model which represents data specific to datafile update
 type DatafileUpdateData struct {
-    Revision       int32    `json:"revision"`
-    OriginURL      string   `json:"origin_url"`
-    CDNUrl         string   `json:"cdn_url"`
-    Environment    string   `json:"environment"`
+	Revision    int32  `json:"revision"`
+	OriginURL   string `json:"origin_url"`
+	CDNUrl      string `json:"cdn_url"`
+	Environment string `json:"environment"`
 }
 
 // OptlyMessage model which represents any message received from Optimizely
 type OptlyMessage struct {
-    ProjectID    int64					`json:"project_id"`
-    Timestamp    int64					`json:"timestamp"`
-    Event        string					`json:"event"`
-    Data         DatafileUpdateData     `json:"data"`
+	ProjectID int64              `json:"project_id"`
+	Timestamp int64              `json:"timestamp"`
+	Event     string             `json:"event"`
+	Data      DatafileUpdateData `json:"data"`
 }
 
 // OptlyWebhookConfig represents configuration of a single Optimizely webhook
 type OptlyWebhookConfig struct {
-    ProjectID   int64                   `yaml:"projectId"`
-    SDKKeys     []string                `yaml:"sdkKeys"`
-    Secret      string                  `yaml:"secret"`
+	ProjectID int64    `yaml:"projectId"`
+	SDKKeys   []string `yaml:"sdkKeys"`
+	Secret    string   `yaml:"secret"`
 }

pkg/webhook/models/optimizely.go

@@ -28,15 +28,15 @@ import (
 
 // RouterOptions defines the configuration parameters for Router
 type RouterOptions struct {
-	cache				optimizely.Cache
-	webhookConfigs		[]models.OptlyWebhookConfig
+	cache          optimizely.Cache
+	webhookConfigs []models.OptlyWebhookConfig
 }
 
 // NewDefaultRouter creates a new router
 func NewDefaultRouter(optlyCache optimizely.Cache, webhookConfigs []models.OptlyWebhookConfig) *chi.Mux {
 	spec := &RouterOptions{
-		cache:				optlyCache,
-		webhookConfigs:		webhookConfigs,
+		cache:          optlyCache,
+		webhookConfigs: webhookConfigs,
 	}
 
 	return NewRouter(spec)