aboutsummaryrefslogtreecommitdiff
path: root/hotline
diff options
context:
space:
mode:
authorJeff Halter <868228+jhalter@users.noreply.github.com>2024-06-10 16:49:37 -0700
committerJeff Halter <868228+jhalter@users.noreply.github.com>2024-06-10 16:53:31 -0700
commita6216dd89252fa01dc176f98f1e4ecfd3f637566 (patch)
tree125aa765058693626207e04da5d01c37827ed036 /hotline
parent5cc444c89968dda9060d4e2f458b1babb9b603cd (diff)
Replace zap logger with slog
Diffstat (limited to 'hotline')
-rw-r--r--hotline/client_conn.go14
-rw-r--r--hotline/panic.go6
-rw-r--r--hotline/server.go69
-rw-r--r--hotline/server_blackbox_test.go20
-rw-r--r--hotline/server_test.go4
-rw-r--r--hotline/transaction_handlers.go20
6 files changed, 59 insertions, 74 deletions
diff --git a/hotline/client_conn.go b/hotline/client_conn.go
index 48a6947..f73265d 100644
--- a/hotline/client_conn.go
+++ b/hotline/client_conn.go
@@ -3,9 +3,9 @@ package hotline
import (
"encoding/binary"
"fmt"
- "go.uber.org/zap"
"golang.org/x/crypto/bcrypt"
"io"
+ "log/slog"
"math/big"
"sort"
"strings"
@@ -44,7 +44,7 @@ type ClientConn struct {
transfersMU sync.Mutex
transfers map[int]map[[4]byte]*FileTransfer
- logger *zap.SugaredLogger
+ logger *slog.Logger
}
func (cc *ClientConn) sendAll(t int, fields ...Field) {
@@ -61,7 +61,7 @@ func (cc *ClientConn) handleTransaction(transaction Transaction) error {
// Validate that required field is present
if field.ID == nil {
- cc.logger.Errorw(
+ cc.logger.Error(
"Missing required field",
"RequestType", handler.Name, "FieldID", reqField.ID,
)
@@ -69,7 +69,7 @@ func (cc *ClientConn) handleTransaction(transaction Transaction) error {
}
if len(field.Data) < reqField.minLen {
- cc.logger.Infow(
+ cc.logger.Info(
"Field does not meet minLen",
"RequestType", handler.Name, "FieldID", reqField.ID,
)
@@ -77,7 +77,7 @@ func (cc *ClientConn) handleTransaction(transaction Transaction) error {
}
}
- cc.logger.Debugw("Received Transaction", "RequestType", handler.Name)
+ cc.logger.Debug("Received Transaction", "RequestType", handler.Name)
transactions, err := handler.Handler(cc, &transaction)
if err != nil {
@@ -87,7 +87,7 @@ func (cc *ClientConn) handleTransaction(transaction Transaction) error {
cc.Server.outbox <- t
}
} else {
- cc.logger.Errorw(
+ cc.logger.Error(
"Unimplemented transaction type received", "RequestID", requestNum)
}
@@ -149,7 +149,7 @@ func (cc *ClientConn) Disconnect() {
}
if err := cc.Connection.Close(); err != nil {
- cc.Server.Logger.Errorw("error closing client connection", "RemoteAddr", cc.RemoteAddr)
+ cc.Server.Logger.Error("error closing client connection", "RemoteAddr", cc.RemoteAddr)
}
}
diff --git a/hotline/panic.go b/hotline/panic.go
index e7c97db..d7376db 100644
--- a/hotline/panic.go
+++ b/hotline/panic.go
@@ -2,14 +2,14 @@ package hotline
import (
"fmt"
- "go.uber.org/zap"
+ "log/slog"
"runtime/debug"
)
// dontPanic logs panics instead of crashing
-func dontPanic(logger *zap.SugaredLogger) {
+func dontPanic(logger *slog.Logger) {
if r := recover(); r != nil {
fmt.Println("stacktrace from panic: \n" + string(debug.Stack()))
- logger.Errorw("PANIC", "err", r, "trace", string(debug.Stack()))
+ logger.Error("PANIC", "err", r, "trace", string(debug.Stack()))
}
}
diff --git a/hotline/server.go b/hotline/server.go
index b5bb0d5..f2a69ad 100644
--- a/hotline/server.go
+++ b/hotline/server.go
@@ -8,11 +8,12 @@ import (
"errors"
"fmt"
"github.com/go-playground/validator/v10"
- "go.uber.org/zap"
"golang.org/x/text/encoding/charmap"
"gopkg.in/yaml.v3"
"io"
"io/fs"
+ "log"
+ "log/slog"
"math/big"
"math/rand"
"net"
@@ -48,7 +49,7 @@ type Server struct {
Config *Config
ConfigDir string
- Logger *zap.SugaredLogger
+ Logger *slog.Logger
banner []byte
PrivateChatsMu sync.Mutex
@@ -91,7 +92,7 @@ type PrivateChat struct {
}
func (s *Server) ListenAndServe(ctx context.Context, cancelRoot context.CancelFunc) error {
- s.Logger.Infow("Hotline server started",
+ s.Logger.Info("Hotline server started",
"version", VERSION,
"API port", fmt.Sprintf("%s:%v", s.NetInterface, s.Port),
"Transfer port", fmt.Sprintf("%s:%v", s.NetInterface, s.Port+1),
@@ -103,20 +104,20 @@ func (s *Server) ListenAndServe(ctx context.Context, cancelRoot context.CancelFu
go func() {
ln, err := net.Listen("tcp", fmt.Sprintf("%s:%v", s.NetInterface, s.Port))
if err != nil {
- s.Logger.Fatal(err)
+ log.Fatal(err)
}
- s.Logger.Fatal(s.Serve(ctx, ln))
+ log.Fatal(s.Serve(ctx, ln))
}()
wg.Add(1)
go func() {
ln, err := net.Listen("tcp", fmt.Sprintf("%s:%v", s.NetInterface, s.Port+1))
if err != nil {
- s.Logger.Fatal(err)
+ log.Fatal(err)
}
- s.Logger.Fatal(s.ServeFileTransfers(ctx, ln))
+ log.Fatal(s.ServeFileTransfers(ctx, ln))
}()
wg.Wait()
@@ -142,7 +143,7 @@ func (s *Server) ServeFileTransfers(ctx context.Context, ln net.Listener) error
)
if err != nil {
- s.Logger.Errorw("file transfer error", "reason", err)
+ s.Logger.Error("file transfer error", "reason", err)
}
}()
}
@@ -179,7 +180,7 @@ func (s *Server) processOutbox() {
t := <-s.outbox
go func() {
if err := s.sendTransaction(t); err != nil {
- s.Logger.Errorw("error sending transaction", "err", err)
+ s.Logger.Error("error sending transaction", "err", err)
}
}()
}
@@ -191,21 +192,21 @@ func (s *Server) Serve(ctx context.Context, ln net.Listener) error {
for {
conn, err := ln.Accept()
if err != nil {
- s.Logger.Errorw("error accepting connection", "err", err)
+ s.Logger.Error("error accepting connection", "err", err)
}
connCtx := context.WithValue(ctx, contextKeyReq, requestCtx{
remoteAddr: conn.RemoteAddr().String(),
})
go func() {
- s.Logger.Infow("Connection established", "RemoteAddr", conn.RemoteAddr())
+ s.Logger.Info("Connection established", "RemoteAddr", conn.RemoteAddr())
defer conn.Close()
if err := s.handleNewConnection(connCtx, conn, conn.RemoteAddr().String()); err != nil {
if err == io.EOF {
- s.Logger.Infow("Client disconnected", "RemoteAddr", conn.RemoteAddr())
+ s.Logger.Info("Client disconnected", "RemoteAddr", conn.RemoteAddr())
} else {
- s.Logger.Errorw("error serving request", "RemoteAddr", conn.RemoteAddr(), "err", err)
+ s.Logger.Error("error serving request", "RemoteAddr", conn.RemoteAddr(), "err", err)
}
}
}()
@@ -217,7 +218,7 @@ const (
)
// NewServer constructs a new Server from a config dir
-func NewServer(configDir, netInterface string, netPort int, logger *zap.SugaredLogger, fs FileStore) (*Server, error) {
+func NewServer(configDir, netInterface string, netPort int, logger *slog.Logger, fs FileStore) (*Server, error) {
server := Server{
NetInterface: netInterface,
Port: netPort,
@@ -280,7 +281,7 @@ func NewServer(configDir, netInterface string, netPort int, logger *zap.SugaredL
*server.NextGuestID = 1
if server.Config.EnableTrackerRegistration {
- server.Logger.Infow(
+ server.Logger.Info(
"Tracker registration enabled",
"frequency", fmt.Sprintf("%vs", trackerUpdateFrequency),
"trackers", server.Config.Trackers,
@@ -297,9 +298,9 @@ func NewServer(configDir, netInterface string, netPort int, logger *zap.SugaredL
binary.BigEndian.PutUint16(tr.Port[:], uint16(server.Port))
for _, t := range server.Config.Trackers {
if err := register(t, tr); err != nil {
- server.Logger.Errorw("unable to register with tracker %v", "error", err)
+ server.Logger.Error("unable to register with tracker %v", "error", err)
}
- server.Logger.Debugw("Sent Tracker registration", "addr", t)
+ server.Logger.Debug("Sent Tracker registration", "addr", t)
}
time.Sleep(trackerUpdateFrequency * time.Second)
@@ -684,7 +685,7 @@ func (s *Server) handleNewConnection(ctx context.Context, rwc io.ReadWriteCloser
return err
}
- c.logger.Infow("Login failed", "clientVersion", fmt.Sprintf("%x", c.Version))
+ c.logger.Info("Login failed", "clientVersion", fmt.Sprintf("%x", c.Version))
return nil
}
@@ -735,7 +736,7 @@ func (s *Server) handleNewConnection(ctx context.Context, rwc io.ReadWriteCloser
// part of TranAgreed
c.logger = c.logger.With("name", string(c.UserName))
- c.logger.Infow("Login successful", "clientVersion", "Not sent (probably 1.2.3)")
+ c.logger.Info("Login successful", "clientVersion", "Not sent (probably 1.2.3)")
// Notify other clients on the server that the new user has logged in. For 1.5+ clients we don't have this
// information yet, so we do it in TranAgreed instead
@@ -770,7 +771,7 @@ func (s *Server) handleNewConnection(ctx context.Context, rwc io.ReadWriteCloser
}
if err := c.handleTransaction(t); err != nil {
- c.logger.Errorw("Error handling transaction", "err", err)
+ c.logger.Error("Error handling transaction", "err", err)
}
}
return nil
@@ -867,7 +868,7 @@ func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) erro
return err
}
- rLogger.Infow("File download started", "filePath", fullPath)
+ rLogger.Info("File download started", "filePath", fullPath)
// if file transfer options are included, that means this is a "quick preview" request from a 1.5+ client
if fileTransfer.options == nil {
@@ -939,7 +940,7 @@ func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) erro
return err
}
- rLogger.Infow("File upload started", "dstFile", fullPath)
+ rLogger.Info("File upload started", "dstFile", fullPath)
rForkWriter := io.Discard
iForkWriter := io.Discard
@@ -956,7 +957,7 @@ func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) erro
}
if err := receiveFile(rwc, file, rForkWriter, iForkWriter, fileTransfer.bytesSentCounter); err != nil {
- s.Logger.Error(err)
+ s.Logger.Error(err.Error())
}
if err := file.Close(); err != nil {
@@ -967,7 +968,7 @@ func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) erro
return err
}
- rLogger.Infow("File upload complete", "dstFile", fullPath)
+ rLogger.Info("File upload complete", "dstFile", fullPath)
case FolderDownload:
s.Stats.DownloadCounter += 1
@@ -1003,7 +1004,7 @@ func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) erro
basePathLen := len(fullPath)
- rLogger.Infow("Start folder download", "path", fullPath)
+ rLogger.Info("Start folder download", "path", fullPath)
nextAction := make([]byte, 2)
if _, err := io.ReadFull(rwc, nextAction); err != nil {
@@ -1030,7 +1031,7 @@ func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) erro
}
subPath := path[basePathLen+1:]
- rLogger.Debugw("Sending fileheader", "i", i, "path", path, "fullFilePath", fullPath, "subPath", subPath, "IsDir", info.IsDir())
+ rLogger.Debug("Sending fileheader", "i", i, "path", path, "fullFilePath", fullPath, "subPath", subPath, "IsDir", info.IsDir())
if i == 1 {
return nil
@@ -1046,7 +1047,7 @@ func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) erro
return err
}
- rLogger.Debugw("Client folder download action", "action", fmt.Sprintf("%X", nextAction[0:2]))
+ rLogger.Debug("Client folder download action", "action", fmt.Sprintf("%X", nextAction[0:2]))
var dataOffset int64
@@ -1078,14 +1079,14 @@ func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) erro
return nil
}
- rLogger.Infow("File download started",
+ rLogger.Info("File download started",
"fileName", info.Name(),
"TransferSize", fmt.Sprintf("%x", hlFile.ffo.TransferSize(dataOffset)),
)
// Send file size to client
if _, err := rwc.Write(hlFile.ffo.TransferSize(dataOffset)); err != nil {
- s.Logger.Error(err)
+ s.Logger.Error(err.Error())
return err
}
@@ -1137,7 +1138,7 @@ func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) erro
s.Stats.UploadCounter += 1
s.Stats.UploadsInProgress += 1
defer func() { s.Stats.UploadsInProgress -= 1 }()
- rLogger.Infow(
+ rLogger.Info(
"Folder upload started",
"dstPath", fullPath,
"TransferSize", binary.BigEndian.Uint32(fileTransfer.TransferSize),
@@ -1178,7 +1179,7 @@ func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) erro
return err
}
- rLogger.Infow(
+ rLogger.Info(
"Folder upload continued",
"FormattedPath", fu.FormattedPath(),
"IsFolder", fmt.Sprintf("%x", fu.IsFolder),
@@ -1249,7 +1250,7 @@ func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) erro
}
if err := receiveFile(rwc, file, io.Discard, io.Discard, fileTransfer.bytesSentCounter); err != nil {
- s.Logger.Error(err)
+ s.Logger.Error(err.Error())
}
err = os.Rename(fullPath+"/"+fu.FormattedPath()+".incomplete", fullPath+"/"+fu.FormattedPath())
@@ -1269,7 +1270,7 @@ func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) erro
return err
}
- rLogger.Infow("Starting file transfer", "path", filePath, "fileNum", i+1, "fileSize", binary.BigEndian.Uint32(fileSize))
+ rLogger.Info("Starting file transfer", "path", filePath, "fileNum", i+1, "fileSize", binary.BigEndian.Uint32(fileSize))
incWriter, err := hlFile.incFileWriter()
if err != nil {
@@ -1304,7 +1305,7 @@ func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) erro
}
}
}
- rLogger.Infof("Folder upload complete")
+ rLogger.Info("Folder upload complete")
}
return nil
diff --git a/hotline/server_blackbox_test.go b/hotline/server_blackbox_test.go
index 138a17f..27ac4a7 100644
--- a/hotline/server_blackbox_test.go
+++ b/hotline/server_blackbox_test.go
@@ -4,27 +4,13 @@ import (
"bytes"
"encoding/hex"
"github.com/stretchr/testify/assert"
- "go.uber.org/zap"
- "go.uber.org/zap/zapcore"
+ "log/slog"
"os"
"testing"
)
-func NewTestLogger() *zap.SugaredLogger {
- encoderCfg := zap.NewProductionEncoderConfig()
- encoderCfg.TimeKey = "timestamp"
- encoderCfg.EncodeTime = zapcore.ISO8601TimeEncoder
-
- core := zapcore.NewCore(
- zapcore.NewConsoleEncoder(encoderCfg),
- zapcore.Lock(os.Stdout),
- zap.DebugLevel,
- )
-
- cores := []zapcore.Core{core}
- l := zap.New(zapcore.NewTee(cores...))
- defer func() { _ = l.Sync() }()
- return l.Sugar()
+func NewTestLogger() *slog.Logger {
+ return slog.New(slog.NewTextHandler(os.Stdout, nil))
}
// assertTransferBytesEqual takes a string with a hexdump in the same format that `hexdump -C` produces and compares with
diff --git a/hotline/server_test.go b/hotline/server_test.go
index 7e2608e..3a368e0 100644
--- a/hotline/server_test.go
+++ b/hotline/server_test.go
@@ -5,8 +5,8 @@ import (
"context"
"fmt"
"github.com/stretchr/testify/assert"
- "go.uber.org/zap"
"io"
+ "log/slog"
"os"
"sync"
"testing"
@@ -35,7 +35,7 @@ func TestServer_handleFileTransfer(t *testing.T) {
fileTransfers map[[4]byte]*FileTransfer
Config *Config
ConfigDir string
- Logger *zap.SugaredLogger
+ Logger *slog.Logger
PrivateChats map[uint32]*PrivateChat
NextGuestID *uint16
TrackerPassID [4]byte
diff --git a/hotline/transaction_handlers.go b/hotline/transaction_handlers.go
index ff23684..3accf2c 100644
--- a/hotline/transaction_handlers.go
+++ b/hotline/transaction_handlers.go
@@ -574,7 +574,7 @@ func HandleMoveFile(cc *ClientConn, t *Transaction) (res []Transaction, err erro
return res, err
}
- cc.logger.Infow("Move file", "src", filePath+"/"+fileName, "dst", fileNewPath+"/"+fileName)
+ cc.logger.Info("Move file", "src", filePath+"/"+fileName, "dst", fileNewPath+"/"+fileName)
hlFile, err := newFileWrapper(cc.Server.FS, filePath, 0)
if err != nil {
@@ -784,7 +784,7 @@ func HandleUpdateUser(cc *ClientConn, t *Transaction) (res []Transaction, err er
}
login := string(encodeString(getField(FieldData, &subFields).Data))
- cc.logger.Infow("DeleteUser", "login", login)
+ cc.logger.Info("DeleteUser", "login", login)
if err := cc.Server.DeleteUser(login); err != nil {
return res, err
@@ -810,9 +810,9 @@ func HandleUpdateUser(cc *ClientConn, t *Transaction) (res []Transaction, err er
// Check if accountToUpdate has an existing account. If so, we know we are updating an existing user.
if acc, ok := cc.Server.Accounts[accountToUpdate]; ok {
if loginToRename != "" {
- cc.logger.Infow("RenameUser", "prevLogin", accountToUpdate, "newLogin", userLogin)
+ cc.logger.Info("RenameUser", "prevLogin", accountToUpdate, "newLogin", userLogin)
} else {
- cc.logger.Infow("UpdateUser", "login", accountToUpdate)
+ cc.logger.Info("UpdateUser", "login", accountToUpdate)
}
// account exists, so this is an update action
@@ -857,7 +857,7 @@ func HandleUpdateUser(cc *ClientConn, t *Transaction) (res []Transaction, err er
return res, nil
}
- cc.logger.Infow("CreateUser", "login", userLogin)
+ cc.logger.Info("CreateUser", "login", userLogin)
newAccess := accessBitmap{}
copy(newAccess[:], getField(FieldUserAccess, &subFields).Data)
@@ -998,7 +998,7 @@ func HandleTranAgreed(cc *ClientConn, t *Transaction) (res []Transaction, err er
cc.Icon = t.GetField(FieldUserIconID).Data
cc.logger = cc.logger.With("name", string(cc.UserName))
- cc.logger.Infow("Login successful", "clientVersion", fmt.Sprintf("%v", func() int { i, _ := byteToInt(cc.Version); return i }()))
+ cc.logger.Info("Login successful", "clientVersion", fmt.Sprintf("%v", func() int { i, _ := byteToInt(cc.Version); return i }()))
options := t.GetField(FieldOptions).Data
optBitmap := big.NewInt(int64(binary.BigEndian.Uint16(options)))
@@ -1107,7 +1107,7 @@ func HandleDisconnectUser(cc *ClientConn, t *Transaction) (res []Transaction, er
switch t.GetField(FieldOptions).Data[1] {
case 1:
// send message: "You are temporarily banned on this server"
- cc.logger.Infow("Disconnect & temporarily ban " + string(clientConn.UserName))
+ cc.logger.Info("Disconnect & temporarily ban " + string(clientConn.UserName))
res = append(res, *NewTransaction(
TranServerMsg,
@@ -1120,7 +1120,7 @@ func HandleDisconnectUser(cc *ClientConn, t *Transaction) (res []Transaction, er
cc.Server.banList[strings.Split(clientConn.RemoteAddr, ":")[0]] = &banUntil
case 2:
// send message: "You are permanently banned on this server"
- cc.logger.Infow("Disconnect & ban " + string(clientConn.UserName))
+ cc.logger.Info("Disconnect & ban " + string(clientConn.UserName))
res = append(res, *NewTransaction(
TranServerMsg,
@@ -1218,8 +1218,6 @@ func HandleNewNewsFldr(cc *ClientConn, t *Transaction) (res []Transaction, err e
name := string(t.GetField(FieldFileName).Data)
pathStrs := ReadNewsPath(t.GetField(FieldNewsPath).Data)
- cc.logger.Infof("Creating new news folder %s", name)
-
cats := cc.Server.GetNewsCatByPath(pathStrs)
cats[name] = NewsCategoryListData15{
Name: name,
@@ -2024,7 +2022,7 @@ func HandleMakeAlias(cc *ClientConn, t *Transaction) (res []Transaction, err err
return res, err
}
- cc.logger.Debugw("Make alias", "src", fullFilePath, "dst", fullNewFilePath)
+ cc.logger.Debug("Make alias", "src", fullFilePath, "dst", fullNewFilePath)
if err := cc.Server.FS.Symlink(fullFilePath, fullNewFilePath); err != nil {
res = append(res, cc.NewErrReply(t, "Error creating alias"))