Compare commits

...

5 commits

Author SHA1 Message Date
3d5cb29c54 chore: cleanup pause/resume functions 2024-10-20 11:28:28 +02:00
b62e92b5a4 fix: resolve race condition in pause/resume check
- replace direct check of pomodoroPaused with IsPomodoroPaused function
2024-10-20 11:28:26 +02:00
4471c86a0c fix: prevent concurrent write to websocket connection
- refactor client handling and message broadcasting
- replace Client struct
- implement SendMessage method in Client struct for safer message sending
- update client map to use *models.Client instead of bool
- adjust BroadcastMessage and RunPomodoroTimer functions to use new client type

🤖
2024-10-20 11:06:37 +02:00
ffc6913344 break: change the "stop" command to "reset"
- change stop channel to reset channel
- create ResetPomodoro function
- broadcast reset message to all clients
- rename stop button to reset button in index.html

🤖
2024-10-20 10:03:29 +02:00
bc3a306c00 feat: add pause and resume functionality
- implement pause and resume commands in the Pomodoro package
- modify timer logic to handle paused state
- adjust client command handling for pause and resume actions
- update HTML to include pause/resume button

🤖
2024-10-20 10:03:22 +02:00
8 changed files with 167 additions and 40 deletions

View file

@ -23,12 +23,14 @@
<h1>Pomodoro Timer</h1>
<div id="timer">Connecting to server...</div>
<!-- Buttons to start and stop the timer -->
<!-- Buttons to start, pause/resume, and stop the timer -->
<button id="startButton">Start</button>
<button id="stopButton">Stop</button>
<button id="pauseResumeButton" style="display: none;">Pause</button>
<button id="resetButton" style="display: none;">Reset</button>
<script>
var ws = new WebSocket("ws://localhost:8080/ws");
var isPaused = false; // Track if the timer is paused
ws.onopen = function () {
document.getElementById("timer").innerText = "Connected to server.";
@ -57,14 +59,43 @@
return minutes.toString().padStart(2, '0') + ":" + remainingSeconds.toString().padStart(2, '0');
}
// Send start command to the server
// Start Button Click Event
document.getElementById("startButton").addEventListener("click", function () {
ws.send(JSON.stringify({command: "start"}));
// Hide start button and show pause/resume and stop buttons
document.getElementById("startButton").style.display = "none";
document.getElementById("pauseResumeButton").style.display = "inline-block";
document.getElementById("resetButton").style.display = "inline-block";
// Set the pause/resume button to show "Pause" initially
isPaused = false;
document.getElementById("pauseResumeButton").innerText = "Pause";
});
// Send stop command to the server
document.getElementById("stopButton").addEventListener("click", function () {
// Pause/Resume Button Click Event
document.getElementById("pauseResumeButton").addEventListener("click", function () {
if (isPaused) {
// If paused, send resume command and update button text
ws.send(JSON.stringify({command: "resume"}));
document.getElementById("pauseResumeButton").innerText = "Pause";
isPaused = false;
} else {
// If running, send pause command and update button text
ws.send(JSON.stringify({command: "pause"}));
document.getElementById("pauseResumeButton").innerText = "Resume";
isPaused = true;
}
});
// Reset Button Click Event
document.getElementById("resetButton").addEventListener("click", function () {
ws.send(JSON.stringify({command: "stop"}));
// Reset buttons after stopping
document.getElementById("startButton").style.display = "inline-block";
document.getElementById("pauseResumeButton").style.display = "none";
document.getElementById("resetButton").style.display = "none";
});
</script>
</body>

View file

@ -8,7 +8,7 @@ import (
)
// BroadcastMessage sends a message to all connected WebSocket clients.
func BroadcastMessage(clients map[*websocket.Conn]bool, message models.BroadcastMessage) {
func BroadcastMessage(clients map[*websocket.Conn]*models.Client, message models.BroadcastMessage) {
// Marshal the message into JSON format
jsonMessage, err := json.Marshal(message)
if err != nil {
@ -17,12 +17,11 @@ func BroadcastMessage(clients map[*websocket.Conn]bool, message models.Broadcast
}
// Iterate over all connected clients and broadcast the message
for client := range clients {
err := client.WriteMessage(websocket.TextMessage, jsonMessage)
for _, client := range clients {
err := client.SendMessage(websocket.TextMessage, jsonMessage)
if err != nil {
log.Printf("Error broadcasting to client: %v", err)
client.Close()
delete(clients, client) // Remove the client if an error occurs
// The client is responsible for closing itself on error
}
}
}

View file

@ -1,6 +1,8 @@
package pomodoro
import (
"git.smsvc.net/pomodoro/GoTomato/internal/broadcast"
"git.smsvc.net/pomodoro/GoTomato/pkg/models"
"github.com/gorilla/websocket"
"sync"
)
@ -13,12 +15,20 @@ const (
)
var pomodoroRunning bool
var pomodoroPaused bool
var pomodoroResetChannel = make(chan bool, 1)
var pomodoroPauseChannel = make(chan bool, 1)
var pomodoroResumeChannel = make(chan bool, 1)
var mu sync.Mutex // to synchronize access to shared state
// RunPomodoroTimer iterates the Pomodoro work/break sessions.
func RunPomodoroTimer(clients map[*websocket.Conn]bool) {
func RunPomodoroTimer(clients map[*websocket.Conn]*models.Client) {
mu.Lock()
pomodoroRunning = true
pomodoroPaused = false
mu.Unlock()
for session := 1; session <= sessions; session++ {
if !startTimer(clients, workDuration, "Work", session) {
@ -35,11 +45,53 @@ func RunPomodoroTimer(clients map[*websocket.Conn]bool) {
}
}
mu.Lock()
pomodoroRunning = false
mu.Unlock()
}
// IsPomodoroRunning returns the status of the timer.
// ResetPomodoro resets the running Pomodoro timer.
func ResetPomodoro(clients map[*websocket.Conn]*models.Client) {
mu.Lock()
pomodoroRunning = false // Reset the running state
pomodoroPaused = false // Reset the paused state
mu.Unlock()
// Broadcast the reset message to all clients
broadcast.BroadcastMessage(clients, models.BroadcastMessage{
Mode: "none",
Session: 0,
MaxSession: 0,
TimeLeft: 0,
})
// Send a reset signal to stop any running timers
pomodoroResetChannel <- true
}
func PausePomodoro() {
mu.Lock()
pomodoroPaused = true
mu.Unlock()
pomodoroPauseChannel <- true
}
func ResumePomodoro() {
mu.Lock()
pomodoroPaused = false
mu.Unlock()
pomodoroResumeChannel <- true
}
func IsPomodoroRunning() bool {
mu.Lock()
defer mu.Unlock() // Ensures that the mutex is unlocked after the function is done
return pomodoroRunning
}
func IsPomodoroPaused() bool {
mu.Lock()
defer mu.Unlock() // Ensures that the mutex is unlocked after the function is done
return pomodoroPaused
}

View file

@ -7,16 +7,19 @@ import (
"time"
)
var timerStopChannel = make(chan bool, 1)
// startTimer runs the countdown and broadcasts every second.
func startTimer(clients map[*websocket.Conn]bool, remainingSeconds int, mode string, session int) bool {
func startTimer(clients map[*websocket.Conn]*models.Client, remainingSeconds int, mode string, session int) bool {
for remainingSeconds > 0 {
select {
case <-timerStopChannel:
return false // Stop the timer if a stop command is received
case <-pomodoroResetChannel:
return false
case <-pomodoroPauseChannel:
// Nothing to set here, just waiting for the signal
case <-pomodoroResumeChannel:
// Nothing to set here, just waiting for the signal
default:
// Broadcast the current state to all clients
if !IsPomodoroPaused() {
broadcast.BroadcastMessage(clients, models.BroadcastMessage{
Mode: mode,
Session: session,
@ -27,6 +30,7 @@ func startTimer(clients map[*websocket.Conn]bool, remainingSeconds int, mode str
remainingSeconds--
}
}
}
// Final broadcast when time reaches zero
broadcast.BroadcastMessage(clients, models.BroadcastMessage{
@ -38,8 +42,3 @@ func startTimer(clients map[*websocket.Conn]bool, remainingSeconds int, mode str
return true
}
// StopTimer sends a signal to stop the running Pomodoro timer.
func StopTimer() {
timerStopChannel <- true
}

View file

@ -6,10 +6,22 @@ import (
"git.smsvc.net/pomodoro/GoTomato/pkg/models"
"github.com/gorilla/websocket"
"log"
"sync"
)
// Clients is a map of connected WebSocket clients, where each client is represented by the Client struct
var Clients = make(map[*websocket.Conn]*models.Client)
var mu sync.Mutex // Mutex to protect access to the Clients map
// handleClientCommands listens for commands from WebSocket clients and dispatches to the timer.
func handleClientCommands(ws *websocket.Conn) {
// Create a new Client and add it to the Clients map
mu.Lock()
Clients[ws] = &models.Client{
Conn: ws,
}
mu.Unlock()
for {
_, message, err := ws.ReadMessage()
if err != nil {
@ -34,8 +46,17 @@ func handleClientCommands(ws *websocket.Conn) {
}
case "stop":
if pomodoro.IsPomodoroRunning() {
pomodoro.StopTimer() // Stop the timer in the Pomodoro package
pomodoro.ResetPomodoro(Clients) // Reset Pomodoro
}
case "pause":
if pomodoro.IsPomodoroRunning() && !pomodoro.IsPomodoroPaused() {
pomodoro.PausePomodoro() // Pause the timer
}
case "resume":
if pomodoro.IsPomodoroRunning() && pomodoro.IsPomodoroPaused() {
pomodoro.ResumePomodoro() // Resume the timer
}
}
}
}

View file

@ -1,14 +1,12 @@
package websocket
import (
"git.smsvc.net/pomodoro/GoTomato/pkg/models"
"github.com/gorilla/websocket"
"log"
"net/http"
)
// Map to track connected clients
var Clients = make(map[*websocket.Conn]bool)
// Upgrader to upgrade HTTP requests to WebSocket connections
var upgrader = websocket.Upgrader{
CheckOrigin: func(r *http.Request) bool { return true },
@ -25,7 +23,9 @@ func HandleConnections(w http.ResponseWriter, r *http.Request) {
defer ws.Close()
// Register the new client
Clients[ws] = true
Clients[ws] = &models.Client{
Conn: ws, // Store the WebSocket connection
}
// Listen for commands from the connected client
handleClientCommands(ws)

View file

@ -7,8 +7,3 @@ type BroadcastMessage struct {
MaxSession int `json:"max_session"` // Total number of sessions
TimeLeft int `json:"time_left"` // Remaining time in seconds
}
// ClientCommand represents a command from the client (start/stop).
type ClientCommand struct {
Command string `json:"command"`
}

30
pkg/models/client.go Normal file
View file

@ -0,0 +1,30 @@
package models
import (
"github.com/gorilla/websocket"
"log"
"sync"
)
// ClientCommand represents a command from the client (start/stop).
type ClientCommand struct {
Command string `json:"command"`
}
type Client struct {
Conn *websocket.Conn
Mutex sync.Mutex
}
// It automatically locks and unlocks the mutex to ensure that only one goroutine can write at a time.
func (c *Client) SendMessage(messageType int, data []byte) error {
c.Mutex.Lock()
defer c.Mutex.Unlock()
err := c.Conn.WriteMessage(messageType, data)
if err != nil {
log.Printf("Error writing to WebSocket: %v", err)
c.Conn.Close() // Close the connection on error
}
return err
}