Add workflows and fix linter errors

Reviewed-on: #1

.envrc

@@ -0,0 +1 @@
+use flake

.github/workflows/go-test-build.yaml

@@ -0,0 +1,20 @@
+name: go-test-build
+on:
+  push:
+  pull_request:
+
+jobs:
+  go-test-build:
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/catthehacker/ubuntu:runner-latest
+    strategy:
+      matrix:
+        go: [ "1.22", "1.21" ]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.go }}
+      - run: go test -v ./...
+      - run: go build -o main main.go

.github/workflows/golangci-lint.yaml

@@ -0,0 +1,19 @@
+name: golangci-lint
+on:
+  push:
+  pull_request:
+
+jobs:
+  goglangci-lint:
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/catthehacker/ubuntu:runner-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "1.22"
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v6
+        with:
+          version: v1.61

.github/workflows/nix-check-build.yaml

@@ -0,0 +1,15 @@
+name: nix-check-build
+on:
+  push:
+  pull_request:
+
+jobs:
+  nix-check-build:
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/catthehacker/ubuntu:runner-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: cachix/install-nix-action@v27
+      - run: nix flake check
+      - run: nix build

.gitignore

@@ -0,0 +1,2 @@
+.direnv
+result

bus/bus.go

@@ -0,0 +1,49 @@
+package bus
+
+import (
+	"time"
+
+	"git.t-juice.club/torjus/ghettoptt/metrics"
+	"github.com/godbus/dbus/v5"
+)
+
+type MumbleBus struct {
+	conn    *dbus.Conn
+	obj     dbus.BusObject
+	metrics *metrics.MumbleMetricsCollector
+
+	lastTalked time.Time
+}
+
+func NewMumbleBus(m *metrics.MumbleMetricsCollector) *MumbleBus {
+	mb := &MumbleBus{
+		metrics: m,
+	}
+	conn, err := dbus.ConnectSessionBus()
+	if err != nil {
+		panic(err)
+	}
+	mb.obj = conn.Object("net.sourceforge.mumble.mumble", "/")
+	mb.conn = conn
+	return mb
+}
+
+func (m *MumbleBus) Close() error {
+	return m.conn.Close()
+}
+
+func (m *MumbleBus) StartTalking() error {
+	m.obj.Call("net.sourceforge.mumble.Mumble.startTalking", 0)
+	m.lastTalked = time.Now()
+	m.metrics.PTTTogglesTotal.Add(1)
+	return nil
+}
+
+func (m *MumbleBus) StopTalking() error {
+	m.obj.Call("net.sourceforge.mumble.Mumble.stopTalking", 0)
+	duration := time.Since(m.lastTalked)
+	m.lastTalked = time.Time{}
+	m.metrics.TalkSecondsTotal.Add(duration.Seconds())
+	m.metrics.PTTTogglesTotal.Add(1)
+	return nil
+}

debouncer/debouncer.go

@@ -0,0 +1,53 @@
+package debouncer
+
+import "time"
+
+type Debouncer struct {
+	input <-chan bool
+	C     <-chan bool
+}
+
+func New(ch <-chan bool, window time.Duration) *Debouncer {
+	output := make(chan bool)
+	var currentState bool
+	var lastState bool
+	falseTimer := time.NewTimer(0)
+	falseTimer.Stop()
+	go func() {
+		for {
+			select {
+			case <-falseTimer.C:
+				if !currentState && lastState {
+					output <- false
+					lastState = false
+				} else {
+					falseTimer.Reset(window)
+				}
+			case v, ok := <-ch:
+				if !ok {
+					falseTimer.Reset(window)
+					<-falseTimer.C
+					output <- false
+					close(output)
+					return
+				}
+				if v {
+					if !lastState {
+						output <- true
+						lastState = true
+						falseTimer.Reset(window)
+					}
+
+					currentState = true
+				} else {
+					falseTimer.Reset(window)
+
+					currentState = false
+				}
+			}
+		}
+	}()
+	d := &Debouncer{input: ch, C: output}
+
+	return d
+}

debouncer/debouncer_test.go

