Compare commits

...

48 commits
v0.0.3 ... main

Author SHA1 Message Date
9a86adaf85 fix: introduce const for broadcast interval
- change ticker to use BROADCAST_INTERVAL constant
- define BROADCAST_INTERVAL as 1 second

🤖
2024-11-22 08:05:21 +01:00
a09de61a33 refactor: improve broadcast loop ticker
- rename tick to ticker for clarity
- change infinite loop to range over ticker channel
- add defer statement to stop the ticker properly
- remove unnecessary channel receive operation

🤖
2024-11-22 08:05:08 +01:00
1ed866bfe5 refactor: merge SendMessage() into SendPermanentBroadCastMessage() 2024-11-22 08:04:34 +01:00
064a720436 fix: add more mutex locks for Clients map 2024-11-22 08:04:34 +01:00
ab2e8c161d feat: implement stale client removal after timeout
- add goroutine to remove stale clients from the connection pool
- update client struct to track `LastPong` time
- set write deadline for websocket connections
- move package variables and const to `vars.go`
- log additional information when broadcasting errors

🤖
2024-11-21 21:48:57 +01:00
e8e65c4f3a break: remove /ws from websocket path 2024-11-18 19:15:30 +01:00
256837c130 feat: add client instructions to usage output
- add custom usage message
- include instructions for WebSocket client connection

🤖
2024-11-18 19:15:12 +01:00
31179d4af4 break: update terminology from "Work" to "Focus"
- change mode from "Work" to "Focus" in server messages
- modify pomodoro configuration to use "Focus" instead of "Work"
- adjust default settings to reflect new terminology
- ensure all references to work duration are updated to focus duration
- update variable names in HTML and JavaScript for clarity

🤖
2024-11-18 19:14:42 +01:00
b3f403cf1a fix(renovate): make Go deps always a "chore"
- add package rules to set semantic commit type for gomod
2024-11-10 17:03:14 +01:00
64f790bf90 feat(goreleaser): update build command to use .ModulePath variable
- change hardcoded module path to dynamic reference

🤖
2024-11-10 09:40:56 +01:00
8683cb2a6b chore: add yaml schemas to Taskfile.yml and .goreleaser.yaml 2024-11-10 09:39:28 +01:00
13e2c2d0e4 fix(goreleaser): don't force-remove ./dist 2024-11-10 09:39:28 +01:00
2f337bb9d6 feat: add release management via Task
- create `Taskfile.yml`
- initial tasks
  - add new version tag
  - push to remote and run goreleaser
  - create snapshot via goreleaser
2024-11-10 09:39:23 +01:00
05a8701a26 feat: update -version output 2024-11-10 09:15:43 +01:00
2032688c1f feat!: always retrieve version from runtime/debug.Main.Version or latest git tag
- set version from runtime/debug.Main.Version
- use latest git tag as fallback
- allow GoTomatoVersion to be overwritten via ldflags
- this will break `go build .` and `go install .`
2024-11-10 09:15:43 +01:00
9852f80461 fix: restore filter that excludes version bump entries 2024-11-10 09:15:43 +01:00
467d90065c feat(goreleaser): update changelog configuration
- uses the compare Gitea API
- drop `sort` setting
- remove the filter that excludes version bump entries
2024-11-10 09:15:43 +01:00
93f39507c1 feat(gorleaser): set version from git tag on build
- make `GoTomatoVersion` a variable and default it to "devel"
- add ldflags to `.goreleaser.yaml` for version tagging
- remove "v" from output of `-version`
2024-11-10 09:15:16 +01:00
783d158e92 feat: bump version to 0.1.1 2024-11-06 23:23:19 +01:00
f346cbbcaa feat: add initial configuration for GoReleaser
🤖
2024-11-06 23:23:10 +01:00
b15324f6f8 feat: bump version to v0.1.0 2024-11-06 20:51:25 +01:00
cbe2e007de break: drop "v" from version string const
- removes "v" from the ProtocolVersion in the ServerMessage
- remove "v" prefix from GoTomatoVersion constant
- re-add "v" for for human readable output (`-version`)
- update README
2024-11-06 20:50:49 +01:00
d7b7789051 feat: bump version to v0.0.8 2024-11-04 20:35:01 +01:00
600d2ed2ff feat: implement centralized logging helper
- remove direct log usage
- create a new logging helper
- update all log calls to use the new Logger instance
- set timestamp to ISO8601

🤖
2024-11-04 20:33:25 +01:00
76f3954299 feat: bump version to v0.0.7 2024-11-03 11:19:03 +01:00
44a64bfce4 feat: handle X-Forward-For for log output
- add Gorilla handlers package for enhanced HTTP handling
- refactor HTTP server to use a new ServeMux for routing
- update ListenAndServe to utilize ProxyHeaders for better proxy support
- add RealIP field to client model
  - use RealIP fild for connect/disconnect log output
