feat: allow clients to send pomodoro config

- allow clients to send custom configuration for pomodoro sessions
- update RunPomodoro to accept a configuration parameter
- modify startTimer to handle session count from config
- add default pomodoro configuration in client command handling

🤖

README.md

@@ -32,6 +32,23 @@ Clients communicate with the server by sending JSON-encoded commands. Each comma
 | `resume` | Resumes a paused session            | `{"command": "resume"}`           |
 | `reset`  | Stops and resets the current session| `{"command": "reset"}`            |
 
+#### Optional Start Parameters
+
+The Start-Command may contain an optional Pomodoro-Config, which allows you to customize the length of the work session, short break, long break, and the number of sessions. If no configuration is provided, the server will use default values.
+
+Example:
+```json
+{
+    command: "start",
+    config: {
+        "work": 10,          // Length of the work session in seconds
+        "shortBreak": 5,     // Length of the short break in seconds
+        "longBreak": 10,     // Length of the long break in seconds
+        "sessions": 2        // Number of total sessions
+    }
+}
+```
+
 ### Server Messages
 
 The server sends JSON-encoded messages to all connected clients to update them on the current state of the Pomodoro session.

index.html

@@ -61,7 +61,8 @@
 
 		// Start Button Click Event
 		document.getElementById("startButton").addEventListener("click", function () {
-			ws.send(JSON.stringify({command: "start"}));
+			// ws.send(JSON.stringify({command: "start"}));
+			ws.send(JSON.stringify({command: "start", config: {work: 10, shortBreak: 5, longBreak: 10, sessions: 2}}));
 
 			// Hide start button and show pause/resume and stop buttons
 			document.getElementById("startButton").style.display = "none";

internal/pomodoro/pomodoro.go

@@ -7,13 +7,6 @@ import (
 	"sync"
 )
 
-var PomodoroConfig = models.GoTomatoPomodoroConfig{
-	Work:       15 * 60,
-	ShortBreak: 5 * 60,
-	LongBreak:  10 * 60,
-	Sessions:   4,
-}
-
 var pomodoroOngoing bool
 var pomodoroPaused bool
 
@@ -24,22 +17,22 @@ var pomodoroResumeChannel = make(chan bool, 1)
 var mu sync.Mutex // to synchronize access to shared state
 
 // RunPomodoro iterates the Pomodoro work/break sessions.
-func RunPomodoro(clients map[*websocket.Conn]*models.Client) {
+func RunPomodoro(clients map[*websocket.Conn]*models.Client, config models.GoTomatoPomodoroConfig) {
 	mu.Lock()
 	pomodoroOngoing = true
 	pomodoroPaused = false
 	mu.Unlock()
 
-	for session := 1; session <= PomodoroConfig.Sessions; session++ {
-		if !startTimer(clients, PomodoroConfig.Work, "Work", session) {
+	for session := 1; session <= config.Sessions; session++ {
+		if !startTimer(clients, config.Work, "Work", session, config.Sessions) {
 			break
 		}
-		if session == PomodoroConfig.Sessions {
-			if !startTimer(clients, PomodoroConfig.LongBreak, "LongBreak", session) {
+		if session == config.Sessions {
+			if !startTimer(clients, config.LongBreak, "LongBreak", session, config.Sessions) {
 				break
 			}
 		} else {
-			if !startTimer(clients, PomodoroConfig.ShortBreak, "ShortBreak", session) {
+			if !startTimer(clients, config.ShortBreak, "ShortBreak", session, config.Sessions) {
 				break
 			}
 		}

internal/pomodoro/timer.go

@@ -8,7 +8,7 @@ import (
 )
 
 // startTimer runs the countdown and broadcasts every second.
-func startTimer(clients map[*websocket.Conn]*models.Client, remainingSeconds int, mode string, session int) bool {
+func startTimer(clients map[*websocket.Conn]*models.Client, remainingSeconds int, mode string, session int, sessions int) bool {
 	for remainingSeconds > 0 {
 		select {
 		case <-pomodoroResetChannel:
@@ -23,7 +23,7 @@ func startTimer(clients map[*websocket.Conn]*models.Client, remainingSeconds int
 				broadcast.BroadcastMessage(clients, models.ServerMessage{
 					Mode:       mode,
 					Session:    session,
-					MaxSession: PomodoroConfig.Sessions,
+					MaxSession: sessions,
 					TimeLeft:   remainingSeconds,
 				})
 				time.Sleep(time.Second)
@@ -36,7 +36,7 @@ func startTimer(clients map[*websocket.Conn]*models.Client, remainingSeconds int
 	broadcast.BroadcastMessage(clients, models.ServerMessage{
 		Mode:       mode,
 		Session:    session,
-		MaxSession: PomodoroConfig.Sessions,
+		MaxSession: sessions,
 		TimeLeft:   0,
 	})
 

internal/websocket/client_commands.go

@@ -8,9 +8,19 @@ import (
 	"log"
 )
 
+var unsetPomodoroConfig models.GoTomatoPomodoroConfig // used to check if client passed a config json
+
 // handleClientCommands listens for commands from WebSocket clients and dispatches to the timer.
 func handleClientCommands(ws *websocket.Conn) {
 	for {
+		var clientCommand models.ClientCommand
+		var pomodoroConfig = models.GoTomatoPomodoroConfig{
+			Work:       25 * 60,
+			ShortBreak: 5 * 60,
+			LongBreak:  15 * 60,
+			Sessions:   4,
+		}
+
 		_, message, err := ws.ReadMessage()
 		if err != nil {
 			log.Printf("Client disconnected: %v", err)
@@ -19,18 +29,20 @@ func handleClientCommands(ws *websocket.Conn) {
 		}
 
 		// Handle incoming commands
-		var command models.ClientCommand
-		err = json.Unmarshal(message, &command)
+		err = json.Unmarshal(message, &clientCommand)
 		if err != nil {
 			log.Printf("Error unmarshalling command: %v", err)
 			continue
 		}
 
 		// Process the command
-		switch command.Command {
+		switch clientCommand.Command {
 		case "start":
 			if !pomodoro.IsPomodoroOngoing() {
-				go pomodoro.RunPomodoro(Clients) // Start the timer with the list of clients
+				if clientCommand.Config != unsetPomodoroConfig {
+					pomodoroConfig = clientCommand.Config
+				}
+				go pomodoro.RunPomodoro(Clients, pomodoroConfig) // Start the timer with the list of clients
 			}
 		case "stop":
 			if pomodoro.IsPomodoroOngoing() {

pkg/models/client.go

@@ -8,7 +8,8 @@ import (
 
 // ClientCommand represents a command from the client (start/stop).
 type ClientCommand struct {
-	Command string `json:"command"`
+	Command string                 `json:"command"`
+	Config  GoTomatoPomodoroConfig `json:"config"`
 }
 
 type Client struct {