@@ -0,0 +1,89 @@
+package debouncer_test
+
+import (
+	"testing"
+	"time"
+
+	"git.t-juice.club/torjus/ghettoptt/debouncer"
+)
+
+func TestDebouncer(t *testing.T) {
+	t.Run("Simple", func(t *testing.T) {
+		ch := make(chan bool)
+		d := debouncer.New(ch, 200*time.Millisecond)
+
+		go func() {
+			ch <- true
+			close(ch)
+		}()
+
+		if v := <-d.C; v != true {
+			t.Errorf("Expected true, got %v", v)
+		}
+	})
+	t.Run("TrueTrueTrueFalse", func(t *testing.T) {
+		ch := make(chan bool)
+		d := debouncer.New(ch, 200*time.Millisecond)
+		go func() {
+			ch <- true
+			ch <- true
+			ch <- true
+			ch <- false
+			close(ch)
+		}()
+		if v := <-d.C; v != true {
+			t.Errorf("Expected true, got %v", v)
+		}
+		if v := <-d.C; v != false {
+			t.Errorf("Expected false, got %v", v)
+		}
+	})
+	t.Run("Debounce", func(t *testing.T) {
+		ch := make(chan bool)
+		d := debouncer.New(ch, 200*time.Millisecond)
+		go func() {
+			ch <- true
+			time.Sleep(10 * time.Millisecond)
+			ch <- false
+			time.Sleep(1 * time.Millisecond)
+			ch <- true
+			time.Sleep(1 * time.Millisecond)
+			ch <- false
+			time.Sleep(10 * time.Millisecond)
+			close(ch)
+		}()
+		if v := <-d.C; v != true {
+			t.Errorf("Expected first value to be true, got %v", v)
+		}
+		if v := <-d.C; v != false {
+			t.Errorf("Expected second value to be false, got %v", v)
+		}
+
+		if v, ok := <-d.C; ok {
+			t.Errorf("Expected closed channel, got %v", v)
+		}
+	})
+	t.Run("DebounceDelay", func(t *testing.T) {
+		ch := make(chan bool)
+		d := debouncer.New(ch, 200*time.Millisecond)
+		go func() {
+			ch <- true
+			ch <- false
+			close(ch)
+		}()
+		start := time.Now()
+		if v := <-d.C; v != true {
+			t.Errorf("Expected first value to be true, got %v", v)
+		}
+		if v, ok := <-d.C; v != false || !ok {
+			if ok {
+				t.Errorf("Expected second value to be false, got %v", v)
+			} else {
+				t.Error("Unexpected closed channel")
+			}
+		}
+		if duration := time.Since(start); duration < 200*time.Millisecond {
+			t.Errorf("Got false too soon: %s", duration)
+		}
+	})
+}

flake.lock

