break: remove /ws from websocket path

- add custom usage message
- include instructions for WebSocket client connection

🤖

README.md

@@ -52,7 +52,7 @@ All fields are mandatory and may not be ommitted.
 
 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:
 
-- mode: Indicates the current phase of the Pomodoro session ("Work", "ShortBreak", "LongBreak", "End" or "Idle").
+- mode: Indicates the current phase of the Pomodoro session ("Focus", "ShortBreak", "LongBreak", "End" or "Idle").
   - "End" is send only once, after all sessions are finished
 - settings: Contains the current Pomodoro settings:
     -  work: Length of the work session in seconds (e.g., 1500 for 25 minutes).
@@ -68,9 +68,9 @@ The server periodically (every second) sends JSON-encoded messages to all connec
 | Message Type      | Example                                                                                                                                                                       |
 | ---               | ---                                                                                                                                                                           |
 | Welcome Message   | {"mode":"Idle", "settings":{"work":1500, "shortBreak":300, "longBreak":900, "sessions":4}, "session":0, "time_left":1500, "ongoing":false, "paused":false, "version":"0"}    |
-| Session Running   | {"mode":"Work", "settings":{"work":1500, "shortBreak":300, "longBreak":900, "sessions":4}, "session":1, "time_left":900, "ongoing":true, "paused":false, "version":"0"}      |
+| Session Running   | {"mode":"Focus", "settings":{"work":1500, "shortBreak":300, "longBreak":900, "sessions":4}, "session":1, "time_left":900, "ongoing":true, "paused":false, "version":"0"}      |
 | Session Running   | {"mode":"ShortBreak", "settings":{"work":1500, "shortBreak":300, "longBreak":900, "sessions":4}, "session":2, "time_left":50, "ongoing":true, "paused":false, "version":"0"} |
-| Session Paused    | {"mode":"Work", "settings":{"work":1500, "shortBreak":300, "longBreak":900, "sessions":4}, "session":2, "time_left":456, "ongoing":true, "paused":true, "version":"0"}       |
+| Session Paused    | {"mode":"Focus", "settings":{"work":1500, "shortBreak":300, "longBreak":900, "sessions":4}, "session":2, "time_left":456, "ongoing":true, "paused":true, "version":"0"}       |
 | Session End/Reset | {"mode":"End", "settings":{"work":1500, "shortBreak":300, "longBreak":900, "sessions":4}, "session":0, "time_left":0, "ongoing":false, "paused":false, "version":"0"}        |
 
 ## Testing

cmd/server/main.go