2024-11-03 11:17:23 +01:00
dd9490bb3b feat: bump version to v0.0.6 2024-10-30 11:29:47 +01:00
e7618b19ef feat: validate client settings and improve logging
- add a function to check if Pomodoro settings are valid
- log a warning for invalid client configurations
- log an info message for valid client configurations
- implement Stringer interface for PomodoroConfig model

🤖
2024-10-30 11:28:42 +01:00
f4fd37c551 feat: update logging for client connect and disconnect
- update logging to use ws.RemoteAddr()

🤖
2024-10-30 10:20:44 +01:00
0ee955189c feat: update client management to use local address as identifier
- change Clients map to use net.Addr as the key type
- update `HandleConnection()` to store clients using LocalAddr
- modify `handleClientCommands()` to delete clients by LocalAddr

🤖
2024-10-30 10:20:12 +01:00
ebb58a4489 feat: rename Client model to WebsocketClient
🤖
2024-10-30 09:57:09 +01:00
2d2ea6ff78 feat: bump version to v0.0.5 2024-10-30 08:11:54 +01:00
bdfd5c3b84 feat: remove unused client mutex
- remove unused Mutex from `models.Client` struct
- remove lock from `HandleConnection()`
- replace websocket.Conn with models.Client in `handleClientCommands()`

🤖
2024-10-30 08:09:41 +01:00
94b6786c7c feat: implement asynchronous timer start
- add new StartAsync method to Timer for non-blocking execution
- use new method in RunPomodoro()

🤖
2024-10-30 07:46:29 +01:00
d0b1260f62 doc: add and improve comments 2024-10-30 07:39:30 +01:00
d83acc77b2 refactor: rename HandleConnections to HandleConnection
- rename function to better reflect its purpose

🤖
2024-10-29 20:21:00 +01:00
b8823acc97 refacor: replace shared.Message with shared.State
🤖
2024-10-29 18:46:00 +01:00
5750ec96cb refactor: update version output
- use `Println` for better readability
2024-10-29 11:05:45 +01:00
d69a4bec10 format: use group style variable declaration to define cli flags 2024-10-29 11:05:45 +01:00
e2ab19066d format: update import statements order for consistency 2024-10-29 11:05:45 +01:00
3a6be4c187 feat: update settings handling for pomodoro configuration
- add `UpdateSettings()` to update pomodoro configuration
- refactor client command handling to use `UpdateSettings()`

🤖
2024-10-29 11:05:45 +01:00
f0d7dc80fc feat: update protocol version handling
- add ProtocolVersion variable to metadata package
- don't set `ServerMessage.ProtocolVersion` in `main`
- update `ServerMessage` default to include ProtocolVersion

🤖
2024-10-29 11:05:44 +01:00
f8ab1375d1 chore: bump version to v0.0.4 2024-10-29 11:05:30 +01:00
ffc994126b break: rename GoTomatoServerConfig -> ServerConfig 2024-10-26 10:19:55 +02:00
c20d36d2d2 break: rename GoTomatoPomodoroConfig -> PomodoroConfig 2024-10-26 10:19:50 +02:00
0180aea8c1 break: rename ServerMessage.GoTomatoVersion -> .ProtocolVersion 2024-10-26 10:19:48 +02:00
16bc946a30 break: rename ClientCommand.PomodoroSettings -> .Settings 2024-10-26 10:19:44 +02:00
61b2f71bf3 break: rename ServerMessage.PomodoroSettings -> .Settings 2024-10-26 10:19:41 +02:00
24 changed files with 432 additions and 180 deletions

2
.gitignore vendored
View file

@ -1 +1,3 @@
GoTomato
dist/

43
.goreleaser.yaml Normal file
View file

@ -0,0 +1,43 @@
# vim: set ts=2 sw=2 tw=0 fo=cnqoj
# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
version: 2
before:
hooks:
- go mod tidy
builds:
- goos:
- linux
goarch:
- amd64
- arm64
env:
- CGO_ENABLED=0
ldflags:
- -s -w -X {{.ModulePath}}/internal/metadata.GoTomatoVersion={{.Version}}
upx:
- enabled: true
compress: best
lzma: true
changelog:
use: gitea
filters:
exclude:
- "chore: bump version to"
archives:
- format: binary
release:
gitea:
owner: pomodoro
name: GoTomato
mode: replace
gitea_urls:
download: http://git.smsvc.net
api: http://git.smsvc.net/api/v1

View file

@ -2,5 +2,11 @@
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"local>infrastructure/renovate-config"
],
"packageRules": [
{
"matchManagers": ["gomod"],
"semanticCommitType": "chore"
}
]
}

View file

