From bec0241d9c4709ecbb3b36427a918004b18c5df0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C5=82=20Rudowicz?= <michal.rudowicz@fl9.eu>
Date: Sun, 11 Feb 2024 22:48:05 +0100
Subject: [PATCH] Logging

---
 main.go               | 17 ++++++++++-------
 sender_worker.go      |  7 ++++++-
 sender_worker_test.go |  7 +++++--
 3 files changed, 21 insertions(+), 10 deletions(-)

diff --git a/main.go b/main.go
index 4075042..21c7fed 100644
--- a/main.go
+++ b/main.go
@@ -3,6 +3,7 @@ package main
 import (
 	"flag"
 	"fmt"
+	"log"
 	"net"
 	"os"
 	"strconv"
@@ -43,23 +44,21 @@ func (self RealSleeper) Sleep(ch chan<- interface{}) {
 	ch <- nil
 }
 
-func getCmdLineParams() (string, []int64) {
+func getCmdLineParams(logger *log.Logger) (string, []int64) {
 	satelApiAddr := flag.String("satel-addr", "", "Address that should be used to connect to the SATEL device")
 	satelApiPort := flag.String("satel-port", "7094", "Port that should be used to connect to the SATEL device")
 	chatIdRaw := flag.String("tg-chat-id", "", "Telegram Chat ID where to send updates. Use \",\" to specify multiple IDs.")
 	flag.Parse()
 
 	if len(*satelApiAddr) == 0 || len(*satelApiPort) == 0 || len(*chatIdRaw) == 0 {
-		fmt.Println("Use --satel-addr=ADDR, --satel-port=PORT and --tg-chat-id=CHAT_ID command line flags to continue.")
-		os.Exit(1)
+		logger.Fatal("Use --satel-addr=ADDR, --satel-port=PORT and --tg-chat-id=CHAT_ID command line flags to continue.")
 	}
 	chatIdsStrings := strings.Split(*chatIdRaw, ",")
 	var chatIds []int64
 	for _, chatIdStr := range chatIdsStrings {
 		chatId, err := strconv.ParseInt(chatIdStr, 10, 64)
 		if err != nil {
-			fmt.Printf("Tried to use a non-int value for one of tg_chatIds: %s. That's bad.", chatIdStr)
-			os.Exit(1)
+			logger.Fatalf("Tried to use a non-int value for one of tg_chatIds: %s. That's bad.", chatIdStr)
 		}
 		chatIds = append(chatIds, chatId)
 	}
@@ -81,20 +80,24 @@ func main() {
 		wg       sync.WaitGroup
 		tgEvents = make(chan GenericMessage, 100)
 		sleeper  = RealSleeper{time.Second * MessageNotMoreOftenThanSeconds}
+		logger   = log.New(os.Stderr, "Main", log.Lmicroseconds)
 	)
 
-	satelAddr, chatIds := getCmdLineParams()
+	satelAddr, chatIds := getCmdLineParams(logger)
 
 	s := makeSatel(satelAddr)
+	logger.Printf("Connected to Satel: %s", satelAddr)
 
 	bot, err := tgbotapi.NewBotAPI(os.Getenv("TELEGRAM_APITOKEN"))
 	if err != nil {
 		panic(err)
 	}
+	logger.Print("Created Telegram Bot API client")
 
 	tgSender := TgSender{bot}
-	go tgSenderWorker(tgEvents, tgSender, &wg, sleeper)
+	go tgSenderWorker(tgEvents, tgSender, &wg, sleeper, log.New(os.Stderr, "TgSender", log.Lmicroseconds))
 	for e := range s.Events {
+		logger.Println("Received change from SATEL: ", e)
 		sendTgMessage(tgEvents, fmt.Sprintln("Change from SATEL: ", "type", e.Type, "index", e.Index, "value", e.Value), chatIds)
 	}
 
diff --git a/sender_worker.go b/sender_worker.go
index 36ba108..c0a7dc1 100644
--- a/sender_worker.go
+++ b/sender_worker.go
@@ -1,6 +1,7 @@
 package main
 
 import (
+	"log"
 	"strings"
 	"sync"
 )
@@ -18,7 +19,8 @@ type Sleeper interface {
 	Sleep(ch chan<- interface{})
 }
 
-func tgSenderWorker(tgEvents <-chan GenericMessage, s Sender, wg *sync.WaitGroup, sleeper Sleeper) {
+func tgSenderWorker(tgEvents <-chan GenericMessage, s Sender, wg *sync.WaitGroup, sleeper Sleeper, logger *log.Logger) {
+	logger.Print("Starting")
 	wg.Add(1)
 	defer wg.Done()
 	messagesToSend := make(map[int64]*strings.Builder)
@@ -40,10 +42,12 @@ loop:
 			messagesToSend[ev.chatId].WriteString(ev.msg)
 			messagesToSend[ev.chatId].WriteRune('\n')
 			if !waitingStarted {
+				logger.Print("Waiting for more messages to arrive before sending...")
 				waitingStarted = true
 				sleeper.Sleep(timeoutEvents)
 			}
 		case <-timeoutEvents:
+			logger.Print("Time's up, sending all messages we've got for now.")
 			waitingStarted = false
 			for chatId, msgBuilder := range messagesToSend {
 				err := s.Send(GenericMessage{chatId, msgBuilder.String()})
@@ -56,6 +60,7 @@ loop:
 		}
 	}
 
+	logger.Print("Exiting")
 	// If anything is left to be sent, send it now
 	for chatId, msgBuilder := range messagesToSend {
 		err := s.Send(GenericMessage{chatId, msgBuilder.String()})
diff --git a/sender_worker_test.go b/sender_worker_test.go
index 4001793..f04e2d7 100644
--- a/sender_worker_test.go
+++ b/sender_worker_test.go
@@ -1,9 +1,12 @@
 package main
 
 import (
-	"github.com/stretchr/testify/assert"
+	"io"
+	"log"
 	"sync"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 type MockSender struct {
@@ -32,7 +35,7 @@ func TestMessageThrottling(t *testing.T) {
 	wg := sync.WaitGroup{}
 	mockSender := MockSender{make([]GenericMessage, 0)}
 	mockSleeper := MockSleeper{nil, 0}
-	go tgSenderWorker(testEvents, &mockSender, &wg, &mockSleeper)
+	go tgSenderWorker(testEvents, &mockSender, &wg, &mockSleeper, log.New(io.Discard, "", log.Ltime))
 	testEvents <- GenericMessage{123, "test1"}
 	testEvents <- GenericMessage{124, "test3"}
 	testEvents <- GenericMessage{123, "test2"}