@@ -2,11 +2,11 @@
   "nodes": {
     "nixpkgs": {
       "locked": {
-        "lastModified": 1709703039,
+        "lastModified": 1727122398,
-        "narHash": "sha256-6hqgQ8OK6gsMu1VtcGKBxKQInRLHtzulDo9Z5jxHEFY=",
+        "narHash": "sha256-o8VBeCWHBxGd4kVMceIayf5GApqTavJbTa44Xcg5Rrk=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "9df3e30ce24fd28c7b3e2de0d986769db5d6225d",
+        "rev": "30439d93eb8b19861ccbe3e581abf97bdc91b093",
         "type": "github"
       },
       "original": {

flake.nix

@@ -3,7 +3,8 @@
 
   inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
 
-  outputs = { self, nixpkgs }:
+  outputs =
+    { self, nixpkgs }:
     let
       allSystems = [
         "x86_64-linux"
@@ -11,28 +12,56 @@
         "x86_64-darwin"
         "aarch64-darwin"
       ];
-      forAllSystems = f: nixpkgs.lib.genAttrs allSystems (system: f {
+      forAllSystems =
-        pkgs = import nixpkgs { inherit system; };
+        f:
-      });
+        nixpkgs.lib.genAttrs allSystems (
+          system:
+          f {
+            pkgs = import nixpkgs { inherit system; };
+          }
+        );
     in
     {
       overlays.default = final: prev: {
         ghettoptt = self.packages.${prev.system}.default;
       };
 
-      packages = forAllSystems ({ pkgs }: {
+      packages = forAllSystems (
-        default = pkgs.buildGoModule {
+        { pkgs }:
-          name = "ghettoptt";
+        {
-          src = ./.;
+          default =
-          vendorHash = "sha256-S/t8EkMRjceGhNcNqGhmnMviQrhqt7n9FiCmpxbKUoI=";
+            let
-        };
+              src = pkgs.lib.sourceFilesBySuffices ./. [
-      });
+                "go.mod"
-      devShells = forAllSystems ({ pkgs }: {
+                "go.sum"
-        default = pkgs.mkShell {
+                ".go"
-          packages = with pkgs; [
+              ];
-            go
+              version = pkgs.lib.strings.removePrefix "v" (
-          ];
+                builtins.elemAt (pkgs.lib.strings.split "\"" (
-        };
+                  pkgs.lib.lists.findFirst (x: pkgs.lib.strings.hasInfix "Version" x) null (
-      });
+                    pkgs.lib.strings.splitString "\n" (builtins.readFile ./main.go)
+                  )
+                )) 2
+              );
+            in
+            pkgs.buildGoModule {
+              version = version;
+              pname = "ghettoptt";
+              src = src;
+              vendorHash = "sha256-Jnk06H/5dIGbb284c2IReZfS7U0TaBoGWYkU/mjyBek=";
+            };
+        }
+      );
+      devShells = forAllSystems (
+        { pkgs }:
+        {
+          default = pkgs.mkShell {
+            packages = with pkgs; [
+              go
+              golangci-lint
+            ];
+          };
+        }
+      );
     };
 }

go.mod

@@ -3,6 +3,19 @@ module git.t-juice.club/torjus/ghettoptt
 go 1.21.6
 
 require (
-	github.com/godbus/dbus/v5 v5.1.0 // indirect
+	github.com/godbus/dbus/v5 v5.1.0
-	github.com/holoplot/go-evdev v0.0.0-20240306072622-217e18f17db1 // indirect
+	github.com/holoplot/go-evdev v0.0.0-20240306072622-217e18f17db1
+	github.com/prometheus/client_golang v1.20.4
+)
+
+require (
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/cespare/xxhash/v2 v2.3.0 // indirect
+	github.com/klauspost/compress v1.17.10 // indirect
+	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
+	github.com/prometheus/client_model v0.6.1 // indirect
+	github.com/prometheus/common v0.60.0 // indirect
+	github.com/prometheus/procfs v0.15.1 // indirect
+	golang.org/x/sys v0.26.0 // indirect
+	google.golang.org/protobuf v1.35.1 // indirect
 )

go.sum

@@ -1,4 +1,42 @@
+github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
+github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
+github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
+github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
+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/godbus/dbus/v5 v5.1.0 h1:4KLkAxT3aOY8Li4FRJe/KvhoNFFxo0m6fNuFUO8QJUk=
 github.com/godbus/dbus/v5 v5.1.0/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
+github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
+github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/holoplot/go-evdev v0.0.0-20240306072622-217e18f17db1 h1:92OsBIf5KB1Tatx+uUGOhah73jyNUrt7DmfDRXXJ5Xo=
 github.com/holoplot/go-evdev v0.0.0-20240306072622-217e18f17db1/go.mod h1:iHAf8OIncO2gcQ8XOjS7CMJ2aPbX2Bs0wl5pZyanEqk=
+github.com/klauspost/compress v1.17.10 h1:oXAz+Vh0PMUvJczoi+flxpnBEPxoER1IaAnU/NMPtT0=
+github.com/klauspost/compress v1.17.10/go.mod h1:pMDklpSncoRMuLFrf1W9Ss9KT+0rH90U12bZKk7uwG0=
+github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc=
+github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw=
+github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq1c1nUAm88MOHcQC9l5mIlSMApZMrHA=
+github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/prometheus/client_golang v1.20.4 h1:Tgh3Yr67PaOv/uTqloMsCEdeuFTatm5zIq5+qNN23vI=
+github.com/prometheus/client_golang v1.20.4/go.mod h1:PIEt8X02hGcP8JWbeHyeZ53Y/jReSnHgO035n//V5WE=
+github.com/prometheus/client_model v0.6.1 h1:ZKSh/rekM+n3CeS952MLRAdFwIKqeY8b62p8ais2e9E=
+github.com/prometheus/client_model v0.6.1/go.mod h1:OrxVMOVHjw3lKMa8+x6HeMGkHMQyHDk9E3jmP2AmGiY=
+github.com/prometheus/common v0.59.1 h1:LXb1quJHWm1P6wq/U824uxYi4Sg0oGvNeUm1z5dJoX0=
+github.com/prometheus/common v0.59.1/go.mod h1:GpWM7dewqmVYcd7SmRaiWVe9SSqjf0UrwnYnpEZNuT0=
+github.com/prometheus/common v0.60.0 h1:+V9PAREWNvJMAuJ1x1BaWl9dewMW4YrHZQbx0sJNllA=
+github.com/prometheus/common v0.60.0/go.mod h1:h0LYf1R1deLSKtD4Vdg8gy4RuOvENW2J/h19V5NADQw=
+github.com/prometheus/procfs v0.15.1 h1:YagwOFzUgYfKKHX6Dr+sHT7km/hxC76UB0learggepc=
+github.com/prometheus/procfs v0.15.1/go.mod h1:fB45yRUv8NstnjriLhBQLuOUt+WW4BsoGhij/e3PBqk=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+golang.org/x/sys v0.25.0 h1:r+8e+loiHxRqhXVl6ML1nO3l1+oFoWbnlu2Ehimmi34=
+golang.org/x/sys v0.25.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.26.0 h1:KHjCJyddX0LoSTb3J+vWpupP9p0oznkqVk/IfjymZbo=
+golang.org/x/sys v0.26.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+google.golang.org/protobuf v1.34.2 h1:6xV6lTsCfpGD21XK49h7MhtcApnLqkfYgPcdHftf6hg=
+google.golang.org/protobuf v1.34.2/go.mod h1:qYOHts0dSfpeUzUFpOMr/WGzszTmLH+DiWniOlNbLDw=
+google.golang.org/protobuf v1.35.1 h1:m3LfL6/Ca+fqnjnlqQXNpFPABW1UD7mjh8KO2mKFytA=
+google.golang.org/protobuf v1.35.1/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

main.go

@@ -4,15 +4,19 @@ import (
 	"context"
 	"errors"
 	"log/slog"
+	"net/http"
 	"os"
 	"os/signal"
 	"time"
 
-	"github.com/godbus/dbus/v5"
+	"git.t-juice.club/torjus/ghettoptt/bus"
+	"git.t-juice.club/torjus/ghettoptt/debouncer"
+	"git.t-juice.club/torjus/ghettoptt/metrics"
 	"github.com/holoplot/go-evdev"
+	"github.com/prometheus/client_golang/prometheus/promhttp"
 )
 
-const Version = "v0.1.1"
+const Version = "v0.1.4"
 
 func main() {
 	// Setup logger
@@ -24,55 +28,96 @@ func main() {
 	ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt)
 	defer stop()
 
-	// Connect to dbus
+	// Setup metrics
-	conn, err := dbus.ConnectSessionBus()
+	m := metrics.NewMumbleMetricsCollector()
-	if err != nil {
-		panic(err)
-	}
-	defer conn.Close()
 
-	obj := conn.Object("net.sourceforge.mumble.mumble", "/")
+	mbus := bus.NewMumbleBus(m)
+	defer mbus.Close()
 
 	// Start reading input events
-	input, err := evdev.OpenWithFlags("/dev/input/event1", os.O_RDONLY)
+	input, err := evdev.OpenWithFlags("/dev/input/by-id/usb-SteelSeries_SteelSeries_Rival_710_Gaming_Mouse-if02-event-kbd", os.O_RDONLY)
 	if err != nil {
 		panic(err)
 	}
 	defer input.Close()
-	input.NonBlock()
+	if err := input.NonBlock(); err != nil {
+		slog.Error("Failed to set non-blocking mode", "error", err)
+		os.Exit(1)
+	}
 
-	var done bool
+	// Start metrics server
+	srvCtx, srvCancel := context.WithCancel(context.Background())
+	defer srvCancel()
+	go func() {
+		mux := http.NewServeMux()
+		mux.Handle("/metrics", promhttp.Handler())
+		srv := http.Server{
+			Handler: mux,
+			Addr:    ":8989",
+		}
+		go func() {
+			<-ctx.Done()
+			_ = srv.Shutdown(context.Background())
+			srvCancel()
+		}()
+
+		slog.Info("Starting metrics server", "addr", srv.Addr)
+		if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
+			slog.Warn("Failed to start metrics server", "error", err)
+		}
+	}()
 
 	// Listen for context cancellation
 	go func() {
 		<-ctx.Done()
-		done = true
 		input.Close()
 	}()
 
-	var lastOn time.Time
 	// Start listening for PTT key
 	slog.Info("Starting event listener", "version", Version)
-	for !done {
+	eventCh := make(chan bool)
-		ev, err := input.ReadOne()
+	doneCtx, doneCancel := context.WithCancel(srvCtx)
-		if err != nil {
+	defer doneCancel()
-			if errors.Is(err, os.ErrClosed) {
+
-				continue
+	debouncer := debouncer.New(eventCh, 400*time.Millisecond)
+	go func() {
+		var done bool
+		for !done {
+			ev, err := input.ReadOne()
+			if err != nil {
+				if errors.Is(err, os.ErrClosed) {
+					continue
+				}
+				slog.Error("Error reading from input device", "error", err)
+				_ = mbus.StopTalking()
+				os.Exit(1)
+			}
+			if ev.Code == evdev.KEY_F24 && ev.Value == 1 {
+				slog.Debug("PTT ON")
+				eventCh <- true
+			}
+			if ev.Code == evdev.KEY_F24 && ev.Value == 0 {
+				slog.Debug("PTT OFF")
+				eventCh <- false
+			}
+			if doneCtx.Err() != nil {
+				close(eventCh)
+				done = true
 			}
-			slog.Error("Error reading fron input device", "error", err)
-			os.Exit(1)
 		}
-		if ev.Code == evdev.KEY_F24 && ev.Value == 1 {
+	}()
-			slog.Info("PTT ON")
+
-			lastOn = time.Now()
+	for v := range debouncer.C {
-			obj.Call("net.sourceforge.mumble.Mumble.startTalking", 0)
+		if v {
-		}
+			_ = mbus.StartTalking()
-		if ev.Code == evdev.KEY_F24 && ev.Value == 0 {
+			slog.Info("Started talking")
-			speakDuration := time.Since(lastOn).String()
+		} else {
-			slog.Info("PTT OFF", "duration", speakDuration)
+			_ = mbus.StopTalking()
-			obj.Call("net.sourceforge.mumble.Mumble.stopTalking", 0)
+			slog.Info("Stopped talking")
 		}
 	}
-	obj.Call("net.sourceforge.mumble.Mumble.stopTalking", 0)
+
+	_ = mbus.StopTalking()
+	<-srvCtx.Done()
 	slog.Info("Exiting")
 }

metrics/metrics.go

@@ -0,0 +1,27 @@
+package metrics
+
+import (
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/prometheus/client_golang/prometheus/promauto"
+)
+
+type MumbleMetricsCollector struct {
+	TalkSecondsTotal prometheus.Counter
+	PTTTogglesTotal  prometheus.Counter
+}
+
+func NewMumbleMetricsCollector() *MumbleMetricsCollector {
+	talkSecondsTotal := promauto.NewCounter(prometheus.CounterOpts{
+		Name: "mumble_talk_seconds_total",
+		Help: "The total number of seconds a user has been talking",
+	})
+	pttTogglesTotal := promauto.NewCounter(prometheus.CounterOpts{
+		Name: "mumble_ptt_toggles_total",
+		Help: "The total number of seconds a user has been talking",
+	})
+
+	return &MumbleMetricsCollector{
+		TalkSecondsTotal: talkSecondsTotal,
+		PTTTogglesTotal:  pttTogglesTotal,
+	}
+}