@ -34,17 +34,17 @@ Here are the available commands:
| `pause` | Pauses the current session | `{"command": "pause", "password": ""}` |
| `resume` | Resumes a paused session | `{"command": "resume", "password": ""}` |
| `reset` | Stops and resets the current session | `{"command": "reset", "password": ""}` |
| `updateSettings` | Update Pomodoro settings | `{"command": "updateSettings", "password": "", "settings": {"work": 600, "shortBreak": 60, "longBreak": 300, "sessions": 2}}` |
| `updateSettings` | Update Pomodoro settings | `{"command": "updateSettings", "password": "", "settings": {"focus": 600, "shortBreak": 60, "longBreak": 300, "sessions": 2}}` |
#### Update Settings Command (`updateSettings`)
The `updateSettings` command allows clients to modify the Pomodoro timer configuration, including the length of work sessions, short breaks, long breaks, and the total number of sessions in a cycle. This command must include a valid password to be accepted by the server. The updateSettings command can be used when the timer is stopped.
The `updateSettings` command allows clients to modify the Pomodoro timer configuration, including the length of focus sessions, short breaks, long breaks, and the total number of sessions in a cycle. This command must include a valid password to be accepted by the server. The updateSettings command can be used when the timer is stopped.
- Fields in the `settings` Object:
- `work`: Length of the work session (in seconds).
- `focus`: Length of the focus session (in seconds).
- `shortBreak`: Length of the short break (in seconds).
- `longBreak`: Length of the long break (in seconds).
- `sessions`: Total number of work/break sessions in the Pomodoro cycle.
- `sessions`: Total number of focus/break sessions in the Pomodoro cycle.
All fields are mandatory and may not be ommitted.
@ -52,14 +52,14 @@ 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).
- focus: Length of the focus session in seconds (e.g., 1500 for 25 minutes).
- shortBreak: Length of the short break in seconds (e.g., 300 for 5 minutes).
- longBreak: Length of the long break in seconds (e.g., 900 for 15 minutes).
- sessions: The total number of work/break sessions (e.g., 4).
- session: The current session number (e.g., 1 for the first work session).
- sessions: The total number of focus/break sessions (e.g., 4).
- session: The current session number (e.g., 1 for the first focus session).
- time_left: The remaining time for the current mode, in seconds (e.g., 900 for 15 minutes).
- ongoing: Whether a Pomodoro session is currently ongoing.
- paused: Whether the timer is paused.
@ -67,11 +67,11 @@ 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":"v0"} |
| Session Running | {"mode":"Work", "settings":{"work":1500, "shortBreak":300, "longBreak":900, "sessions":4}, "session":1, "time_left":900, "ongoing":true, "paused":false, "version":"v0"} |
| Session Running | {"mode":"ShortBreak", "settings":{"work":1500, "shortBreak":300, "longBreak":900, "sessions":4}, "session":2, "time_left":50, "ongoing":true, "paused":false, "version":"v0"} |
| Session Paused | {"mode":"Work", "settings":{"work":1500, "shortBreak":300, "longBreak":900, "sessions":4}, "session":2, "time_left":456, "ongoing":true, "paused":true, "version":"v0"} |
| Session End/Reset | {"mode":"End", "settings":{"work":1500, "shortBreak":300, "longBreak":900, "sessions":4}, "session":0, "time_left":0, "ongoing":false, "paused":false, "version":"v0"} |
| Welcome Message | {"mode":"Idle", "settings":{"focus":1500, "shortBreak":300, "longBreak":900, "sessions":4}, "session":0, "time_left":1500, "ongoing":false, "paused":false, "version":"0"} |
| Session Running | {"mode":"Focus", "settings":{"focus":1500, "shortBreak":300, "longBreak":900, "sessions":4}, "session":1, "time_left":900, "ongoing":true, "paused":false, "version":"0"} |
| Session Running | {"mode":"ShortBreak", "settings":{"focus":1500, "shortBreak":300, "longBreak":900, "sessions":4}, "session":2, "time_left":50, "ongoing":true, "paused":false, "version":"0"} |
| Session Paused | {"mode":"Focus", "settings":{"focus":1500, "shortBreak":300, "longBreak":900, "sessions":4}, "session":2, "time_left":456, "ongoing":true, "paused":true, "version":"0"} |
| Session End/Reset | {"mode":"End", "settings":{"focus":1500, "shortBreak":300, "longBreak":900, "sessions":4}, "session":0, "time_left":0, "ongoing":false, "paused":false, "version":"0"} |
## Testing

34
Taskfile.yml Normal file
View file

@ -0,0 +1,34 @@
# yaml-language-server: $schema=https://taskfile.dev/schema.json
#
# github.com/go-task/task/v3/cmd/task@latest
# Requirements:
# github.com/caarlos0/svu@latest
# github.com/goreleaser/goreleaser/v2@latest
version: '3'
tasks:
release:
desc: Create and publish an new release
vars:
RELEASE:
sh: svu next
BRANCH:
sh: git branch --show-current
COMMIT:
sh: git rev-parse --short --verify {{.BRANCH}}
preconditions:
- sh: test "{{.BRANCH}}" == "main"
msg: "You must be on the main branch to release"
prompt: Create new release {{.RELEASE}} from {{.COMMIT}}@{{.BRANCH}}?
cmds:
- git tag {{.RELEASE}}
- git push
- git push origin tag {{.RELEASE}}
- goreleaser release --clean
snapshot:
desc: Create a local snapshot release
cmds:
- goreleaser release --clean --snapshot

