feat: Add configurable/static device ID support (#37, PR: #52)

* feat: Add ability to set static device ID and also added testing for device ID stability

* docs: Update README to clarify device_id option

* feat: Implement device ID persistence with file storage and update README

Author: mobileqaguy

.github/workflows/test.yml

@@ -1,10 +1,29 @@
-name: Test Build
+name: Test & Build
 
 on:
   pull_request:
     types: [synchronize, opened]
+  push:
+    branches:
+      - master
 
 jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: 1.21
+      - name: Get dependencies
+        run: go mod download
+      - name: Run tests
+        run: go test -v ./...
+      - name: Run tests with race detector
+        run: go test -race -short ./...
+
   build:
     runs-on: ubuntu-latest
     steps:

.gitignore

@@ -28,3 +28,4 @@ channels.json
 config.json
 routes/.DS_Store
 .DS_Store
+.device_id

README.md

@@ -43,6 +43,7 @@ services:
 2. Create a `config.json` in the working directory and fill in the necessary.
    - Possible values for `encoder_profile` are `vaapi`, `video_toolbox`, `omx`, `nvenc` and `cpu`. A sample `config.example.json` is available on GitHub.
      - `nvenc` requires an NVIDIA GPU and ffmpeg with NVENC support. For Docker, see [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html).
+   - **Optional:** Set `device_id` to a specific value (e.g. `"30480554"`) to maintain a stable device ID. If omitted, a random ID will be generated on first run and automatically saved to `.device_id` for persistence across restarts. Priority order: `config.json` > `.device_id` file > auto-generate new.
 3. Create a `channels.json` and fill in the necessary.
    - A sample `channels.example.json` is available on GitHub.
 4. Copy the `templates` folder from this repository into the working directory (alongside the two JSON files)
@@ -53,3 +54,19 @@ services:
 1. Clone the repo
 2. Run `go mod download`
 3. To run the server, run `go run cmd/main.go`
+
+### Testing
+Run the test suite:
+```bash
+go test ./...
+```
+
+Run tests with verbose output:
+```bash
+go test -v ./...
+```
+
+Run tests with race detection:
+```bash
+go test -race ./...
+```

config.example.json

@@ -1,5 +1,6 @@
 {
   "name": "Amazing Tuner",
   "encoder_profile": "cpu",
-  "tuner_count": 3
+  "tuner_count": 3,
+  "device_id": "30480554"
 }

config/channels.go

@@ -2,9 +2,10 @@ package config
 
 import (
 	"encoding/json"
+	"errors"
 	"log"
 	"os"
-	"errors"
+	"strings"
 	"sync"
 
     "github.com/fsnotify/fsnotify"
@@ -111,7 +112,14 @@ func LoadChannels() error {
 }
 
 func init() {
-    var playlist = os.Getenv("PLAYLIST")
+	// Skip initialization during tests by checking command line args
+	for _, arg := range os.Args {
+		if strings.HasPrefix(arg, "-test.") {
+			return
+		}
+	}
+
+	var playlist = os.Getenv("PLAYLIST")
 	if len(playlist) > 0 {
 	    err := LoadChannelsFromPl(playlist)	
 	    if err == nil {

config/config.go

@@ -2,8 +2,11 @@ package config
 
 import (
 	"encoding/json"
+	"fmt"
 	"log"
+	"math/rand"
 	"os"
+	"strings"
 )
 
 type EncoderProfile string
@@ -20,6 +23,7 @@ type Config struct {
 	Name           string          `json:"name"`
 	EncoderProfile *EncoderProfile `json:"encoder_profile"`
 	TunerCount     *int            `json:"tuner_count"`
+	DeviceID       *string         `json:"device_id"`
 }
 
 func (c Config) GetEncoderProfile() EncoderProfile {
@@ -45,18 +49,66 @@ var (
 	Cfg Config
 )
 
-func init() {
-	file, err := os.Open("config.json")
+const deviceIDFile = ".device_id"
+
+func loadDeviceIDFromFile() (string, error) {
+	data, err := os.ReadFile(deviceIDFile)
 	if err != nil {
-		log.Fatal(err)
+		return "", err
 	}
+	return strings.TrimSpace(string(data)), nil
+}
 
+func saveDeviceIDToFile(deviceID string) error {
+	return os.WriteFile(deviceIDFile, []byte(deviceID), 0644)
+}
+
+func LoadConfig() error {
+	file, err := os.Open("config.json")
+	if err != nil {
+		return err
+	}
 	defer file.Close()
 
 	var decoder = json.NewDecoder(file)
 	err = decoder.Decode(&Cfg)
-
 	if err != nil {
+		return err
+	}
+
+	// Device ID priority: config.json > .device_id file > generate new
+	if Cfg.DeviceID == nil {
+		// Try to load from state file
+		if savedID, err := loadDeviceIDFromFile(); err == nil && savedID != "" {
+			Cfg.DeviceID = &savedID
+			log.Printf("Loaded device_id from %s: %s", deviceIDFile, savedID)
+		} else {
+			// Generate new ID and save it
+			deviceID := fmt.Sprintf("%d", rand.Int63n(90000000-10000000)+10000000)
+			Cfg.DeviceID = &deviceID
+
+			// Try to save to file, but don't fail if we can't (e.g., read-only filesystem)
+			if err := saveDeviceIDToFile(deviceID); err != nil {
+				log.Printf("Warning: Generated device_id %s but could not save to %s: %v", deviceID, deviceIDFile, err)
+				log.Printf("Device ID will change on restart. Set device_id in config.json to make it permanent.")
+			} else {
+				log.Printf("Generated and saved device_id to %s: %s", deviceIDFile, deviceID)
+			}
+		}
+	}
+
+	return nil
+}
+
+func init() {
+	// Skip initialization during tests by checking command line args
+	for _, arg := range os.Args {
+		if strings.HasPrefix(arg, "-test.") {
+			return
+		}
+	}
+
+	if err := LoadConfig(); err != nil {
 		log.Fatal(err)
 	}
 }