@@ -16,18 +16,25 @@ import (
 
 var (
 	// define CLI flags
-	listenAddress   = flag.String("listenAddress", shared.DefaultServerConfig.ListenAddress, "IP address to listen on")
+	listenAddress = flag.String("listenAddress", shared.DefaultServerConfig.ListenAddress, "IP address to listen on")
-	listenPort      = flag.Int("listenPort", shared.DefaultServerConfig.ListenPort, "Port to listen on")
+	listenPort    = flag.Int("listenPort", shared.DefaultServerConfig.ListenPort, "Port to listen on")
-	password        = flag.String("password", "", "Control password for pomodoro session (optional)")
+	password      = flag.String("password", "", "Control password for pomodoro session (optional)")
-	showVersionFlag = flag.Bool("version", false, "Output version")
+	showVersion   = flag.Bool("version", false, "Output version")
 )
 
 // Start the pomodoro server
 func Start() {
+	// Update usage output
+	flag.Usage = func() {
+		fmt.Fprintf(flag.CommandLine.Output(), "Usage of %s:\n", "GoTomato")
+		flag.PrintDefaults()
+		fmt.Println("\nPoint your client to 'ws://<listenAddress>:<listenPort>'")
+	}
+
 	flag.Parse()
 
 	// show server and protocl version and exit
-	if *showVersionFlag {
+	if *showVersion {
 		fmt.Printf("GoTomato v%s\n", metadata.GoTomatoVersion)
 		fmt.Printf("Protocol-Version: %s\n", metadata.ProtocolVersion)
 		os.Exit(0)
@@ -45,7 +52,7 @@ func Start() {
 
 	// start connection handler and broadcast
 	r := http.NewServeMux()
-	r.HandleFunc("/ws", websocket.HandleConnection)
+	r.HandleFunc("/", websocket.HandleConnection)
 	go websocket.SendPermanentBroadCastMessage()
 
 	helper.Logger.Info("GoTomato started", "version", metadata.GoTomatoVersion)

index.html

@@ -40,8 +40,8 @@
 			<input type="text" id="password" placeholder="Password" />
 		</p>
 		<p>
-			<label for="workDuration">Work Duration (seconds):</label>
+			<label for="focusDuration">Focus Duration (seconds):</label>
-			<input type="number" id="workDuration" placeholder="Work time in seconds" value="900" />
+			<input type="number" id="foucsDuration" placeholder="Work time in seconds" value="900" />
 			<br />
 			<label for="shortBreakDuration">Short Break Duration (seconds):</label>
 			<input type="number" id="shortBreakDuration" placeholder="Short break in seconds" value="300" />
@@ -64,7 +64,7 @@
 	<button id="resetButton" style="display: none;">Reset</button>
 
 	<script>
-		var ws = new WebSocket("ws://localhost:8080/ws");
+		var ws = new WebSocket("ws://localhost:8080");
 		var isPaused = false; // Track if the timer is paused
 
 		ws.onopen = function () {
@@ -98,7 +98,7 @@
 		document.getElementById("saveButton").addEventListener("click", function () {
 			// Get the values from the input fields
 			var password = document.getElementById("password").value;
-			var work = parseInt(document.getElementById("workDuration").value);
+			var focus = parseInt(document.getElementById("focusDuration").value);
 			var shortBreak = parseInt(document.getElementById("shortBreakDuration").value);
 			var longBreak = parseInt(document.getElementById("longBreakDuration").value);
 			var sessions = parseInt(document.getElementById("sessions").value);
@@ -108,7 +108,7 @@
 				command: "updateSettings",
 				password: password,
 				settings: {
-					work: work,
+					focus: focus,
 					shortBreak: shortBreak,
 					longBreak: longBreak,
 					sessions: sessions

internal/pomodoro/pomodoro.go

@@ -40,9 +40,9 @@ func RunPomodoro() {
 
 		shared.State.Session = session
 
-		// Work
+		// Focus
-		shared.State.Mode = "Work"
+		shared.State.Mode = "Focus"
-		timer.StartAsync(pomodoroConfig.Work)
+		timer.StartAsync(pomodoroConfig.Focus)
 		if !waitForTimer(timer) {
 			break
 		}
@@ -74,7 +74,7 @@ func RunPomodoro() {
 
 	shared.State.Mode = "Idle"
 	shared.State.Session = 0
-	shared.State.TimeLeft = shared.State.Settings.Work
+	shared.State.TimeLeft = shared.State.Settings.Focus
 }
 
 func ResetPomodoro() {
@@ -111,6 +111,6 @@ func IsPomodoroPaused() bool {
 func UpdateSettings(settings models.PomodoroConfig) {
 	if settings != (models.PomodoroConfig{}) {
 		shared.State.Settings = settings
-		shared.State.TimeLeft = settings.Work
+		shared.State.TimeLeft = settings.Focus
 	}
 }

internal/shared/configDefaults.go

@@ -10,7 +10,7 @@ var DefaultServerConfig = models.ServerConfig{
 
 // The default pomodoro config if nothing else is set
 var DefaultPomodoroConfig = models.PomodoroConfig{
-	Work:       25 * 60,
+	Focus:      25 * 60,
 	ShortBreak: 5 * 60,
 	LongBreak:  15 * 60,
 	Sessions:   4,

internal/shared/state.go

@@ -10,7 +10,7 @@ var State = models.ServerMessage{
 	Mode:            "Idle",
 	Settings:        DefaultPomodoroConfig,
 	Session:         0,
-	TimeLeft:        DefaultPomodoroConfig.Work,
+	TimeLeft:        DefaultPomodoroConfig.Focus,
 	Ongoing:         false,
 	Paused:          false,
 	ProtocolVersion: metadata.ProtocolVersion,

internal/websocket/client_commands.go

@@ -10,7 +10,7 @@ import (
 )
 
 func checkSettings(settings models.PomodoroConfig) bool {
-	return settings.Work > 0 && settings.ShortBreak > 0 && settings.LongBreak > 0 && settings.Sessions > 0
+	return settings.Focus > 0 && settings.ShortBreak > 0 && settings.LongBreak > 0 && settings.Sessions > 0
 }
 
 // Listens for commands from a client and handles them

pkg/models/config.go

@@ -4,7 +4,7 @@ import "fmt"
 
 // Represents the configuration of a pomodoro
 type PomodoroConfig struct {
-	Work       int `json:"work"`       // Length of work sessions in seconds
+	Focus      int `json:"Focus"`      // Length of work sessions in seconds
 	ShortBreak int `json:"shortBreak"` // Length of short break in seconds
 	LongBreak  int `json:"longBreak"`  // Length of long break in seconds
 	Sessions   int `json:"sessions"`   // Number of total sessions
@@ -12,7 +12,7 @@ type PomodoroConfig struct {
 
 // Stringer interface for the PomodocoConfig model
 func (c PomodoroConfig) String() string {
-	return fmt.Sprintf("{work: %d, short: %d, long: %d, sessions: %d}", c.Work, c.ShortBreak, c.LongBreak, c.Sessions)
+	return fmt.Sprintf("{work: %d, short: %d, long: %d, sessions: %d}", c.Focus, c.ShortBreak, c.LongBreak, c.Sessions)
 }
 
 // Represents the server configuration

pkg/models/server.go

@@ -2,7 +2,7 @@ package models
 
 // Represents the data sent to the client via WebSocket
 type ServerMessage struct {
-	Mode            string         `json:"mode"`      // "Idle", "Work", "ShortBreak", "LongBreak" or "End"
+	Mode            string         `json:"mode"`      // "Idle", "Focus", "ShortBreak", "LongBreak" or "End"
 	Settings        PomodoroConfig `json:"settings"`  // The currrent pomodoro settings
 	Session         int            `json:"session"`   // Current session number
 	TimeLeft        int            `json:"time_left"` // Remaining time in seconds