[MM-19315] Replace old Logger with mlog.Logger (mattermost package)

go.mod

@@ -1,20 +1,21 @@
 module github.com/mattermost/mattermost-push-proxy
 
-go 1.21
+go 1.22
 
-toolchain go1.21.9
+toolchain go1.22.6
 
 require (
 	firebase.google.com/go/v4 v4.14.0
 	github.com/gorilla/handlers v1.5.2
 	github.com/gorilla/mux v1.8.1
 	github.com/kyokomi/emoji v2.2.4+incompatible
+	github.com/mattermost/mattermost/server/public v0.1.9
 	github.com/prometheus/client_golang v1.19.0
 	github.com/prometheus/common v0.53.0
 	github.com/sideshow/apns2 v0.23.0
 	github.com/stretchr/testify v1.9.0
-	golang.org/x/net v0.24.0
-	golang.org/x/oauth2 v0.19.0
+	golang.org/x/net v0.27.0
+	golang.org/x/oauth2 v0.21.0
 	google.golang.org/api v0.176.1
 	gopkg.in/natefinch/lumberjack.v2 v2.2.1
 	gopkg.in/throttled/throttled.v1 v1.0.0
@@ -33,8 +34,9 @@ require (
 	github.com/PuerkitoBio/boom v0.0.0-20140219125548-fecdef1c97ca // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/cespare/xxhash/v2 v2.3.0 // indirect
-	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
 	github.com/felixge/httpsnoop v1.0.4 // indirect
+	github.com/francoispqt/gojay v1.2.13 // indirect
 	github.com/garyburd/redigo v1.6.4 // indirect
 	github.com/go-logr/logr v1.4.1 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
@@ -46,28 +48,32 @@ require (
 	github.com/googleapis/enterprise-certificate-proxy v0.3.2 // indirect
 	github.com/googleapis/gax-go/v2 v2.12.3 // indirect
 	github.com/kr/text v0.2.0 // indirect
+	github.com/mattermost/logr/v2 v2.0.21 // indirect
 	github.com/olekukonko/ts v0.0.0-20171002115256-78ecb04241c0 // indirect
-	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
 	github.com/prometheus/client_model v0.6.1 // indirect
 	github.com/prometheus/procfs v0.14.0 // indirect
 	github.com/rakyll/pb v0.0.0-20160123035540-8d46b8b097ef // indirect
 	github.com/rogpeppe/go-internal v1.11.0 // indirect
+	github.com/wiggin77/merror v1.0.5 // indirect
+	github.com/wiggin77/srslog v1.0.1 // indirect
 	go.opencensus.io v0.24.0 // indirect
 	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.51.0 // indirect
 	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.51.0 // indirect
 	go.opentelemetry.io/otel v1.26.0 // indirect
 	go.opentelemetry.io/otel/metric v1.26.0 // indirect
 	go.opentelemetry.io/otel/trace v1.26.0 // indirect
-	golang.org/x/crypto v0.22.0 // indirect
+	golang.org/x/crypto v0.25.0 // indirect
 	golang.org/x/sync v0.7.0 // indirect
-	golang.org/x/sys v0.19.0 // indirect
-	golang.org/x/text v0.14.0 // indirect
+	golang.org/x/sys v0.22.0 // indirect
+	golang.org/x/text v0.16.0 // indirect
 	golang.org/x/time v0.5.0 // indirect
 	google.golang.org/appengine/v2 v2.0.6 // indirect
 	google.golang.org/genproto v0.0.0-20240415180920-8c6c420018be // indirect
-	google.golang.org/genproto/googleapis/api v0.0.0-20240415180920-8c6c420018be // indirect
-	google.golang.org/genproto/googleapis/rpc v0.0.0-20240415180920-8c6c420018be // indirect
-	google.golang.org/grpc v1.63.2 // indirect
-	google.golang.org/protobuf v1.33.0 // indirect
+	google.golang.org/genproto/googleapis/api v0.0.0-20240528184218-531527333157 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20240722135656-d784300faade // indirect
+	google.golang.org/grpc v1.65.0 // indirect
+	google.golang.org/protobuf v1.34.2 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

main.go

@@ -12,6 +12,7 @@ import (
 
 	"github.com/mattermost/mattermost-push-proxy/internal/version"
 	"github.com/mattermost/mattermost-push-proxy/server"
+	"github.com/mattermost/mattermost/server/public/shared/mlog"
 )
 
 var (
@@ -39,7 +40,24 @@ func main() {
 		log.Fatal(err)
 	}
 
-	logger := server.NewLogger(cfg)
+	// Initialize the logger - begin
+	logger, err := mlog.NewLogger()
+	if err != nil {
+		log.Fatal(err)
+	}
+	cfgJSON := cfg.LoggingCfgJSON
+	if cfg.LoggingCfgFile == "" && cfgJSON == "" {
+		// if no logging defined, use default config (console output)
+		cfgJSON = server.DefaultLoggingConfig(cfg)
+	}
+	err = logger.Configure(cfg.LoggingCfgFile, cfgJSON, nil)
+	if err != nil {
+		log.Fatal("Error in config file for logger: ", err)
+		return
+	}
+	defer func() { _ = logger.Shutdown() }()
+	// Initialize the logger - end
+
 	logger.Info("Loading " + fileName)
 
 	srv := server.New(cfg, logger)

server/android_notification_server.go

@@ -8,6 +8,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"github.com/mattermost/mattermost/server/public/shared/mlog"
 	"os"
 	"reflect"
 	"strconv"
@@ -37,7 +38,7 @@ const (
 
 type AndroidNotificationServer struct {
 	metrics             *metrics
-	logger              *Logger
+	logger              *mlog.Logger
 	AndroidPushSettings AndroidPushSettings
 	client              *messaging.Client
 	sendTimeout         time.Duration
@@ -54,7 +55,7 @@ type serviceAccount struct {
 	TokenURI    string `json:"token_uri"`
 }
 
-func NewAndroidNotificationServer(settings AndroidPushSettings, logger *Logger, metrics *metrics, sendTimeoutSecs int) *AndroidNotificationServer {
+func NewAndroidNotificationServer(settings AndroidPushSettings, logger *mlog.Logger, metrics *metrics, sendTimeoutSecs int) *AndroidNotificationServer {
 	return &AndroidNotificationServer{
 		AndroidPushSettings: settings,
 		metrics:             metrics,
@@ -64,10 +65,10 @@ func NewAndroidNotificationServer(settings AndroidPushSettings, logger *Logger,
 }
 
 func (me *AndroidNotificationServer) Initialize() error {
-	me.logger.Infof("Initializing Android notification server for type=%v", me.AndroidPushSettings.Type)
+	me.logger.Info("Initializing Android notification server", mlog.String("type", me.AndroidPushSettings.Type))
 
 	if me.AndroidPushSettings.AndroidAPIKey != "" {
-		me.logger.Infof("AndroidPushSettings.AndroidAPIKey is no longer used. Please remove this config value.")
+		me.logger.Info("AndroidPushSettings.AndroidAPIKey is no longer used. Please remove this config value.")
 	}
 
 	if me.AndroidPushSettings.ServiceFileLocation == "" {
@@ -169,7 +170,12 @@ func (me *AndroidNotificationServer) SendNotification(msg *PushNotification) Pus
 	ctx, cancel := context.WithTimeout(context.Background(), me.sendTimeout)
 	defer cancel()
 
-	me.logger.Infof("Sending android push notification for device=%v type=%v ackId=%v", me.AndroidPushSettings.Type, msg.Type, msg.AckID)
+	me.logger.Info(
+		"Sending android push notification ackId=%v",
+		mlog.String("device", me.AndroidPushSettings.Type),
+		mlog.String("type", msg.Type),
+		mlog.String("AckId", msg.AckID),
+	)
 
 	start := time.Now()
 	_, err := me.client.Send(ctx, fcmMsg)
@@ -183,17 +189,17 @@ func (me *AndroidNotificationServer) SendNotification(msg *PushNotification) Pus
 			errorCode = "NONE"
 		}
 
-		me.logger.Errorf(
-			"Failed to send FCM push sid=%v did=%v err=%v type=%v errorCode=%v",
-			msg.ServerID,
-			msg.DeviceID,
-			err,
-			me.AndroidPushSettings.Type,
-			errorCode,
+		me.logger.Error(
+			"Failed to send FCM push",
+			mlog.String("sid", msg.ServerID),
+			mlog.String("did", msg.DeviceID),
+			mlog.Err(err),
+			mlog.String("type", me.AndroidPushSettings.Type),
+			mlog.String("errorCode", errorCode),
 		)
 
 		if messaging.IsUnregistered(err) || messaging.IsSenderIDMismatch(err) {
-			me.logger.Infof("Android response failure sending remove code: type=%v", me.AndroidPushSettings.Type)
+			me.logger.Info("Android response failure sending remove code", mlog.String("type", me.AndroidPushSettings.Type))
 			if me.metrics != nil {
 				me.metrics.incrementRemoval(PushNotifyAndroid, pushType, unregistered)
 			}

server/apple_notification_server.go

@@ -7,6 +7,7 @@ import (
 	"context"
 	"crypto/tls"
 	"fmt"
+	"github.com/mattermost/mattermost/server/public/shared/mlog"
 	"net/http"
 	"net/url"
 	"time"
@@ -22,13 +23,13 @@ import (
 type AppleNotificationServer struct {
 	AppleClient       *apns.Client
 	metrics           *metrics
-	logger            *Logger
+	logger            *mlog.Logger
 	ApplePushSettings ApplePushSettings
 	sendTimeout       time.Duration
 	retryTimeout      time.Duration
 }
 
-func NewAppleNotificationServer(settings ApplePushSettings, logger *Logger, metrics *metrics, sendTimeoutSecs int, retryTimeoutSecs int) *AppleNotificationServer {
+func NewAppleNotificationServer(settings ApplePushSettings, logger *mlog.Logger, metrics *metrics, sendTimeoutSecs int, retryTimeoutSecs int) *AppleNotificationServer {
 	return &AppleNotificationServer{
 		ApplePushSettings: settings,
 		metrics:           metrics,
@@ -64,9 +65,9 @@ func (me *AppleNotificationServer) setupProxySettings(appleCert *tls.Certificate
 	}
 
 	if appleCert != nil {
-		me.logger.Infof("Initializing apple notification server for type=%v with PEM certificate", me.ApplePushSettings.Type)
+		me.logger.Info("Initializing apple notification server with PEM certificate", mlog.String("type", me.ApplePushSettings.Type))
 	} else {
-		me.logger.Infof("Initializing apple notification server for type=%v with AuthKey", me.ApplePushSettings.Type)
+		me.logger.Info("Initializing apple notification server for type=%v with AuthKey", mlog.String("type", me.ApplePushSettings.Type))
 	}
 
 	return nil
@@ -228,11 +229,22 @@ func (me *AppleNotificationServer) SendNotification(msg *PushNotification) PushR
 	}
 
 	if me.AppleClient != nil {
-		me.logger.Infof("Sending apple push notification for device=%v type=%v ackId=%v", me.ApplePushSettings.Type, msg.Type, msg.AckID)
+		me.logger.Info(
+			"Sending apple push notification for ackId=%v",
+			mlog.String("device", me.ApplePushSettings.Type),
+			mlog.String("type", msg.Type),
+			mlog.String("AckId", msg.AckID),
+		)
 
 		res, err := me.SendNotificationWithRetry(notification)
 		if err != nil {
-			me.logger.Errorf("Failed to send apple push sid=%v did=%v err=%v type=%v", msg.ServerID, msg.DeviceID, err, me.ApplePushSettings.Type)
+			me.logger.Error(
+				"Failed to send apple push",
+				mlog.String("sid", msg.ServerID),
+				mlog.String("did", msg.DeviceID),
+				mlog.Err(err),
+				mlog.String("type", me.ApplePushSettings.Type),
+			)
 			if me.metrics != nil {
 				me.metrics.incrementFailure(PushNotifyApple, pushType, "RequestError")
 			}
@@ -241,14 +253,26 @@ func (me *AppleNotificationServer) SendNotification(msg *PushNotification) PushR
 
 		if !res.Sent() {
 			if res.Reason == apns.ReasonBadDeviceToken || res.Reason == apns.ReasonUnregistered || res.Reason == apns.ReasonMissingDeviceToken || res.Reason == apns.ReasonDeviceTokenNotForTopic {
-				me.logger.Infof("Failed to send apple push sending remove code res ApnsID=%v reason=%v code=%v type=%v", res.ApnsID, res.Reason, res.StatusCode, me.ApplePushSettings.Type)
+				me.logger.Info(
+					"Failed to send apple push sending remove code res",
+					mlog.String("ApnsID", res.ApnsID),
+					mlog.String("reason", res.Reason),
+					mlog.Int("code", res.StatusCode),
+					mlog.String("type", me.ApplePushSettings.Type),
+				)
 				if me.metrics != nil {
 					me.metrics.incrementRemoval(PushNotifyApple, pushType, res.Reason)
 				}
 				return NewRemovePushResponse()
 			}
 
-			me.logger.Errorf("Failed to send apple push with res ApnsID=%v reason=%v code=%v type=%v", res.ApnsID, res.Reason, res.StatusCode, me.ApplePushSettings.Type)
+			me.logger.Error(
+				"Failed to send apple push with res",
+				mlog.String("ApnsID", res.ApnsID),
+				mlog.String("reason", res.Reason),
+				mlog.Int("code", res.StatusCode),
+				mlog.String("type", me.ApplePushSettings.Type),
+			)
 			if me.metrics != nil {
 				me.metrics.incrementFailure(PushNotifyApple, pushType, res.Reason)
 			}
@@ -289,10 +313,15 @@ func (me *AppleNotificationServer) SendNotificationWithRetry(notification *apns.
 			break
 		}
 
-		me.logger.Errorf("Failed to send apple push did=%v retry=%v error=%v", notification.DeviceToken, retries, err)
+		me.logger.Error(
+			"Failed to send apple push",
+			mlog.String("did", notification.DeviceToken),
+			mlog.Int("retry", retries),
+			mlog.Err(err),
+		)
 
 		if retries == MAX_RETRIES-1 {
-			me.logger.Errorf("Max retries reached did=%v", notification.DeviceToken)
+			me.logger.Error("Max retries reached", mlog.String("did", notification.DeviceToken))
 			break
 		}
 
@@ -302,7 +331,12 @@ func (me *AppleNotificationServer) SendNotificationWithRetry(notification *apns.
 		}
 
 		if generalContext.Err() != nil {
-			me.logger.Infof("Not retrying because context error did=%v retry=%v error=%v", notification.DeviceToken, retries, generalContext.Err())
+			me.logger.Info(
+				"Not retrying because context error",
+				mlog.String("did", notification.DeviceToken),
+				mlog.Int("retry", retries),
+				mlog.Err(generalContext.Err()),
+			)
 			err = generalContext.Err()
 			break
 		}

server/config_push_proxy.go

@@ -12,16 +12,21 @@ import (
 )
 
 type ConfigPushProxy struct {
-	AndroidPushSettings     []AndroidPushSettings
-	ListenAddress           string
-	ThrottleVaryByHeader    string
-	LogFileLocation         string
-	SendTimeoutSec          int
-	RetryTimeoutSec         int
-	ApplePushSettings       []ApplePushSettings
-	EnableMetrics           bool
-	EnableConsoleLog        bool
+	AndroidPushSettings  []AndroidPushSettings
+	ListenAddress        string
+	ThrottleVaryByHeader string
+	// Deprecated: Use it is maintained for backward compatibility of the Logger struct. Use LoggingCfgFile or LoggingCfgJSON instead.
+	LogFileLocation   string
+	SendTimeoutSec    int
+	RetryTimeoutSec   int
+	ApplePushSettings []ApplePushSettings
+	EnableMetrics     bool
+	// Deprecated: Same reason as LogFileLocation.
+	EnableConsoleLog bool
+	// Deprecated: Same reason as LogFileLocation.
 	EnableFileLog           bool
+	LoggingCfgFile          string
+	LoggingCfgJSON          string
 	ThrottlePerSec          int
 	ThrottleMemoryStoreSize int
 }
@@ -78,10 +83,6 @@ func LoadConfig(fileName string) (*ConfigPushProxy, error) {
 		fmt.Println(buf, err)
 		return nil, err
 	}
-	// If both are disabled, that means an old config file is being used. Atleast enable console log.
-	if !cfg.EnableConsoleLog && !cfg.EnableFileLog {
-		cfg.EnableConsoleLog = true
-	}
 
 	// Set timeout defaults
 	if cfg.SendTimeoutSec == 0 {
@@ -96,29 +97,5 @@ func LoadConfig(fileName string) (*ConfigPushProxy, error) {
 		cfg.RetryTimeoutSec = cfg.SendTimeoutSec
 	}
 
-	if cfg.EnableFileLog {
-		if cfg.LogFileLocation == "" {
-			// We just do an mkdir -p equivalent.
-			// Otherwise, it would need 2 steps of statting and creating.
-			err := os.MkdirAll("./logs", 0755)
-			if err != nil {
-				// If it fails, we log in the current directory itself
-				cfg.LogFileLocation = "./push_proxy.log"
-			} else {
-				cfg.LogFileLocation = "./logs/push_proxy.log"
-			}
-		}
-		// if file does not exist, create it.
-		if _, err := os.Stat(cfg.LogFileLocation); os.IsNotExist(err) {
-			f, err := os.Create(cfg.LogFileLocation)
-			if err != nil {
-				return nil, err
-			}
-			if err := f.Close(); err != nil {
-				return nil, err
-			}
-		}
-	}
-
 	return cfg, nil
 }