View file

@ -3,46 +3,65 @@ package server
import (
"flag"
"fmt"
"github.com/gorilla/handlers"
"net/http"
"os"
"git.smsvc.net/pomodoro/GoTomato/internal/helper"
"git.smsvc.net/pomodoro/GoTomato/internal/metadata"
"git.smsvc.net/pomodoro/GoTomato/internal/shared"
"git.smsvc.net/pomodoro/GoTomato/internal/websocket"
"git.smsvc.net/pomodoro/GoTomato/pkg/models"
"github.com/charmbracelet/log"
"net/http"
"os"
"strings"
)
var (
// define CLI flags
listenAddress = flag.String("listenAddress", shared.DefaultServerConfig.ListenAddress, "IP address to listen on")
listenPort = flag.Int("listenPort", shared.DefaultServerConfig.ListenPort, "Port to listen on")
password = flag.String("password", "", "Control password for pomodoro session (optional)")
showVersion = flag.Bool("version", false, "Output version")
)
// Start the pomodoro server
func Start() {
// Define CLI flags for ListenAddress and ListenPort
listenAddress := flag.String("listenAddress", shared.DefaultServerConfig.ListenAddress, "IP address to listen on")
listenPort := flag.Int("listenPort", shared.DefaultServerConfig.ListenPort, "Port to listen on")
password := flag.String("password", "", "Control password for pomodoro session (optional)")
showVersionFlag := flag.Bool("version", false, "Output version")
// 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()
shared.Message.GoTomatoVersion = strings.Split(metadata.GoTomatoVersion, ".")[0]
if *showVersionFlag {
fmt.Printf("App-Version: %s\n", metadata.GoTomatoVersion)
fmt.Printf("Protocol-Version: %s\n", shared.Message.GoTomatoVersion)
// show server and protocl version and exit
if *showVersion {
fmt.Printf("GoTomato v%s\n", metadata.GoTomatoVersion)
fmt.Printf("Protocol-Version: %s\n", metadata.ProtocolVersion)
os.Exit(0)
}
serverConfig := models.GoTomatoServerConfig{
// set server config
serverConfig := models.ServerConfig{
ListenAddress: *listenAddress,
ListenPort: *listenPort,
}
shared.PomodoroPassword = *password
// define listen address for websocket
listen := fmt.Sprintf("%s:%d", serverConfig.ListenAddress, serverConfig.ListenPort)
http.HandleFunc("/ws", websocket.HandleConnections)
// start connection handler and broadcast
r := http.NewServeMux()
r.HandleFunc("/", websocket.HandleConnection)
go websocket.SendPermanentBroadCastMessage()
go websocket.RemoveStaleClients()
log.Info("GoTomato started", "version", metadata.GoTomatoVersion)
log.Info("Websocket listening", "address", listen)
err := http.ListenAndServe(listen, nil)
helper.Logger.Info("GoTomato started", "version", metadata.GoTomatoVersion)
helper.Logger.Info("Websocket listening", "address", listen)
// start the listener
err := http.ListenAndServe(listen, handlers.ProxyHeaders(r))
if err != nil {
log.Fatal("Error starting server:", "msg", err)
helper.Logger.Fatal("Error starting server:", "msg", err)
}
}

2
go.mod
View file

@ -4,12 +4,14 @@ go 1.23
require (
github.com/charmbracelet/log v0.4.0
github.com/gorilla/handlers v1.5.2
github.com/gorilla/websocket v1.5.3
)
require (
github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
github.com/charmbracelet/lipgloss v0.10.0 // indirect
github.com/felixge/httpsnoop v1.0.3 // indirect
github.com/go-logfmt/logfmt v0.6.0 // indirect
github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
github.com/mattn/go-isatty v0.0.18 // indirect

4
go.sum
View file

@ -6,8 +6,12 @@ github.com/charmbracelet/log v0.4.0 h1:G9bQAcx8rWA2T3pWvx7YtPTPwgqpk7D68BX21IRW8
github.com/charmbracelet/log v0.4.0/go.mod h1:63bXt/djrizTec0l11H20t8FDSvA4CRZJ1KH22MdptM=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/felixge/httpsnoop v1.0.3 h1:s/nj+GCswXYzN5v2DpNMuMQYe+0DDwt5WVCU6CWBdXk=
github.com/felixge/httpsnoop v1.0.3/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U=
github.com/go-logfmt/logfmt v0.6.0 h1:wGYYu3uicYdqXVgoYbvnkrPVXkuLM1p1ifugDMEdRi4=
github.com/go-logfmt/logfmt v0.6.0/go.mod h1:WYhtIu8zTZfxdn5+rREduYbwxfcBr/Vr6KEVveWlfTs=
github.com/gorilla/handlers v1.5.2 h1:cLTUSsNkgcwhgRqvCNmdbRWG0A3N4F+M2nWKdScwyEE=
github.com/gorilla/handlers v1.5.2/go.mod h1:dX+xVpaxdSw+q0Qek8SSsl3dfMk3jNddUkMzo0GtH0w=
github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg=
github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=

View file

@ -40,8 +40,8 @@
<input type="text" id="password" placeholder="Password" />
</p>
<p>
<label for="workDuration">Work Duration (seconds):</label>
<input type="number" id="workDuration" placeholder="Work time in seconds" value="900" />
<label for="focusDuration">Focus Duration (seconds):</label>
<input type="number" id="foucsDuration" placeholder="Focus 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

View file

@ -0,0 +1,12 @@
package helper
import (
"github.com/charmbracelet/log"
"os"
"time"
)
var Logger = log.NewWithOptions(os.Stdout, log.Options{
ReportTimestamp: true,
TimeFormat: time.RFC3339,
})

View file

@ -1,3 +1,37 @@
package metadata
const GoTomatoVersion = "v0.0.3" // The GoTomato Version
import (
"os/exec"
"runtime/debug"
"strings"
)
var (
GoTomatoVersion = "" // The GoTomato version
ProtocolVersion = "" // The protocol version
)
func stripVersionPrefix(version string) string {
return strings.TrimLeft(version, "v")
}
func getLatestTag() string {
bytes, _ := exec.Command("git", "describe", "--tags").Output()
output := strings.TrimSpace(string(bytes))
return stripVersionPrefix(output)
}
// set GoTomatoVersion from runtime/debug.Main.Version
// use latest git tag as fallback
// can be overwritten via ldflags (e,g. by goreleaser)
func init() {
if GoTomatoVersion == "" {
info, _ := debug.ReadBuildInfo()
if info.Main.Version != "(devel)" {
GoTomatoVersion = stripVersionPrefix(info.Main.Version)
} else {
GoTomatoVersion = getLatestTag()
}
}
ProtocolVersion = strings.Split(GoTomatoVersion, ".")[0]
}

View file

@ -1,14 +1,18 @@
package pomodoro
import (
"git.smsvc.net/pomodoro/GoTomato/internal/shared"
"sync"
"time"
"git.smsvc.net/pomodoro/GoTomato/internal/shared"
"git.smsvc.net/pomodoro/GoTomato/pkg/models"
)
var mu sync.Mutex // to synchronize access to shared state
var timer Timer
// Update `State` with the remaining seconds of the passed timer
// until the timer sends an End or Abort signal
func waitForTimer(t Timer) bool {
for {
select {
@ -16,57 +20,61 @@ func waitForTimer(t Timer) bool {
return true
case <-t.Abort:
return false
case shared.Message.TimeLeft = <-t.TimeLeft:
case shared.State.TimeLeft = <-t.TimeLeft:
// do nothing, just let the timer update the message
}
}
}
// RunPomodoro iterates the Pomodoro work/break sessions.
// RunPomodoro iterates the Pomodoro focus/break sessions
func RunPomodoro() {
mu.Lock()
shared.Message.Ongoing = true
shared.Message.Paused = false
shared.State.Ongoing = true
shared.State.Paused = false
mu.Unlock()
pomodoroConfig := shared.Message.PomodoroSettings
pomodoroConfig := shared.State.Settings
for session := 1; session <= pomodoroConfig.Sessions; session++ {
timer = timer.Init()
shared.Message.Session = session
shared.State.Session = session
shared.Message.Mode = "Work"
go timer.Start(pomodoroConfig.Work)
// Focus
shared.State.Mode = "Focus"
timer.StartAsync(pomodoroConfig.Focus)
if !waitForTimer(timer) {
break
}
// Breaks
if session < pomodoroConfig.Sessions {
shared.Message.Mode = "ShortBreak"
go timer.Start(pomodoroConfig.ShortBreak)
shared.State.Mode = "ShortBreak"
timer.StartAsync(pomodoroConfig.ShortBreak)
if !waitForTimer(timer) {
break
}
} else { // last phase, prepare for finish
shared.Message.Mode = "LongBreak"
go timer.Start(pomodoroConfig.LongBreak)
shared.State.Mode = "LongBreak"
timer.StartAsync(pomodoroConfig.LongBreak)
if !waitForTimer(timer) {
break
}
shared.Message.Mode = "End"
// send "End" state for one second
shared.State.Mode = "End"
time.Sleep(time.Second)
}
}
mu.Lock()
shared.Message.Ongoing = false
shared.Message.Paused = false
shared.State.Ongoing = false
shared.State.Paused = false
mu.Unlock()
shared.Message.Mode = "Idle"
shared.Message.Session = 0
shared.Message.TimeLeft = shared.Message.PomodoroSettings.Work
shared.State.Mode = "Idle"
shared.State.Session = 0
shared.State.TimeLeft = shared.State.Settings.Focus
}
func ResetPomodoro() {
@ -75,7 +83,7 @@ func ResetPomodoro() {
func PausePomodoro() {
mu.Lock()
shared.Message.Paused = true
shared.State.Paused = true
mu.Unlock()
timer.Pause()
@ -83,19 +91,26 @@ func PausePomodoro() {
func ResumePomodoro() {
mu.Lock()
shared.Message.Paused = false
shared.State.Paused = false
mu.Unlock()
timer.Resume()
}
func IsPomodoroOngoing() bool {
mu.Lock()
defer mu.Unlock() // Ensures that the mutex is unlocked after the function is done
return shared.Message.Ongoing
defer mu.Unlock()
return shared.State.Ongoing
}
func IsPomodoroPaused() bool {
mu.Lock()
defer mu.Unlock() // Ensures that the mutex is unlocked after the function is done
return shared.Message.Paused
defer mu.Unlock()
return shared.State.Paused
}
func UpdateSettings(settings models.PomodoroConfig) {
if settings != (models.PomodoroConfig{}) {
shared.State.Settings = settings
shared.State.TimeLeft = settings.Focus
}
}

View file

@ -1,18 +1,18 @@
package pomodoro
import (
"time"
)
import "time"
// Represents a timer
type Timer struct {
TimeLeft chan int // time left
TimeLeft chan int // signals time left on every second
End chan bool // signal on successful end
Abort chan bool // signal on premature end
stop chan bool
wait chan bool
resume chan bool
stop chan bool // internal channel
wait chan bool // internal channel
resume chan bool // internal channel
}
// Initializes a new timer with fresh channels
func (t Timer) Init() Timer {
return Timer{
TimeLeft: make(chan int),
@ -24,6 +24,12 @@ func (t Timer) Init() Timer {
}
}
// Start the timer (goroutine)
func (t *Timer) StartAsync(duration int) {
go t.Start(duration)
}
// Start the timer (blocking)
func (t *Timer) Start(duration int) {
tick := time.NewTicker(time.Second)
for timeLeft := duration; timeLeft > 0; {

View file

@ -1,16 +1,16 @@
package shared
import (
"git.smsvc.net/pomodoro/GoTomato/pkg/models"
)
import "git.smsvc.net/pomodoro/GoTomato/pkg/models"
var DefaultServerConfig = models.GoTomatoServerConfig{
// The default server config if nothing else is set
var DefaultServerConfig = models.ServerConfig{
ListenAddress: "0.0.0.0",
ListenPort: 8080,
}
var DefaultPomodoroConfig = models.GoTomatoPomodoroConfig{
Work: 25 * 60,
// The default pomodoro config if nothing else is set
var DefaultPomodoroConfig = models.PomodoroConfig{
Focus: 25 * 60,
ShortBreak: 5 * 60,
LongBreak: 15 * 60,
Sessions: 4,

View file

@ -1,16 +1,20 @@
package shared
import (
"git.smsvc.net/pomodoro/GoTomato/internal/metadata"
"git.smsvc.net/pomodoro/GoTomato/pkg/models"
)
var Message = models.ServerMessage{
// The global state of the pomodoro
var State = models.ServerMessage{
Mode: "Idle",
PomodoroSettings: DefaultPomodoroConfig,
Settings: DefaultPomodoroConfig,
Session: 0,
TimeLeft: DefaultPomodoroConfig.Work,
TimeLeft: DefaultPomodoroConfig.Focus,
Ongoing: false,
Paused: false,
ProtocolVersion: metadata.ProtocolVersion,
}
// The password needed to execute client commands or change the pomodoro config
var PomodoroPassword string

View file

@ -2,30 +2,36 @@ package websocket
import (
"encoding/json"
"git.smsvc.net/pomodoro/GoTomato/internal/shared"
"github.com/charmbracelet/log"
"github.com/gorilla/websocket"
"time"
"git.smsvc.net/pomodoro/GoTomato/internal/helper"
"git.smsvc.net/pomodoro/GoTomato/internal/shared"
)
// sends continous messages to all connected WebSocket clients.
// Sends continous messages to all connected WebSocket clients
func SendPermanentBroadCastMessage() {
tick := time.NewTicker(time.Second)
for {
ticker := time.NewTicker(BROADCAST_INTERVAL * time.Second)
defer ticker.Stop()
for range ticker.C {
// Marshal the message into JSON format
jsonMessage, err := json.Marshal(shared.Message)
jsonMessage, err := json.Marshal(shared.State)
if err != nil {
log.Error("Error marshalling message:", "msg", err)
helper.Logger.Error("Error marshalling message:", "msg", err)
return
}
// Iterate over all connected clients and broadcast the message
mu.Lock()
for _, client := range Clients {
err := client.SendMessage(websocket.TextMessage, jsonMessage)
// Send message to client
client.Conn.SetWriteDeadline(time.Now().Add(SEND_TIMEOUT * time.Second))
err := client.Conn.WriteMessage(websocket.TextMessage, jsonMessage)
if err != nil {
log.Error("Error broadcasting to client:", "msg", err)
// The client is responsible for closing itself on error
helper.Logger.Error("Error broadcasting to client:", "msg", err, "host", client.RealIP, "clients", len(Clients))
}
}
<-tick.C
mu.Unlock()
}
}

View file

@ -2,29 +2,37 @@ package websocket
import (
"encoding/json"
"git.smsvc.net/pomodoro/GoTomato/internal/helper"
"git.smsvc.net/pomodoro/GoTomato/internal/pomodoro"
"git.smsvc.net/pomodoro/GoTomato/internal/shared"
"git.smsvc.net/pomodoro/GoTomato/pkg/models"
"github.com/charmbracelet/log"
"github.com/gorilla/websocket"
)
// handleClientCommands listens for commands from WebSocket clients
func handleClientCommands(ws *websocket.Conn) {
func checkSettings(settings models.PomodoroConfig) bool {
return settings.Focus > 0 && settings.ShortBreak > 0 && settings.LongBreak > 0 && settings.Sessions > 0
}
// Listens for commands from a client and handles them
func handleClientCommands(c models.WebsocketClient) {
ws := c.Conn
for {
var clientCommand models.ClientCommand
_, message, err := ws.ReadMessage()
if err != nil {
log.Info("Client disconnected:", "msg", err, "host", ws.NetConn().RemoteAddr(), "clients", len(Clients)-1)
delete(Clients, ws)
// remove client on error/disconnect
mu.Lock()
delete(Clients, ws.LocalAddr())
mu.Unlock()
helper.Logger.Info("Client disconnected:", "msg", err, "host", c.RealIP, "clients", len(Clients))
break
}
// Handle incoming commands
err = json.Unmarshal(message, &clientCommand)
if err != nil {
log.Error("Error unmarshalling command:", "msg", err)
helper.Logger.Error("Error unmarshalling command:", "msg", err)
continue
}
@ -49,11 +57,12 @@ func handleClientCommands(ws *websocket.Conn) {
}
case "updateSettings":
if !pomodoro.IsPomodoroOngoing() {
if clientCommand.PomodoroSettings != (models.GoTomatoPomodoroConfig{}) {
shared.Message.PomodoroSettings = clientCommand.PomodoroSettings
shared.Message.TimeLeft = clientCommand.PomodoroSettings.Work
if !checkSettings(clientCommand.Settings) {
helper.Logger.Warn("Ignoring invalid config:", "msg", clientCommand.Settings, "host", c.Conn.RemoteAddr())
break
}
helper.Logger.Info("Client send config", "config", clientCommand.Settings, "host", c.Conn.RemoteAddr())
pomodoro.UpdateSettings(clientCommand.Settings)
}
}
}

View file

@ -0,0 +1,46 @@
package websocket
import (
"github.com/gorilla/websocket"
"net/http"
"time"
"git.smsvc.net/pomodoro/GoTomato/internal/helper"
"git.smsvc.net/pomodoro/GoTomato/pkg/models"
)
// Upgrade HTTP requests to WebSocket connections
var upgrader = websocket.Upgrader{
CheckOrigin: func(r *http.Request) bool { return true },
}
// Upgrades HTTP requests to WebSocket connections and manages the client lifecycle
func HandleConnection(w http.ResponseWriter, r *http.Request) {
// Upgrade initial GET request to a WebSocket
ws, err := upgrader.Upgrade(w, r, nil)
if err != nil {
helper.Logger.Error("WebSocket upgrade error:", "msg", err)
return
}
defer ws.Close()
// Register the new client
client := models.WebsocketClient{
Conn: ws,
LastPong: time.Now(),
RealIP: r.RemoteAddr,
}
client.Conn.SetPongHandler(func(s string) error {
client.LastPong = time.Now()
return nil
})
mu.Lock()
Clients[ws.LocalAddr()] = &client
mu.Unlock()
helper.Logger.Info("Client connected", "host", client.RealIP, "clients", len(Clients))
// Listen for commands from the connected client
handleClientCommands(client)
}

View file

@ -1,41 +0,0 @@
package websocket
import (
"git.smsvc.net/pomodoro/GoTomato/pkg/models"
"github.com/charmbracelet/log"
"github.com/gorilla/websocket"
"net/http"
"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
// Upgrader to upgrade HTTP requests to WebSocket connections
var upgrader = websocket.Upgrader{
CheckOrigin: func(r *http.Request) bool { return true },
}
// HandleConnections upgrades HTTP requests to WebSocket connections and manages the client lifecycle.
func HandleConnections(w http.ResponseWriter, r *http.Request) {
// Upgrade initial GET request to a WebSocket
ws, err := upgrader.Upgrade(w, r, nil)
if err != nil {
log.Error("WebSocket upgrade error:", "msg", err)
return
}
defer ws.Close()
log.Info("Client connected", "host", ws.NetConn().RemoteAddr(), "clients", len(Clients)+1)
// Register the new client
mu.Lock()
Clients[ws] = &models.Client{
Conn: ws, // Store the WebSocket connection
}
mu.Unlock()
// Listen for commands from the connected client
handleClientCommands(ws)
}

View file

@ -0,0 +1,34 @@
package websocket
import (
"time"
"git.smsvc.net/pomodoro/GoTomato/internal/helper"
"git.smsvc.net/pomodoro/GoTomato/pkg/models"
"github.com/gorilla/websocket"
)
// Check and remove stale clients
func RemoveStaleClients() {
ticker := time.NewTicker(STALE_CHECK_INTERVALL * time.Second)
defer ticker.Stop()
for range ticker.C {
mu.Lock()
for _, client := range Clients {
client.Conn.SetWriteDeadline(time.Now().Add(SEND_TIMEOUT * time.Second))
client.Conn.WriteMessage(websocket.PingMessage, nil)
if isStale(client) {
helper.Logger.Info("Removing stale client", "host", client.RealIP, "lastPong", client.LastPong.Format(time.RFC3339))
client.Conn.Close()
delete(Clients, client.Conn.LocalAddr())
}
}
mu.Unlock()
}
}
func isStale(client *models.WebsocketClient) bool {
return time.Since(client.LastPong) > (STALE_CLIENT_TIMEOUT * time.Second)
}

View file

@ -0,0 +1,19 @@
package websocket
import (
"net"
"sync"
"git.smsvc.net/pomodoro/GoTomato/pkg/models"
)
const BROADCAST_INTERVAL = 1
const SEND_TIMEOUT = 10
const STALE_CLIENT_TIMEOUT = 90
const STALE_CHECK_INTERVALL = 30
// Clients is a map of connected WebSocket clients, where each client is represented by the WebsocketClient struct
var Clients = make(map[net.Addr]*models.WebsocketClient)
// Mutex to protect access to the Clients map
var mu sync.Mutex

View file

@ -1,32 +1,21 @@
package models
import (
"github.com/charmbracelet/log"
"time"
"github.com/gorilla/websocket"
"sync"
)
// ClientCommand represents a command from the client (start/stop).
// Represents a command from the client (start/stop)
type ClientCommand struct {
Command string `json:"command"` // comman send to the server
Password string `json:"password"` // pomodoro control password
PomodoroSettings GoTomatoPomodoroConfig `json:"settings"` // pomodoro config
Command string `json:"command"` // Command send to the server
Password string `json:"password"` // Pomodoro control password
Settings PomodoroConfig `json:"settings"` // Pomodoro config
}
type Client struct {
// Represents a single client
type WebsocketClient 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.Error("Error writing to WebSocket:", "msg", err)
c.Conn.Close() // Close the connection on error
}
return err
LastPong time.Time
RealIP string
}

View file

@ -1,13 +1,22 @@
package models
type GoTomatoPomodoroConfig struct {
Work int `json:"work"` // Length of work sessions in seconds
import "fmt"
// Represents the configuration of a pomodoro
type PomodoroConfig struct {
Focus int `json:"focus"` // Length of focus sessions in seconds
ShortBreak int `json:"shortBreak"` // Length of short break in seconds
LongBreak int `json:"longBreak"` // Length if ling break in seconds
LongBreak int `json:"longBreak"` // Length of long break in seconds
Sessions int `json:"sessions"` // Number of total sessions
}
type GoTomatoServerConfig struct {
// Stringer interface for the PomodocoConfig model
func (c PomodoroConfig) String() string {
return fmt.Sprintf("{focus: %d, short: %d, long: %d, sessions: %d}", c.Focus, c.ShortBreak, c.LongBreak, c.Sessions)
}
// Represents the server configuration
type ServerConfig struct {
ListenAddress string `json:"listenAddress"` // Server listen address
ListenPort int `json:"listenPort"` // Server listen port
}

View file

@ -1,12 +1,12 @@
package models
// ServerMessage represents the data sent to the client via WebSocket.
// Represents the data sent to the client via WebSocket
type ServerMessage struct {
Mode string `json:"mode"` // "Idle", "Work", "ShortBreak", "LongBreak" or "End"
PomodoroSettings GoTomatoPomodoroConfig `json:"settings"` // The currrent pomodoro settings
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
Ongoing bool `json:"ongoing"` // Ongoing pomodoro
Ongoing bool `json:"ongoing"` // Pomodoro ongoing
Paused bool `json:"paused"` // Is timer paused
GoTomatoVersion string `json:"version"` // Version of the server
ProtocolVersion string `json:"version"` // Version of the protocol
}