pomodoro/GoTomato
3
0
Fork 0
Code Issues Pull requests Releases 15 Activity

break: empty Message.Mode when no pomodoro ongoing

Browse source 
- change "none" to an empty string for the mode field
- update README to reflect the new mode representation
- ensure consistency across session end/reset and welcome messages

🤖
This commit is contained in:
Sebastian Mark 2024-10-21 13:14:26 +02:00
parent a9d145ee71
commit b7d03aa1d8
3 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -53,7 +53,7 @@ Example:
The server periodically (every second) sends JSON-encoded messages to all connected clients to update them on the current state of the Pomodoro session. The server periodically (every second) sends JSON-encoded messages to all connected clients to update them on the current state of the Pomodoro session.
These messages contain the following fields: 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 empty 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).
- total_sessions: 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).
@ -62,11 +62,11 @@ These messages contain the following fields:
| Message Type | Example | | Message Type | Example |
| --------------------- | --------------------------------------------------- | | --------------------- | --------------------------------------------------- |
| Welcome Message | `{"mode": "none", "session":0, "total_sessions":0, "time_left":0, "ongoing": false, "paused": false}` | | Welcome Message | `{"mode": "", "session":0, "total_sessions":0, "time_left":0, "ongoing": false, "paused": false}` |
| Session Running | `{"mode": "Work", "session": 1, "total_sessions": 4, "time_left": 900, "ongoing": true, "paused": false}` | | Session Running | `{"mode": "Work", "session": 1, "total_sessions": 4, "time_left": 900, "ongoing": true, "paused": false}` |
| Session Running | `{"mode": "ShortBreak", "session": 2, "total_sessions": 4, "time_left": 50, "ongoing": true, "paused": false}` | | Session Running | `{"mode": "ShortBreak", "session": 2, "total_sessions": 4, "time_left": 50, "ongoing": true, "paused": false}` |
| Session Paused | `{"mode": "Work", "session": 2, "total_sessions": 4, "time_left": 456, "ongoing": true, "paused": true}` | | Session Paused | `{"mode": "Work", "session": 2, "total_sessions": 4, "time_left": 456, "ongoing": true, "paused": true}` |
| Session End/Reset | `{"mode": "none", "session": 0, "total_sessions": 0, "time_left": 0, "ongoing": false, "paused": false}` | | Session End/Reset | `{"mode": "", "session": 0, "total_sessions": 0, "time_left": 0, "ongoing": false, "paused": false}` |
## Testing ## Testing

2
internal/pomodoro/pomodoro.go
View file

@ -56,7 +56,7 @@ func ResetPomodoro() {
mu.Unlock() mu.Unlock()
// Reset message // Reset message
shared.Message.Mode = "none" shared.Message.Mode = ""
shared.Message.Session = 0 shared.Message.Session = 0
shared.Message.TotalSession = 0 shared.Message.TotalSession = 0
shared.Message.TimeLeft = 0 shared.Message.TimeLeft = 0

2
internal/shared/state.go
View file

@ -5,7 +5,7 @@ import (
) )
var Message = models.ServerMessage{ var Message = models.ServerMessage{
Mode: "none", Mode: "",
Session: 0, Session: 0,
TotalSession: 0, TotalSession: 0,
TimeLeft: 0, TimeLeft: 0,