break: update ServerMessage model

- rename MaxSession to TotalSession (and JSON struct tags)

🤖
This commit is contained in:
Sebastian Mark 2024-10-20 23:20:23 +02:00
parent 314e71acba
commit f9b2a76894
5 changed files with 23 additions and 23 deletions

View file

@ -55,14 +55,14 @@ These messages contain the following fields:
- mode: Indicates the current phase of the Pomodoro session ("Work", "ShortBreak", "LongBreak", or "none" if no session is running). - mode: Indicates the current phase of the Pomodoro session ("Work", "ShortBreak", "LongBreak", or "none" if no session is running).
- session: The current session number (e.g., 1 for the first work session). - session: The current session number (e.g., 1 for the first work session).
- max_session: The total number of sessions for the current Pomodoro cycle (e.g., 4 if the cycle consists of 4 work/break sessions). - total_sessions: The total number of sessions for the current Pomodoro cycle (e.g., 4 if the cycle consists of 4 work/break sessions).
- time_left: The remaining time for the current mode, in seconds (e.g., 900 for 15 minutes). - time_left: The remaining time for the current mode, in seconds (e.g., 900 for 15 minutes).
| Message Type | Sent by Server | Example | | Message Type | Sent by Server | Example |
| --------------------- | ------------------------------------------------ | --------------------------------------------------- | | --------------------- | ------------------------------------------------ | --------------------------------------------------- |
| Welcome Message | Upon initial client connection | `{"mode": "none", "session": 0, "max_session": 0, "time_left": 0}` | | Welcome Message | Upon initial client connection | `{"mode": "none", "session": 0, "total_sessions": 0, "time_left": 0}` |
| Session Update | Periodically during a session | `{"mode": "Work", "session": 1, "max_session": 4, "time_left": 900}` | | Session Update | Periodically during a session | `{"mode": "Work", "session": 1, "total_sessions": 4, "time_left": 900}` |
| Session End/Reset | After session completes or is reset | `{"mode": "none", "session": 0, "max_session": 0, "time_left": 0}` | | Session End/Reset | After session completes or is reset | `{"mode": "none", "session": 0, "total_sessions": 0, "time_left": 0}` |
## Testing ## Testing

View file

@ -41,11 +41,11 @@
var data = JSON.parse(event.data); var data = JSON.parse(event.data);
var mode = data.mode; var mode = data.mode;
var session = data.session; var session = data.session;
var maxSession = data.max_session; var totalSession = data.total_sessions;
var timeLeft = data.time_left; var timeLeft = data.time_left;
document.getElementById("timer").innerText = document.getElementById("timer").innerText =
mode + " Session " + session + "/" + maxSession + ": " + formatTime(timeLeft); mode + " Session " + session + "/" + totalSession + ": " + formatTime(timeLeft);
}; };
ws.onclose = function () { ws.onclose = function () {

View file

@ -52,10 +52,10 @@ func ResetPomodoro(clients map[*websocket.Conn]*models.Client) {
// Broadcast the reset message to all clients // Broadcast the reset message to all clients
broadcast.BroadcastMessage(clients, models.ServerMessage{ broadcast.BroadcastMessage(clients, models.ServerMessage{
Mode: "none", Mode: "none",
Session: 0, Session: 0,
MaxSession: 0, TotalSession: 0,
TimeLeft: 0, TimeLeft: 0,
}) })
// Send a reset signal to stop any running timers // Send a reset signal to stop any running timers

View file

@ -8,7 +8,7 @@ import (
) )
// startTimer runs the countdown and broadcasts every second. // startTimer runs the countdown and broadcasts every second.
func startTimer(clients map[*websocket.Conn]*models.Client, remainingSeconds int, mode string, session int, sessions int) bool { func startTimer(clients map[*websocket.Conn]*models.Client, remainingSeconds int, mode string, session int, totalSessions int) bool {
for remainingSeconds > 0 { for remainingSeconds > 0 {
select { select {
case <-pomodoroResetChannel: case <-pomodoroResetChannel:
@ -21,10 +21,10 @@ func startTimer(clients map[*websocket.Conn]*models.Client, remainingSeconds int
// Broadcast the current state to all clients // Broadcast the current state to all clients
if !IsPomodoroPaused() { if !IsPomodoroPaused() {
broadcast.BroadcastMessage(clients, models.ServerMessage{ broadcast.BroadcastMessage(clients, models.ServerMessage{
Mode: mode, Mode: mode,
Session: session, Session: session,
MaxSession: sessions, TotalSession: totalSessions,
TimeLeft: remainingSeconds, TimeLeft: remainingSeconds,
}) })
time.Sleep(time.Second) time.Sleep(time.Second)
remainingSeconds-- remainingSeconds--
@ -34,10 +34,10 @@ func startTimer(clients map[*websocket.Conn]*models.Client, remainingSeconds int
// Final broadcast when time reaches zero // Final broadcast when time reaches zero
broadcast.BroadcastMessage(clients, models.ServerMessage{ broadcast.BroadcastMessage(clients, models.ServerMessage{
Mode: mode, Mode: mode,
Session: session, Session: session,
MaxSession: sessions, TotalSession: totalSessions,
TimeLeft: 0, TimeLeft: 0,
}) })
return true return true

View file

@ -2,8 +2,8 @@ package models
// ServerMessage represents the data sent to the client via WebSocket. // ServerMessage represents the data sent to the client via WebSocket.
type ServerMessage struct { type ServerMessage struct {
Mode string `json:"mode"` // "Work", "ShortBreak", or "LongBreak" Mode string `json:"mode"` // "Work", "ShortBreak", or "LongBreak"
Session int `json:"session"` // Current session number Session int `json:"session"` // Current session number
MaxSession int `json:"max_session"` // Total number of sessions TotalSession int `json:"total_sessions"` // Total number of sessions
TimeLeft int `json:"time_left"` // Remaining time in seconds TimeLeft int `json:"time_left"` // Remaining time in seconds
} }