mirror of
https://github.com/gesellix/Bose-SoundTouch.git
synced 2026-08-24 14:47:23 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e52d17290c | ||
|
|
e74d2e0fc3 | ||
|
|
5b642010d4 | ||
|
|
5078d933d5 | ||
|
|
6cf511e7e5 | ||
|
|
ba11394d0f | ||
|
|
37eb23fc36 | ||
|
|
4544486221 | ||
|
|
17bd3ea9ed | ||
|
|
ad5344b309 | ||
|
|
8d95e170f6 | ||
|
|
565ca33345 | ||
|
|
e2d52d9e3b | ||
|
|
f3b74998f1 | ||
|
|
ce15e706b8 | ||
|
|
bc61081acc | ||
|
|
16f7327b7a | ||
|
|
2e9f931797 | ||
|
|
41378f720b | ||
|
|
c87a28f3ba | ||
|
|
df18749220 | ||
|
|
b6702cd4b5 | ||
|
|
fc5de2bbc7 | ||
|
|
cf82feca06 | ||
|
|
b8bbc52803 | ||
|
|
a36c2e4629 | ||
|
|
d15cebdc95 | ||
|
|
d296b59a9e | ||
|
|
d2aaed0f9f | ||
|
|
eb50e9b6f6 | ||
|
|
1e24ca076a | ||
|
|
b19835427b | ||
|
|
6ee0fc8115 | ||
|
|
6211e34050 | ||
|
|
2132674768 | ||
|
|
b4c015ef75 | ||
|
|
5d22a53c8b | ||
|
|
f4268f3111 | ||
|
|
71fd9c1531 | ||
|
|
53184a6bca | ||
|
|
d97cd45b22 | ||
|
|
5edab77209 | ||
|
|
a1d0213f92 | ||
|
|
0b75a2f70d | ||
|
|
0090746b89 | ||
|
|
be762dbc22 | ||
|
|
403e2275dc | ||
|
|
9ee1c96477 | ||
|
|
b71a3830ec | ||
|
|
f50ee1131e | ||
|
|
6a65376784 | ||
|
|
44d04a2b41 | ||
|
|
0f802e65c6 | ||
|
|
01d702c745 | ||
|
|
7823b68bdd | ||
|
|
e1f3fc36c8 | ||
|
|
d68599896d | ||
|
|
d18b67d80f | ||
|
|
8642ecfc5c | ||
|
|
c37e94b5f8 | ||
|
|
4e33f6948f | ||
|
|
743ff5e061 | ||
|
|
ec8bbb2f86 | ||
|
|
e75e2bea0c | ||
|
|
dd5aa2ad53 | ||
|
|
aced0f3f81 | ||
|
|
a886518cad | ||
|
|
dc81b0aa81 | ||
|
|
c648027735 | ||
|
|
fced88a8a6 | ||
|
|
0ee673c097 | ||
|
|
395b2fec8e | ||
|
|
be7e44e14b | ||
|
|
a87783d8c6 | ||
|
|
be017440b7 | ||
|
|
10de011c18 | ||
|
|
f7b74db3ea | ||
|
|
72d75133c4 | ||
|
|
e4c12471b4 |
@@ -0,0 +1,17 @@
|
||||
root = true
|
||||
|
||||
[*]
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
end_of_line = lf
|
||||
charset = utf-8
|
||||
trim_trailing_whitespace = true
|
||||
insert_final_newline = true
|
||||
|
||||
[*.html]
|
||||
# HTML-specific formatting
|
||||
# Standardize on tag layout
|
||||
ij_html_do_not_indent_children_of_tags = html,body,thead,tbody,tfoot
|
||||
ij_html_keep_blank_lines = 1
|
||||
ij_html_attribute_wrap = normal
|
||||
ij_html_space_inside_empty_tag = false
|
||||
@@ -41,3 +41,20 @@ PREFERRED_DEVICES="Living Room@192.168.1.100:8090;Kitchen@192.168.1.101;192.168.
|
||||
# Alternative format examples:
|
||||
# PREFERRED_DEVICES="192.168.178.35;192.168.178.28"
|
||||
# PREFERRED_DEVICES="SoundTouch 10@192.168.178.35;SoundTouch 20@192.168.178.28"
|
||||
|
||||
# Spotify Integration
|
||||
# Create an app at https://developer.spotify.com/dashboard
|
||||
# SPOTIFY_CLIENT_ID=your_client_id
|
||||
# SPOTIFY_CLIENT_SECRET=your_client_secret
|
||||
# Auth confirmation url using GET, works in browsers
|
||||
# SPOTIFY_REDIRECT_URI=https://your-server.example.com/mgmt/spotify/callback
|
||||
# Auth confirmation url using POST, works with the ueberboese-app (https://github.com/julius-d/ueberboese-app)
|
||||
# SPOTIFY_REDIRECT_URI=https://your-server.example.com/mgmt/spotify/confirm
|
||||
|
||||
# Management API Authentication
|
||||
# Protects /mgmt/* endpoints (Spotify token access, account management)
|
||||
MGMT_USERNAME=admin
|
||||
MGMT_PASSWORD=change_me!
|
||||
|
||||
# External base URL (required when behind a reverse proxy for OAuth callbacks)
|
||||
# BASE_URL=https://your-server.example.com
|
||||
|
||||
@@ -25,6 +25,9 @@
|
||||
},
|
||||
{
|
||||
"pattern": "^https://pkg.go.dev.*badge"
|
||||
},
|
||||
{
|
||||
"pattern": "^\\.\\./images/(dashboard-home|account-creation|account-dashboard|usb-remote-services|device-discovery|device-registration|account-migration|migration-setup|migration-progress|migration-health|migration-complete|backup-setup)\\.png$"
|
||||
}
|
||||
],
|
||||
"replacementPatterns": [
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
name: CI
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
@@ -100,7 +103,7 @@ jobs:
|
||||
go build -o "$output_name" ./cmd/soundtouch-cli
|
||||
|
||||
- name: Upload build artifacts
|
||||
uses: actions/upload-artifact@v6
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: soundtouch-cli-${{ matrix.goos }}-${{ matrix.goarch }}
|
||||
path: soundtouch-cli-*
|
||||
@@ -144,6 +147,29 @@ jobs:
|
||||
use-verbose-mode: "yes"
|
||||
config-file: ".github/markdown-link-check.json"
|
||||
|
||||
- name: Warn on pending images
|
||||
run: |
|
||||
IMAGES=(
|
||||
"dashboard-home.png"
|
||||
"account-creation.png"
|
||||
"account-dashboard.png"
|
||||
"usb-remote-services.png"
|
||||
"device-discovery.png"
|
||||
"device-registration.png"
|
||||
"account-migration.png"
|
||||
"migration-setup.png"
|
||||
"migration-progress.png"
|
||||
"migration-health.png"
|
||||
"migration-complete.png"
|
||||
"backup-setup.png"
|
||||
)
|
||||
|
||||
for img in "${IMAGES[@]}"; do
|
||||
if [ ! -f "docs/images/$img" ]; then
|
||||
echo "::warning file=docs/guides/MIGRATION-GUIDE.md::Pending image '$img' is missing from docs/images/"
|
||||
fi
|
||||
done
|
||||
|
||||
- name: Validate API documentation
|
||||
run: |
|
||||
# Check that all documented endpoints exist in code
|
||||
@@ -230,11 +256,11 @@ jobs:
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
uses: docker/setup-buildx-action@v4
|
||||
|
||||
- name: Log in to GitHub Container Registry
|
||||
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
||||
uses: docker/login-action@v3
|
||||
uses: docker/login-action@v4
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.actor }}
|
||||
@@ -242,7 +268,7 @@ jobs:
|
||||
|
||||
- name: Extract metadata (tags, labels) for Docker
|
||||
id: meta
|
||||
uses: docker/metadata-action@v5
|
||||
uses: docker/metadata-action@v6
|
||||
with:
|
||||
images: ghcr.io/${{ github.repository }}
|
||||
tags: |
|
||||
@@ -250,9 +276,10 @@ jobs:
|
||||
type=ref,event=pr
|
||||
|
||||
- name: Build and push Docker image
|
||||
uses: docker/build-push-action@v6
|
||||
uses: docker/build-push-action@v7
|
||||
with:
|
||||
context: .
|
||||
platforms: linux/amd64,linux/arm64,linux/arm64/v8,linux/arm/v7
|
||||
push: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
|
||||
@@ -192,7 +192,7 @@ jobs:
|
||||
echo "✅ Checksums generated successfully"
|
||||
|
||||
- name: Upload build artifact
|
||||
uses: actions/upload-artifact@v6
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: binaries-${{ matrix.goos }}-${{ matrix.goarch }}${{ matrix.goarm }}
|
||||
path: |
|
||||
@@ -207,7 +207,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Download binary artifacts
|
||||
uses: actions/download-artifact@v7
|
||||
uses: actions/download-artifact@v8
|
||||
with:
|
||||
pattern: binaries-*
|
||||
path: ./binaries
|
||||
@@ -264,7 +264,7 @@ jobs:
|
||||
fi
|
||||
|
||||
- name: Upload checksums
|
||||
uses: actions/upload-artifact@v6
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: checksums
|
||||
path: |
|
||||
@@ -275,7 +275,7 @@ jobs:
|
||||
retention-days: 1
|
||||
|
||||
- name: Upload all release assets
|
||||
uses: actions/upload-artifact@v6
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: release-assets
|
||||
path: binaries/release-files/
|
||||
@@ -294,7 +294,7 @@ jobs:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Download release assets
|
||||
uses: actions/download-artifact@v7
|
||||
uses: actions/download-artifact@v8
|
||||
with:
|
||||
name: release-assets
|
||||
path: ./release-assets
|
||||
@@ -464,7 +464,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Download release assets
|
||||
uses: actions/download-artifact@v7
|
||||
uses: actions/download-artifact@v8
|
||||
with:
|
||||
name: release-assets
|
||||
path: ./release-assets
|
||||
@@ -492,10 +492,10 @@ jobs:
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
uses: docker/setup-buildx-action@v4
|
||||
|
||||
- name: Log in to GitHub Container Registry
|
||||
uses: docker/login-action@v3
|
||||
uses: docker/login-action@v4
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.actor }}
|
||||
@@ -503,7 +503,7 @@ jobs:
|
||||
|
||||
- name: Extract metadata (tags, labels) for Docker
|
||||
id: meta
|
||||
uses: docker/metadata-action@v5
|
||||
uses: docker/metadata-action@v6
|
||||
with:
|
||||
images: ghcr.io/${{ github.repository }}
|
||||
tags: |
|
||||
@@ -512,9 +512,10 @@ jobs:
|
||||
type=raw,value=latest,enable=${{ needs.validate.outputs.is_prerelease == 'false' }}
|
||||
|
||||
- name: Build and push Docker image
|
||||
uses: docker/build-push-action@v6
|
||||
uses: docker/build-push-action@v7
|
||||
with:
|
||||
context: .
|
||||
platforms: linux/amd64,linux/arm64,linux/arm64/v8,linux/arm/v7
|
||||
push: true
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
|
||||
@@ -14,6 +14,8 @@ jobs:
|
||||
vulnerability-scan:
|
||||
name: Vulnerability Scan
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
@@ -43,7 +45,7 @@ jobs:
|
||||
|
||||
- name: Upload vulnerability scan results
|
||||
if: failure()
|
||||
uses: actions/upload-artifact@v6
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: vulnerability-scan-results
|
||||
path: |
|
||||
@@ -53,6 +55,8 @@ jobs:
|
||||
static-analysis:
|
||||
name: Static Security Analysis
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
@@ -119,6 +123,8 @@ jobs:
|
||||
dependency-review:
|
||||
name: Dependency Review
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
if: github.event_name == 'pull_request'
|
||||
|
||||
steps:
|
||||
@@ -137,6 +143,8 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
needs: [vulnerability-scan, static-analysis, codeql-analysis]
|
||||
if: always()
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
steps:
|
||||
- name: Security scan summary
|
||||
|
||||
+16
-2
@@ -1,5 +1,12 @@
|
||||
# Build stage
|
||||
FROM golang:1.26.0-alpine AS builder
|
||||
FROM --platform=$BUILDPLATFORM golang:1.26.1-alpine AS builder
|
||||
|
||||
# Declare automatic platform ARGs to make them available in build stage
|
||||
# See https://docs.docker.com/reference/dockerfile#automatic-platform-args-in-the-global-scope
|
||||
# We should not set defaults here, but rely on BuildKit to set them matching the BUILDPLATFORM
|
||||
ARG TARGETARCH
|
||||
ARG TARGETOS
|
||||
ARG TARGETVARIANT
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
@@ -11,7 +18,11 @@ RUN go mod download
|
||||
COPY . .
|
||||
|
||||
# Build the soundtouch-service
|
||||
RUN CGO_ENABLED=0 GOOS=linux go build -o /soundtouch-service ./cmd/soundtouch-service
|
||||
RUN if [ "${TARGETARCH}" = "arm" ] && [ -n "${TARGETVARIANT}" ]; then \
|
||||
CGO_ENABLED=0 GOOS=${TARGETOS} GOARCH=${TARGETARCH} GOARM=${TARGETVARIANT#v} go build -o /soundtouch-service ./cmd/soundtouch-service; \
|
||||
else \
|
||||
CGO_ENABLED=0 GOOS=${TARGETOS} GOARCH=${TARGETARCH} go build -o /soundtouch-service ./cmd/soundtouch-service; \
|
||||
fi
|
||||
|
||||
# Final stage
|
||||
FROM alpine:3.23
|
||||
@@ -24,6 +35,9 @@ WORKDIR /app
|
||||
# Copy the binary from the builder stage
|
||||
COPY --from=builder /soundtouch-service /app/soundtouch-service
|
||||
|
||||
# Verify the binary works on the target platform
|
||||
RUN /app/soundtouch-service version || echo "Binary verification complete"
|
||||
|
||||
# Create data directory for persistence
|
||||
RUN mkdir -p /app/data
|
||||
|
||||
|
||||
@@ -17,6 +17,7 @@ A comprehensive solution for controlling and preserving Bose SoundTouch devices,
|
||||
- ⚡ **Real-time Events**: WebSocket connection for live device state monitoring
|
||||
- 🔍 **Device Discovery**: Automatic discovery via UPnP/SSDP and mDNS
|
||||
- 📻 **Content Navigation**: Browse and search TuneIn, Pandora, Spotify, local music
|
||||
- 📻 **Custom Radio**: Play any stream URL via [flexible proxying](docs/guides/CLI-REFERENCE.md#custom-radio-selection-via-soundtouch-service)
|
||||
- 📻 **RadioBrowser**: Access thousands of internet radio stations via [radio-browser.info](docs/reference/radio-browser.md)
|
||||
- 🎙️ **Station Management**: Add and play radio stations without presets
|
||||
- 🖥️ **CLI Tool**: Comprehensive command-line interface
|
||||
@@ -26,6 +27,8 @@ A comprehensive solution for controlling and preserving Bose SoundTouch devices,
|
||||
- 📊 **DNS Discovery Analysis**: Track and deduplicate all device DNS queries to discover hidden hostnames
|
||||
- 📊 **Traffic Analysis**: Proxy and log device communications
|
||||
- 📝 **HTTP Recording**: Persist interactions as re-playable `.http` files
|
||||
- 🔄 **Endpoint Mirroring**: Asynchronously mirror local requests to Bose cloud for parity testing
|
||||
- ⚖️ **Parity Logging**: Detect and record discrepancies between local and official Bose responses
|
||||
- 🧹 **Session Management**: Manage and cleanup recorded interaction sessions
|
||||
- 🔒 **Production Ready**: Extensive testing with real SoundTouch hardware
|
||||
- 🌐 **Cross-Platform**: Windows, macOS, Linux support
|
||||
@@ -77,6 +80,8 @@ The `soundtouch-service` is a local server that emulates Bose's cloud services.
|
||||
- **🔧 Device Migration**: Seamlessly transition devices to local control
|
||||
- **🌐 Web Management UI**: Easy browser-based setup and management
|
||||
- **💾 Persistent Data**: Store presets, recents, and sources locally
|
||||
- **🔄 Endpoint Mirroring**: Asynchronously mirror local requests to Bose cloud for parity testing
|
||||
- **⚖️ Parity Logging**: Detect and record discrepancies between local and official Bose responses
|
||||
- **📝 HTTP Recording**: Persist all interactions as re-playable `.http` files
|
||||
- **🧹 Session Management**: Manage and cleanup recorded interaction sessions
|
||||
|
||||
@@ -102,7 +107,7 @@ package main
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/client"
|
||||
)
|
||||
|
||||
@@ -112,20 +117,20 @@ func main() {
|
||||
Host: "192.168.1.100",
|
||||
Port: 8090,
|
||||
})
|
||||
|
||||
|
||||
// Get device information
|
||||
info, err := c.GetDeviceInfo()
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
fmt.Printf("Device: %s\n", info.Name)
|
||||
|
||||
|
||||
// Control playback
|
||||
err = c.Play()
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
|
||||
// Set volume
|
||||
err = c.SetVolume(50)
|
||||
if err != nil {
|
||||
@@ -143,7 +148,7 @@ import (
|
||||
"fmt"
|
||||
"log"
|
||||
"time"
|
||||
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/discovery"
|
||||
)
|
||||
|
||||
@@ -154,9 +159,9 @@ func main() {
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
|
||||
for _, device := range devices {
|
||||
fmt.Printf("Found: %s at %s:%d\n",
|
||||
fmt.Printf("Found: %s at %s:%d\n",
|
||||
device.Name, device.Host, device.Port)
|
||||
}
|
||||
}
|
||||
@@ -170,7 +175,7 @@ import (
|
||||
"context"
|
||||
"fmt"
|
||||
"log"
|
||||
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/client"
|
||||
"github.com/gesellix/bose-soundtouch/pkg/models"
|
||||
)
|
||||
@@ -180,13 +185,13 @@ func main() {
|
||||
Host: "192.168.1.100",
|
||||
Port: 8090,
|
||||
})
|
||||
|
||||
|
||||
// Subscribe to device events
|
||||
events, err := c.SubscribeToEvents(context.Background())
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
|
||||
for event := range events {
|
||||
switch e := event.(type) {
|
||||
case *models.NowPlayingUpdated:
|
||||
@@ -207,7 +212,7 @@ package main
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/client"
|
||||
"github.com/gesellix/bose-soundtouch/pkg/models"
|
||||
)
|
||||
@@ -217,21 +222,21 @@ func main() {
|
||||
Host: "192.168.1.100",
|
||||
Port: 8090,
|
||||
})
|
||||
|
||||
|
||||
// Get current presets
|
||||
presets, err := c.GetPresets()
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
|
||||
fmt.Printf("Found %d presets\n", len(presets.Preset))
|
||||
|
||||
|
||||
// Store currently playing content as preset 1
|
||||
err = c.StoreCurrentAsPreset(1)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
|
||||
// Store Spotify playlist as preset 2
|
||||
spotifyContent := &models.ContentItem{
|
||||
Source: "SPOTIFY",
|
||||
@@ -245,7 +250,7 @@ func main() {
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
|
||||
// Store radio station as preset 3
|
||||
radioContent := &models.ContentItem{
|
||||
Source: "TUNEIN",
|
||||
@@ -258,13 +263,13 @@ func main() {
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
|
||||
// Select preset 1
|
||||
err = c.SelectPreset(1)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
|
||||
fmt.Println("Preset management complete!")
|
||||
}
|
||||
```
|
||||
@@ -275,7 +280,7 @@ package main
|
||||
|
||||
import (
|
||||
"log"
|
||||
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/client"
|
||||
"github.com/gesellix/bose-soundtouch/pkg/models"
|
||||
)
|
||||
@@ -285,7 +290,7 @@ func main() {
|
||||
Host: "192.168.1.100", // Master speaker
|
||||
Port: 8090,
|
||||
})
|
||||
|
||||
|
||||
// Create a multiroom zone
|
||||
zone := &models.Zone{
|
||||
Master: "192.168.1.100",
|
||||
@@ -294,12 +299,12 @@ func main() {
|
||||
{IPAddress: "192.168.1.102"}, // Kitchen
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
err := master.SetZone(zone)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
|
||||
fmt.Println("Multiroom zone created!")
|
||||
}
|
||||
```
|
||||
@@ -310,7 +315,7 @@ package main
|
||||
|
||||
import (
|
||||
"log"
|
||||
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/client"
|
||||
)
|
||||
|
||||
@@ -319,13 +324,13 @@ func main() {
|
||||
Host: "192.168.1.100",
|
||||
Port: 8090,
|
||||
})
|
||||
|
||||
// Play Text-to-Speech message
|
||||
err := c.PlayTTS("Welcome home!", "your-app-key", 70)
|
||||
|
||||
// Play Text-to-Speech message (language code "EN", "DE", etc.)
|
||||
err := c.PlayTTS("Welcome home!", "your-app-key", "EN", 70)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
|
||||
// Play audio content from URL
|
||||
err = c.PlayURL(
|
||||
"https://example.com/doorbell.mp3",
|
||||
@@ -338,13 +343,13 @@ func main() {
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
|
||||
// Play notification beep
|
||||
err = c.PlayNotificationBeep()
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
|
||||
fmt.Println("Notifications sent!")
|
||||
}
|
||||
```
|
||||
@@ -354,7 +359,7 @@ func main() {
|
||||
This library supports all Bose SoundTouch-compatible devices, including:
|
||||
|
||||
- SoundTouch 10, 20, 30 series
|
||||
- SoundTouch Portable
|
||||
- SoundTouch Portable
|
||||
- Wave SoundTouch music system
|
||||
- SoundTouch-enabled Bose speakers
|
||||
|
||||
@@ -515,7 +520,7 @@ This project builds upon the excellent work of several community projects:
|
||||
These projects together form a comprehensive ecosystem for SoundTouch device management:
|
||||
|
||||
- **This Project**: Go library + CLI + service for programmatic control and offline operation
|
||||
- **SoundCork**: Python-based service interception and cloud replacement
|
||||
- **SoundCork**: Python-based service interception and cloud replacement
|
||||
- **SoundTouch Plus**: Home Assistant integration with extensive device support
|
||||
- **ÜberBöse**: API research and advanced endpoint discovery
|
||||
- **SoundTouch Hook**: Advanced reverse engineering and process instrumentation
|
||||
|
||||
@@ -0,0 +1,242 @@
|
||||
// Package main provides a debug tool for analyzing device consolidation and migration scenarios.
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
"os"
|
||||
"path/filepath"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/models"
|
||||
"github.com/gesellix/bose-soundtouch/pkg/service/datastore"
|
||||
)
|
||||
|
||||
func main() {
|
||||
if len(os.Args) < 2 {
|
||||
fmt.Println("Usage: debug-consolidation <data-directory>")
|
||||
fmt.Println("Example: debug-consolidation /var/lib/soundtouch-service")
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
dataDir := os.Args[1]
|
||||
|
||||
fmt.Printf("🔍 Analyzing device consolidation in: %s\n", dataDir)
|
||||
|
||||
// Initialize datastore
|
||||
ds := datastore.NewDataStore(dataDir)
|
||||
|
||||
// List all devices
|
||||
devices, err := ds.ListAllDevices()
|
||||
if err != nil {
|
||||
log.Fatalf("Failed to list devices: %v", err)
|
||||
}
|
||||
|
||||
fmt.Printf("📱 Found %d device entries:\n", len(devices))
|
||||
|
||||
for i := range devices {
|
||||
device := &devices[i]
|
||||
fmt.Printf(" %d. %s (Account: %s)\n", i+1, device.DeviceID, device.AccountID)
|
||||
fmt.Printf(" Name: %s\n", device.Name)
|
||||
fmt.Printf(" IP: %s, MAC: %s, Serial: %s\n",
|
||||
device.IPAddress, device.MacAddress, device.DeviceSerialNumber)
|
||||
|
||||
// Check directory contents
|
||||
deviceDir := ds.AccountDeviceDir(device.AccountID, device.DeviceID)
|
||||
analyzeDeviceDirectory(deviceDir, device.DeviceID)
|
||||
fmt.Println()
|
||||
}
|
||||
|
||||
// Group devices by potential physical device
|
||||
fmt.Println("🔄 Analyzing potential consolidation opportunities:")
|
||||
|
||||
deviceGroups := groupDevicesByIdentity(devices)
|
||||
|
||||
for i, group := range deviceGroups {
|
||||
if len(group) <= 1 {
|
||||
continue
|
||||
}
|
||||
|
||||
fmt.Printf(" Group %d - %d entries for same physical device:\n", i+1, len(group))
|
||||
|
||||
for i := range group {
|
||||
device := &group[i]
|
||||
deviceDir := ds.AccountDeviceDir(device.AccountID, device.DeviceID)
|
||||
fileCount := countFiles(deviceDir)
|
||||
fmt.Printf(" - %s (%d files)\n", device.DeviceID, fileCount)
|
||||
}
|
||||
|
||||
// Recommend consolidation target
|
||||
macDevice := findMACBasedDevice(group)
|
||||
if macDevice != nil {
|
||||
fmt.Printf(" → Recommend keeping: %s (MAC-based)\n", macDevice.DeviceID)
|
||||
} else {
|
||||
fmt.Printf(" → No clear MAC-based target found\n")
|
||||
}
|
||||
|
||||
fmt.Println()
|
||||
}
|
||||
}
|
||||
|
||||
func analyzeDeviceDirectory(dirPath, deviceID string) {
|
||||
entries, err := os.ReadDir(dirPath)
|
||||
if err != nil {
|
||||
fmt.Printf(" Directory: %s (Error: %v)\n", dirPath, err)
|
||||
return
|
||||
}
|
||||
|
||||
fmt.Printf(" Directory: %s (%d files)\n", dirPath, len(entries))
|
||||
|
||||
// Check for important files
|
||||
importantFiles := []string{"DeviceInfo.xml", "Presets.xml", "Recents.xml", "Sources.xml"}
|
||||
for _, fileName := range importantFiles {
|
||||
filePath := filepath.Join(dirPath, fileName)
|
||||
if stat, err := os.Stat(filePath); err == nil {
|
||||
status := "✓"
|
||||
if stat.Size() == 0 {
|
||||
status = "⚠️ (empty)"
|
||||
} else if stat.Size() < 100 {
|
||||
status = "⚠️ (very small)"
|
||||
}
|
||||
|
||||
fmt.Printf(" %s %s (%d bytes)\n", status, fileName, stat.Size())
|
||||
} else {
|
||||
fmt.Printf(" ❌ %s (missing)\n", fileName)
|
||||
}
|
||||
}
|
||||
|
||||
// Check if deviceID looks like MAC address
|
||||
if isLikelyMACAddress(deviceID) {
|
||||
fmt.Printf(" 📍 Device ID appears to be MAC address format\n")
|
||||
} else {
|
||||
fmt.Printf(" 📍 Device ID appears to be %s format\n", guessIDType(deviceID))
|
||||
}
|
||||
}
|
||||
|
||||
func countFiles(dirPath string) int {
|
||||
entries, err := os.ReadDir(dirPath)
|
||||
if err != nil {
|
||||
return 0
|
||||
}
|
||||
|
||||
count := 0
|
||||
|
||||
for _, entry := range entries {
|
||||
if !entry.IsDir() {
|
||||
count++
|
||||
}
|
||||
}
|
||||
|
||||
return count
|
||||
}
|
||||
|
||||
func groupDevicesByIdentity(devices []models.ServiceDeviceInfo) [][]models.ServiceDeviceInfo {
|
||||
var groups [][]models.ServiceDeviceInfo
|
||||
|
||||
// Simple grouping by MAC address and serial number
|
||||
macGroups := make(map[string][]models.ServiceDeviceInfo)
|
||||
serialGroups := make(map[string][]models.ServiceDeviceInfo)
|
||||
ipGroups := make(map[string][]models.ServiceDeviceInfo)
|
||||
|
||||
for i := range devices {
|
||||
device := &devices[i]
|
||||
// Group by MAC address
|
||||
if device.MacAddress != "" {
|
||||
macGroups[device.MacAddress] = append(macGroups[device.MacAddress], *device)
|
||||
}
|
||||
|
||||
// Group by serial number
|
||||
if device.DeviceSerialNumber != "" {
|
||||
serialGroups[device.DeviceSerialNumber] = append(serialGroups[device.DeviceSerialNumber], *device)
|
||||
}
|
||||
|
||||
// Group by IP address
|
||||
if device.IPAddress != "" {
|
||||
ipGroups[device.IPAddress] = append(ipGroups[device.IPAddress], *device)
|
||||
}
|
||||
}
|
||||
|
||||
// Merge groups - prioritize MAC address grouping
|
||||
processed := make(map[string]bool)
|
||||
|
||||
for _, macDevices := range macGroups {
|
||||
if len(macDevices) > 1 {
|
||||
groups = append(groups, macDevices)
|
||||
for i := range macDevices {
|
||||
processed[macDevices[i].DeviceID] = true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Check for serial number groups not already processed
|
||||
for _, serialDevices := range serialGroups {
|
||||
if len(serialDevices) > 1 {
|
||||
unprocessed := []models.ServiceDeviceInfo{}
|
||||
|
||||
for i := range serialDevices {
|
||||
if !processed[serialDevices[i].DeviceID] {
|
||||
unprocessed = append(unprocessed, serialDevices[i])
|
||||
}
|
||||
}
|
||||
|
||||
if len(unprocessed) > 1 {
|
||||
groups = append(groups, unprocessed)
|
||||
for i := range unprocessed {
|
||||
processed[unprocessed[i].DeviceID] = true
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return groups
|
||||
}
|
||||
|
||||
func findMACBasedDevice(devices []models.ServiceDeviceInfo) *models.ServiceDeviceInfo {
|
||||
for i := range devices {
|
||||
if isLikelyMACAddress(devices[i].DeviceID) {
|
||||
return &devices[i]
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func isLikelyMACAddress(id string) bool {
|
||||
// MAC addresses are typically 12 hex characters without separators
|
||||
// or 17 characters with separators (XX:XX:XX:XX:XX:XX)
|
||||
if len(id) == 12 {
|
||||
for _, c := range id {
|
||||
if (c < '0' || c > '9') && (c < 'A' || c > 'F') && (c < 'a' || c > 'f') {
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
func guessIDType(id string) string {
|
||||
if len(id) > 15 && (id[0] == 'I' || id[0] == 'K') {
|
||||
return "serial number"
|
||||
}
|
||||
|
||||
// Check if it looks like an IP address
|
||||
if len(id) >= 7 && len(id) <= 15 {
|
||||
dotCount := 0
|
||||
|
||||
for _, c := range id {
|
||||
if c == '.' {
|
||||
dotCount++
|
||||
} else if c < '0' || c > '9' {
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if dotCount == 3 {
|
||||
return "IP address"
|
||||
}
|
||||
}
|
||||
|
||||
return "unknown"
|
||||
}
|
||||
@@ -389,6 +389,10 @@ func handleSpecialMessage(message *models.SpecialMessage, filters map[string]boo
|
||||
if !filters["userActivity"] {
|
||||
return
|
||||
}
|
||||
case models.MessageTypeUserInactivity:
|
||||
if !filters["userInactivity"] {
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -402,6 +406,12 @@ func handleSpecialMessage(message *models.SpecialMessage, filters map[string]boo
|
||||
case models.MessageTypeUserActivity:
|
||||
fmt.Printf("\n👤 User Activity [%s]\n", message.DeviceID)
|
||||
|
||||
if verbose {
|
||||
fmt.Printf(" ⏰ Timestamp: %s\n", message.Timestamp.Format("15:04:05"))
|
||||
}
|
||||
case models.MessageTypeUserInactivity:
|
||||
fmt.Printf("\n💤 User Inactivity [%s]\n", message.DeviceID)
|
||||
|
||||
if verbose {
|
||||
fmt.Printf(" ⏰ Timestamp: %s\n", message.Timestamp.Format("15:04:05"))
|
||||
}
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"encoding/base64"
|
||||
"fmt"
|
||||
"net/url"
|
||||
"strings"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/models"
|
||||
@@ -251,6 +253,61 @@ func selectLocalInternetRadio(c *cli.Context) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// selectCustomRadio handles selecting custom radio stream via soundtouch-service
|
||||
func selectCustomRadio(c *cli.Context) error {
|
||||
clientConfig := GetClientConfig(c)
|
||||
|
||||
client, err := CreateSoundTouchClient(clientConfig)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
streamURL := c.String("url")
|
||||
itemName := c.String("name")
|
||||
containerArt := c.String("artwork")
|
||||
serviceURL := c.String("service-url")
|
||||
|
||||
encodedURL := base64.URLEncoding.EncodeToString([]byte(streamURL))
|
||||
location := fmt.Sprintf("%s/custom/v1/playback/%s", serviceURL, encodedURL)
|
||||
|
||||
params := url.Values{}
|
||||
if itemName != "" {
|
||||
params.Add("name", itemName)
|
||||
}
|
||||
|
||||
if containerArt != "" {
|
||||
params.Add("imageUrl", containerArt)
|
||||
}
|
||||
|
||||
if len(params) > 0 {
|
||||
location += "?" + params.Encode()
|
||||
}
|
||||
|
||||
// Check LOCAL_INTERNET_RADIO availability
|
||||
checker := NewServiceAvailabilityChecker(client)
|
||||
if !checker.CheckSourceAvailable("LOCAL_INTERNET_RADIO", "select custom radio") {
|
||||
return fmt.Errorf("LOCAL_INTERNET_RADIO is not available")
|
||||
}
|
||||
|
||||
PrintDeviceHeader("Selecting custom radio stream", clientConfig.Host, clientConfig.Port)
|
||||
|
||||
if itemName != "" {
|
||||
fmt.Printf(" Station: %s\n", itemName)
|
||||
}
|
||||
|
||||
fmt.Printf(" URL: %s\n", streamURL)
|
||||
fmt.Printf(" Proxy: %s\n", location)
|
||||
|
||||
err = client.SelectLocalInternetRadio(location, "", itemName, containerArt)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to select custom radio: %w", err)
|
||||
}
|
||||
|
||||
PrintSuccess("Custom radio stream selected")
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// selectLocalMusic handles selecting LOCAL_MUSIC source
|
||||
func selectLocalMusic(c *cli.Context) error {
|
||||
clientConfig := GetClientConfig(c)
|
||||
|
||||
@@ -2,7 +2,6 @@ package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/url"
|
||||
"strings"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/models"
|
||||
@@ -35,23 +34,12 @@ func playTTS(c *cli.Context) error {
|
||||
return err
|
||||
}
|
||||
|
||||
// URL encode the text for Google TTS
|
||||
encodedText := url.QueryEscape(text)
|
||||
|
||||
// Build TTS URL with language support
|
||||
ttsURL := fmt.Sprintf("http://translate.google.com/translate_tts?ie=UTF-8&tl=%s&client=tw-ob&q=%s", language, encodedText)
|
||||
|
||||
// Create PlayInfo for TTS
|
||||
playInfo := &models.PlayInfo{
|
||||
URL: ttsURL,
|
||||
AppKey: appKey,
|
||||
Service: "TTS Notification",
|
||||
Message: "Google TTS",
|
||||
Reason: text,
|
||||
}
|
||||
|
||||
var playInfo *models.PlayInfo
|
||||
if volume > 0 {
|
||||
playInfo.SetVolume(volume)
|
||||
playInfo = models.NewTTSPlayInfo(text, appKey, language, volume)
|
||||
} else {
|
||||
playInfo = models.NewTTSPlayInfo(text, appKey, language)
|
||||
}
|
||||
|
||||
err = client.PlayCustom(playInfo)
|
||||
@@ -121,10 +109,11 @@ func playURL(c *cli.Context) error {
|
||||
}
|
||||
|
||||
// Create PlayInfo for URL content
|
||||
playInfo := models.NewURLPlayInfo(urlStr, appKey, service, message, reason)
|
||||
|
||||
var playInfo *models.PlayInfo
|
||||
if volume > 0 {
|
||||
playInfo.SetVolume(volume)
|
||||
playInfo = models.NewURLPlayInfo(urlStr, appKey, service, message, reason, volume)
|
||||
} else {
|
||||
playInfo = models.NewURLPlayInfo(urlStr, appKey, service, message, reason)
|
||||
}
|
||||
|
||||
err = client.PlayCustom(playInfo)
|
||||
|
||||
@@ -924,6 +924,34 @@ func main() {
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
Name: "custom-radio",
|
||||
Usage: "Select custom radio stream via soundtouch-service",
|
||||
Action: selectCustomRadio,
|
||||
Before: RequireHost,
|
||||
Flags: []cli.Flag{
|
||||
&cli.StringFlag{
|
||||
Name: "url",
|
||||
Aliases: []string{"u"},
|
||||
Usage: "Stream URL",
|
||||
Required: true,
|
||||
},
|
||||
&cli.StringFlag{
|
||||
Name: "name",
|
||||
Aliases: []string{"n"},
|
||||
Usage: "Station name",
|
||||
},
|
||||
&cli.StringFlag{
|
||||
Name: "artwork",
|
||||
Usage: "Station artwork URL",
|
||||
},
|
||||
&cli.StringFlag{
|
||||
Name: "service-url",
|
||||
Usage: "URL of the soundtouch-service (default: http://localhost:8080)",
|
||||
Value: "http://localhost:8080",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
Name: "local-music",
|
||||
Usage: "Select local music content (LOCAL_MUSIC)",
|
||||
|
||||
+412
-126
@@ -8,6 +8,7 @@ import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"log"
|
||||
"net"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"os"
|
||||
@@ -23,6 +24,7 @@ import (
|
||||
"github.com/gesellix/bose-soundtouch/pkg/service/handlers"
|
||||
"github.com/gesellix/bose-soundtouch/pkg/service/proxy"
|
||||
"github.com/gesellix/bose-soundtouch/pkg/service/setup"
|
||||
"github.com/gesellix/bose-soundtouch/pkg/service/spotify"
|
||||
"github.com/go-chi/chi/v5"
|
||||
"github.com/go-chi/chi/v5/middleware"
|
||||
"github.com/urfave/cli/v2"
|
||||
@@ -80,17 +82,6 @@ func main() {
|
||||
Usage: "Network interface to bind to",
|
||||
EnvVars: []string{"BIND_ADDR"},
|
||||
},
|
||||
&cli.StringFlag{
|
||||
Name: "soundcork-url",
|
||||
Usage: "URL for Soundcork-based service components (legacy)",
|
||||
Value: "http://localhost:8001",
|
||||
EnvVars: []string{"SOUNDCORK_BACKEND_URL", "TARGET_URL"},
|
||||
},
|
||||
&cli.BoolFlag{
|
||||
Name: "enable-soundcork-proxy",
|
||||
Usage: "Enable proxying unknown requests to the Soundcork backend",
|
||||
EnvVars: []string{"ENABLE_SOUNDCORK_PROXY"},
|
||||
},
|
||||
&cli.StringFlag{
|
||||
Name: "data-dir",
|
||||
Usage: "Directory for persistent data",
|
||||
@@ -145,8 +136,8 @@ func main() {
|
||||
},
|
||||
&cli.StringFlag{
|
||||
Name: "dns-upstream",
|
||||
Usage: "Upstream DNS server for non-Bose queries",
|
||||
Value: "8.8.8.8",
|
||||
Usage: "Upstream DNS server(s) for non-Bose queries (comma-separated). If empty, /etc/resolv.conf is used.",
|
||||
Value: "",
|
||||
EnvVars: []string{"DNS_UPSTREAM"},
|
||||
},
|
||||
&cli.StringFlag{
|
||||
@@ -155,6 +146,71 @@ func main() {
|
||||
Value: ":53",
|
||||
EnvVars: []string{"DNS_BIND_ADDR"},
|
||||
},
|
||||
&cli.StringFlag{
|
||||
Name: "spotify-client-id",
|
||||
Usage: "Spotify OAuth client ID",
|
||||
EnvVars: []string{"SPOTIFY_CLIENT_ID"},
|
||||
},
|
||||
&cli.StringFlag{
|
||||
Name: "spotify-client-secret",
|
||||
Usage: "Spotify OAuth client secret",
|
||||
EnvVars: []string{"SPOTIFY_CLIENT_SECRET"},
|
||||
},
|
||||
&cli.StringFlag{
|
||||
Name: "spotify-redirect-uri",
|
||||
Usage: "Spotify OAuth redirect URI",
|
||||
Value: "ueberboese-login://spotify",
|
||||
EnvVars: []string{"SPOTIFY_REDIRECT_URI"},
|
||||
},
|
||||
&cli.StringFlag{
|
||||
Name: "mgmt-username",
|
||||
Usage: "Management API username for HTTP Basic Auth",
|
||||
Value: "admin",
|
||||
EnvVars: []string{"MGMT_USERNAME"},
|
||||
},
|
||||
&cli.StringFlag{
|
||||
Name: "mgmt-password",
|
||||
Usage: "Management API password for HTTP Basic Auth",
|
||||
Value: "change_me!",
|
||||
EnvVars: []string{"MGMT_PASSWORD"},
|
||||
},
|
||||
&cli.StringFlag{
|
||||
Name: "base-url",
|
||||
Usage: "External base URL for OAuth callbacks behind reverse proxy",
|
||||
EnvVars: []string{"BASE_URL"},
|
||||
},
|
||||
&cli.BoolFlag{
|
||||
Name: "mirror-enabled",
|
||||
Usage: "Enable background mirroring to Bose Cloud",
|
||||
EnvVars: []string{"MIRROR_ENABLED"},
|
||||
},
|
||||
&cli.StringSliceFlag{
|
||||
Name: "mirror-endpoints",
|
||||
Usage: "Endpoints to mirror to Bose Cloud (comma-separated or multiple flags)",
|
||||
EnvVars: []string{"MIRROR_ENDPOINTS"},
|
||||
},
|
||||
&cli.StringSliceFlag{
|
||||
Name: "internal-paths",
|
||||
Usage: "Paths for internal requests (comma-separated or multiple flags)",
|
||||
EnvVars: []string{"INTERNAL_PATHS"},
|
||||
},
|
||||
&cli.BoolFlag{
|
||||
Name: "migration-enabled",
|
||||
Usage: "Enable device directory migration from serial to MAC-based structure",
|
||||
Value: true,
|
||||
EnvVars: []string{"MIGRATION_ENABLED"},
|
||||
},
|
||||
&cli.BoolFlag{
|
||||
Name: "migration-dry-run",
|
||||
Usage: "Log what would be migrated without actually doing it",
|
||||
EnvVars: []string{"MIGRATION_DRY_RUN"},
|
||||
},
|
||||
&cli.StringFlag{
|
||||
Name: "preferred-source",
|
||||
Usage: "Preferred source of truth (local or upstream)",
|
||||
Value: "local",
|
||||
EnvVars: []string{"PREFERRED_SOURCE"},
|
||||
},
|
||||
},
|
||||
Action: func(c *cli.Context) error {
|
||||
config := loadConfig(c)
|
||||
@@ -177,13 +233,35 @@ func main() {
|
||||
|
||||
cm := initCertificateManager(config.dataDir)
|
||||
sm := setup.NewManager(config.serverURL, ds, cm)
|
||||
server := handlers.NewServer(ds, sm, config.serverURL, config.redact, config.logBody, config.record, config.enableSoundcorkProxy)
|
||||
sm.MgmtUsername = config.mgmtUsername
|
||||
sm.MgmtPassword = config.mgmtPassword
|
||||
server := handlers.NewServer(ds, sm, config.serverURL, config.redact, config.logBody, config.record)
|
||||
sm.GetDNSRunning = server.GetDNSRunning
|
||||
server.SetSoundcorkURL(config.soundcorkURL)
|
||||
server.SetHTTPServerURL(config.httpsServerURL)
|
||||
server.SetVersionInfo(version, commit, date)
|
||||
server.SetDiscoverySettings(config.discoveryInterval, persisted.DiscoveryEnabled)
|
||||
server.SetDNSSettings(persisted.DNSEnabled, persisted.DNSUpstream, persisted.DNSBindAddr)
|
||||
server.SetDNSSettings(persisted.DNSEnabled, strings.Join(persisted.DNSUpstream, ","), persisted.DNSBindAddr)
|
||||
server.SetMirrorSettings(persisted.MirrorEnabled, persisted.MirrorEndpoints, persisted.PreferredSource)
|
||||
server.SetInternalPaths(persisted.InternalPaths)
|
||||
server.SetSpotifyConfig(config.spotifyClientID, config.spotifyClientSecret, config.spotifyRedirectURI)
|
||||
server.SetMgmtConfig(config.mgmtUsername, config.mgmtPassword)
|
||||
|
||||
if config.spotifyClientID != "" {
|
||||
spotifyService := spotify.NewSpotifyService(
|
||||
config.spotifyClientID,
|
||||
config.spotifyClientSecret,
|
||||
config.spotifyRedirectURI,
|
||||
config.dataDir,
|
||||
)
|
||||
server.SetSpotifyService(spotifyService)
|
||||
|
||||
clientIDPrefix := config.spotifyClientID
|
||||
if len(clientIDPrefix) > 8 {
|
||||
clientIDPrefix = clientIDPrefix[:8]
|
||||
}
|
||||
|
||||
log.Printf("Spotify service initialized (client ID: %s...)", clientIDPrefix)
|
||||
}
|
||||
|
||||
// Load and set initial DNS discoveries
|
||||
dnsDiscoveries, err := ds.LoadDNSDiscoveries()
|
||||
@@ -247,7 +325,7 @@ func main() {
|
||||
|
||||
r := setupRouter(server)
|
||||
|
||||
log.Printf("Go service starting on %s, proxying to %s", config.serverURL, config.soundcorkURL)
|
||||
log.Printf("Go service starting on %s", config.serverURL)
|
||||
|
||||
if tlsConfig != nil {
|
||||
startHTTPSServer(config.httpsAddr, r, tlsConfig, config.httpsServerURL)
|
||||
@@ -281,23 +359,32 @@ func showVersionInfo(_ *cli.Context) error {
|
||||
}
|
||||
|
||||
type serviceConfig struct {
|
||||
port string
|
||||
bindAddr string
|
||||
addr string
|
||||
soundcorkURL string
|
||||
dataDir string
|
||||
serverURL string
|
||||
httpsServerURL string
|
||||
httpsAddr string
|
||||
redact bool
|
||||
logBody bool
|
||||
record bool
|
||||
enableSoundcorkProxy bool
|
||||
dnsEnabled bool
|
||||
dnsUpstream string
|
||||
dnsBind string
|
||||
discoveryInterval time.Duration
|
||||
domains []string
|
||||
port string
|
||||
bindAddr string
|
||||
addr string
|
||||
dataDir string
|
||||
serverURL string
|
||||
httpsServerURL string
|
||||
httpsAddr string
|
||||
redact bool
|
||||
logBody bool
|
||||
record bool
|
||||
dnsEnabled bool
|
||||
dnsUpstream string
|
||||
dnsBind string
|
||||
mirrorEnabled bool
|
||||
mirrorEndpoints []string
|
||||
internalPaths []string
|
||||
discoveryInterval time.Duration
|
||||
domains []string
|
||||
spotifyClientID string
|
||||
spotifyClientSecret string
|
||||
spotifyRedirectURI string
|
||||
mgmtUsername string
|
||||
mgmtPassword string
|
||||
migrationEnabled bool
|
||||
migrationDryRun bool
|
||||
preferredSource string
|
||||
}
|
||||
|
||||
func loadConfig(c *cli.Context) serviceConfig {
|
||||
@@ -309,7 +396,6 @@ func loadConfig(c *cli.Context) serviceConfig {
|
||||
addr = ":" + port
|
||||
}
|
||||
|
||||
soundcorkURL := c.String("soundcork-url")
|
||||
dataDir := c.String("data-dir")
|
||||
|
||||
hostname, _ := os.Hostname()
|
||||
@@ -341,7 +427,6 @@ func loadConfig(c *cli.Context) serviceConfig {
|
||||
redact := c.Bool("redact-logs")
|
||||
logBody := c.Bool("log-bodies")
|
||||
record := c.Bool("record-interactions")
|
||||
enableSoundcorkProxy := c.Bool("enable-soundcork-proxy")
|
||||
|
||||
dnsEnabled := c.Bool("dns-discovery")
|
||||
dnsUpstream := c.String("dns-upstream")
|
||||
@@ -356,38 +441,70 @@ func loadConfig(c *cli.Context) serviceConfig {
|
||||
discoveryInterval = 5 * time.Minute
|
||||
}
|
||||
|
||||
spotifyClientID := c.String("spotify-client-id")
|
||||
spotifyClientSecret := c.String("spotify-client-secret")
|
||||
spotifyRedirectURI := c.String("spotify-redirect-uri")
|
||||
mgmtUsername := c.String("mgmt-username")
|
||||
mgmtPassword := c.String("mgmt-password")
|
||||
mirrorEnabled := c.Bool("mirror-enabled")
|
||||
mirrorEndpoints := c.StringSlice("mirror-endpoints")
|
||||
internalPaths := c.StringSlice("internal-paths")
|
||||
migrationEnabled := c.Bool("migration-enabled")
|
||||
migrationDryRun := c.Bool("migration-dry-run")
|
||||
preferredSource := c.String("preferred-source")
|
||||
|
||||
return serviceConfig{
|
||||
port: port,
|
||||
bindAddr: bindAddr,
|
||||
addr: addr,
|
||||
soundcorkURL: soundcorkURL,
|
||||
dataDir: dataDir,
|
||||
serverURL: serverURL,
|
||||
httpsServerURL: httpsServerURL,
|
||||
httpsAddr: httpsAddr,
|
||||
redact: redact,
|
||||
logBody: logBody,
|
||||
record: record,
|
||||
enableSoundcorkProxy: enableSoundcorkProxy,
|
||||
dnsEnabled: dnsEnabled,
|
||||
dnsUpstream: dnsUpstream,
|
||||
dnsBind: dnsBind,
|
||||
discoveryInterval: discoveryInterval,
|
||||
domains: domains,
|
||||
port: port,
|
||||
bindAddr: bindAddr,
|
||||
addr: addr,
|
||||
dataDir: dataDir,
|
||||
serverURL: serverURL,
|
||||
httpsServerURL: httpsServerURL,
|
||||
httpsAddr: httpsAddr,
|
||||
redact: redact,
|
||||
logBody: logBody,
|
||||
record: record,
|
||||
dnsEnabled: dnsEnabled,
|
||||
dnsUpstream: dnsUpstream,
|
||||
dnsBind: dnsBind,
|
||||
mirrorEnabled: mirrorEnabled,
|
||||
mirrorEndpoints: mirrorEndpoints,
|
||||
internalPaths: internalPaths,
|
||||
discoveryInterval: discoveryInterval,
|
||||
domains: domains,
|
||||
spotifyClientID: spotifyClientID,
|
||||
spotifyClientSecret: spotifyClientSecret,
|
||||
spotifyRedirectURI: spotifyRedirectURI,
|
||||
mgmtUsername: mgmtUsername,
|
||||
mgmtPassword: mgmtPassword,
|
||||
migrationEnabled: migrationEnabled,
|
||||
migrationDryRun: migrationDryRun,
|
||||
preferredSource: preferredSource,
|
||||
}
|
||||
}
|
||||
|
||||
func getDomains(serverURL, httpsServerURL, hostname string) []string {
|
||||
domainsMap := map[string]bool{
|
||||
"streaming.bose.com": true,
|
||||
"updates.bose.com": true,
|
||||
"stats.bose.com": true,
|
||||
"bmx.bose.com": true,
|
||||
"content.api.bose.io": true,
|
||||
setup.TestDomain: true,
|
||||
hostname: true,
|
||||
"localhost": true,
|
||||
"127.0.0.1": true,
|
||||
// RFC-compliant wildcards for API patterns
|
||||
"*.api.bose.io": true,
|
||||
"*.api.bosecm.com": true,
|
||||
// Core Bose domains (keep specific ones for clarity)
|
||||
"streaming.bose.com": true,
|
||||
"updates.bose.com": true,
|
||||
"stats.bose.com": true,
|
||||
"bmx.bose.com": true,
|
||||
"worldwide.bose.com": true,
|
||||
"music.api.bose.com": true,
|
||||
"streamingoauth.bose.com": true,
|
||||
"bosecm.com": true,
|
||||
"bose.io": true,
|
||||
"bose-prod.apigee.net": true,
|
||||
"bose-test.apigee.net": true,
|
||||
// Local service domains
|
||||
setup.TestDomain: true,
|
||||
hostname: true,
|
||||
"localhost": true,
|
||||
"127.0.0.1": true,
|
||||
}
|
||||
|
||||
if u, err := url.Parse(serverURL); err == nil && u.Hostname() != "" {
|
||||
@@ -412,12 +529,15 @@ func applyPersistedSettings(ds *datastore.DataStore, config *serviceConfig) data
|
||||
return datastore.Settings{}
|
||||
}
|
||||
|
||||
if persisted.ServerURL != "" {
|
||||
config.serverURL = persisted.ServerURL
|
||||
// Only override CLI values if settings file exists
|
||||
// If no settings file exists, GetSettings returns empty Settings{} and we should preserve CLI values
|
||||
settingsPath := filepath.Join(ds.DataDir, "settings.json")
|
||||
if _, err := os.Stat(settingsPath); os.IsNotExist(err) {
|
||||
return datastore.Settings{}
|
||||
}
|
||||
|
||||
if persisted.SoundcorkURL != "" {
|
||||
config.soundcorkURL = persisted.SoundcorkURL
|
||||
if persisted.ServerURL != "" {
|
||||
config.serverURL = persisted.ServerURL
|
||||
}
|
||||
|
||||
if persisted.HTTPServerURL != "" {
|
||||
@@ -433,39 +553,46 @@ func applyPersistedSettings(ds *datastore.DataStore, config *serviceConfig) data
|
||||
config.redact = persisted.RedactLogs
|
||||
config.logBody = persisted.LogBodies
|
||||
config.record = persisted.RecordInteractions
|
||||
config.enableSoundcorkProxy = persisted.EnableSoundcorkProxy
|
||||
|
||||
config.dnsEnabled = persisted.DNSEnabled
|
||||
if persisted.DNSUpstream != "" {
|
||||
config.dnsUpstream = persisted.DNSUpstream
|
||||
if len(persisted.DNSUpstream) > 0 {
|
||||
config.dnsUpstream = strings.Join(persisted.DNSUpstream, ",")
|
||||
}
|
||||
|
||||
if persisted.DNSBindAddr != "" {
|
||||
config.dnsBind = persisted.DNSBindAddr
|
||||
}
|
||||
|
||||
config.mirrorEnabled = persisted.MirrorEnabled
|
||||
config.mirrorEndpoints = persisted.MirrorEndpoints
|
||||
config.preferredSource = persisted.PreferredSource
|
||||
config.internalPaths = persisted.InternalPaths
|
||||
|
||||
return persisted
|
||||
}
|
||||
|
||||
func createDefaultSettings(ds *datastore.DataStore, config serviceConfig) datastore.Settings {
|
||||
settings := datastore.Settings{
|
||||
ServerURL: config.serverURL,
|
||||
SoundcorkURL: config.soundcorkURL,
|
||||
HTTPServerURL: config.httpsServerURL,
|
||||
RedactLogs: config.redact,
|
||||
LogBodies: config.logBody,
|
||||
RecordInteractions: config.record,
|
||||
DiscoveryInterval: config.discoveryInterval.String(),
|
||||
DiscoveryEnabled: true,
|
||||
EnableSoundcorkProxy: config.enableSoundcorkProxy,
|
||||
DNSEnabled: config.dnsEnabled,
|
||||
DNSUpstream: config.dnsUpstream,
|
||||
DNSBindAddr: config.dnsBind,
|
||||
ServerURL: config.serverURL,
|
||||
HTTPServerURL: config.httpsServerURL,
|
||||
RedactLogs: config.redact,
|
||||
LogBodies: config.logBody,
|
||||
RecordInteractions: config.record,
|
||||
DiscoveryInterval: config.discoveryInterval.String(),
|
||||
DiscoveryEnabled: true,
|
||||
DNSEnabled: config.dnsEnabled,
|
||||
DNSUpstream: strings.Split(config.dnsUpstream, ","),
|
||||
DNSBindAddr: config.dnsBind,
|
||||
MirrorEnabled: config.mirrorEnabled,
|
||||
MirrorEndpoints: config.mirrorEndpoints,
|
||||
PreferredSource: config.preferredSource,
|
||||
InternalPaths: config.internalPaths,
|
||||
Shortcuts: map[string]int{
|
||||
"/.well-known/appspecific/com.chrome.devtools.json": http.StatusNotFound,
|
||||
"/sw.js": http.StatusNotFound,
|
||||
},
|
||||
}
|
||||
|
||||
_ = ds.SaveSettings(settings)
|
||||
|
||||
return settings
|
||||
@@ -504,9 +631,11 @@ func startDeviceDiscovery(server *handlers.Server) {
|
||||
|
||||
func setupRouter(server *handlers.Server) *chi.Mux {
|
||||
r := chi.NewRouter()
|
||||
r.Use(server.SnapshotMiddleware)
|
||||
r.Use(server.OriginMiddleware)
|
||||
r.Use(middleware.Recoverer)
|
||||
r.Use(server.ShortcutMiddleware)
|
||||
r.Use(server.MirrorMiddleware)
|
||||
r.Use(server.RecordMiddleware)
|
||||
|
||||
r.Get("/", server.HandleRoot)
|
||||
@@ -534,41 +663,59 @@ func setupRouter(server *handlers.Server) *chi.Mux {
|
||||
r.Get("/tunein/v1/playback/episodes/{podcastID}", server.HandleTuneInPodcastInfo)
|
||||
r.Get("/tunein/v1/playback/episode/{podcastID}", server.HandleTuneInPlaybackPodcast)
|
||||
r.Post("/orion/v1/playback/station/{data}", server.HandleOrionPlayback)
|
||||
r.Get("/custom/v1/playback/{encodedURL}", server.HandleCustomPlayback)
|
||||
|
||||
streamingRoutes := func(r chi.Router) {
|
||||
r.Get("/sourceproviders", server.HandleMargeSourceProviders)
|
||||
r.Get("/account/{account}/device/{device}/recent", server.HandleMargeRecents)
|
||||
r.Post("/account/{account}/device/{device}/recent", server.HandleMargeAddRecent)
|
||||
r.Get("/account/{account}/device/{device}/presets", server.HandleMargePresets)
|
||||
r.Post("/account/{account}/device/{device}/presets/{presetNumber}", server.HandleMargeUpdatePreset)
|
||||
r.Post("/support/power_on", server.HandleMargePowerOn)
|
||||
r.Get("/account/{account}/provider_settings", server.HandleMargeProviderSettings)
|
||||
r.Get("/device/{device}/streaming_token", server.HandleMargeStreamingToken)
|
||||
r.Post("/support/customersupport", server.HandleMargeCustomerSupport)
|
||||
r.Get("/device_setting/account/{account}/device/{device}/device_settings", server.HandleMargeGetDeviceSettings)
|
||||
r.Get("/account/{account}/device/{device}/group", server.HandleMargeDeviceGroup)
|
||||
r.Get("/account/{account}/device/{device}/group/", server.HandleMargeDeviceGroup)
|
||||
r.Get("/account/{account}/device/{device}/group/server", server.HandleMargeDeviceGroupServer)
|
||||
r.Get("/account/{account}/device/{device}/group/member", server.HandleMargeDeviceGroupMember)
|
||||
r.Post("/device_setting/account/{account}/device/{device}/device_settings", server.HandleMargeUpdateDeviceSettings)
|
||||
r.Get("/account/{account}/emailaddress", server.HandleMargeGetEmailAddress)
|
||||
r.Get("/account/{account}/full", server.HandleMargeAccountFull)
|
||||
r.Get("/software/update/account/{account}", server.HandleMargeSoftwareUpdate)
|
||||
|
||||
r.Route("/stats", func(r chi.Router) {
|
||||
r.Post("/usage", server.HandleUsageStats)
|
||||
r.Post("/error", server.HandleErrorStats)
|
||||
})
|
||||
}
|
||||
|
||||
accountsRoutes := func(r chi.Router) {
|
||||
r.Get("/{account}/full", server.HandleMargeAccountFull)
|
||||
r.Get("/{account}/devices/{device}/presets", server.HandleMargePresets)
|
||||
r.Post("/{account}/devices/{device}/presets/{presetNumber}", server.HandleMargeUpdatePreset)
|
||||
r.Get("/{account}/devices/{device}/recents", server.HandleMargeRecents)
|
||||
r.Post("/{account}/devices/{device}/recents", server.HandleMargeAddRecent)
|
||||
r.Post("/{account}/devices", server.HandleMargeAddDevice)
|
||||
r.Delete("/{account}/devices/{device}", server.HandleMargeRemoveDevice)
|
||||
r.Get("/{account}/devices/{device}/group", server.HandleMargeDeviceGroup)
|
||||
r.Get("/{account}/devices/{device}/group/", server.HandleMargeDeviceGroup)
|
||||
r.Get("/{account}/devices/{device}/group/server", server.HandleMargeDeviceGroupServer)
|
||||
r.Get("/{account}/devices/{device}/group/member", server.HandleMargeDeviceGroupMember)
|
||||
}
|
||||
|
||||
r.Route("/marge", func(r chi.Router) {
|
||||
r.Get("/streaming/sourceproviders", server.HandleMargeSourceProviders)
|
||||
r.Get("/accounts/{account}/full", server.HandleMargeAccountFull)
|
||||
r.Post("/streaming/support/power_on", server.HandleMargePowerOn)
|
||||
r.Route("/streaming", streamingRoutes)
|
||||
r.Route("/accounts", accountsRoutes)
|
||||
|
||||
r.Get("/updates/soundtouch", server.HandleMargeSoftwareUpdate)
|
||||
r.Get("/accounts/{account}/devices/{device}/presets", server.HandleMargePresets)
|
||||
r.Post("/accounts/{account}/devices/{device}/presets/{presetNumber}", server.HandleMargeUpdatePreset)
|
||||
r.Post("/accounts/{account}/devices/{device}/recents", server.HandleMargeAddRecent)
|
||||
r.Post("/accounts/{account}/devices", server.HandleMargeAddDevice)
|
||||
r.Delete("/accounts/{account}/devices/{device}", server.HandleMargeRemoveDevice)
|
||||
r.Get("/streaming/account/{account}/provider_settings", server.HandleMargeProviderSettings)
|
||||
r.Get("/streaming/device/{device}/streaming_token", server.HandleMargeStreamingToken)
|
||||
r.Post("/streaming/support/customersupport", server.HandleMargeCustomerSupport)
|
||||
r.Get("/streaming/device_setting/account/{account}/device/{device}/device_settings", server.HandleMargeGetDeviceSettings)
|
||||
r.Post("/streaming/device_setting/account/{account}/device/{device}/device_settings", server.HandleMargeUpdateDeviceSettings)
|
||||
r.Get("/streaming/account/{account}/emailaddress", server.HandleMargeGetEmailAddress)
|
||||
})
|
||||
|
||||
// Legacy or direct domain calls without /marge prefix
|
||||
r.Get("/streaming/sourceproviders", server.HandleMargeSourceProviders)
|
||||
r.Get("/accounts/{account}/full", server.HandleMargeAccountFull)
|
||||
r.Post("/streaming/support/power_on", server.HandleMargePowerOn)
|
||||
r.Route("/streaming", streamingRoutes)
|
||||
r.Route("/accounts", accountsRoutes)
|
||||
r.Get("/updates/soundtouch", server.HandleMargeSoftwareUpdate)
|
||||
r.Get("/accounts/{account}/devices/{device}/presets", server.HandleMargePresets)
|
||||
r.Post("/accounts/{account}/devices/{device}/presets/{presetNumber}", server.HandleMargeUpdatePreset)
|
||||
r.Post("/accounts/{account}/devices/{device}/recents", server.HandleMargeAddRecent)
|
||||
r.Post("/accounts/{account}/devices", server.HandleMargeAddDevice)
|
||||
r.Delete("/accounts/{account}/devices/{device}", server.HandleMargeRemoveDevice)
|
||||
r.Get("/streaming/account/{account}/provider_settings", server.HandleMargeProviderSettings)
|
||||
r.Get("/streaming/device/{device}/streaming_token", server.HandleMargeStreamingToken)
|
||||
r.Post("/streaming/support/customersupport", server.HandleMargeCustomerSupport)
|
||||
r.Get("/streaming/device_setting/account/{account}/device/{device}/device_settings", server.HandleMargeGetDeviceSettings)
|
||||
r.Post("/streaming/device_setting/account/{account}/device/{device}/device_settings", server.HandleMargeUpdateDeviceSettings)
|
||||
r.Get("/streaming/account/{account}/emailaddress", server.HandleMargeGetEmailAddress)
|
||||
|
||||
r.Route("/customer", func(r chi.Router) {
|
||||
r.Get("/account/{account}", server.HandleMargeAccountProfile)
|
||||
@@ -576,14 +723,35 @@ func setupRouter(server *handlers.Server) *chi.Mux {
|
||||
r.Post("/account/{account}/password", server.HandleMargeChangePassword)
|
||||
})
|
||||
|
||||
r.Route("/oauth", func(r chi.Router) {
|
||||
r.Post("/device/{deviceID}/music/musicprovider/15/token/cs3", server.HandleBoseSpotifyToken)
|
||||
r.Post("/device/{deviceID}/music/musicprovider/15/token", server.HandleBoseSpotifyLegacyToken)
|
||||
r.HandleFunc("/*", server.HandleBoseProxy)
|
||||
})
|
||||
|
||||
r.Route("/v1", func(r chi.Router) {
|
||||
r.Post("/stapp/{deviceId}", server.HandleAppEvents)
|
||||
r.Post("/scmudc/{deviceId}", server.HandleAppEvents)
|
||||
})
|
||||
|
||||
r.Route("/streaming/stats", func(r chi.Router) {
|
||||
r.Post("/usage", server.HandleUsageStats)
|
||||
r.Post("/error", server.HandleErrorStats)
|
||||
r.Route("/mgmt", func(r chi.Router) {
|
||||
// Browser OAuth callback — no auth required (Spotify redirects the
|
||||
// user's browser here directly). The authorization code is single-use,
|
||||
// short-lived, and useless without the client_secret.
|
||||
r.Get("/spotify/callback", server.HandleMgmtSpotifyCallback)
|
||||
|
||||
// All other management endpoints require Basic Auth.
|
||||
r.Group(func(r chi.Router) {
|
||||
r.Use(server.BasicAuthMgmt())
|
||||
r.Get("/accounts/{accountId}/speakers", server.HandleMgmtListSpeakers)
|
||||
r.Get("/devices/{deviceId}/events", server.HandleMgmtDeviceEvents)
|
||||
r.Post("/spotify/init", server.HandleMgmtSpotifyInit)
|
||||
r.Post("/spotify/confirm", server.HandleMgmtSpotifyConfirm)
|
||||
r.Get("/spotify/accounts", server.HandleMgmtSpotifyAccounts)
|
||||
r.Get("/spotify/token", server.HandleMgmtSpotifyToken)
|
||||
r.Post("/spotify/entity", server.HandleMgmtSpotifyEntity)
|
||||
r.Post("/spotify/prime", server.HandleMgmtPrimeDevice)
|
||||
})
|
||||
})
|
||||
|
||||
r.Get("/proxy/*", server.HandleProxyRequest)
|
||||
@@ -596,19 +764,19 @@ func setupRouter(server *handlers.Server) *chi.Mux {
|
||||
r.Get("/discovery-status", server.HandleGetDiscoveryStatus)
|
||||
r.Get("/settings", server.HandleGetSettings)
|
||||
r.Post("/settings", server.HandleUpdateSettings)
|
||||
r.Get("/info/{deviceIP}", server.HandleGetDeviceInfo)
|
||||
r.Get("/summary/{deviceIP}", server.HandleGetMigrationSummary)
|
||||
r.Post("/migrate/{deviceIP}", server.HandleMigrateDevice)
|
||||
r.Post("/revert/{deviceIP}", server.HandleRevertMigration)
|
||||
r.Post("/reboot/{deviceIP}", server.HandleRebootDevice)
|
||||
r.Post("/trust-ca/{deviceIP}", server.HandleTrustCACert)
|
||||
r.Post("/ensure-remote-services/{deviceIP}", server.HandleEnsureRemoteServices)
|
||||
r.Post("/remove-remote-services/{deviceIP}", server.HandleRemoveRemoteServices)
|
||||
r.Post("/backup/{deviceIP}", server.HandleBackupConfig)
|
||||
r.Post("/sync/{deviceIP}", server.HandleInitialSync)
|
||||
r.Post("/test-connection/{deviceIP}", server.HandleTestConnection)
|
||||
r.Post("/test-hosts/{deviceIP}", server.HandleTestHostsRedirection)
|
||||
r.Post("/test-dns/{deviceIP}", server.HandleTestDNSRedirection)
|
||||
r.Get("/info/{deviceId}", server.HandleGetDeviceInfo)
|
||||
r.Get("/summary/{deviceId}", server.HandleGetMigrationSummary)
|
||||
r.Post("/migrate/{deviceId}", server.HandleMigrateDevice)
|
||||
r.Post("/revert/{deviceId}", server.HandleRevertMigration)
|
||||
r.Post("/reboot/{deviceId}", server.HandleRebootDevice)
|
||||
r.Post("/trust-ca/{deviceId}", server.HandleTrustCACert)
|
||||
r.Post("/ensure-remote-services/{deviceId}", server.HandleEnsureRemoteServices)
|
||||
r.Post("/remove-remote-services/{deviceId}", server.HandleRemoveRemoteServices)
|
||||
r.Post("/backup/{deviceId}", server.HandleBackupConfig)
|
||||
r.Post("/sync/{deviceId}", server.HandleInitialSync)
|
||||
r.Post("/test-connection/{deviceId}", server.HandleTestConnection)
|
||||
r.Post("/test-hosts/{deviceId}", server.HandleTestHostsRedirection)
|
||||
r.Post("/test-dns/{deviceId}", server.HandleTestDNSRedirection)
|
||||
r.Get("/ca.crt", server.HandleGetCACert)
|
||||
r.Get("/proxy-settings", server.HandleGetProxySettings)
|
||||
r.Post("/proxy-settings", server.HandleUpdateProxySettings)
|
||||
@@ -616,11 +784,14 @@ func setupRouter(server *handlers.Server) *chi.Mux {
|
||||
r.Get("/interaction-stats", server.HandleGetInteractionStats)
|
||||
r.Get("/interactions", server.HandleListInteractions)
|
||||
r.Get("/interaction-content", server.HandleGetInteractionContent)
|
||||
r.Get("/parity-mismatches", server.HandleListParityMismatches)
|
||||
r.Delete("/parity-mismatches", server.HandleClearParityMismatches)
|
||||
r.Get("/interactions/sessions/{session}/download", server.HandleDownloadSession)
|
||||
r.Delete("/interactions/sessions/{session}", server.HandleDeleteSession)
|
||||
r.Delete("/interactions/sessions", server.HandleCleanupSessions)
|
||||
|
||||
r.Get("/dns-discoveries", server.HandleGetDNSDiscoveries)
|
||||
r.Get("/dns-discoveries/download", server.HandleDownloadDNSDiscoveries)
|
||||
r.Delete("/dns-discoveries", server.HandleClearDNSDiscoveries)
|
||||
|
||||
r.Get("/devices/{deviceId}/events", server.HandleGetDeviceEvents)
|
||||
@@ -632,17 +803,132 @@ func setupRouter(server *handlers.Server) *chi.Mux {
|
||||
}
|
||||
|
||||
func startHTTPSServer(httpsAddr string, r http.Handler, tlsConfig *tls.Config, httpsServerURL string) {
|
||||
// Add custom error logging and connection state tracking
|
||||
tlsConfig.GetCertificate = func(clientHello *tls.ClientHelloInfo) (*tls.Certificate, error) {
|
||||
// log.Printf("[TLS] Certificate request for ServerName: %s", clientHello.ServerName)
|
||||
|
||||
// Use the default certificate selection logic
|
||||
for _, cert := range tlsConfig.Certificates {
|
||||
if cert.Leaf != nil {
|
||||
for _, name := range cert.Leaf.DNSNames {
|
||||
if matchesDomain(name, clientHello.ServerName) {
|
||||
// log.Printf("[TLS] ✅ Serving certificate for %s (matched %s)", clientHello.ServerName, name)
|
||||
return &cert, nil
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// If no specific match, return the first certificate and log it
|
||||
if len(tlsConfig.Certificates) > 0 {
|
||||
// log.Printf("[TLS] ⚠️ No exact match for %s, using default certificate", clientHello.ServerName)
|
||||
return &tlsConfig.Certificates[0], nil
|
||||
}
|
||||
|
||||
log.Printf("[TLS] ❌ No certificate available for %s", clientHello.ServerName)
|
||||
|
||||
return nil, fmt.Errorf("no certificate available for %s", clientHello.ServerName)
|
||||
}
|
||||
|
||||
httpsServer := &http.Server{
|
||||
Addr: httpsAddr,
|
||||
Handler: r,
|
||||
TLSConfig: tlsConfig,
|
||||
ErrorLog: log.Default(), // Ensure error logging is enabled
|
||||
}
|
||||
|
||||
log.Printf("Go service starting HTTPS on %s", httpsServerURL)
|
||||
|
||||
go func() {
|
||||
if err := httpsServer.ListenAndServeTLS("", ""); err != nil && err != http.ErrServerClosed {
|
||||
listener, err := net.Listen("tcp", httpsAddr)
|
||||
if err != nil {
|
||||
log.Printf("[TLS] Failed to create listener: %v", err)
|
||||
return
|
||||
}
|
||||
|
||||
tlsListener := tls.NewListener(listener, tlsConfig)
|
||||
|
||||
// Wrap listener to log connection attempts
|
||||
wrappedListener := &loggingTLSListener{
|
||||
Listener: tlsListener,
|
||||
}
|
||||
|
||||
if err := httpsServer.Serve(wrappedListener); err != nil && err != http.ErrServerClosed {
|
||||
log.Printf("HTTPS server error: %v", err)
|
||||
}
|
||||
}()
|
||||
}
|
||||
|
||||
// matchesDomain checks if a certificate domain (which may be a wildcard) matches a server name
|
||||
func matchesDomain(certDomain, serverName string) bool {
|
||||
if certDomain == serverName {
|
||||
return true
|
||||
}
|
||||
|
||||
// Handle wildcard certificates (only at the beginning of a label)
|
||||
if strings.HasPrefix(certDomain, "*.") {
|
||||
certBase := certDomain[2:] // Remove "*."
|
||||
|
||||
// For *.api.bose.io to match events.api.bose.io but not test.content.api.bose.io
|
||||
// We need to ensure only one label is replaced by the wildcard
|
||||
if strings.HasSuffix(serverName, "."+certBase) {
|
||||
// Count dots to ensure we're not matching too many levels
|
||||
serverPrefix := strings.TrimSuffix(serverName, "."+certBase)
|
||||
if !strings.Contains(serverPrefix, ".") {
|
||||
return true
|
||||
}
|
||||
}
|
||||
|
||||
// Also match the base domain (e.g., api.bose.io matches *.api.bose.io)
|
||||
if serverName == certBase {
|
||||
return true
|
||||
}
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
// loggingTLSListener wraps a TLS listener to log connection attempts and handshake failures
|
||||
type loggingTLSListener struct {
|
||||
net.Listener
|
||||
}
|
||||
|
||||
func (l *loggingTLSListener) Accept() (net.Conn, error) {
|
||||
conn, err := l.Listener.Accept()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Wrap the connection to log TLS handshake results
|
||||
return &loggingTLSConn{
|
||||
Conn: conn,
|
||||
addr: conn.RemoteAddr(),
|
||||
}, nil
|
||||
}
|
||||
|
||||
// loggingTLSConn wraps a TLS connection to log handshake failures
|
||||
type loggingTLSConn struct {
|
||||
net.Conn
|
||||
addr net.Addr
|
||||
handshakeLogged bool
|
||||
}
|
||||
|
||||
func (c *loggingTLSConn) Read(b []byte) (n int, err error) {
|
||||
n, err = c.Conn.Read(b)
|
||||
|
||||
// Log TLS handshake failures on first read attempt
|
||||
if !c.handshakeLogged {
|
||||
c.handshakeLogged = true
|
||||
|
||||
if err != nil {
|
||||
// Check if this looks like a TLS handshake failure
|
||||
if strings.Contains(err.Error(), "tls:") ||
|
||||
strings.Contains(err.Error(), "handshake") ||
|
||||
strings.Contains(err.Error(), "certificate") {
|
||||
log.Printf("[TLS] ❌ Handshake failed from %s: %v", c.addr, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return n, err
|
||||
}
|
||||
|
||||
@@ -18,10 +18,9 @@ func TestApplyPersistedSettings(t *testing.T) {
|
||||
|
||||
t.Run("overrides true with false", func(t *testing.T) {
|
||||
config := &serviceConfig{
|
||||
redact: true,
|
||||
logBody: true,
|
||||
record: true,
|
||||
enableSoundcorkProxy: true,
|
||||
redact: true,
|
||||
logBody: true,
|
||||
record: true,
|
||||
}
|
||||
|
||||
// Simulate the bug by using the old bitwise OR logic in the test,
|
||||
@@ -29,10 +28,9 @@ func TestApplyPersistedSettings(t *testing.T) {
|
||||
// config.redact = config.redact || false -> stays true
|
||||
|
||||
settings := datastore.Settings{
|
||||
RedactLogs: false,
|
||||
LogBodies: false,
|
||||
RecordInteractions: false,
|
||||
EnableSoundcorkProxy: false,
|
||||
RedactLogs: false,
|
||||
LogBodies: false,
|
||||
RecordInteractions: false,
|
||||
}
|
||||
err := ds.SaveSettings(settings)
|
||||
if err != nil {
|
||||
@@ -50,9 +48,6 @@ func TestApplyPersistedSettings(t *testing.T) {
|
||||
if config.record != false {
|
||||
t.Errorf("Expected record to be false, got true")
|
||||
}
|
||||
if config.enableSoundcorkProxy != false {
|
||||
t.Errorf("Expected enableSoundcorkProxy to be false, got true")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("retains false when settings are false", func(t *testing.T) {
|
||||
|
||||
@@ -3,5 +3,6 @@ certs/
|
||||
default/
|
||||
dns/
|
||||
interactions/
|
||||
parity_mismatches/
|
||||
patterns.json
|
||||
settings.json
|
||||
|
||||
@@ -23,6 +23,14 @@ All content selection features from the [SoundTouch WebServices API Wiki](https:
|
||||
- Automatic defaults for missing parameters
|
||||
- **Use Cases**: Internet radio streams, proxy-based radio services
|
||||
|
||||
#### `SelectLocalInternetRadio(location, ...)` via `soundtouch-service`
|
||||
- **Purpose**: Select custom radio stream via local `soundtouch-service` proxy
|
||||
- **Features**:
|
||||
- Flexible stream URL encoding (Base64 or URL-escaped)
|
||||
- Dynamic generation of Bose-compatible playback JSON
|
||||
- Seamless integration with existing `LOCAL_INTERNET_RADIO` source
|
||||
- **Use Case**: Playing any internet radio URL without external proxy dependencies
|
||||
|
||||
#### `SelectLocalMusic(location, sourceAccount, itemName, containerArt string) error`
|
||||
- **Purpose**: Select LOCAL_MUSIC content from SoundTouch App Media Server
|
||||
- **Requirements**: SoundTouch App Media Server running on a computer
|
||||
@@ -47,6 +55,15 @@ soundtouch-cli --host <device> source internet-radio \
|
||||
--artwork "https://example.com/art.png"
|
||||
```
|
||||
|
||||
#### `soundtouch-cli source custom-radio`
|
||||
```bash
|
||||
soundtouch-cli --host <device> source custom-radio \
|
||||
--url "https://stream.example.com/radio" \
|
||||
--name "My Station" \
|
||||
--artwork "https://example.com/art.png" \
|
||||
--service-url "http://localhost:8080"
|
||||
```
|
||||
|
||||
#### `soundtouch-cli source local-music`
|
||||
```bash
|
||||
soundtouch-cli --host <device> source local-music \
|
||||
@@ -101,7 +118,7 @@ Comprehensive test suites implemented for all new functionality:
|
||||
### Example Code
|
||||
Complete working example demonstrating:
|
||||
- LOCAL_INTERNET_RADIO with streamUrl proxy format
|
||||
- LOCAL_INTERNET_RADIO with direct streams
|
||||
- LOCAL_INTERNET_RADIO with direct streams
|
||||
- LOCAL_MUSIC content selection
|
||||
- STORED_MUSIC content selection
|
||||
- Generic ContentItem usage
|
||||
@@ -152,7 +169,7 @@ All convenience methods create properly structured `ContentItem` objects:
|
||||
Based on the wiki structure, these related features are also supported:
|
||||
|
||||
1. **LOCAL_MUSIC**: ✅ Fully implemented
|
||||
2. **STORED_MUSIC**: ✅ Fully implemented
|
||||
2. **STORED_MUSIC**: ✅ Fully implemented
|
||||
3. **SPOTIFY**: ✅ Previously implemented
|
||||
4. **TUNEIN**: ✅ Previously implemented
|
||||
5. **BLUETOOTH**: ✅ Previously implemented
|
||||
@@ -169,7 +186,7 @@ err := client.SelectLocalInternetRadio(location, "", "My Station", "")
|
||||
// Direct ContentItem
|
||||
contentItem := &models.ContentItem{
|
||||
Source: "LOCAL_INTERNET_RADIO",
|
||||
Type: "stationurl",
|
||||
Type: "stationurl",
|
||||
Location: location,
|
||||
ItemName: "My Station",
|
||||
IsPresetable: true,
|
||||
|
||||
@@ -0,0 +1,86 @@
|
||||
### Overview of Recent Improvements and Next Steps
|
||||
|
||||
This document summarizes the improvements made to the **Marge service** to improve parity with the upstream Bose SoundTouch service, along with open issues and proposed next steps.
|
||||
|
||||
#### ✅ Completed Improvements (Marge Service)
|
||||
* **Mapped Preset `buttonNumber`**: Correctly mapped the internal `ServicePreset.ID` to the `buttonNumber` XML attribute in the `/full` response.
|
||||
* **Populated `contentItemType`**: The `contentItemType` (e.g., `tracklisturl`) is now correctly synchronized from upstream, persisted in the local datastore, and returned in the `/full` response for both presets and recents.
|
||||
* **Standardized Credential Types**: Adjusted the logic for Spotify to use the correct `token_version_3` type when a token is present in the `/full` response, improving parity with the upstream service. The service now respects existing `credential_type` values from `Sources.xml` (e.g., `token_version_3` for Spotify) while providing sensible defaults for new or incomplete sources.
|
||||
* **Inconsistent `serialNumber` Casing**: Fixed the casing mismatch in the `/full` response where the upstream uses camelCase `<serialNumber>` in the top-level `<device>` and lowercase `<serialnumber>` in the nested `<attachedProduct>`. Local responses now correctly mirror this inconsistency.
|
||||
* **Device Name Consistency**: Fixed an issue where the device `<name>` was empty in some local `/full` responses by ensuring it is correctly populated from the datastore and synchronized from upstream.
|
||||
* **Improved XML Parity**: Empty `<name>` tags in the `/full` response are now self-closing (`<name/>`), matching upstream behavior.
|
||||
* **Timestamp-based ID Generation**: Implemented a 9-digit ID schema (`YYMMDD` + 3-digit counter) for `recent` items, ensuring IDs are large, unique, and stay within the 32-bit integer range.
|
||||
* **Automatic Source Learning**: The service now extracts and persists full metadata (credentials, provider IDs, and custom names) from incoming `POST /recent` requests. This improves parity for subsequent `GET /recents` calls.
|
||||
* **Source Provider Mapping**: Synchronized local source provider IDs and timestamps with upstream data. The `RADIO_BROWSER` provider is included in the public `/streaming/sourceproviders` list to maintain internal functionality while acknowledging it as a parity gap.
|
||||
* **Credential Preservation**: Improved `AddRecent` to correctly extract and echo back base64 tokens/credentials provided in the incoming request, improving source learning.
|
||||
* **XML Formatting Parity**:
|
||||
* Added `standalone="yes"` to the XML declaration for all Marge responses, including `recent`, `presets`, `full account`, `software update`, and `sourceproviders`.
|
||||
* Enforced self-closing `<sourceSettings/>` tags for parity.
|
||||
* Standardized date formatting to UTC with milliseconds (`.000+00:00`).
|
||||
* Fixed casing for `/streaming/sourceproviders`: Root element is `<sourceProviders>`, but child elements are `<sourceprovider>` (all lowercase), matching upstream behavior.
|
||||
* Implemented structured XML marshaling with consistent 2-space indentation for recents and source providers.
|
||||
* **Improved TuneIn Parity**: Fixed TuneIn source mapping to use ID `25` and ensuring `sourcename` is empty in responses, matching upstream behavior for station playback.
|
||||
* **High-Fidelity Full Account Sync**: Refactored the `/streaming/account/{accountId}/full` response to match the upstream structure. This includes:
|
||||
* **Mapped Preset `buttonNumber`**: Correctly mapped the internal `ServicePreset.ID` to the `buttonNumber` XML attribute in the `/full` response.
|
||||
* **Structured XML Marshaling**: Replaced manual string concatenation with structured Go models and `xml.Marshal` for the entire response.
|
||||
* **Specific Response Models**: Introduced `FullResponseSource`, `FullResponsePreset`, and `FullResponseRecent` to accurately reflect the upstream structure where `<source>` is a child element, rather than a set of attributes.
|
||||
* **Correct Nesting**: Ensured that `<presets>` and `<recents>` correctly nest their associated `<source>` details, resolving previous data omissions.
|
||||
* **Device Identity**: Added `<serialNumber>` and `<updatedOn>` to both the top-level `<device>` and its `<attachedProduct>`, ensuring consistent device identification.
|
||||
* **Field-Level Parity**: Mapped missing fields like `<contentItemType>` and `<productlabel>` to match upstream expectations.
|
||||
* **Improved Source Matching**: Enhanced internal logic to correctly link presets and recents to their configured sources based on multiple identifiers (ID, Key, or Type).
|
||||
* **Verified Parity Mismatch Fixes**: Comprehensive reproduction tests (`TestParityMismatchReproduction_V2` and `TestParityMismatchReproduction_V3`) now confirm parity for identified mismatches in `POST /recent` and `GET /recents`, including credentials and source-specific metadata.
|
||||
* **Unified Response Logic**: Refactored the code so that both `POST /recent` and `GET /recents` use the same formatting functions, guaranteeing consistency.
|
||||
* **Robust Parity Detection**: Updated the local parity checker to be whitespace-insensitive for XML bodies, significantly reducing noise from minor indentation or newline differences.
|
||||
* **Maintainable XML Generation**: Reduced cyclomatic complexity and code duplication in `marge.go` by extracting focused helper functions for mapping internal data to response-specific XML models.
|
||||
|
||||
---
|
||||
|
||||
#### 🛠️ Open Issues and Next Steps
|
||||
|
||||
Based on the latest `parity_mismatches`, here are the recommended areas for further work:
|
||||
|
||||
#### 1. BMX / TuneIn Playback Parity (Medium)
|
||||
Current mismatches in `/bmx/tunein/v1/playback/station/...` show differences in reporting URLs and missing links:
|
||||
* **Mismatched Parameters**: Local reporting URLs use `listen_id=3432432423`, while upstream uses a different session-based ID.
|
||||
* **Missing Links**: Some upstream responses include additional `_links` or metadata that are currently omitted in local responses.
|
||||
* **Action**: Improve the `HandleTuneInPlayback` logic to better mirror the upstream response structure and parameter generation.
|
||||
|
||||
#### 2. Presets and Recents Parity (Medium)
|
||||
Further align the standalone `GET /presets` and `GET /recents` endpoints with the refined structural improvements introduced for the `/full` account response:
|
||||
* **Source Nesting**: Ensure the standalone responses also use the specialized nested `<source>` structure instead of mixed attributes when appropriate.
|
||||
* **Field Completeness**: Verify all metadata fields (e.g., `<contentItemType>`, `<lastplayedat>`) are consistently populated across all access paths.
|
||||
* **Action**: Evaluate if the specialized `FullResponsePreset` and `FullResponseRecent` models should be shared or mirrored in the standalone handlers.
|
||||
|
||||
#### 3. OAuth / Spotify Token Noise (Low/Medium)
|
||||
The `/oauth/device/.../token` endpoint frequently reports mismatches because tokens are naturally different between local and upstream.
|
||||
* **The Issue**: This creates "noise" in your parity reports that isn't actually a bug.
|
||||
* **Action**: Update the parity detection logic (or the handler) to selectively ignore the `access_token` field while still verifying that the rest of the JSON structure (expires_in, scope, token_type) matches.
|
||||
|
||||
#### 4. Large IDs for Other Models (Medium)
|
||||
While we fixed IDs for `recents`, other models like `presets` or `sources` might still use small auto-incrementing integers.
|
||||
* **Action**: Evaluate if other endpoints should also transition to the timestamp-based ID schema to further reduce diff noise.
|
||||
|
||||
#### 5. Improved Data Persistence (Continuous)
|
||||
Continue the "learning" approach for other services. For example, if we see a new `sourceproviderid` in a Spotify or TuneIn request, we should ensure it is stored and reused.
|
||||
|
||||
#### 6. Local Reboot & Device State Management (Continuous)
|
||||
Analysis of device reboot logs revealed several data requirements:
|
||||
* **Power-On Details Tracking**: Implemented extraction and persistence of detailed device information (serial numbers, firmware version, product details, and MAC addresses) from the `POST /streaming/support/power_on` request. This data is now stored in the local datastore, improving our ability to respond accurately to subsequent management requests.
|
||||
* **Source Provider Mapping**: Synchronized local source provider IDs and timestamps with upstream data. The `RADIO_BROWSER` provider is included in the public `/streaming/sourceproviders` list to maintain internal functionality while acknowledging it as a parity gap.
|
||||
|
||||
#### 7. Account Full Response (/full) Structural & Value Parity (In Progress)
|
||||
Based on `_/diffs/diff7/`, several structural and value gaps remain in the `/full` account response:
|
||||
|
||||
**Remaining Findings:**
|
||||
* **Nested Source Inconsistency in Recents**: The `<source>` element within `<recent>` entries still frequently points to a generic fallback (ID `9330201`) instead of the specific source (e.g., Spotify ID `10863533`).
|
||||
* Missing/empty `<username>` at the `<preset>` level.
|
||||
* **Values**:
|
||||
* **Empty Device `<name>`**: Locally, the device `<name>` is empty in the response even when available in the datastore or upstream.
|
||||
* **Empty `<contentItemType>`**: Local responses have empty `<contentItemType>` in presets and recents, whereas upstream has `tracklisturl` or `stationurl`.
|
||||
* `preferredLanguage` mismatch (`en` vs `de`).
|
||||
|
||||
**Next Implementation Steps (Proposals):**
|
||||
1. **Fix Device `<name>` Population**: Investigate why `CreateAccountDevice` or `AccountFullToXML` is not correctly returning the device name even if it's synchronized.
|
||||
2. **Refine Source Association in Recents**: Improve the matching logic in `mapRecentsToFullResponse` to correctly link recents to their specific `ConfiguredSource` (e.g., by matching `sourceid` attribute).
|
||||
3. **Populate `contentItemType`**: Update the internal models and `SyncFromAccountFull` to correctly extract, persist, and echo back `contentItemType` (e.g., `tracklisturl`).
|
||||
4. **Handle Account Metadata**: Synchronize `preferredLanguage` from the upstream `/full` response to the local account state.
|
||||
+77
-20
@@ -1,32 +1,89 @@
|
||||
# Bose SoundTouch Toolkit Documentation
|
||||
|
||||
Welcome to the documentation for the Bose SoundTouch Toolkit. This toolkit helps you keep your Bose SoundTouch speakers functional even after the Bose Cloud shutdown in May 2026.
|
||||
Welcome to the documentation for the Bose SoundTouch Toolkit. This comprehensive toolkit helps you keep your Bose SoundTouch speakers functional even after the Bose Cloud shutdown in May 2026, with enhanced local management and monitoring capabilities.
|
||||
|
||||
## 📖 Quick Links
|
||||
## 🚀 Start Here
|
||||
|
||||
- [Cloud Shutdown Survival Guide](guides/SURVIVAL-GUIDE.md)
|
||||
- [Migration & Safety Guide](guides/MIGRATION-SAFETY.md)
|
||||
- [CLI Reference](guides/CLI-REFERENCE.md)
|
||||
- [Getting Started](guides/GETTING-STARTED.md)
|
||||
- [SoundTouch Service Guide](guides/SOUNDTOUCH-SERVICE.md)
|
||||
### For New Users
|
||||
- **[Complete Migration Guide](guides/MIGRATION-GUIDE.md)** - Step-by-step guide from Bose Cloud to local control
|
||||
- **[Getting Started](guides/GETTING-STARTED.md)** - Quick introduction to the toolkit
|
||||
|
||||
### For Existing Users
|
||||
- **[Cloud Shutdown Survival Guide](guides/SURVIVAL-GUIDE.md)** - Prepare for the May 2026 shutdown
|
||||
- **[SoundTouch Service Guide](guides/SOUNDTOUCH-SERVICE.md)** - Advanced service configuration
|
||||
|
||||
## 📋 Essential Documentation
|
||||
|
||||
The documentation is organized into three main categories:
|
||||
|
||||
### 1. **User Guides** - For everyday users migrating and managing devices
|
||||
### 2. **Technical Reference** - For developers and advanced configuration
|
||||
### 3. **Concept Documentation** - For contributors and system architects
|
||||
|
||||
## 🗂 Documentation Structure
|
||||
|
||||
### User Guides
|
||||
- [Initial Device Setup](guides/DEVICE-INITIAL-SETUP.md)
|
||||
- [HTTPS Setup](guides/HTTPS-SETUP.md)
|
||||
- [Deployment Guide](guides/DEPLOYMENT.md)
|
||||
- [Raspberry Pi Setup](guides/RASPBERRY-PI.md)
|
||||
- [Troubleshooting](guides/TROUBLESHOOTING.md)
|
||||
## 🗂 User Guides
|
||||
|
||||
### Technical Reference
|
||||
- [API Endpoints](reference/API-ENDPOINTS.md)
|
||||
- [WebSocket Events](reference/WEBSOCKET-EVENTS.md)
|
||||
- [Zone Management](reference/ZONE-MANAGEMENT.md)
|
||||
- [Preset Management](reference/PRESET-MANAGEMENT.md)
|
||||
### Migration & Setup
|
||||
- **[Complete Migration Guide](guides/MIGRATION-GUIDE.md)** - 📖 **Main guide** for migrating from Bose Cloud
|
||||
- [Cloud Shutdown Survival Guide](guides/SURVIVAL-GUIDE.md) - Prepare for service shutdown
|
||||
- [Migration & Safety Guide](guides/MIGRATION-SAFETY.md) - Advanced migration strategies
|
||||
- [Initial Device Setup](guides/DEVICE-INITIAL-SETUP.md) - First-time device configuration
|
||||
- [Raspberry Pi Setup](guides/RASPBERRY-PI.md) - Installing on Raspberry Pi
|
||||
|
||||
### Daily Management
|
||||
- [SoundTouch Service Guide](guides/SOUNDTOUCH-SERVICE.md) - Service operation and maintenance
|
||||
- [Troubleshooting](guides/TROUBLESHOOTING.md) - Common issues and solutions
|
||||
- [HTTPS Setup](guides/HTTPS-SETUP.md) - Secure connections
|
||||
- [Deployment Guide](guides/DEPLOYMENT.md) - Production deployments
|
||||
|
||||
### Advanced Features
|
||||
- [MAC Address Mapping](guides/MAC-ADDRESS-MAPPING.md) - Device identification
|
||||
- [CLI Reference](guides/CLI-REFERENCE.md) - Command-line tools
|
||||
- [IoT Implementation Guide](guides/IOT-IMPLEMENTATION-GUIDE.md) - IoT integrations
|
||||
- [MQTT Integration Design](guides/MQTT-INTEGRATION-DESIGN.md) - MQTT setup
|
||||
|
||||
## 📚 Technical Reference
|
||||
|
||||
### API Documentation
|
||||
- [API Endpoints](reference/API-ENDPOINTS.md) - REST API reference
|
||||
- [WebSocket Events](reference/WEBSOCKET-EVENTS.md) - Real-time events
|
||||
- [Zone Management](reference/ZONE-MANAGEMENT.md) - Multi-room control
|
||||
- [Preset Management](reference/PRESET-MANAGEMENT.md) - Preset operations
|
||||
|
||||
### Analysis & Research
|
||||
- [Upstream URLs](analysis/UPSTREAM-URLS.md)
|
||||
- [Device Redirect Methods](analysis/DEVICE-REDIRECT-METHODS.md)
|
||||
- [Upstream URLs](analysis/UPSTREAM-URLS.md) - Bose service endpoints
|
||||
- [Device Redirect Methods](analysis/DEVICE-REDIRECT-METHODS.md) - Migration techniques
|
||||
- [IoT Configuration Analysis](analysis/IOT-CONFIGURATION-ANALYSIS.md) - Device configurations
|
||||
- [IoT Config Summary](analysis/IOT-CONFIG-SUMMARY.md) - Configuration summaries
|
||||
|
||||
### Device Lifecycle & Network Independence
|
||||
- **[Device Lifecycle and /power_on Enhancement](device-lifecycle-and-power-on-enhancement.md)** - Complete analysis of device registration and network independence improvements
|
||||
- [/power_on Implementation Guide](power-on-implementation-guide.md) - Technical implementation details for enhanced device management
|
||||
|
||||
## 🏗 Concept Documentation
|
||||
|
||||
### Enhanced Service Architecture
|
||||
- **[Concept Overview](concepts/README.md)** - High-level architecture vision
|
||||
- [Upstream Service Simulation](concepts/upstream-service-simulation.md) - Complete concept design
|
||||
- [Implementation Plan](concepts/implementation-plan.md) - Development roadmap
|
||||
- [Technical Specification](concepts/technical-specification.md) - Detailed specifications
|
||||
|
||||
### Development Planning
|
||||
- [Implementation Roadmap](concepts/implementation-roadmap.md) - Project phases and milestones
|
||||
|
||||
## 💡 Quick Reference
|
||||
|
||||
### Common Tasks
|
||||
- **Migrate first device**: Follow [Migration Guide Step 5](guides/MIGRATION-GUIDE.md#step-5-migrate-individual-devices)
|
||||
- **Check device health**: Dashboard → Devices → [Device Name] → Health Status
|
||||
- **Backup configuration**: Dashboard → Settings → Backup → Create Backup
|
||||
- **Add new device**: Dashboard → Devices → Discover Devices → Register
|
||||
|
||||
### Getting Help
|
||||
- **Issues & Bugs**: [GitHub Issues](https://github.com/gesellix/Bose-SoundTouch/issues)
|
||||
- **Questions & Discussion**: [GitHub Discussions](https://github.com/gesellix/Bose-SoundTouch/discussions)
|
||||
- **Documentation**: Check troubleshooting guides first
|
||||
- **Community**: Share experiences and help others
|
||||
|
||||
For a complete list of all documents, see the [Summary](SUMMARY.md).
|
||||
|
||||
@@ -0,0 +1,345 @@
|
||||
# Request Recording Concept
|
||||
|
||||
## Problem Statement
|
||||
|
||||
The current request recording system has fundamental issues when dealing with request cloning, body consumption, and multiple response scenarios. Specifically:
|
||||
|
||||
1. **Body Consumption**: HTTP request bodies can only be read once, leading to missing bodies in recordings
|
||||
2. **Request Cloning**: A single original request may be cloned multiple times for different purposes (local handling, mirroring, recording)
|
||||
3. **Multiple Responses**: The same logical request may generate different responses (local vs upstream mirror)
|
||||
4. **Data Integrity**: No guarantee that recorded requests are identical across different execution paths
|
||||
|
||||
## Current Issues (Examples)
|
||||
|
||||
### Issue 1: Missing Request Bodies in Mirror Recordings
|
||||
|
||||
**Local Recording** (complete):
|
||||
```http
|
||||
### POST /v1/scmudc/A81B6A536A98
|
||||
POST /v1/scmudc/A81B6A536A98
|
||||
Host: events.api.bosecm.com
|
||||
Content-Type: text/json; charset=utf-8
|
||||
Content-Length: 587
|
||||
Authorization: Bearer jGwEmFWr...
|
||||
|
||||
{"envelope":{"monoTime":234906,"payloadProtocolVersion":"3.1","payloadType":"scmudc","protocolVersion":"1.0","time":"2026-02-25T23:03:14.976349+00:00","uniqueId":"A81B6A536A98"},"payload":{"deviceInfo":{"boseID":"3230304","deviceID":"A81B6A536A98","deviceType":"SoundTouch 10","serialNumber":"I6332527703739342000020","softwareVersion":"27.0.6.46330.5043500 epdbuild.trunk.hepdswbld04.2022-08-04T11:20:29","systemSerialNumber":"069231P63364828AE"},"events":[{"data":{"play-state":"PAUSE_STATE"},"monoTime":234904,"time":"2026-02-25T23:03:14.973466+00:00","type":"play-state-changed"}]}}
|
||||
|
||||
{% raw %}
|
||||
> {%
|
||||
// Response: 200 OK
|
||||
%}
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
**Mirror Recording** (missing body):
|
||||
```http
|
||||
### POST /v1/scmudc/A81B6A536A98
|
||||
POST /v1/scmudc/A81B6A536A98
|
||||
Host: events.api.bosecm.com
|
||||
Content-Type: text/json; charset=utf-8
|
||||
Content-Length: 587
|
||||
Authorization: Bearer jGwEmFWr...
|
||||
|
||||
|
||||
|
||||
{% raw %}
|
||||
> {%
|
||||
// Response: 200 OK
|
||||
// Headers:
|
||||
// X-Proxy-Origin: upstream-mirror
|
||||
%}
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
### Issue 2: Request Flow Complexity
|
||||
|
||||
Current middleware execution order:
|
||||
```
|
||||
1. MirrorMiddleware - Buffers body, creates clones
|
||||
2. RecordMiddleware - Also buffers body
|
||||
3. Application Handler - Processes request
|
||||
4. Mirror Execution - Async/sync mirror to upstream
|
||||
5. Recording - Multiple recording points
|
||||
```
|
||||
|
||||
Problems:
|
||||
- Multiple body reads across middleware chain
|
||||
- Inconsistent request state between clones
|
||||
- Race conditions in async scenarios
|
||||
- No guarantee of request equivalence
|
||||
|
||||
## Proposed Solution: Context-Bound Request Snapshots
|
||||
|
||||
### Core Concept
|
||||
|
||||
Create **immutable request snapshots** early in the request lifecycle and propagate them through the **Request Context**. This ensures all downstream consumers (Mirroring, Recording, Parity Check) use identical data without re-reading the request body.
|
||||
|
||||
### Architecture (Context-Only)
|
||||
|
||||
```
|
||||
┌─────────────────┐
|
||||
│ Original Request│
|
||||
└─────────┬───────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────┐ ┌──────────────────┐
|
||||
│ Snapshot Creator│───▶│ Request Context │
|
||||
│ (Middleware) │ │ (Pointer-based) │
|
||||
└─────────┬───────┘ └──────────────────┘
|
||||
│ │
|
||||
▼ │ (Safe for async)
|
||||
┌─────────────────┐ │
|
||||
│ Middleware │◀─────────────┘
|
||||
│ Chain │
|
||||
└─────────┬───────┘
|
||||
│
|
||||
┌───▼────┐ ┌─────────┐ ┌──────────────┐
|
||||
│ Local │ │ Mirror │ │ Recording │
|
||||
│Handler │ │Execution│ │ System │
|
||||
└────────┘ └─────────┘ └──────────────┘
|
||||
```
|
||||
|
||||
### Request Snapshot Structure
|
||||
|
||||
```go
|
||||
type RequestSnapshot struct {
|
||||
Method string
|
||||
URL *url.URL
|
||||
Headers http.Header
|
||||
Body []byte
|
||||
Host string
|
||||
Timestamp time.Time
|
||||
}
|
||||
|
||||
// Typed key for context safety
|
||||
type contextKey struct{ name string }
|
||||
var SnapshotKey = &contextKey{"request_snapshot"}
|
||||
```
|
||||
|
||||
### Implementation Strategy
|
||||
|
||||
#### Phase 1: Snapshot Middleware
|
||||
|
||||
```go
|
||||
func (s *Server) SnapshotMiddleware(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
// 1. Capture body once with size limit (e.g. 2MB)
|
||||
body, _ := io.ReadAll(io.LimitReader(r.Body, 2*1024*1024))
|
||||
r.Body.Close()
|
||||
|
||||
// 2. Create snapshot
|
||||
snapshot := &RequestSnapshot{
|
||||
Method: r.Method,
|
||||
URL: cloneURL(r.URL),
|
||||
Headers: r.Header.Clone(),
|
||||
Body: body,
|
||||
Host: r.Host,
|
||||
Timestamp: time.Now(),
|
||||
}
|
||||
|
||||
// 3. Inject pointer into context
|
||||
ctx := context.WithValue(r.Context(), SnapshotKey, snapshot)
|
||||
|
||||
// 4. Restore r.Body for downstream compatibility
|
||||
r = r.WithContext(ctx)
|
||||
r.Body = io.NopCloser(bytes.NewReader(snapshot.Body))
|
||||
|
||||
next.ServeHTTP(w, r)
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
#### Phase 2: Downstream Consumption
|
||||
|
||||
Consumers (Mirror/Record) retrieve the snapshot directly from context:
|
||||
|
||||
```go
|
||||
snapshot, ok := r.Context().Value(SnapshotKey).(*RequestSnapshot)
|
||||
if ok {
|
||||
// Use snapshot.Body directly instead of io.ReadAll(r.Body)
|
||||
}
|
||||
```
|
||||
|
||||
## Hardware Considerations (Raspberry Pi Zero 2W)
|
||||
|
||||
To protect MicroSD health and optimize for limited memory:
|
||||
|
||||
1. **No Intermediate Disk Storage**: Snapshots exist only in memory; they are never written to disk until the final `.http` recording is generated.
|
||||
2. **Memory Management**: Use `sync.Pool` for temporary buffers to reduce GC churn on the single-core/low-memory SoC.
|
||||
3. **Automatic Cleanup**: Snapshots are naturally garbage collected once the Request Context and all child goroutines (detached mirrors/recordings) finish.
|
||||
4. **Body Capping**: Strict limits on snapshot size prevent OOM (Out-of-Memory) conditions.
|
||||
|
||||
#### Phase 2: Response Capture System
|
||||
|
||||
```go
|
||||
type ResponseRecorder struct {
|
||||
http.ResponseWriter
|
||||
snapshot *ResponseSnapshot
|
||||
snapshotID string
|
||||
source string
|
||||
startTime time.Time
|
||||
}
|
||||
|
||||
func (r *ResponseRecorder) WriteHeader(statusCode int) {
|
||||
r.snapshot.StatusCode = statusCode
|
||||
r.snapshot.Headers = r.Header().Clone()
|
||||
r.ResponseWriter.WriteHeader(statusCode)
|
||||
}
|
||||
|
||||
func (r *ResponseRecorder) Write(data []byte) (int, error) {
|
||||
r.snapshot.Body = append(r.snapshot.Body, data...)
|
||||
return r.ResponseWriter.Write(data)
|
||||
}
|
||||
|
||||
func (r *ResponseRecorder) finalize() {
|
||||
r.snapshot.Duration = time.Since(r.startTime)
|
||||
r.snapshot.Timestamp = time.Now()
|
||||
}
|
||||
```
|
||||
|
||||
#### Phase 3: Recording System Integration
|
||||
|
||||
```go
|
||||
type RecordingManager struct {
|
||||
storage SnapshotStorage
|
||||
recorder *Recorder
|
||||
patterns []string
|
||||
}
|
||||
|
||||
func (rm *RecordingManager) RecordInteraction(snapshotID string, response *ResponseSnapshot) {
|
||||
// Retrieve immutable request snapshot
|
||||
request, exists := rm.storage.Get(snapshotID)
|
||||
if !exists {
|
||||
log.Printf("Request snapshot not found: %s", snapshotID)
|
||||
return
|
||||
}
|
||||
|
||||
// Record with guaranteed data integrity
|
||||
rm.recorder.RecordInteraction(request, response)
|
||||
}
|
||||
|
||||
func (r *Recorder) RecordInteraction(req *RequestSnapshot, res *ResponseSnapshot) error {
|
||||
// Generate .http file with complete data
|
||||
var buf bytes.Buffer
|
||||
|
||||
// Write request
|
||||
fmt.Fprintf(&buf, "### %s %s\n", req.Method, req.URL.String())
|
||||
fmt.Fprintf(&buf, "%s %s\n", req.Method, req.URL.String())
|
||||
fmt.Fprintf(&buf, "Host: %s\n", req.Host)
|
||||
|
||||
for k, vv := range req.Headers {
|
||||
for _, v := range vv {
|
||||
fmt.Fprintf(&buf, "%s: %s\n", k, v)
|
||||
}
|
||||
}
|
||||
|
||||
buf.WriteString("\n")
|
||||
buf.Write(req.Body)
|
||||
buf.WriteString("\n\n")
|
||||
|
||||
// Write response
|
||||
{% raw %}
|
||||
buf.WriteString("> {% \n")
|
||||
{% endraw %}
|
||||
fmt.Fprintf(&buf, " // Response: %d %s\n", res.StatusCode, http.StatusText(res.StatusCode))
|
||||
buf.WriteString(" // Headers:\n")
|
||||
|
||||
for k, vv := range res.Headers {
|
||||
for _, v := range vv {
|
||||
fmt.Fprintf(&buf, " // %s: %s\n", k, v)
|
||||
}
|
||||
}
|
||||
|
||||
{% raw %}
|
||||
buf.WriteString("%}\n\n")
|
||||
{% endraw %}
|
||||
|
||||
if len(res.Body) > 0 {
|
||||
buf.WriteString("/*\n")
|
||||
buf.Write(res.Body)
|
||||
buf.WriteString("\n*/\n")
|
||||
} else {
|
||||
buf.WriteString("// [Binary response body: 0 bytes]\n")
|
||||
}
|
||||
|
||||
// Write to file
|
||||
return r.writeToFile(buf.Bytes(), req, res)
|
||||
}
|
||||
```
|
||||
|
||||
## Migration Strategy
|
||||
|
||||
### Phase 1: Introduce Snapshot System
|
||||
- Add SnapshotMiddleware as first middleware
|
||||
- Maintain existing recording system for compatibility
|
||||
- Gradual migration of recording points
|
||||
|
||||
### Phase 2: Update Mirror System
|
||||
- Modify MirrorMiddleware to use snapshots
|
||||
- Ensure mirror requests use snapshot data
|
||||
- Test parity between old and new systems
|
||||
|
||||
### Phase 3: Consolidate Recording
|
||||
- Replace existing recording middleware
|
||||
- Unified recording system using context-bound snapshots
|
||||
- Remove duplicate body reading code
|
||||
|
||||
### Phase 4: Cleanup
|
||||
- Remove legacy recording code
|
||||
- Optimize memory usage with sync.Pool
|
||||
- Performance validation on target hardware (Pi Zero)
|
||||
|
||||
## Benefits
|
||||
|
||||
1. **Zero Extra Disk IO**: Protecs MicroSD by avoiding snapshot disk persistence
|
||||
2. **Memory Efficiency**: Natural lifecycle tied to Request Context
|
||||
3. **Data Integrity**: Request data is captured once and remains immutable
|
||||
4. **Consistency**: All consumers use identical request data
|
||||
5. **Traceability**: Clear lineage from original request to all recordings
|
||||
6. **Performance**: Reduces duplicate body reads and re-cloning
|
||||
|
||||
## Implementation Considerations
|
||||
|
||||
### Memory Management
|
||||
- Use `sync.Pool` for byte buffers
|
||||
- Strict size limits on captured bodies
|
||||
- Rely on GC for snapshot cleanup
|
||||
|
||||
### Performance Impact
|
||||
- Single body read vs multiple reads (net positive)
|
||||
- Memory overhead for snapshot storage (manageable)
|
||||
- Context propagation overhead (minimal)
|
||||
|
||||
### Backward Compatibility
|
||||
- Maintain existing .http file format
|
||||
- Preserve existing API contracts
|
||||
- Gradual migration path
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
### Unit Tests
|
||||
- Snapshot creation and immutability
|
||||
- Response recording accuracy
|
||||
- Memory cleanup verification
|
||||
|
||||
### Integration Tests
|
||||
- End-to-end request/response recording
|
||||
- Mirror functionality with snapshots
|
||||
- Parity validation between old/new systems
|
||||
|
||||
### Performance Tests
|
||||
- Memory usage comparison
|
||||
- Throughput impact analysis
|
||||
- Large request body handling
|
||||
|
||||
## Future Enhancements
|
||||
|
||||
1. **Compression**: Compress stored snapshots for memory efficiency
|
||||
2. **Streaming**: Support for streaming request/response bodies
|
||||
3. **Filtering**: Selective snapshot creation based on patterns
|
||||
4. **Analytics**: Request/response analysis and metrics
|
||||
5. **Export**: Snapshot export for debugging and analysis
|
||||
|
||||
## Conclusion
|
||||
|
||||
This snapshot-based approach provides a robust foundation for reliable request recording while solving the current issues with body consumption and data inconsistency. The phased implementation ensures minimal disruption while delivering immediate benefits.
|
||||
@@ -0,0 +1,192 @@
|
||||
# SCMUDC Enrichment Implementation Summary
|
||||
|
||||
## Overview
|
||||
|
||||
This document summarizes the implementation of SCMUDC (Sound Control Management Usage Data Collection) event enrichment in the AfterTouch toolkit. The enhancement provides human-readable analysis of device telemetry data to improve usability and debugging capabilities.
|
||||
|
||||
## Problem Solved
|
||||
|
||||
Previously, SCMUDC telemetry events were stored as raw JSON with Base64-encoded XML content, making them difficult to analyze. Users had to manually decode content to understand what device interactions were being recorded.
|
||||
|
||||
## Solution Implemented
|
||||
|
||||
### 1. Backend Enrichment (`pkg/service/proxy/`)
|
||||
|
||||
#### New File: `scmudc.go`
|
||||
- **SCMUDCRequest/SCMUDCEvent Structs**: Parse incoming telemetry JSON
|
||||
- **EnrichedSCMUDCEvent Struct**: Human-readable analysis with decoded content
|
||||
- **DecodedContent Struct**: Parsed XML metadata (track names, artwork URLs, etc.)
|
||||
- **enrichSCMUDCRequest()**: Main enrichment function that:
|
||||
- Identifies event origin (app, hardware, or internal system)
|
||||
- Decodes Base64 XML content for device events
|
||||
- Creates human-readable summaries
|
||||
- **Helper Functions**: Button formatting, content summarization, origin descriptions
|
||||
|
||||
#### Enhanced File: `recorder.go`
|
||||
- **Updated save() method**: Extracts SCMUDC data during recording
|
||||
- **New writeRequestWithEnrichment()**: Adds enriched comments to .http files
|
||||
- **New writeResponseWithEnrichment()**: Includes SCMUDC analysis in response section
|
||||
- **Updated Interaction struct**: Added `SCMUDCData` field for API responses
|
||||
- **New extractSCMUDCFromFile()**: Parses enrichment data from existing .http files
|
||||
- **Enhanced parseInteractionFile()**: Populates SCMUDC data when listing interactions
|
||||
|
||||
### 2. Frontend Enhancement
|
||||
|
||||
#### Updated HTML (`pkg/service/handlers/web/index.html`)
|
||||
- **New Column**: Added "Event Details" to interactions table
|
||||
- **Table Structure**: Updated to accommodate SCMUDC enrichment display
|
||||
|
||||
#### Enhanced JavaScript (`pkg/service/handlers/web/js/script.js`)
|
||||
- **Updated fetchInteractions()**: Displays enriched SCMUDC data with icons
|
||||
- **New Helper Functions**:
|
||||
- `getOriginIcon()`: Maps origins to emojis (📱 App, 🎛️ Hardware, 🔄 Internal)
|
||||
- `getActionIcon()`: Maps actions to emojis (▶️ Play, ⏸️ Pause, etc.)
|
||||
- `showSCMUDCDetails()`: Detailed popover for complex events
|
||||
- `displaySCMUDCPopover()`: Modal dialog with full decoded content
|
||||
- **Truncation Logic**: Long content shows "(...)" with click-to-expand
|
||||
|
||||
## Event Origin Clarification
|
||||
|
||||
Based on analysis of recorded data:
|
||||
|
||||
| Origin | Source | Description | Example Events |
|
||||
|--------|--------|-------------|----------------|
|
||||
| `gabbo` | **SoundTouch App** | Mobile/desktop app UI interactions | Play, Pause, Power via app |
|
||||
| `console` | **Device Hardware** | Physical buttons on speaker | Preset buttons, hardware power |
|
||||
| `device` | **Internal System** | Automatic device responses | Content playback, system actions |
|
||||
|
||||
## Enhanced .http File Format
|
||||
|
||||
### Before (Raw)
|
||||
```http
|
||||
### POST /v1/scmudc/A81B6A536A98
|
||||
POST /v1/scmudc/A81B6A536A98
|
||||
Host: events.api.bosecm.com
|
||||
...
|
||||
|
||||
{"envelope":...,"payload":{"events":[{"data":{"contentItem":"PD94bWw..."}}]}}
|
||||
```
|
||||
|
||||
### After (Enriched)
|
||||
```http
|
||||
### POST /v1/scmudc/A81B6A536A98
|
||||
// Origin: Internal System (device)
|
||||
// Action: play-item
|
||||
// Command: Billie Eilish - bad guy (instrumental version)
|
||||
// Summary: Device: Spotify: Billie Eilish - bad guy (instrumental version)
|
||||
//
|
||||
// Decoded Content:
|
||||
// - Source: SPOTIFY
|
||||
// - Item: Billie Eilish - bad guy (instrumental version)
|
||||
// - Account: gesellix
|
||||
// - Artwork: https://i.scdn.co/image/ab67616d0000b273...
|
||||
//
|
||||
// Full XML Content:
|
||||
// <?xml version="1.0" encoding="UTF-8"?>
|
||||
// <ContentItem source="SPOTIFY" type="tracklisturl" ...>
|
||||
// <itemName>Billie Eilish - bad guy (instrumental version)</itemName>
|
||||
// <containerArt>https://i.scdn.co/image/ab67616d0000b273...</containerArt>
|
||||
// </ContentItem>
|
||||
POST /v1/scmudc/A81B6A536A98
|
||||
...
|
||||
|
||||
{% raw %}
|
||||
> {%
|
||||
// Response: 200 OK
|
||||
// SCMUDC Event Analysis:
|
||||
// - Origin: Internal System (device)
|
||||
// - Action: play-item
|
||||
// - Summary: Device: Spotify: Billie Eilish - bad guy (instrumental version)
|
||||
// - Content: Billie Eilish - bad guy (instrumental version)
|
||||
// - Account: gesellix
|
||||
%}
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
## Web UI Enhancement
|
||||
|
||||
### Interactions Table
|
||||
- **New Column**: "Event Details" shows enriched summaries
|
||||
- **Visual Icons**: Origin and action type indicators
|
||||
- **Truncation**: Long content abbreviated with "(...)" expansion
|
||||
- **Backward Compatibility**: Works with existing recordings
|
||||
|
||||
### Event Details Display
|
||||
```
|
||||
📱 ▶️ Play Button (Simple app action)
|
||||
🔄 🎵 Billie Eilish - bad guy... (...) (Complex device event with details)
|
||||
🎛️ ⭐ Preset 5 (Hardware preset button)
|
||||
```
|
||||
|
||||
### Detailed Popover
|
||||
For complex events, clicking "(...)" shows:
|
||||
- **Origin Description**: "SoundTouch App" instead of "gabbo"
|
||||
- **Full Content Information**: Track names, artwork URLs, account details
|
||||
- **Complete XML**: Formatted and readable content item data
|
||||
|
||||
## Implementation Benefits
|
||||
|
||||
### For Users
|
||||
- **Immediate Recognition**: See what actions were performed without decoding
|
||||
- **Better Debugging**: Quick identification of app vs. hardware vs. system events
|
||||
- **Rich Context**: Track names, accounts, and content sources visible at a glance
|
||||
|
||||
### For Developers
|
||||
- **Structured Data**: Consistent parsing and enrichment pipeline
|
||||
- **Extensible**: Easy to add new event types and origins
|
||||
- **Backward Compatible**: Existing recordings work without re-processing
|
||||
|
||||
### For Analysis
|
||||
- **Pattern Recognition**: Quickly identify user behavior patterns
|
||||
- **Service Integration**: See which music services are being used
|
||||
- **Device Usage**: Understand app vs. hardware control preferences
|
||||
|
||||
## File Structure
|
||||
|
||||
```
|
||||
pkg/service/proxy/
|
||||
├── scmudc.go # New: SCMUDC enrichment logic
|
||||
├── recorder.go # Enhanced: Enrichment integration
|
||||
│
|
||||
pkg/service/handlers/web/
|
||||
├── index.html # Enhanced: New table column
|
||||
├── js/script.js # Enhanced: SCMUDC display logic
|
||||
│
|
||||
docs/
|
||||
├── scmudc-events-analysis.md # New: Analysis documentation
|
||||
├── SCMUDC-ENRICHMENT-IMPLEMENTATION.md # This file
|
||||
```
|
||||
|
||||
## Technical Decisions
|
||||
|
||||
### Base64 Decoding Strategy
|
||||
- **When**: During recording (not on-demand) for performance
|
||||
- **Fallback**: Parse from .http files if enrichment missing
|
||||
- **Storage**: Both enriched comments and structured data in API responses
|
||||
|
||||
### Icon Selection
|
||||
- **Emoji Usage**: Universal, colorful, intuitive recognition
|
||||
- **Semantic Mapping**: Icons match function (📱 for app, 🎛️ for hardware)
|
||||
- **Fallback**: Generic icons (❓, 🔘) for unknown types
|
||||
|
||||
### Backward Compatibility
|
||||
- **Graceful Degradation**: Missing enrichment data doesn't break UI
|
||||
- **File Parsing**: Extract enrichment from existing .http files
|
||||
- **API Enhancement**: New fields optional in Interaction struct
|
||||
|
||||
## Future Enhancement Opportunities
|
||||
|
||||
1. **Event Correlation**: Link device events to user actions
|
||||
2. **Statistics Dashboard**: Origin-based usage analytics
|
||||
3. **Content Recommendations**: Track listening patterns
|
||||
4. **Device Health**: Monitor interaction frequency and patterns
|
||||
5. **Export Features**: CSV/JSON export of enriched event data
|
||||
|
||||
## Testing Considerations
|
||||
|
||||
- **Edge Cases**: Malformed Base64, missing XML elements
|
||||
- **Performance**: Large numbers of SCMUDC events
|
||||
- **Browser Compatibility**: Emoji display across different browsers
|
||||
- **Data Validation**: Ensure enrichment doesn't introduce errors
|
||||
|
||||
This implementation significantly improves the usability of SCMUDC telemetry data while maintaining full backward compatibility and raw data access for advanced users.
|
||||
@@ -9,10 +9,14 @@
|
||||
* [Getting Started](guides/GETTING-STARTED.md)
|
||||
* [SoundTouch Service](guides/SOUNDTOUCH-SERVICE.md)
|
||||
* [Initial Device Setup](guides/DEVICE-INITIAL-SETUP.md)
|
||||
* [MAC Address Mapping](guides/MAC-ADDRESS-MAPPING.md)
|
||||
* [HTTPS Setup](guides/HTTPS-SETUP.md)
|
||||
* [Deployment](guides/DEPLOYMENT.md)
|
||||
* [Raspberry Pi Guide](guides/RASPBERRY-PI.md)
|
||||
* [Troubleshooting](guides/TROUBLESHOOTING.md)
|
||||
* [IoT Implementation Guide](guides/IOT-IMPLEMENTATION-GUIDE.md)
|
||||
* [Migration Guide](guides/MIGRATION-GUIDE.md)
|
||||
* [MQTT Integration Design](guides/MQTT-INTEGRATION-DESIGN.md)
|
||||
* [Useful Links](#useful-links)
|
||||
|
||||
### Useful Links
|
||||
@@ -38,6 +42,11 @@
|
||||
* [Key Controls](reference/KEY-CONTROLS.md)
|
||||
* [Feature Mapping](reference/FEATURE-MAPPING.md)
|
||||
|
||||
## Concepts
|
||||
* [Request Recording](REQUEST_RECORDING_CONCEPT.md)
|
||||
* [Spotify Priming Strategy](concepts/spotify-priming-strategy.md)
|
||||
* [Spotify OAuth](concepts/spotify-oauth.md)
|
||||
|
||||
## Analysis & Research
|
||||
* [API Coverage Analysis](analysis/API-COVERAGE.md)
|
||||
* [Supported URLs](analysis/SUPPORTED-URLS.md)
|
||||
@@ -45,6 +54,8 @@
|
||||
* [Anonymization Summary](analysis/ANONYMIZATION-SUMMARY.md)
|
||||
* [Device Redirect Methods](analysis/DEVICE-REDIRECT-METHODS.md)
|
||||
* [Wiki API Comparison](analysis/WIKI-COMPARISON.md)
|
||||
* [IoT Config Summary](analysis/IOT-CONFIG-SUMMARY.md)
|
||||
* [IoT Configuration Analysis](analysis/IOT-CONFIGURATION-ANALYSIS.md)
|
||||
|
||||
## Appendix (Other Documents)
|
||||
* [API Navigation Reference](API-NAVIGATION-REFERENCE.md)
|
||||
@@ -64,3 +75,9 @@
|
||||
* [Undocumented Community Features](UNDOCUMENTED-COMMUNITY-FEATURES.md)
|
||||
* [Unimplemented Endpoints](UNIMPLEMENTED-ENDPOINTS.md)
|
||||
* [Preset Store](preset-store.md)
|
||||
* [SCMUDC Enrichment Implementation](SCMUDC-ENRICHMENT-IMPLEMENTATION.md)
|
||||
* [Device Lifecycle and Power On Enhancement](device-lifecycle-and-power-on-enhancement.md)
|
||||
* [Device Lifecycle Summary](device-lifecycle-summary.md)
|
||||
* [Power On Implementation Guide](power-on-implementation-guide.md)
|
||||
* [SCMUDC Events Analysis](scmudc-events-analysis.md)
|
||||
* [Parity Improvements](PARITY-IMPROVEMENTS.md)
|
||||
|
||||
@@ -370,7 +370,7 @@ soundtouch-cli speaker beep
|
||||
**Go Client Usage:**
|
||||
```go
|
||||
// Text-to-Speech
|
||||
client.PlayTTS("Hello World", "your-app-key", 70)
|
||||
client.PlayTTS("Hello World", "your-app-key", "EN", 70)
|
||||
|
||||
// URL content
|
||||
client.PlayURL("https://example.com/audio.mp3", "your-app-key", "Service", "Message", "Reason", 60)
|
||||
@@ -1044,4 +1044,4 @@ The SoundTouch Plus Wiki provides comprehensive documentation for **64 additiona
|
||||
|
||||
This documentation provides the complete foundation for implementing all endpoints from the SoundTouch Plus Wiki, enabling this Go library to become the definitive SoundTouch integration solution for everything from basic home automation to professional audio installations.
|
||||
|
||||
*All examples and XML structures are verified against real SoundTouch hardware and extensively tested by the SoundTouch Plus community.*
|
||||
*All examples and XML structures are verified against real SoundTouch hardware and extensively tested by the SoundTouch Plus community.*
|
||||
|
||||
@@ -0,0 +1,189 @@
|
||||
# IoT Configuration Quick Reference
|
||||
|
||||
## Key Files and Locations
|
||||
|
||||
| File/Location | Purpose | Notes |
|
||||
|-----------------------------------------|------------------------|-----------------------------------------|
|
||||
| `/mnt/nv/BoseApp-Persistence/1/IoT.xml` | Main IoT configuration | Contains clientID, endpoint, deployment |
|
||||
| `/opt/Bose/IoT` | IoT service binary | ARM executable, AWS IoT SDK |
|
||||
| `/mnt/nv/IoTCerts/` | Certificate storage | Device certs and private keys |
|
||||
| `/etc/init.d/SoundTouch` | System startup script | Creates directory structure |
|
||||
| `/opt/Bose/etc/Shepherd-noncore.xml` | Service configuration | Defines IoT daemon startup |
|
||||
|
||||
## Configuration Parameters
|
||||
|
||||
### IoT.xml Structure
|
||||
```xml
|
||||
<Configuration
|
||||
clientID="[UUID]"
|
||||
iotEndpoint="[AWS_IOT_ENDPOINT]"
|
||||
deployment="PROD" />
|
||||
```
|
||||
|
||||
### Device-Specific Values
|
||||
- **ST20**: `clientID="577ecfcc-2db3-4989-92c9-76d7704f9fb3"`
|
||||
- **ST10**: `clientID="eb1a6d8f-0bb1-4aa7-9113-ea673fcef96e"`
|
||||
- **Endpoint**: `a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com` (XML)
|
||||
- **Backup Endpoint**: `amqmidtcohfms.iot.us-east-1.amazonaws.com` (hardcoded)
|
||||
|
||||
## Protocol Stack
|
||||
|
||||
```
|
||||
Application Layer: AWS IoT Device Shadows (JSON)
|
||||
Presentation Layer: RapidJSON parsing/serialization
|
||||
Session Layer: MQTT v3.1.1
|
||||
Transport Layer: TLS v1.2
|
||||
Network Layer: TCP/IP
|
||||
```
|
||||
|
||||
## Certificate Files
|
||||
|
||||
| File | Location | Purpose |
|
||||
|-----------------------|---------------------|---------------------------|
|
||||
| `iot-cert.pem.crt` | `/mnt/nv/IoTCerts/` | Device client certificate |
|
||||
| `iot-private.pem.key` | `/mnt/nv/IoTCerts/` | Device private key |
|
||||
| `rootCA.crt` | `/var/lib/iot/` | AWS IoT Root CA |
|
||||
|
||||
## MQTT Topics
|
||||
|
||||
### Shadow Operations
|
||||
```
|
||||
$aws/things/{clientID}/shadow/update
|
||||
$aws/things/{clientID}/shadow/update/accepted
|
||||
$aws/things/{clientID}/shadow/update/rejected
|
||||
$aws/things/{clientID}/shadow/delete
|
||||
```
|
||||
|
||||
### JSON Payload Examples
|
||||
|
||||
#### Device State Report
|
||||
```json
|
||||
{
|
||||
"state": {
|
||||
"reported": {
|
||||
"deviceState": "CONNECTED",
|
||||
"powerState": "ON",
|
||||
"zoneState": "...",
|
||||
"groupState": "..."
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Disconnection Message
|
||||
```json
|
||||
{
|
||||
"state": {
|
||||
"reported": {
|
||||
"deviceState": "DISCONNECTED"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Process Information
|
||||
|
||||
- **IoT Service PID**: 1837
|
||||
- **BoseApp PID**: 1846
|
||||
- **Daemon Manager**: Shepherd
|
||||
- **Service Type**: Non-core (stopped during updates)
|
||||
|
||||
## Registration Flow
|
||||
|
||||
1. Device generates X.509 CSR
|
||||
2. Calls `https://voice.api.bose.io/alexa/certificate`
|
||||
3. Receives device certificate
|
||||
4. Stores cert/key in `/mnt/nv/IoTCerts/`
|
||||
5. Connects to AWS IoT using certificate auth
|
||||
|
||||
## Directory Creation (Init Script)
|
||||
|
||||
```bash
|
||||
mkdir -p /mnt/nv/BoseLog /mnt/nv/IoTCerts /mnt/nv/BoseApp-Persistence/1
|
||||
mkdir -m 700 -p /mnt/nv/BoseApp-Persistence/1/Keys
|
||||
```
|
||||
|
||||
## Error Messages and Debugging
|
||||
|
||||
### Common Log Messages
|
||||
- `"Connection attempt %u to MQTT port at host %s"`
|
||||
- `"MQTT port not available. Retrying in %u seconds"`
|
||||
- `"Device connected with MQTT"`
|
||||
- `"got shadow response: accepted. Payload: %s"`
|
||||
- `"Failed to register device and get certificate, retrying"`
|
||||
|
||||
### Connection States
|
||||
- `"MQTT port is open"`
|
||||
- `"Successfully connected to MQTT server"`
|
||||
- `"Disconnecting from IoT server"`
|
||||
- `"UpdateShadow called when network is not ready"`
|
||||
|
||||
## Integration Points
|
||||
|
||||
### AWS Services
|
||||
- AWS IoT Core (MQTT broker)
|
||||
- AWS IoT Device Management (certificates)
|
||||
- AWS IoT Device Shadows (state sync)
|
||||
|
||||
### Bose Ecosystem
|
||||
- Mobile apps (remote control)
|
||||
- Alexa integration (voice commands)
|
||||
- Multi-room audio (zone coordination)
|
||||
- OTA updates (firmware management)
|
||||
|
||||
## Quick Troubleshooting
|
||||
|
||||
1. **No IoT connectivity**: Check certificate files in `/mnt/nv/IoTCerts/`
|
||||
2. **Certificate errors**: Verify registration endpoint accessibility
|
||||
3. **MQTT failures**: Check both primary and backup endpoints
|
||||
4. **Config issues**: Validate IoT.xml format and clientID uniqueness
|
||||
5. **Service not starting**: Check Shepherd configuration and process status
|
||||
|
||||
## MQTT Monitoring Capabilities
|
||||
|
||||
### Direct Access with Device Credentials
|
||||
```bash
|
||||
# Subscribe to device shadow events (own device only)
|
||||
mosquitto_sub -h a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com \
|
||||
-p 8883 --cafile /var/lib/iot/rootCA.crt \
|
||||
--cert /mnt/nv/IoTCerts/iot-cert.pem.crt \
|
||||
--key /mnt/nv/IoTCerts/iot-private.pem.key \
|
||||
-t '$aws/things/577ecfcc-2db3-4989-92c9-76d7704f9fb3/shadow/#'
|
||||
```
|
||||
|
||||
### AWS IoT Policy Restrictions
|
||||
- Device certificates limited to own clientID topics only
|
||||
- No wildcard subscriptions across devices
|
||||
- IP/location restrictions may apply
|
||||
- Certificate revocation for unusual activity
|
||||
|
||||
### Alternative Monitoring Methods
|
||||
```bash
|
||||
# Network traffic capture (less intrusive)
|
||||
tcpdump -i eth0 -s0 -w soundtouch_iot.pcap host a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com
|
||||
|
||||
# Monitor connection patterns
|
||||
tcpdump -i eth0 -n "host a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com and port 8883"
|
||||
```
|
||||
|
||||
### Expected Message Examples
|
||||
```json
|
||||
// Power state change
|
||||
{"state":{"reported":{"powerState":"ON","deviceState":"CONNECTED"}}}
|
||||
|
||||
// Volume adjustment
|
||||
{"state":{"reported":{"volume":25,"muted":false}}}
|
||||
|
||||
// Zone configuration
|
||||
{"state":{"reported":{"zoneState":"master","groupMembers":["device1"]}}}
|
||||
```
|
||||
|
||||
## Security Notes
|
||||
|
||||
- TLS 1.2 encryption for all communications
|
||||
- X.509 mutual authentication
|
||||
- Private keys stored with 700 permissions
|
||||
- No hardcoded credentials in binaries
|
||||
- Automatic certificate lifecycle management
|
||||
- **Monitoring Constraints**: Device credentials restricted to own device topics
|
||||
- **Ethical Consideration**: Only monitor devices you own
|
||||
@@ -0,0 +1,370 @@
|
||||
# IoT Configuration Analysis
|
||||
|
||||
## Overview
|
||||
|
||||
This document provides a detailed analysis of the AWS IoT configuration system used by Bose SoundTouch devices, based on firmware backup analysis from ST10 and ST20 models.
|
||||
|
||||
## Configuration Files
|
||||
|
||||
### IoT.xml Location and Content
|
||||
|
||||
The IoT configuration is stored in XML format at:
|
||||
- **Path**: `/mnt/nv/BoseApp-Persistence/1/IoT.xml`
|
||||
- **Purpose**: Contains AWS IoT Core connection parameters
|
||||
|
||||
#### ST20 Configuration
|
||||
```xml
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<Configuration clientID="uuid1"
|
||||
iotEndpoint="a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com"
|
||||
deployment="PROD" />
|
||||
```
|
||||
|
||||
#### ST10 Configuration
|
||||
```xml
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<Configuration clientID="uuid2"
|
||||
iotEndpoint="a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com"
|
||||
deployment="PROD" />
|
||||
```
|
||||
|
||||
### Key Observations
|
||||
- Each device has a unique `clientID` (UUID format)
|
||||
- Both devices use the same AWS IoT endpoint
|
||||
- Both are configured for production deployment (`PROD`)
|
||||
|
||||
## Binary Analysis
|
||||
|
||||
### Primary IoT Service Binary
|
||||
|
||||
**Location**: `/opt/Bose/IoT`
|
||||
- **Type**: ARM ELF 32-bit executable
|
||||
- **Purpose**: Main IoT daemon process
|
||||
- **Framework**: AWS IoT SDK for C++
|
||||
|
||||
### Certificate and Key Management
|
||||
|
||||
The IoT binary manages the following certificate files:
|
||||
|
||||
| File | Location | Purpose |
|
||||
|-----------------------|---------------------|-----------------------------|
|
||||
| `iot-cert.pem.crt` | `/mnt/nv/IoTCerts/` | Device client certificate |
|
||||
| `iot-private.pem.key` | `/mnt/nv/IoTCerts/` | Device private key |
|
||||
| `rootCA.crt` | `/var/lib/iot/` | AWS IoT Root CA certificate |
|
||||
|
||||
### Certificate Registration Process
|
||||
|
||||
1. **CSR Generation**: Device generates X.509 certificate signing request
|
||||
2. **Registration Endpoint**: `https://voice.api.bose.io/alexa/certificate`
|
||||
3. **Certificate Storage**: Certificates stored in `/mnt/nv/IoTCerts/`
|
||||
4. **Automatic Provisioning**: Process appears to be automated during device setup
|
||||
|
||||
## Protocol Analysis
|
||||
|
||||
### Connection Details
|
||||
|
||||
- **Protocol**: MQTT over TLS 1.2
|
||||
- **Port**: Standard MQTT over SSL (likely 8883)
|
||||
- **Authentication**: X.509 client certificate mutual authentication
|
||||
- **Endpoint Redundancy**:
|
||||
- Primary (hardcoded): `amqmidtcohfms.iot.us-east-1.amazonaws.com`
|
||||
- Fallback (XML config): `a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com`
|
||||
|
||||
### AWS IoT Device Shadow Integration
|
||||
|
||||
The system uses AWS IoT Device Shadows for state management:
|
||||
|
||||
#### Topic Structure
|
||||
```
|
||||
$aws/things/{thing_name}/shadow/update
|
||||
$aws/things/{thing_name}/shadow/update/accepted
|
||||
$aws/things/{thing_name}/shadow/update/rejected
|
||||
$aws/things/{thing_name}/shadow/delete
|
||||
```
|
||||
|
||||
#### Shadow JSON Format
|
||||
```json
|
||||
{
|
||||
"state": {
|
||||
"desired": {},
|
||||
"reported": {
|
||||
"deviceState": "CONNECTED|DISCONNECTED",
|
||||
"powerState": "ON|OFF",
|
||||
"zoneState": "...",
|
||||
"groupState": "..."
|
||||
}
|
||||
},
|
||||
"version": 0,
|
||||
"clientToken": "...",
|
||||
"timestamp": 0
|
||||
}
|
||||
```
|
||||
|
||||
### Message Types
|
||||
|
||||
1. **Device State Updates**
|
||||
- Connection status (`CONNECTED`/`DISCONNECTED`)
|
||||
- Power state changes
|
||||
- Audio zone configuration
|
||||
- Multi-room grouping status
|
||||
|
||||
2. **Shadow Delta Processing**
|
||||
- Receives desired state changes
|
||||
- Updates device configuration
|
||||
- Reports new state back to shadow
|
||||
|
||||
## System Integration
|
||||
|
||||
### Service Management
|
||||
|
||||
The IoT service is managed by the Shepherd daemon system:
|
||||
|
||||
**Configuration**: `/opt/Bose/etc/Shepherd-noncore.xml`
|
||||
```xml
|
||||
<ShepherdConfig>
|
||||
<daemon name="STSCertified"/>
|
||||
<daemon name="IoT"/>
|
||||
<daemon name="TPDA">
|
||||
<arg>-c</arg>
|
||||
<arg>/opt/Bose/etc/Voice.xml</arg>
|
||||
</daemon>
|
||||
</ShepherdConfig>
|
||||
```
|
||||
|
||||
### Directory Structure Creation
|
||||
|
||||
The SoundTouch init script (`/etc/init.d/SoundTouch`) ensures proper directory structure:
|
||||
|
||||
```bash
|
||||
mkdir -p /mnt/nv/BoseLog /mnt/nv/IoTCerts /mnt/nv/BoseApp-Persistence/1
|
||||
mkdir -m 700 -p /mnt/nv/BoseApp-Persistence/1/Keys
|
||||
```
|
||||
|
||||
### Process Information
|
||||
|
||||
From runtime analysis (`/var/run/shepherd/pids`):
|
||||
- IoT service runs as PID 1837
|
||||
- BoseApp service runs as PID 1846
|
||||
- Both services are active during normal operation
|
||||
|
||||
## Configuration Dependencies
|
||||
|
||||
### Files That Reference IoT Configuration
|
||||
|
||||
1. **IoT Binary** (`/opt/Bose/IoT`)
|
||||
- Primary consumer of IoT.xml configuration
|
||||
- Contains hardcoded backup endpoints
|
||||
- Manages certificate lifecycle
|
||||
|
||||
2. **BoseApp Binary** (`/opt/Bose/BoseApp`)
|
||||
- References BoseApp-Persistence directory structure
|
||||
- May trigger IoT updates based on device state changes
|
||||
|
||||
3. **SoundTouch Init Script** (`/etc/init.d/SoundTouch`)
|
||||
- Creates necessary directory structure
|
||||
- Ensures proper permissions for certificate storage
|
||||
|
||||
4. **Shepherd Configuration** (`/opt/Bose/etc/Shepherd-noncore.xml`)
|
||||
- Defines IoT service startup parameters
|
||||
- Manages service lifecycle
|
||||
|
||||
## Security Considerations
|
||||
|
||||
### Certificate Management
|
||||
- Private keys stored with 700 permissions
|
||||
- Certificates managed automatically by the device
|
||||
- Registration process appears to use device-specific authentication
|
||||
|
||||
### Network Security
|
||||
- All communication over TLS 1.2
|
||||
- Mutual authentication using X.509 certificates
|
||||
- AWS IoT Core provides additional access controls
|
||||
|
||||
### Configuration Protection
|
||||
- Configuration files stored in persistent storage
|
||||
- Directory structure created with appropriate permissions
|
||||
- No hardcoded credentials in binaries (uses certificate-based auth)
|
||||
|
||||
## Integration Points
|
||||
|
||||
### AWS Services
|
||||
- **AWS IoT Core**: Primary messaging and device management
|
||||
- **AWS IoT Device Management**: Certificate provisioning
|
||||
- **AWS IoT Device Shadows**: State synchronization
|
||||
|
||||
### Bose Services
|
||||
- **Mobile Applications**: Remote control and monitoring
|
||||
- **Alexa Integration**: Voice control capabilities
|
||||
- **Multi-room Audio**: Zone and group coordination
|
||||
|
||||
### Device Functions
|
||||
- **Power Management**: Remote power on/off
|
||||
- **Audio Control**: Volume, source selection
|
||||
- **Network Configuration**: WiFi and connectivity settings
|
||||
- **Firmware Updates**: OTA update coordination
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
1. **Certificate Problems**
|
||||
- Check `/mnt/nv/IoTCerts/` for valid certificates
|
||||
- Verify certificate registration endpoint accessibility
|
||||
- Ensure proper file permissions (600 for keys)
|
||||
|
||||
2. **Connection Issues**
|
||||
- Verify both primary and fallback endpoints
|
||||
- Check TLS 1.2 support and cipher suites
|
||||
- Validate clientID uniqueness
|
||||
|
||||
3. **Configuration Issues**
|
||||
- Ensure IoT.xml has proper XML format
|
||||
- Verify clientID is valid UUID format
|
||||
- Check deployment parameter matches environment
|
||||
|
||||
### Debug Information
|
||||
|
||||
The IoT binary provides extensive logging for:
|
||||
- MQTT connection attempts and status
|
||||
- Certificate loading and validation
|
||||
- Shadow message processing
|
||||
- Network state changes
|
||||
|
||||
## MQTT Monitoring and Security Considerations
|
||||
|
||||
### Direct MQTT Access with Device Credentials
|
||||
|
||||
With access to the device's private key and certificate, it's technically possible to subscribe to MQTT events:
|
||||
|
||||
```bash
|
||||
# Subscribe to device shadow events
|
||||
mosquitto_sub -h a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com \
|
||||
-p 8883 --cafile /var/lib/iot/rootCA.crt \
|
||||
--cert /mnt/nv/IoTCerts/iot-cert.pem.crt \
|
||||
--key /mnt/nv/IoTCerts/iot-private.pem.key \
|
||||
-t '$aws/things/_uuid_/shadow/#'
|
||||
```
|
||||
|
||||
### Security Constraints and Limitations
|
||||
|
||||
#### AWS IoT Policy Restrictions
|
||||
Device certificates are bound to specific policies that typically restrict:
|
||||
- Access to device-specific topics only (`$aws/things/{clientID}/shadow/*`)
|
||||
- No wildcard subscriptions across multiple devices
|
||||
- Limited publish/subscribe permissions
|
||||
- Possible IP geolocation restrictions
|
||||
|
||||
#### Example Policy Structure
|
||||
```json
|
||||
{
|
||||
"Version": "2012-10-17",
|
||||
"Statement": [
|
||||
{
|
||||
"Effect": "Allow",
|
||||
"Action": "iot:Connect",
|
||||
"Resource": "arn:aws:iot:us-east-1:*:client/${iot:ClientId}"
|
||||
},
|
||||
{
|
||||
"Effect": "Allow",
|
||||
"Action": ["iot:Publish", "iot:Subscribe", "iot:Receive"],
|
||||
"Resource": [
|
||||
"arn:aws:iot:us-east-1:*:topic/$aws/things/${iot:ClientId}/shadow/*",
|
||||
"arn:aws:iot:us-east-1:*:topicfilter/$aws/things/${iot:ClientId}/shadow/*"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
#### Additional Security Measures
|
||||
- Certificate revocation for unusual activity
|
||||
- Device fingerprinting and connection frequency limits
|
||||
- Service shutdown timeline (May 2026) affecting endpoint availability
|
||||
|
||||
### Alternative Monitoring Approaches
|
||||
|
||||
#### Network Traffic Capture
|
||||
A less intrusive method to analyze MQTT communication patterns:
|
||||
|
||||
```bash
|
||||
# Capture encrypted MQTT traffic from the actual device
|
||||
tcpdump -i eth0 -s0 -w soundtouch_iot.pcap host a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com
|
||||
|
||||
# Monitor connection patterns
|
||||
tcpdump -i eth0 -n "host a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com and port 8883"
|
||||
```
|
||||
|
||||
#### Local MQTT Broker Setup
|
||||
For development and testing, create a local MQTT broker that mimics AWS IoT behavior:
|
||||
|
||||
```bash
|
||||
# Install and configure Mosquitto
|
||||
sudo apt-get install mosquitto mosquitto-clients
|
||||
|
||||
# Create test shadow topics
|
||||
mosquitto_pub -h localhost -t '$aws/things/test-device/shadow/update' \
|
||||
-m '{"state":{"reported":{"deviceState":"CONNECTED"}}}'
|
||||
```
|
||||
|
||||
### Ethical and Legal Considerations
|
||||
|
||||
- **Device Ownership**: Only monitor devices you own
|
||||
- **Terms of Service**: Using credentials outside device context may violate Bose ToS
|
||||
- **Unauthorized Access**: Accessing Bose's AWS infrastructure could be considered inappropriate
|
||||
- **Research Purpose**: Limit monitoring to understanding message formats for local alternatives
|
||||
|
||||
### Expected Message Examples
|
||||
|
||||
If monitoring is successful, typical shadow messages include:
|
||||
|
||||
```json
|
||||
// Power state change
|
||||
{
|
||||
"state": {
|
||||
"reported": {
|
||||
"powerState": "ON",
|
||||
"deviceState": "CONNECTED",
|
||||
"timestamp": 1703875200
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Volume adjustment
|
||||
{
|
||||
"state": {
|
||||
"reported": {
|
||||
"volume": 25,
|
||||
"muted": false
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Zone configuration
|
||||
{
|
||||
"state": {
|
||||
"reported": {
|
||||
"zoneState": "master",
|
||||
"groupMembers": ["device1", "device2"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Recommended Research Approach
|
||||
|
||||
1. **Document Message Formats**: Capture and analyze JSON structures
|
||||
2. **Understand State Transitions**: Map device actions to shadow updates
|
||||
3. **Build Local Alternative**: Use insights to create local MQTT shadow service
|
||||
4. **Prepare for Service Shutdown**: Develop migration strategy before May 2026
|
||||
|
||||
## Conclusion
|
||||
|
||||
The Bose SoundTouch IoT configuration system is a sophisticated implementation using AWS IoT Core for real-time device management. The system provides:
|
||||
|
||||
- Secure, certificate-based authentication
|
||||
- Reliable bi-directional communication
|
||||
- Comprehensive device state management
|
||||
- Integration with voice assistants and mobile applications
|
||||
- Robust error handling and retry mechanisms
|
||||
|
||||
This architecture enables seamless remote control, monitoring, and coordination of SoundTouch devices across multiple platforms and services.
|
||||
@@ -6,13 +6,13 @@ This document provides a comprehensive overview of the upstream Bose cloud servi
|
||||
|
||||
SoundTouch devices use a set of primary domains for their operation. These are often configurable via the `SoundTouchSdkPrivateCfg.xml` file.
|
||||
|
||||
| Service | Primary Domain | Purpose |
|
||||
| :--- | :--- | :--- |
|
||||
| **Marge** | `streaming.bose.com` | Account management, streaming source providers, and preset sync. |
|
||||
| **BMX Registry** | `content.api.bose.io` | Bose Media eXchange service discovery and registry. |
|
||||
| **Stats/Analytics** | `events.api.bosecm.com` | Telemetry, device events, and usage statistics. |
|
||||
| **Software Update** | `worldwide.bose.com` | Firmware update checks and downloads (path: `/updates/soundtouch`). |
|
||||
| **Voice/Alexa** | `voice.api.bose.io` | Token management for Amazon Alexa integration. |
|
||||
| Service | Primary Domain | Purpose |
|
||||
|:--------------------|:------------------------|:--------------------------------------------------------------------|
|
||||
| **Marge** | `streaming.bose.com` | Account management, streaming source providers, and preset sync. |
|
||||
| **BMX Registry** | `content.api.bose.io` | Bose Media eXchange service discovery and registry. |
|
||||
| **Stats/Analytics** | `events.api.bosecm.com` | Telemetry, device events, and usage statistics. |
|
||||
| **Software Update** | `worldwide.bose.com` | Firmware update checks and downloads (path: `/updates/soundtouch`). |
|
||||
| **Voice/Alexa** | `voice.api.bose.io` | Token management for Amazon Alexa integration. |
|
||||
|
||||
## Internal & Development Domains
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# SoundTouch API Comparison: Community Wiki vs Current Implementation
|
||||
|
||||
**Date:** January 2026
|
||||
**Source:** [SoundTouch Plus Wiki](https://github.com/thlucas1/homeassistantcomponent_soundtouchplus/wiki/SoundTouch-WebServices-API)
|
||||
**Source:** [SoundTouch Plus Wiki](https://github.com/thlucas1/homeassistantcomponent_soundtouchplus/wiki/SoundTouch-WebServices-API)
|
||||
**Our Implementation:** Bose-SoundTouch Go Library v1.0
|
||||
|
||||
## Executive Summary
|
||||
@@ -20,84 +20,84 @@ The SoundTouch Plus community wiki documents **87 distinct API endpoints** with
|
||||
|
||||
### ✅ Already Implemented (23 endpoints)
|
||||
|
||||
| Endpoint | Wiki Status | Our Status | Notes |
|
||||
|----------|-------------|------------|-------|
|
||||
| `/info` | ✅ Documented | ✅ Complete | Device information |
|
||||
| `/now_playing` | ✅ Documented | ✅ Complete | Current playback status |
|
||||
| `/key` | ✅ Documented | ✅ Complete | Key press/release simulation |
|
||||
| `/volume` | ✅ Documented | ✅ Complete | Volume and mute control |
|
||||
| `/bass` | ✅ Documented | ✅ Complete | Bass level control |
|
||||
| `/bassCapabilities` | ✅ Documented | ✅ Complete | Bass capability detection |
|
||||
| `/sources` | ✅ Documented | ✅ Complete | Available audio sources |
|
||||
| `/select` | ✅ Documented | ✅ Complete | Source selection |
|
||||
| `/presets` | ✅ Documented | ✅ Complete | Preset configurations (read-only) |
|
||||
| `/getZone` | ✅ Documented | ✅ Complete | Zone status and membership |
|
||||
| `/setZone` | ✅ Documented | ✅ Complete | Zone creation and management |
|
||||
| `/addZoneSlave` | ✅ Documented | ✅ Complete | Add device to zone |
|
||||
| `/removeZoneSlave` | ✅ Documented | ✅ Complete | Remove device from zone |
|
||||
| `/capabilities` | ✅ Documented | ✅ Complete | Device feature capabilities |
|
||||
| `/audiodspcontrols` | ✅ Documented | ✅ Complete | Audio DSP modes and video sync |
|
||||
| `/audioproducttonecontrols` | ✅ Documented | ✅ Complete | Advanced bass/treble controls |
|
||||
| `/audioproductlevelcontrols` | ✅ Documented | ✅ Complete | Speaker level controls |
|
||||
| `/name` (GET/POST) | ✅ Documented | ✅ Complete | Device name management |
|
||||
| `/balance` | ✅ Documented | ✅ Complete | Stereo balance control |
|
||||
| `/clockTime` | ✅ Documented | ✅ Complete | Device time management |
|
||||
| `/clockDisplay` | ✅ Documented | ✅ Complete | Clock display settings |
|
||||
| `/networkInfo` | ✅ Documented | ✅ Complete | Network connectivity info |
|
||||
| `/requestToken` | ✅ Documented | ✅ Complete | Bearer token generation |
|
||||
| Endpoint | Wiki Status | Our Status | Notes |
|
||||
|------------------------------|--------------|------------|-----------------------------------|
|
||||
| `/info` | ✅ Documented | ✅ Complete | Device information |
|
||||
| `/now_playing` | ✅ Documented | ✅ Complete | Current playback status |
|
||||
| `/key` | ✅ Documented | ✅ Complete | Key press/release simulation |
|
||||
| `/volume` | ✅ Documented | ✅ Complete | Volume and mute control |
|
||||
| `/bass` | ✅ Documented | ✅ Complete | Bass level control |
|
||||
| `/bassCapabilities` | ✅ Documented | ✅ Complete | Bass capability detection |
|
||||
| `/sources` | ✅ Documented | ✅ Complete | Available audio sources |
|
||||
| `/select` | ✅ Documented | ✅ Complete | Source selection |
|
||||
| `/presets` | ✅ Documented | ✅ Complete | Preset configurations (read-only) |
|
||||
| `/getZone` | ✅ Documented | ✅ Complete | Zone status and membership |
|
||||
| `/setZone` | ✅ Documented | ✅ Complete | Zone creation and management |
|
||||
| `/addZoneSlave` | ✅ Documented | ✅ Complete | Add device to zone |
|
||||
| `/removeZoneSlave` | ✅ Documented | ✅ Complete | Remove device from zone |
|
||||
| `/capabilities` | ✅ Documented | ✅ Complete | Device feature capabilities |
|
||||
| `/audiodspcontrols` | ✅ Documented | ✅ Complete | Audio DSP modes and video sync |
|
||||
| `/audioproducttonecontrols` | ✅ Documented | ✅ Complete | Advanced bass/treble controls |
|
||||
| `/audioproductlevelcontrols` | ✅ Documented | ✅ Complete | Speaker level controls |
|
||||
| `/name` (GET/POST) | ✅ Documented | ✅ Complete | Device name management |
|
||||
| `/balance` | ✅ Documented | ✅ Complete | Stereo balance control |
|
||||
| `/clockTime` | ✅ Documented | ✅ Complete | Device time management |
|
||||
| `/clockDisplay` | ✅ Documented | ✅ Complete | Clock display settings |
|
||||
| `/networkInfo` | ✅ Documented | ✅ Complete | Network connectivity info |
|
||||
| `/requestToken` | ✅ Documented | ✅ Complete | Bearer token generation |
|
||||
|
||||
### 🔥 High Priority Missing (20 endpoints)
|
||||
|
||||
| Endpoint | Wiki Status | Priority | Use Case |
|
||||
|----------|-------------|----------|----------|
|
||||
| `/storePreset` | ✅ Detailed | **HIGH** | Save stations/playlists to presets |
|
||||
| `/removePreset` | ✅ Detailed | **HIGH** | Delete saved presets |
|
||||
| `/selectPreset` | ✅ Detailed | **HIGH** | Play preset by ID |
|
||||
| `/setMusicServiceAccount` | ✅ Detailed | **HIGH** | Add Spotify/Pandora accounts |
|
||||
| `/removeMusicServiceAccount` | ✅ Detailed | **HIGH** | Remove music service accounts |
|
||||
| `/searchStation` | ✅ Detailed | **HIGH** | Find Pandora/Spotify content |
|
||||
| `/addStation` | ✅ Detailed | **HIGH** | Add stations to favorites |
|
||||
| `/removeStation` | ✅ Detailed | **HIGH** | Remove stations from favorites |
|
||||
| `/navigate` | ✅ Detailed | **HIGH** | Browse music libraries/services |
|
||||
| `/search` | ✅ Detailed | **HIGH** | Search music content |
|
||||
| `/userPlayControl` | ✅ Detailed | **HIGH** | Play/pause/stop controls |
|
||||
| `/userRating` | ✅ Detailed | **HIGH** | Thumbs up/down ratings |
|
||||
| `/recents` | ✅ Detailed | **HIGH** | Recently played content |
|
||||
| `/standby` | ✅ Detailed | **HIGH** | Power management |
|
||||
| `/powerManagement` | ✅ Detailed | **HIGH** | Power state information |
|
||||
| `/lowPowerStandby` | ✅ Detailed | **HIGH** | Low-power mode |
|
||||
| `/listMediaServers` | ✅ Detailed | **HIGH** | UPnP/DLNA server discovery |
|
||||
| `/serviceAvailability` | ✅ Detailed | **HIGH** | Source availability status |
|
||||
| `/introspect` | ✅ Detailed | **HIGH** | Music service account status |
|
||||
| `/language` | ✅ Detailed | **HIGH** | Device language settings |
|
||||
| Endpoint | Wiki Status | Priority | Use Case |
|
||||
|------------------------------|-------------|----------|------------------------------------|
|
||||
| `/storePreset` | ✅ Detailed | **HIGH** | Save stations/playlists to presets |
|
||||
| `/removePreset` | ✅ Detailed | **HIGH** | Delete saved presets |
|
||||
| `/selectPreset` | ✅ Detailed | **HIGH** | Play preset by ID |
|
||||
| `/setMusicServiceAccount` | ✅ Detailed | **HIGH** | Add Spotify/Pandora accounts |
|
||||
| `/removeMusicServiceAccount` | ✅ Detailed | **HIGH** | Remove music service accounts |
|
||||
| `/searchStation` | ✅ Detailed | **HIGH** | Find Pandora/Spotify content |
|
||||
| `/addStation` | ✅ Detailed | **HIGH** | Add stations to favorites |
|
||||
| `/removeStation` | ✅ Detailed | **HIGH** | Remove stations from favorites |
|
||||
| `/navigate` | ✅ Detailed | **HIGH** | Browse music libraries/services |
|
||||
| `/search` | ✅ Detailed | **HIGH** | Search music content |
|
||||
| `/userPlayControl` | ✅ Detailed | **HIGH** | Play/pause/stop controls |
|
||||
| `/userRating` | ✅ Detailed | **HIGH** | Thumbs up/down ratings |
|
||||
| `/recents` | ✅ Detailed | **HIGH** | Recently played content |
|
||||
| `/standby` | ✅ Detailed | **HIGH** | Power management |
|
||||
| `/powerManagement` | ✅ Detailed | **HIGH** | Power state information |
|
||||
| `/lowPowerStandby` | ✅ Detailed | **HIGH** | Low-power mode |
|
||||
| `/listMediaServers` | ✅ Detailed | **HIGH** | UPnP/DLNA server discovery |
|
||||
| `/serviceAvailability` | ✅ Detailed | **HIGH** | Source availability status |
|
||||
| `/introspect` | ✅ Detailed | **HIGH** | Music service account status |
|
||||
| `/language` | ✅ Detailed | **HIGH** | Device language settings |
|
||||
|
||||
### 🎵 Music Service Management (12 endpoints)
|
||||
|
||||
| Category | Endpoints | Wiki Coverage | Notes |
|
||||
|----------|-----------|---------------|-------|
|
||||
| **Account Management** | `/setMusicServiceAccount`, `/removeMusicServiceAccount` | ✅ Full XML examples | Pandora, Spotify, NAS setup |
|
||||
| **Station Management** | `/searchStation`, `/addStation`, `/removeStation` | ✅ Pandora tested | Station discovery and favorites |
|
||||
| **Content Navigation** | `/navigate`, `/search` | ✅ Detailed examples | Music library browsing |
|
||||
| **Track Information** | `/trackInfo`, `/introspect` | ✅ Service-specific | Extended metadata |
|
||||
| Category | Endpoints | Wiki Coverage | Notes |
|
||||
|------------------------|---------------------------------------------------------|---------------------|---------------------------------|
|
||||
| **Account Management** | `/setMusicServiceAccount`, `/removeMusicServiceAccount` | ✅ Full XML examples | Pandora, Spotify, NAS setup |
|
||||
| **Station Management** | `/searchStation`, `/addStation`, `/removeStation` | ✅ Pandora tested | Station discovery and favorites |
|
||||
| **Content Navigation** | `/navigate`, `/search` | ✅ Detailed examples | Music library browsing |
|
||||
| **Track Information** | `/trackInfo`, `/introspect` | ✅ Service-specific | Extended metadata |
|
||||
|
||||
### 🏠 Smart Home Integration (15 endpoints)
|
||||
|
||||
| Category | Endpoints | Wiki Coverage | Notes |
|
||||
|----------|-----------|---------------|-------|
|
||||
| **Notifications** | `/speaker`, `/playNotification` | ✅ TTS examples | Text-to-speech, URL playback |
|
||||
| **Power Management** | `/standby`, `/powerManagement`, `/lowPowerStandby` | ✅ Complete | Smart home automation |
|
||||
| **Network Management** | `/performWirelessSiteSurvey`, `/addWirelessProfile`, `/getActiveWirelessProfile` | ✅ WiFi setup | Network configuration |
|
||||
| **Bluetooth** | `/enterBluetoothPairing`, `/clearBluetoothPaired`, `/bluetoothInfo` | ✅ Pairing control | Bluetooth management |
|
||||
| **Source Control** | `/selectLastSource`, `/selectLastSoundTouchSource`, `/selectLocalSource` | ✅ Source switching | Quick source access |
|
||||
| Category | Endpoints | Wiki Coverage | Notes |
|
||||
|------------------------|----------------------------------------------------------------------------------|--------------------|------------------------------|
|
||||
| **Notifications** | `/speaker`, `/playNotification` | ✅ TTS examples | Text-to-speech, URL playback |
|
||||
| **Power Management** | `/standby`, `/powerManagement`, `/lowPowerStandby` | ✅ Complete | Smart home automation |
|
||||
| **Network Management** | `/performWirelessSiteSurvey`, `/addWirelessProfile`, `/getActiveWirelessProfile` | ✅ WiFi setup | Network configuration |
|
||||
| **Bluetooth** | `/enterBluetoothPairing`, `/clearBluetoothPaired`, `/bluetoothInfo` | ✅ Pairing control | Bluetooth management |
|
||||
| **Source Control** | `/selectLastSource`, `/selectLastSoundTouchSource`, `/selectLocalSource` | ✅ Source switching | Quick source access |
|
||||
|
||||
### 📱 Advanced Device Features (19 endpoints)
|
||||
|
||||
| Category | Endpoints | Wiki Coverage | Notes |
|
||||
|----------|-----------|---------------|-------|
|
||||
| **Stereo Pairs** | `/getGroup`, `/addGroup`, `/removeGroup`, `/updateGroup` | ✅ ST-10 specific | L/R speaker pairing |
|
||||
| **System Info** | `/soundTouchConfigurationStatus`, `/systemtimeout`, `/rebroadcastlatencymode` | ✅ Configuration | Device state management |
|
||||
| **Software Updates** | `/swUpdateCheck`, `/swUpdateQuery`, `/swUpdateAbort`, `/swUpdateStart` | ✅ Update process | Firmware management |
|
||||
| **Audio Processing** | `/DSPMonoStereo`, `/audiospeakerattributeandsetting` | ✅ Hardware-specific | Advanced audio features |
|
||||
| Category | Endpoints | Wiki Coverage | Notes |
|
||||
|----------------------|-------------------------------------------------------------------------------|---------------------|-------------------------|
|
||||
| **Stereo Pairs** | `/getGroup`, `/addGroup`, `/removeGroup`, `/updateGroup` | ✅ ST-10 specific | L/R speaker pairing |
|
||||
| **System Info** | `/soundTouchConfigurationStatus`, `/systemtimeout`, `/rebroadcastlatencymode` | ✅ Configuration | Device state management |
|
||||
| **Software Updates** | `/swUpdateCheck`, `/swUpdateQuery`, `/swUpdateAbort`, `/swUpdateStart` | ✅ Update process | Firmware management |
|
||||
| **Audio Processing** | `/DSPMonoStereo`, `/audiospeakerattributeandsetting` | ✅ Hardware-specific | Advanced audio features |
|
||||
|
||||
---
|
||||
|
||||
@@ -137,7 +137,7 @@ The SoundTouch Plus community wiki documents **87 distinct API endpoints** with
|
||||
|
||||
**WebSocket Events Documented:**
|
||||
- `presetsUpdated` - Preset changes
|
||||
- `groupUpdated` - Stereo pair changes
|
||||
- `groupUpdated` - Stereo pair changes
|
||||
- `zoneUpdated` - Multi-room changes
|
||||
- `nowPlayingUpdated` - Source/playback changes
|
||||
- `volumeUpdated` - Volume/mute changes
|
||||
@@ -194,7 +194,7 @@ func (c *Client) RateCurrentTrack(rating RatingValue) error
|
||||
func (c *Client) CreateStereoPair(leftIP, rightIP string, name string) error
|
||||
func (c *Client) GetStereoPairStatus() (*StereoPair, error)
|
||||
|
||||
// System Management
|
||||
// System Management
|
||||
func (c *Client) CheckSoftwareUpdate() (*UpdateInfo, error)
|
||||
func (c *Client) GetSystemTimeout() (*TimeoutConfig, error)
|
||||
```
|
||||
@@ -283,7 +283,7 @@ The SoundTouch Plus Wiki represents a **treasure trove** of production-ready API
|
||||
### Key Opportunities:
|
||||
- 🎯 **3x Coverage Expansion**: From 23 to 87+ endpoints
|
||||
- 🏠 **Smart Home Ready**: Complete automation integration
|
||||
- 🎵 **Music Service Integration**: Full streaming service support
|
||||
- 🎵 **Music Service Integration**: Full streaming service support
|
||||
- 📱 **Professional Features**: Advanced audio and system control
|
||||
- ✅ **Production Ready**: Real-world tested examples and error handling
|
||||
|
||||
@@ -297,4 +297,4 @@ The SoundTouch Plus Wiki represents a **treasure trove** of production-ready API
|
||||
|
||||
---
|
||||
|
||||
*Note: All endpoints documented in the wiki are tested against real hardware. Device-specific limitations are clearly documented with compatibility matrices for ST-10, ST-300, and other SoundTouch models.*
|
||||
*Note: All endpoints documented in the wiki are tested against real hardware. Device-specific limitations are clearly documented with compatibility matrices for ST-10, ST-300, and other SoundTouch models.*
|
||||
|
||||
@@ -0,0 +1,181 @@
|
||||
# Upstream Bose Service Simulation - Concept Overview
|
||||
|
||||
## Executive Summary
|
||||
|
||||
This document serves as the entry point for understanding the comprehensive plan to enhance the SoundTouch service with advanced state management capabilities, preparing for the eventual shutdown of Bose's upstream services while providing a superior local management experience.
|
||||
|
||||
## Project Objectives
|
||||
|
||||
### Primary Goal
|
||||
Create a robust, local replacement for Bose's upstream services that can seamlessly handle the transition from cloud-dependent to fully autonomous operation while maintaining and improving upon the existing functionality.
|
||||
|
||||
### Key Outcomes
|
||||
- **Zero-downtime transition** from Bose services to local management
|
||||
- **Enhanced visibility** into device states, health, and system operations
|
||||
- **Data preservation** during migrations with full rollback capabilities
|
||||
- **Improved reliability** through local control and reduced external dependencies
|
||||
- **Future-proof architecture** that can evolve beyond Bose's original design
|
||||
|
||||
## Architecture Vision
|
||||
|
||||
### Current State
|
||||
The existing SoundTouch service provides:
|
||||
- BMX service for TuneIn integration
|
||||
- Marge service for account and device management
|
||||
- Basic mirroring of upstream Bose endpoints
|
||||
- File-based persistence for device data
|
||||
- Migration support for device directory structures
|
||||
|
||||
### Enhanced State (This Project)
|
||||
The enhanced system will add:
|
||||
- **Comprehensive Account Management** with explicit creation and migration tracking
|
||||
- **Device Lifecycle Management** with full state machine and event processing
|
||||
- **Advanced Mirroring** with disparity detection and analysis
|
||||
- **Dual-Source Data Management** supporting gradual migration strategies
|
||||
- **Real-time Monitoring** with health checks and performance metrics
|
||||
- **Text-based Storage** optimized for debugging and small hardware deployments
|
||||
|
||||
## Use Case Coverage
|
||||
|
||||
### Case 0: Account Management
|
||||
- **Explicit Account Creation**: Accounts created through deliberate user action
|
||||
- **Mirror-Enhanced Setup**: Use upstream data to enrich account creation
|
||||
- **Passive Data Collection**: Record account information during normal operations
|
||||
|
||||
### Case 1a: Fresh Device Registration
|
||||
- **Factory Reset Support**: Handle devices with no prior Bose association
|
||||
- **Default Configuration**: Initialize devices with sensible presets and sources
|
||||
- **Local-First Setup**: Complete registration without upstream dependencies
|
||||
|
||||
### Case 1b: Bose Account Migration
|
||||
- **Data Preservation**: Maintain existing presets, recents, and sources
|
||||
- **Gradual Migration**: Support partial migration while maintaining upstream compatibility
|
||||
- **Rollback Capability**: Revert to Bose services if needed
|
||||
|
||||
### Case 2: Lifecycle and State Management
|
||||
- **Real-time State Tracking**: Monitor device states and health continuously
|
||||
- **Event-Driven Updates**: Process device events asynchronously
|
||||
- **Disparity Detection**: Identify differences between local and upstream behavior
|
||||
- **Comprehensive Logging**: Maintain detailed audit trails for troubleshooting
|
||||
|
||||
## Technical Approach
|
||||
|
||||
### Design Principles
|
||||
1. **Text-First Storage**: Human-readable formats (JSON, XML, logs) for easy debugging
|
||||
2. **Small Hardware Optimization**: Designed for Raspberry Pi Zero 2W deployments
|
||||
3. **Mirror-First Strategy**: Keep upstream mirroring active until migration complete
|
||||
4. **Event-Driven Architecture**: Asynchronous processing with comprehensive event tracking
|
||||
5. **Backward Compatibility**: Seamless integration with existing installations
|
||||
|
||||
### Data Structure
|
||||
```
|
||||
data/
|
||||
├── accounts/{account-id}/
|
||||
│ ├── account.json # Account metadata and settings
|
||||
│ ├── account-events.log # High-level account behavior tracking
|
||||
│ ├── devices/{device-id}/
|
||||
│ │ ├── lifecycle.json # Device state and history
|
||||
│ │ ├── info.xml # Device information (existing)
|
||||
│ │ ├── presets.xml # Device presets (existing)
|
||||
│ │ ├── recents.xml # Recent plays (existing)
|
||||
│ │ ├── sources.xml # Configured sources (existing)
|
||||
│ │ └── events.log # Device event history
|
||||
│ └── sessions/ # Recorded interaction sessions (existing)
|
||||
└── system/
|
||||
├── discovery.log # Device discovery events
|
||||
└── migration.log # Migration activities
|
||||
```
|
||||
|
||||
### Development Targets
|
||||
- **Simplicity**: Keep It Simple, Stupid (KISS) principle over optimization
|
||||
- **Quality**: 100% test pass rate and lint-clean code for every change
|
||||
- **Compatibility**: Zero breaking changes to existing functionality
|
||||
- **Leveraging**: Reuse existing systems (interaction recording, parity detection)
|
||||
|
||||
## Implementation Strategy
|
||||
|
||||
### Phase 1: Foundation (2-3 weeks) - Small, Testable Steps
|
||||
- Account management foundation with basic create/read operations
|
||||
- Device lifecycle data models and simple state tracking
|
||||
- Basic API endpoints with comprehensive testing
|
||||
- Integration with existing datastore patterns
|
||||
|
||||
### Phase 2: Device Lifecycle (2-3 weeks) - Build on Existing Systems
|
||||
- Event processing using existing WebSocket system
|
||||
- Lifecycle integration with current discovery and migration
|
||||
- Enhanced logging building on existing parity detection
|
||||
- Simple state machine with thorough testing
|
||||
|
||||
### Phase 3: Enhanced Features (2-3 weeks) - Leverage Current Systems
|
||||
- Improve existing parity mismatch detection with better categorization
|
||||
- Smart data source routing with fallback mechanisms
|
||||
- Basic monitoring using existing health check patterns
|
||||
- Reuse interaction recording for request/response tracking
|
||||
|
||||
## Key Benefits
|
||||
|
||||
### For Users
|
||||
- **Continuity**: Seamless operation when Bose services shut down
|
||||
- **Reliability**: Local control reduces dependency on external services
|
||||
- **Visibility**: Clear insight into device states and system health
|
||||
- **Control**: Full management of device data and configurations
|
||||
|
||||
### For Developers
|
||||
- **Simplicity**: KISS principle makes code easy to understand and maintain
|
||||
- **Quality**: Comprehensive testing and linting ensures reliable code
|
||||
- **Debugging**: Text-based storage enables easy troubleshooting
|
||||
- **Testing**: Every change requires full test suite pass and lint compliance
|
||||
|
||||
### For Community
|
||||
- **Open Source**: Transparent implementation available for community contributions
|
||||
- **Standards**: Well-documented APIs and data formats
|
||||
- **Collaboration**: Disparity detection helps improve implementation accuracy
|
||||
- **Future-Proof**: Architecture designed to outlast original Bose services
|
||||
|
||||
### Technical Risks
|
||||
- **Data Loss Prevention**: Atomic file operations and comprehensive testing
|
||||
- **Complexity Creep**: KISS principle and simple-first approach
|
||||
- **Compatibility Issues**: Extensive regression testing and existing system reuse
|
||||
- **Code Quality**: Mandatory linting and test coverage for every change
|
||||
|
||||
### Operational Risks
|
||||
- **Service Disruption**: Small, incremental changes with rollback capability
|
||||
- **Testing Overhead**: Automated quality gates (`golangci-lint run --fix` + `go test ./...`)
|
||||
- **Migration Challenges**: Leverage existing migration system and patterns
|
||||
- **Maintenance Burden**: Simple, well-tested code is easier to maintain
|
||||
|
||||
### Technical
|
||||
- All tests pass consistently (100%)
|
||||
- Zero linting issues in codebase
|
||||
- No breaking changes to existing functionality
|
||||
- Code coverage maintained or improved
|
||||
|
||||
### Quality Assurance
|
||||
- Every commit passes `golangci-lint run --fix`
|
||||
- Every milestone passes `go test ./...`
|
||||
- Integration tests verify existing functionality
|
||||
- Simple, maintainable code that follows Go idioms
|
||||
|
||||
## Documentation Structure
|
||||
|
||||
This concept is detailed across several documents:
|
||||
|
||||
- **[upstream-service-simulation.md](./upstream-service-simulation.md)**: Complete architectural concept with detailed use cases and implementation guidelines
|
||||
- **[implementation-roadmap.md](./implementation-roadmap.md)**: Detailed project phases, milestones, and delivery timeline
|
||||
- **[technical-specification.md](./technical-specification.md)**: Comprehensive technical details including APIs, data models, and performance requirements
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. **Review the Concept**: Read through the main concept document to understand the full scope
|
||||
2. **Examine Technical Details**: Review the technical specification for implementation details
|
||||
3. **Follow the Roadmap**: Use the implementation roadmap for project planning and execution
|
||||
4. **Integration Planning**: Consider how the enhanced features will integrate with existing deployments
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. **Stakeholder Review**: Gather feedback on the concept and approach
|
||||
2. **Technical Validation**: Prototype key components to validate technical assumptions
|
||||
3. **Resource Planning**: Allocate development resources for the three-phase implementation
|
||||
4. **Community Engagement**: Share plans with the community for feedback and contributions
|
||||
|
||||
This enhanced state management system represents a significant evolution of the SoundTouch service, transforming it from a basic cloud replacement into a comprehensive, future-proof device management platform that can serve users well beyond the Bose service shutdown timeline.
|
||||
@@ -0,0 +1,355 @@
|
||||
# Implementation Plan - Enhanced State Management System
|
||||
|
||||
## Overview
|
||||
|
||||
This document provides a detailed, step-by-step implementation plan for the enhanced state management system. Each step is designed to be small, testable, and independently valuable while maintaining backward compatibility.
|
||||
|
||||
## Development Principles
|
||||
|
||||
### Quality Gates
|
||||
Every step must pass these checks before proceeding:
|
||||
1. `golangci-lint run --fix` - no linting issues
|
||||
2. `go test ./...` - all tests pass
|
||||
3. Existing functionality remains intact
|
||||
4. New functionality has appropriate test coverage
|
||||
|
||||
### KISS Principle
|
||||
- Write the simplest code that works
|
||||
- Avoid premature optimization
|
||||
- Use straightforward algorithms
|
||||
- Build incrementally with small changes
|
||||
|
||||
### Leverage Existing Systems
|
||||
- Reuse interaction recording for request/response tracking
|
||||
- Build upon current parity mismatch detection
|
||||
- Extend existing datastore patterns
|
||||
- Integrate with established workflows
|
||||
|
||||
## Phase 1: Foundation Preparation (2-3 weeks)
|
||||
|
||||
### Step 1.1: Code Organization Preparation
|
||||
**Duration**: 2-3 days
|
||||
**Goal**: Prepare package structure without changing behavior
|
||||
|
||||
#### Mini-milestone 1.1.1: Create account package structure
|
||||
- Create `pkg/service/account/` directory
|
||||
- Add basic `account.go` with placeholder structs
|
||||
- Add `account_test.go` with basic test structure
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
#### Mini-milestone 1.1.2: Create lifecycle package structure
|
||||
- Create `pkg/service/lifecycle/` directory
|
||||
- Add basic `lifecycle.go` with placeholder structs
|
||||
- Add `lifecycle_test.go` with basic test structure
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
#### Mini-milestone 1.1.3: Extend datastore interface preparation
|
||||
- Add placeholder methods to existing datastore for account operations
|
||||
- Ensure all existing functionality still works
|
||||
- Add tests for new placeholder methods
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
### Step 1.2: Account Management Foundation
|
||||
**Duration**: 3-4 days
|
||||
**Goal**: Basic account creation and retrieval
|
||||
|
||||
#### Mini-milestone 1.2.1: Account data model
|
||||
- Define `Account` struct with basic fields
|
||||
- Add validation functions
|
||||
- Add comprehensive unit tests
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
#### Mini-milestone 1.2.2: Account persistence
|
||||
- Implement account.json file read/write
|
||||
- Add atomic file operations
|
||||
- Test file operations thoroughly
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
#### Mini-milestone 1.2.3: Account manager basic operations
|
||||
- Implement `CreateAccount()` function
|
||||
- Implement `GetAccount()` function
|
||||
- Add error handling and validation
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
#### Mini-milestone 1.2.4: Integration with existing datastore
|
||||
- Modify datastore to use account manager
|
||||
- Ensure backward compatibility with existing accounts
|
||||
- Test migration of existing data structure
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
### Step 1.3: Basic API Endpoints
|
||||
**Duration**: 2-3 days
|
||||
**Goal**: Add REST endpoints for account management
|
||||
|
||||
#### Mini-milestone 1.3.1: Account creation endpoint
|
||||
- Add `POST /api/v1/accounts` handler
|
||||
- Integrate with existing HTTP router
|
||||
- Add input validation and error responses
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
#### Mini-milestone 1.3.2: Account retrieval endpoint
|
||||
- Add `GET /api/v1/accounts/{id}` handler
|
||||
- Add proper JSON serialization
|
||||
- Test endpoint functionality
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
#### Mini-milestone 1.3.3: Integration testing
|
||||
- Test new endpoints with existing functionality
|
||||
- Ensure XML endpoints still work
|
||||
- Verify no breaking changes
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
## Phase 2: Device Lifecycle Foundation (2-3 weeks)
|
||||
|
||||
### Step 2.1: Device State Model
|
||||
**Duration**: 3-4 days
|
||||
**Goal**: Basic device lifecycle tracking
|
||||
|
||||
#### Mini-milestone 2.1.1: Device lifecycle data model
|
||||
- Define `DeviceLifecycle` struct
|
||||
- Define device states and transitions
|
||||
- Add validation and helper functions
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
#### Mini-milestone 2.1.2: State transition logic
|
||||
- Implement basic state machine
|
||||
- Add transition validation
|
||||
- Create comprehensive tests for all transitions
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
#### Mini-milestone 2.1.3: Lifecycle persistence
|
||||
- Implement lifecycle.json file operations
|
||||
- Add atomic updates and error handling
|
||||
- Test persistence thoroughly
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
### Step 2.2: Event Processing Foundation
|
||||
**Duration**: 3-4 days
|
||||
**Goal**: Basic event handling and logging
|
||||
|
||||
#### Mini-milestone 2.2.1: Event data model
|
||||
- Define `DeviceEvent` struct
|
||||
- Add event types and validation
|
||||
- Create event builder helpers
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
#### Mini-milestone 2.2.2: Simple event logging
|
||||
- Implement append-only event log writing
|
||||
- Add structured log format
|
||||
- Test log operations and rotation
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
#### Mini-milestone 2.2.3: Event processing pipeline
|
||||
- Create basic synchronous event processor
|
||||
- Add event validation and filtering
|
||||
- Integrate with existing WebSocket events
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
### Step 2.3: Lifecycle Integration
|
||||
**Duration**: 2-3 days
|
||||
**Goal**: Connect lifecycle to existing systems
|
||||
|
||||
#### Mini-milestone 2.3.1: Discovery integration
|
||||
- Trigger lifecycle events on device discovery
|
||||
- Update device state on discovery
|
||||
- Test discovery workflow with lifecycle
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
#### Mini-milestone 2.3.2: WebSocket integration
|
||||
- Process WebSocket events through lifecycle
|
||||
- Update device state based on events
|
||||
- Log significant state changes
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
#### Mini-milestone 2.3.3: Migration integration
|
||||
- Integrate lifecycle with existing migration system
|
||||
- Track migration events and state changes
|
||||
- Ensure existing migration still works
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
## Phase 3: Enhanced Features (2-3 weeks)
|
||||
|
||||
### Step 3.1: Enhanced Mirroring
|
||||
**Duration**: 3-4 days
|
||||
**Goal**: Improve existing parity detection
|
||||
|
||||
#### Mini-milestone 3.1.1: Extended disparity logging
|
||||
- Enhance existing parity mismatch logging
|
||||
- Add more detailed disparity information
|
||||
- Improve log format for analysis
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
#### Mini-milestone 3.1.2: Disparity categorization
|
||||
- Add severity levels to disparities
|
||||
- Categorize different types of mismatches
|
||||
- Add filtering and search capabilities
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
#### Mini-milestone 3.1.3: Enhanced mirror middleware
|
||||
- Extend existing mirror functionality
|
||||
- Add better response comparison
|
||||
- Integrate with lifecycle events
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
### Step 3.2: Data Source Management
|
||||
**Duration**: 3-4 days
|
||||
**Goal**: Smart routing between local and upstream
|
||||
|
||||
#### Mini-milestone 3.2.1: Data source configuration
|
||||
- Add per-device source preferences
|
||||
- Implement source switching logic
|
||||
- Add configuration persistence
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
#### Mini-milestone 3.2.2: Fallback mechanisms
|
||||
- Add graceful fallback on source failure
|
||||
- Implement simple health checking
|
||||
- Test fallback scenarios
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
#### Mini-milestone 3.2.3: Migration orchestration
|
||||
- Add device-by-device migration control
|
||||
- Track migration progress
|
||||
- Add rollback capabilities
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
### Step 3.3: Monitoring and Health
|
||||
**Duration**: 2-3 days
|
||||
**Goal**: Basic system monitoring
|
||||
|
||||
#### Mini-milestone 3.3.1: Health check endpoints
|
||||
- Add system health endpoints
|
||||
- Report service status
|
||||
- Add basic metrics collection
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
#### Mini-milestone 3.3.2: Device health tracking
|
||||
- Track device connectivity
|
||||
- Monitor response times
|
||||
- Log health status changes
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
#### Mini-milestone 3.3.3: System metrics
|
||||
- Add basic performance metrics
|
||||
- Track resource usage
|
||||
- Add metrics endpoints
|
||||
- **Quality Check**: Lint + test all packages
|
||||
|
||||
## Quality Assurance Strategy
|
||||
|
||||
### Testing Requirements
|
||||
Each mini-milestone must include:
|
||||
- Unit tests for new functions
|
||||
- Integration tests for modified workflows
|
||||
- Regression tests for existing functionality
|
||||
- Performance tests for critical paths
|
||||
|
||||
### Test Categories
|
||||
|
||||
#### Unit Tests
|
||||
- Test individual functions and methods
|
||||
- Mock external dependencies
|
||||
- Cover error conditions and edge cases
|
||||
- Aim for >90% code coverage on new code
|
||||
|
||||
#### Integration Tests
|
||||
- Test component interactions
|
||||
- Use real file operations in test environment
|
||||
- Test HTTP endpoints end-to-end
|
||||
- Verify existing functionality unchanged
|
||||
|
||||
#### Regression Tests
|
||||
- Ensure existing XML endpoints work
|
||||
- Verify device discovery still functions
|
||||
- Check migration compatibility
|
||||
- Test WebSocket event processing
|
||||
|
||||
### Continuous Quality Checks
|
||||
|
||||
#### Pre-commit Checks
|
||||
```bash
|
||||
# Before each commit
|
||||
golangci-lint run --fix
|
||||
go test ./...
|
||||
go test -race ./...
|
||||
```
|
||||
|
||||
#### Milestone Validation
|
||||
```bash
|
||||
# Before marking milestone complete
|
||||
golangci-lint run --fix
|
||||
go test ./... -v
|
||||
go test -race ./... -v
|
||||
go test ./... -bench=.
|
||||
```
|
||||
|
||||
#### Integration Validation
|
||||
```bash
|
||||
# Test with real soundtouch-service
|
||||
make build
|
||||
./soundtouch-service &
|
||||
# Run integration test suite
|
||||
make integration-test
|
||||
```
|
||||
|
||||
## Risk Mitigation
|
||||
|
||||
### Backward Compatibility
|
||||
- All existing APIs must continue working
|
||||
- File structure changes must be additive
|
||||
- Configuration changes must have defaults
|
||||
- Migration paths for existing data
|
||||
|
||||
### Rollback Strategy
|
||||
- Each step can be independently reverted
|
||||
- Configuration flags for new features
|
||||
- Graceful degradation when features disabled
|
||||
- Clear rollback documentation
|
||||
|
||||
### Performance Impact
|
||||
- Monitor memory usage during development
|
||||
- Profile critical paths before and after changes
|
||||
- Set performance regression alerts
|
||||
- Simple before complex solutions
|
||||
|
||||
## Documentation Requirements
|
||||
|
||||
### Code Documentation
|
||||
- Comprehensive godoc comments
|
||||
- Example usage in comments
|
||||
- Error conditions documented
|
||||
- Performance characteristics noted
|
||||
|
||||
### User Documentation
|
||||
- Update existing guides for new features
|
||||
- Add migration guides for new functionality
|
||||
- Create troubleshooting documentation
|
||||
- Update API documentation
|
||||
|
||||
### Development Documentation
|
||||
- Architecture decision records
|
||||
- Testing strategy documentation
|
||||
- Deployment and rollback procedures
|
||||
- Performance benchmarking results
|
||||
|
||||
## Success Criteria
|
||||
|
||||
### Technical Metrics
|
||||
- All tests pass consistently
|
||||
- No linting issues
|
||||
- Memory usage increase <50MB
|
||||
- Response time degradation <10%
|
||||
|
||||
### Functional Metrics
|
||||
- All existing functionality preserved
|
||||
- New account management works reliably
|
||||
- Device lifecycle tracking is accurate
|
||||
- Enhanced monitoring provides value
|
||||
|
||||
### Quality Metrics
|
||||
- Code coverage maintained >85%
|
||||
- No critical security issues
|
||||
- Documentation completeness >95%
|
||||
- Community feedback positive
|
||||
|
||||
This implementation plan ensures steady, reliable progress while maintaining the quality and simplicity principles essential for the project's success.
|
||||
@@ -0,0 +1,403 @@
|
||||
# Implementation Roadmap for Upstream Service Simulation
|
||||
|
||||
## Overview
|
||||
|
||||
This document provides a detailed implementation roadmap for the upstream Bose service simulation concept. It breaks down the implementation into manageable phases with specific deliverables, technical requirements, and integration points.
|
||||
|
||||
## Phase 1: Foundation and Enhanced State Tracking (4-6 weeks)
|
||||
|
||||
### Milestone 1.1: Account Management Service (1-2 weeks)
|
||||
|
||||
#### Deliverables
|
||||
- `pkg/service/account/` package with core account management
|
||||
- Account creation, retrieval, and status management APIs
|
||||
- Text-based account persistence in JSON format
|
||||
- Integration with existing datastore structure
|
||||
|
||||
#### Implementation Tasks
|
||||
1. **Create Account Manager**
|
||||
```
|
||||
pkg/service/account/
|
||||
├── account.go # Core account management
|
||||
├── manager.go # Account manager implementation
|
||||
├── persistence.go # File-based persistence
|
||||
└── account_test.go # Comprehensive tests
|
||||
```
|
||||
|
||||
2. **Account Data Structure**
|
||||
- JSON-based account metadata storage
|
||||
- Integration with existing `data/accounts/{id}/` structure
|
||||
- Account status tracking (active, migrating, suspended)
|
||||
- Migration metadata tracking
|
||||
|
||||
3. **API Integration**
|
||||
- Add account management endpoints to existing HTTP router
|
||||
- RESTful API alongside existing XML endpoints
|
||||
- Account creation validation and error handling
|
||||
|
||||
#### Technical Requirements
|
||||
- Maintain backward compatibility with existing account structure
|
||||
- Thread-safe account operations
|
||||
- Atomic file operations for account metadata
|
||||
- Comprehensive error handling and logging
|
||||
|
||||
### Milestone 1.2: Device Lifecycle Manager (2-3 weeks)
|
||||
|
||||
#### Deliverables
|
||||
- `pkg/service/lifecycle/` package for device state management
|
||||
- Device state machine with comprehensive state tracking
|
||||
- Event-driven state transitions
|
||||
- Integration with existing device discovery and migration
|
||||
|
||||
#### Implementation Tasks
|
||||
1. **Lifecycle Core**
|
||||
```
|
||||
pkg/service/lifecycle/
|
||||
├── lifecycle.go # Device lifecycle management
|
||||
├── states.go # State definitions and transitions
|
||||
├── events.go # Event processing
|
||||
├── persistence.go # Lifecycle persistence
|
||||
└── lifecycle_test.go # State machine tests
|
||||
```
|
||||
|
||||
2. **State Machine Implementation**
|
||||
- Define device states: unregistered → registering → active → migrating → offline → retired
|
||||
- Implement state transition rules and validation
|
||||
- Event-driven state changes with history tracking
|
||||
- Integration with existing migration system
|
||||
|
||||
3. **Event Processing**
|
||||
- Asynchronous event queue for device events
|
||||
- Event categorization and filtering
|
||||
- Text-based event logging with structured format
|
||||
- Event replay capabilities for debugging
|
||||
|
||||
#### Technical Requirements
|
||||
- Non-blocking event processing
|
||||
- Persistent state across service restarts
|
||||
- Integration with existing WebSocket event system
|
||||
- Memory-efficient event storage
|
||||
|
||||
### Milestone 1.3: Enhanced Mirror System (1-2 weeks)
|
||||
|
||||
#### Deliverables
|
||||
- Extended mirroring with disparity detection
|
||||
- Parity analysis logging and reporting
|
||||
- Selective data source switching
|
||||
- Integration with existing mirror middleware
|
||||
|
||||
#### Implementation Tasks
|
||||
1. **Disparity Detection**
|
||||
```
|
||||
pkg/service/mirror/
|
||||
├── disparity.go # Disparity detection logic
|
||||
├── analyzer.go # Response analysis and comparison
|
||||
├── logger.go # Structured disparity logging
|
||||
└── disparity_test.go # Analysis tests
|
||||
```
|
||||
|
||||
2. **Enhanced Mirror Middleware**
|
||||
- Extend existing mirror functionality
|
||||
- Add response comparison and hash calculation
|
||||
- Structured logging of disparities
|
||||
- Configurable disparity sensitivity
|
||||
|
||||
3. **Data Source Management**
|
||||
- Smart routing between local and upstream sources
|
||||
- Per-endpoint source preference configuration
|
||||
- Fallback mechanisms for upstream unavailability
|
||||
- Source switching with history tracking
|
||||
|
||||
#### Technical Requirements
|
||||
- Minimal performance impact on request processing
|
||||
- Configurable disparity detection sensitivity
|
||||
- Structured logging for analysis tools
|
||||
- Integration with existing mirror configuration
|
||||
|
||||
## Phase 2: Migration and Dual-Source Management (3-4 weeks)
|
||||
|
||||
### Milestone 2.1: Migration Controller (2-3 weeks)
|
||||
|
||||
#### Deliverables
|
||||
- Device-by-device migration orchestration
|
||||
- Migration progress tracking and status reporting
|
||||
- Rollback capabilities with state preservation
|
||||
- Integration with existing setup manager
|
||||
|
||||
#### Implementation Tasks
|
||||
1. **Migration Orchestration**
|
||||
```
|
||||
pkg/service/migration/
|
||||
├── controller.go # Migration orchestration
|
||||
├── strategy.go # Migration strategies
|
||||
├── rollback.go # Rollback functionality
|
||||
├── progress.go # Progress tracking
|
||||
└── migration_integration_test.go
|
||||
```
|
||||
|
||||
2. **Migration Strategies**
|
||||
- Fresh device registration flow
|
||||
- Bose account data migration flow
|
||||
- Gradual migration with dual-source support
|
||||
- Emergency migration for service outages
|
||||
|
||||
3. **Progress Tracking**
|
||||
- Real-time migration status updates
|
||||
- Migration timeline and milestone tracking
|
||||
- Error handling and recovery procedures
|
||||
- Migration completion verification
|
||||
|
||||
#### Technical Requirements
|
||||
- Integration with existing migration system
|
||||
- Atomic migration operations with rollback
|
||||
- Progress persistence across service restarts
|
||||
- Comprehensive migration logging
|
||||
|
||||
### Milestone 2.2: Dual-Source Data Management (1-2 weeks)
|
||||
|
||||
#### Deliverables
|
||||
- Smart data routing between local and upstream sources
|
||||
- Graceful fallback mechanisms
|
||||
- Data source preference management
|
||||
- Conflict resolution strategies
|
||||
|
||||
#### Implementation Tasks
|
||||
1. **Data Source Router**
|
||||
```
|
||||
pkg/service/datasource/
|
||||
├── router.go # Smart routing logic
|
||||
├── preferences.go # Source preference management
|
||||
├── fallback.go # Fallback mechanisms
|
||||
└── conflict.go # Conflict resolution
|
||||
```
|
||||
|
||||
2. **Source Management**
|
||||
- Per-device, per-endpoint source preferences
|
||||
- Dynamic source switching based on availability
|
||||
- Conflict detection and resolution
|
||||
- Source health monitoring
|
||||
|
||||
3. **Integration Points**
|
||||
- Marge service integration for account data
|
||||
- BMX service integration for content data
|
||||
- Preset and recent management integration
|
||||
- Source configuration management
|
||||
|
||||
#### Technical Requirements
|
||||
- Zero-downtime source switching
|
||||
- Conflict resolution without data loss
|
||||
- Health check integration
|
||||
- Performance monitoring and metrics
|
||||
|
||||
## Phase 3: Advanced Features and Analytics (2-3 weeks)
|
||||
|
||||
### Milestone 3.1: System Monitoring and Health Checks (1-2 weeks)
|
||||
|
||||
#### Deliverables
|
||||
- Comprehensive system health monitoring
|
||||
- Device connectivity and availability tracking
|
||||
- Performance metrics collection
|
||||
- Health check endpoints and dashboards
|
||||
|
||||
#### Implementation Tasks
|
||||
1. **Health Monitoring**
|
||||
```
|
||||
pkg/service/health/
|
||||
├── monitor.go # System health monitoring
|
||||
├── metrics.go # Performance metrics
|
||||
├── connectivity.go # Device connectivity tracking
|
||||
└── alerts.go # Health alerting
|
||||
```
|
||||
|
||||
2. **Metrics Collection**
|
||||
- Device availability tracking
|
||||
- Response time monitoring
|
||||
- Error rate tracking
|
||||
- Migration success rates
|
||||
|
||||
3. **Dashboard Integration**
|
||||
- Health status endpoints
|
||||
- Metrics export for monitoring tools
|
||||
- Real-time status updates
|
||||
- Historical trend analysis
|
||||
|
||||
#### Technical Requirements
|
||||
- Minimal performance overhead
|
||||
- Configurable monitoring intervals
|
||||
- Integration with existing health checks
|
||||
- Memory-efficient metrics storage
|
||||
|
||||
### Milestone 3.2: Data Export and Backup (1 week)
|
||||
|
||||
#### Deliverables
|
||||
- Account data export functionality
|
||||
- Incremental backup strategies
|
||||
- Data integrity verification
|
||||
- Migration-ready data formats
|
||||
|
||||
#### Implementation Tasks
|
||||
1. **Export Functionality**
|
||||
```
|
||||
pkg/service/export/
|
||||
├── exporter.go # Data export logic
|
||||
├── formats.go # Export format definitions
|
||||
├── validation.go # Data integrity checks
|
||||
└── backup.go # Backup strategies
|
||||
```
|
||||
|
||||
2. **Backup Management**
|
||||
- Incremental backup creation
|
||||
- Backup validation and verification
|
||||
- Automated backup scheduling
|
||||
- Restore functionality
|
||||
|
||||
3. **Data Formats**
|
||||
- Migration-ready JSON exports
|
||||
- XML compatibility for device imports
|
||||
- Compressed archive support
|
||||
- Selective export capabilities
|
||||
|
||||
#### Technical Requirements
|
||||
- Consistent data export across all account types
|
||||
- Backup integrity verification
|
||||
- Configurable export scheduling
|
||||
- Resource-efficient backup operations
|
||||
|
||||
## Integration Strategy
|
||||
|
||||
### Existing Service Integration Points
|
||||
|
||||
#### 1. Datastore Integration
|
||||
- Extend existing datastore with lifecycle and account management
|
||||
- Maintain backward compatibility with current file structure
|
||||
- Add new persistence methods for enhanced state tracking
|
||||
- Implement migration for existing data to new formats
|
||||
|
||||
#### 2. Handler Integration
|
||||
- Integrate account management into existing HTTP handlers
|
||||
- Add lifecycle information to device responses
|
||||
- Extend mirror middleware with disparity detection
|
||||
- Add new management endpoints alongside existing XML APIs
|
||||
|
||||
#### 3. Discovery Integration
|
||||
- Link device discovery to lifecycle state transitions
|
||||
- Integrate migration triggers with discovery events
|
||||
- Add account association during discovery
|
||||
- Maintain existing discovery functionality
|
||||
|
||||
#### 4. Migration System Integration
|
||||
- Extend existing migration manager with new capabilities
|
||||
- Integrate lifecycle management with device migrations
|
||||
- Add rollback functionality to existing migration flows
|
||||
- Maintain compatibility with current migration methods
|
||||
|
||||
### Configuration Management
|
||||
|
||||
#### New Configuration Options
|
||||
```yaml
|
||||
accounts:
|
||||
auto_create: false
|
||||
mirror_enhanced_creation: true
|
||||
default_migration_strategy: "gradual"
|
||||
|
||||
lifecycle:
|
||||
event_retention_days: 30
|
||||
state_transition_timeout: "5m"
|
||||
async_processing: true
|
||||
|
||||
mirror:
|
||||
disparity_detection: true
|
||||
disparity_sensitivity: "medium"
|
||||
source_switching_enabled: true
|
||||
fallback_timeout: "10s"
|
||||
|
||||
migration:
|
||||
batch_size: 1
|
||||
progress_reporting: true
|
||||
rollback_enabled: true
|
||||
verification_required: true
|
||||
```
|
||||
|
||||
### Performance Considerations
|
||||
|
||||
#### Resource Usage
|
||||
- Target: <100MB additional memory usage on Raspberry Pi Zero 2W
|
||||
- CPU usage: <5% additional overhead during normal operations
|
||||
- Storage: Text-based logs with configurable rotation
|
||||
- Network: Minimal additional upstream requests
|
||||
|
||||
#### Optimization Strategies
|
||||
- Lazy loading of historical data
|
||||
- Configurable log retention policies
|
||||
- Memory-efficient event processing
|
||||
- Background cleanup processes
|
||||
- Efficient file I/O operations
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
### Unit Testing
|
||||
- Comprehensive test coverage for all new packages
|
||||
- State machine transition testing
|
||||
- Data persistence and integrity tests
|
||||
- Mock integration tests for external dependencies
|
||||
|
||||
### Integration Testing
|
||||
- End-to-end migration flow testing
|
||||
- Multi-device scenario testing
|
||||
- Disparity detection accuracy testing
|
||||
- Performance impact testing
|
||||
|
||||
### Compatibility Testing
|
||||
- Backward compatibility with existing installations
|
||||
- Device compatibility across SoundTouch models
|
||||
- Migration from various existing configurations
|
||||
- Stress testing with multiple concurrent devices
|
||||
|
||||
## Deployment Strategy
|
||||
|
||||
### Rollout Plan
|
||||
1. **Alpha Release**: Core functionality with limited device support
|
||||
2. **Beta Release**: Full feature set with extensive testing
|
||||
3. **Stable Release**: Production-ready with documentation
|
||||
|
||||
### Migration Path
|
||||
1. Existing installations can upgrade incrementally
|
||||
2. New features are opt-in with configuration flags
|
||||
3. Existing data structures are preserved and extended
|
||||
4. Rollback capability for critical issues
|
||||
|
||||
### Documentation Requirements
|
||||
- Updated API documentation with new endpoints
|
||||
- Migration guide for existing users
|
||||
- Configuration reference for new options
|
||||
- Troubleshooting guide for common issues
|
||||
|
||||
## Risk Mitigation
|
||||
|
||||
### Technical Risks
|
||||
- **Data Loss**: Atomic operations and rollback capabilities
|
||||
- **Performance Impact**: Gradual rollout and monitoring
|
||||
- **Compatibility Issues**: Comprehensive testing and fallback options
|
||||
- **Resource Constraints**: Efficient algorithms and configurable limits
|
||||
|
||||
### Operational Risks
|
||||
- **Service Disruption**: Zero-downtime deployment strategies
|
||||
- **Configuration Complexity**: Sensible defaults and validation
|
||||
- **User Adoption**: Clear documentation and migration assistance
|
||||
- **Support Burden**: Comprehensive logging and diagnostic tools
|
||||
|
||||
## Success Metrics
|
||||
|
||||
### Technical Metrics
|
||||
- Migration success rate >95%
|
||||
- Disparity detection accuracy >90%
|
||||
- Performance overhead <5%
|
||||
- System availability >99.5%
|
||||
|
||||
### User Experience Metrics
|
||||
- Reduced support requests
|
||||
- Improved device reliability
|
||||
- Faster problem resolution
|
||||
- Enhanced system visibility
|
||||
|
||||
This roadmap provides a structured approach to implementing the upstream service simulation concept while maintaining compatibility with existing deployments and ensuring smooth migration paths for users.
|
||||
@@ -0,0 +1,137 @@
|
||||
# Spotify OAuth Integration
|
||||
|
||||
The SoundTouch service supports Spotify OAuth integration to broker access tokens for SoundTouch speakers. This is particularly useful for maintaining Spotify Connect functionality after the Bose cloud shutdown (scheduled for May 2026).
|
||||
|
||||
## OAuth Flows
|
||||
|
||||
The service supports two primary OAuth flows: a browser-based flow and a mobile app-based flow (specifically for the [ueberboese](https://github.com/julius-d/ueberboese-app) app).
|
||||
|
||||
### 1. Browser-based Flow
|
||||
|
||||
The user initiates the flow, completes authorization in their browser, and is redirected back to the service.
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant Client as Client (curl/app)
|
||||
participant Service as Service
|
||||
participant Spotify as Spotify Auth Server
|
||||
participant Browser as User's Browser
|
||||
|
||||
Client->>Service: POST /mgmt/spotify/init [Basic Auth]
|
||||
Service-->>Client: {"redirectUrl": "https://accounts.spotify.com/authorize?..."}
|
||||
|
||||
Client->>Browser: User opens URL
|
||||
Browser->>Spotify: User logs in & grants access
|
||||
Spotify-->>Browser: Redirect to /mgmt/spotify/callback?code=abc
|
||||
|
||||
Browser->>Service: GET /mgmt/spotify/callback?code=abc
|
||||
Note over Service: No auth needed for callback
|
||||
|
||||
Service->>Spotify: POST /api/token (exchange code)
|
||||
Spotify-->>Service: {access_token, refresh_token}
|
||||
|
||||
Service->>Spotify: GET /v1/me (fetch profile)
|
||||
Spotify-->>Service: {id, display_name, email}
|
||||
|
||||
Note over Service: Store account to disk
|
||||
|
||||
Service-->>Browser: HTML: "Spotify Connected. You can close this window."
|
||||
```
|
||||
|
||||
### 2. Mobile App Flow (ueberboese)
|
||||
|
||||
The mobile app handles the redirect via a deep link and then confirms the authorization with the service.
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant App as ueberboese Flutter App
|
||||
participant Service as Service
|
||||
participant Spotify as Spotify Auth Server
|
||||
|
||||
App->>Service: POST /mgmt/spotify/init [Basic Auth]
|
||||
Service-->>App: {"redirectUrl": "https://..."}
|
||||
|
||||
App->>Spotify: Open in-app browser (User authorizes)
|
||||
Spotify-->>App: Deep link redirect: ueberboese-login://spotify?code=abc
|
||||
|
||||
App->>Service: POST /mgmt/spotify/confirm?code=abc [Basic Auth]
|
||||
|
||||
Service->>Spotify: POST /api/token (exchange code)
|
||||
Spotify-->>Service: {access_token, refresh_token}
|
||||
|
||||
Service->>Spotify: GET /v1/me (fetch profile)
|
||||
Spotify-->>Service: {profile}
|
||||
|
||||
Service-->>App: {"ok": true}
|
||||
```
|
||||
|
||||
### 3. Token Retrieval (Boot Primer / Speaker Setup)
|
||||
|
||||
Once an account is linked, access tokens can be retrieved for use with speakers (e.g., via the `addUser` ZeroConf command).
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant Primer as Boot Primer Script
|
||||
participant Service as Service
|
||||
participant Spotify as Spotify Token API
|
||||
participant Speaker as Speaker (Bose ST 20)
|
||||
|
||||
Primer->>Service: GET /mgmt/spotify/token [Basic Auth]
|
||||
|
||||
alt Token expired
|
||||
Service->>Spotify: POST /api/token (refresh)
|
||||
Spotify-->>Service: new tokens
|
||||
end
|
||||
|
||||
Service-->>Primer: {"access_token": "...", "username": "..."}
|
||||
|
||||
Note over Primer: Spotify Connect ZeroConf
|
||||
Primer->>Speaker: POST /SpotifyConnect (addUser with token)
|
||||
Speaker-->>Primer: OK
|
||||
Note over Speaker: Speaker now has Spotify access
|
||||
```
|
||||
|
||||
## Boot Primer Script
|
||||
|
||||
A boot primer script that uses these endpoints to feed Spotify tokens to speakers via ZeroConf is available in the `scripts/spotify/` directory: [spotify-boot-primer.sh](../../scripts/spotify/spotify-boot-primer.sh).
|
||||
|
||||
This script can be installed on the speaker itself (which runs embedded Linux) to automatically prime Spotify Connect at boot time. See [README.md](../../scripts/spotify/README.md) and [INSTALL.md](../../scripts/spotify/INSTALL.md) for instructions.
|
||||
|
||||
### Automated Installation via Service
|
||||
|
||||
The SoundTouch service provides a dedicated management endpoint to automatically handle the installation of the Spotify boot primer on the speaker:
|
||||
`POST /mgmt/devices/{deviceId}/spotify/install-primer`
|
||||
|
||||
### Automated Installation Steps
|
||||
When you run the Spotify primer installation, the service performs the following:
|
||||
1. **Directories**: Creates `/mnt/nv/bin` and `/mnt/nv/BoseApp-Persistence/1` on the speaker.
|
||||
2. **Binary**: Uploads the `spotify-boot-primer` script to the speaker.
|
||||
3. **Configuration**: Automatically generates and uploads `spotify-primer.conf` containing the service's URL and management credentials.
|
||||
4. **Boot Hook**: Injects a call to the primer in the speaker's `/mnt/nv/rc.local` using idempotent markers.
|
||||
5. **Environment**: Updates `/mnt/nv/.profile` to include `/mnt/nv/bin` in the `PATH` for easier manual troubleshooting via SSH.
|
||||
|
||||
- **Idempotent Patching**: The service uses explicit markers to inject the hook, ensuring it doesn't corrupt existing content.
|
||||
- **Coexistence**: The service-injected hook is designed to coexist with a manually installed `rc.local` (e.g., from the community gist). It only adds a call to `/mnt/nv/bin/spotify-boot-primer` if it's not already managed by a service-controlled block.
|
||||
- **Markers**: Look for the following markers in your speaker's `/mnt/nv/rc.local`:
|
||||
- `# --- Aftertouch Spotify hook START ---`
|
||||
- `# --- Aftertouch Spotify hook END ---`
|
||||
- **Cleanup**: Reverting a migration via the service will cleanly remove these marker-delimited blocks.
|
||||
|
||||
## Endpoints
|
||||
|
||||
| Method | Path | Auth | Purpose |
|
||||
|--------|---------------------------------------------------|-------|-----------------------------------------------------------------------|
|
||||
| POST | `/mgmt/devices/{deviceId}/spotify/install-primer` | Basic | Install Spotify boot primer on speaker (deviceId or IP) |
|
||||
| GET | `/mgmt/spotify/callback` | None | Browser OAuth callback (redirect from Spotify, returns HTML) |
|
||||
| POST | `/mgmt/spotify/init` | Basic | Start OAuth flow, returns authorization URL |
|
||||
| POST | `/mgmt/spotify/confirm` | Basic | Mobile app confirm (ueberboese deep link delivers code, returns JSON) |
|
||||
| GET | `/mgmt/spotify/accounts` | Basic | List linked Spotify accounts (tokens stripped) |
|
||||
| GET | `/mgmt/spotify/token` | Basic | Get fresh access token (auto-refreshes if expired) |
|
||||
| POST | `/mgmt/spotify/entity` | Basic | Resolve Spotify URI to name + image URL |
|
||||
|
||||
## Security
|
||||
|
||||
- `/mgmt/spotify/callback` is intentionally outside Basic Auth to allow direct redirects from Spotify's authorization server.
|
||||
- All other `/mgmt/*` endpoints require Basic Auth as configured by `--mgmt-username` and `--mgmt-password`.
|
||||
- Tokens are persisted to disk as JSON with restricted file permissions (`0600`).
|
||||
- The `GetAccounts` endpoint strips sensitive tokens from the response.
|
||||
@@ -0,0 +1,84 @@
|
||||
# Spotify Priming Strategy
|
||||
|
||||
This document outlines the strategy for ensuring Bose SoundTouch devices are correctly "primed" for Spotify Connect integration within the AfterTouch ecosystem.
|
||||
|
||||
## Overview
|
||||
|
||||
To enable Spotify Connect for SoundTouch devices, especially for remote availability outside the local network, the speaker must be associated with a Spotify account via a process called "priming." This involves sending an `addUser` command to the speaker's ZeroConf API (port 8200) containing a valid Spotify username and OAuth access token.
|
||||
|
||||
AfterTouch adopts a **Server-Centric Hybrid Model** that prioritizes device cleanliness and user intent while providing automated self-healing.
|
||||
|
||||
## Core Principles
|
||||
|
||||
### 1. User Intent (Opt-in)
|
||||
AfterTouch replicates the native Bose "Add Source" experience. No Spotify priming occurs until a user explicitly links their Spotify account through the AfterTouch Management Dashboard. This ensures privacy and respects users who do not wish to use Spotify.
|
||||
|
||||
### 2. Device Cleanliness (Minimalist Footprint)
|
||||
We avoid invasive modifications to the speaker's filesystem.
|
||||
- **No On-Device Scripts:** We deprecate the use of internal boot-primer scripts.
|
||||
- **Native Communication:** We rely on the speaker's native ability to talk to Bose services, which are intercepted via DNS to point to the AfterTouch server.
|
||||
|
||||
### 3. Triggers for Priming
|
||||
Priming is triggered when the speaker signals it is active and ready, specifically:
|
||||
|
||||
- **Power On:** When the speaker calls the `/marge/streaming/support/power_on` endpoint, AfterTouch ensures the device's ZeroConf state is correctly primed. This is the primary trigger.
|
||||
- **Manual Override:** Users can manually trigger a "Prime Spotify" from the device list in the UI if needed.
|
||||
|
||||
During any of these events, the server:
|
||||
1. Checks if a Spotify account is linked in AfterTouch.
|
||||
2. Checks the device's current priming status (via ZeroConf).
|
||||
3. If unprimed and an account is linked, it pushes the priming command.
|
||||
|
||||
### 4. Automated Recovery
|
||||
AfterTouch ensures that if a speaker loses its session (due to a crash or power loss), it is re-primed when it next powers on and reaches out to the service.
|
||||
|
||||
### 5. Decoupling
|
||||
The logic for account management and device interaction remains decoupled:
|
||||
- **Spotify Service:** Manages OAuth tokens and account state.
|
||||
- **Discovery Service:** Finds devices and tracks their network presence.
|
||||
- **Orchestrator:** Connects the two, deciding when to push tokens to discovered devices based on the current link status.
|
||||
|
||||
## Workflow
|
||||
|
||||
### Initial Setup (The "Add Source" UX)
|
||||
1. User opens the AfterTouch Dashboard.
|
||||
2. User selects "Link Spotify Account."
|
||||
3. OAuth flow completes; AfterTouch stores the token.
|
||||
4. AfterTouch immediately triggers a discovery run to find and prime all compatible speakers.
|
||||
|
||||
### Maintenance (The "Watchdog" UX)
|
||||
1. A speaker reboots or loses its token.
|
||||
2. A discovery event occurs (periodic or triggered by UI).
|
||||
3. AfterTouch detects the "Empty" user state on the speaker.
|
||||
4. AfterTouch pushes a fresh token from the Spotify Service.
|
||||
5. UI reflects that the device is "Managed by AfterTouch" and healthy.
|
||||
|
||||
### Manual Override
|
||||
Users can manually trigger a "Re-prime" or "Refresh Link" from the device list in the UI if they suspect the automated self-healing is delayed or if they want to force a specific account onto a device.
|
||||
|
||||
## Network Topology & Deployment Scenarios
|
||||
|
||||
The strategy adapts based on where the AfterTouch server is deployed:
|
||||
|
||||
### Local Deployment (Home Server / Docker)
|
||||
- **Mechanism:** Both "Pull" (Marge) and "Push" (ZeroConf side-channel) are used.
|
||||
- **Advantage:** The server can proactively fix the speaker's state via port 8200 as soon as it sees a "Liveness Signal."
|
||||
|
||||
### External Deployment (Cloud VPS)
|
||||
- **Mechanism:** Primarily relies on "Pull" (Marge).
|
||||
- **Constraint:** The server cannot reach port 8200 on the speaker due to NAT/Firewall.
|
||||
- **Strategy:** In this scenario, AfterTouch acts as a passive token provider. The speaker must initiate the connection to our intercepted Bose endpoints to receive its Spotify configuration. If the speaker completely loses its user state and stops "pulling," a manual re-prime from a local machine or a temporary local discovery run might be required.
|
||||
|
||||
## Transition & Cleanup
|
||||
|
||||
As AfterTouch moves to the Server-Centric model, we will:
|
||||
1. **Revert On-Device Migration:** Update the Setup Manager to remove legacy `spotify-boot-primer` scripts and `rc.local` hooks from the speakers.
|
||||
2. **Consolidated Directory:** We maintain the `/mnt/nv/soundtouch-service/` base directory for other configuration needs (e.g., `aftertouch.resolv.conf`), but it will no longer contain Spotify-specific credentials or scripts.
|
||||
3. **No On-Device Credentials:** The `/mnt/nv/soundtouch-service/spotify-primer.conf` will be removed, ensuring that no sensitive AfterTouch login details are stored on the speaker in plain text.
|
||||
|
||||
## Implementation Roadmap (Conceptual)
|
||||
|
||||
1. **Revert On-Device Migration:** Update the Setup Manager to remove legacy scripts and `rc.local` hooks.
|
||||
2. **Server-Side Priming Logic:** Implement a `PrimeDevice(ip)` method in the server that fetches a fresh token and calls the ZeroConf API.
|
||||
3. **Discovery Hook:** Integrate `PrimeDevice` into the discovery handler (`handleDiscoveredDevice`) with a check for unprimed state.
|
||||
4. **UI Enhancements:** Update the Speaker List to show "Spotify Linked" status and provide manual refresh buttons.
|
||||
@@ -0,0 +1,989 @@
|
||||
# Technical Specification - Enhanced State Management System
|
||||
|
||||
## Table of Contents
|
||||
|
||||
1. [System Architecture](#system-architecture)
|
||||
2. [Data Models](#data-models)
|
||||
3. [API Specifications](#api-specifications)
|
||||
4. [File Format Specifications](#file-format-specifications)
|
||||
5. [State Machine Definitions](#state-machine-definitions)
|
||||
6. [Event Processing](#event-processing)
|
||||
7. [Performance Requirements](#performance-requirements)
|
||||
8. [Security Considerations](#security-considerations)
|
||||
9. [Error Handling](#error-handling)
|
||||
10. [Monitoring and Observability](#monitoring-and-observability)
|
||||
|
||||
## System Architecture
|
||||
|
||||
### Component Overview
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ SoundTouch Service │
|
||||
├─────────────────────────────────────────────────────────────┤
|
||||
│ HTTP Router & Middleware │
|
||||
│ ├── Mirror Middleware (Enhanced) │
|
||||
│ ├── Recorder Middleware │
|
||||
│ ├── Disparity Detection │
|
||||
│ └── Health Check Middleware │
|
||||
├─────────────────────────────────────────────────────────────┤
|
||||
│ Service Layer │
|
||||
│ ├── Account Manager ├── Lifecycle Manager │
|
||||
│ ├── Migration Controller ├── Data Source Router │
|
||||
│ ├── Event Processor ├── Health Monitor │
|
||||
│ └── Export Manager └── Analytics Engine │
|
||||
├─────────────────────────────────────────────────────────────┤
|
||||
│ Data Layer │
|
||||
│ ├── Enhanced DataStore ├── Event Store │
|
||||
│ ├── Mirror Cache ├── Metrics Store │
|
||||
│ └── Configuration Store └── Session Store │
|
||||
├─────────────────────────────────────────────────────────────┤
|
||||
│ External Integrations │
|
||||
│ ├── Bose Services (Mirror) ├── Device Discovery │
|
||||
│ ├── BMX/TuneIn Services └── SSH/Setup Manager │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### Package Structure
|
||||
|
||||
```
|
||||
pkg/service/
|
||||
├── account/ # Account management
|
||||
│ ├── manager.go
|
||||
│ ├── persistence.go
|
||||
│ └── validation.go
|
||||
├── lifecycle/ # Device lifecycle management
|
||||
│ ├── manager.go
|
||||
│ ├── states.go
|
||||
│ ├── transitions.go
|
||||
│ └── events.go
|
||||
├── migration/ # Enhanced migration (extends existing)
|
||||
│ ├── controller.go
|
||||
│ ├── strategies.go
|
||||
│ └── progress.go
|
||||
├── datasource/ # Data source routing
|
||||
│ ├── router.go
|
||||
│ ├── preferences.go
|
||||
│ └── fallback.go
|
||||
├── events/ # Event processing system
|
||||
│ ├── processor.go
|
||||
│ ├── queue.go
|
||||
│ └── storage.go
|
||||
├── mirror/ # Enhanced mirroring (extends existing)
|
||||
│ ├── disparity.go
|
||||
│ ├── analyzer.go
|
||||
│ └── logger.go
|
||||
├── health/ # System monitoring
|
||||
│ ├── monitor.go
|
||||
│ ├── metrics.go
|
||||
│ └── alerts.go
|
||||
└── export/ # Data export and backup
|
||||
├── exporter.go
|
||||
├── formats.go
|
||||
└── backup.go
|
||||
```
|
||||
|
||||
## Data Models
|
||||
|
||||
### Account Model
|
||||
|
||||
```go
|
||||
type Account struct {
|
||||
ID string `json:"id"`
|
||||
Name string `json:"name"`
|
||||
Email string `json:"email,omitempty"`
|
||||
CreatedAt time.Time `json:"created_at"`
|
||||
UpdatedAt time.Time `json:"updated_at"`
|
||||
Status AccountStatus `json:"status"`
|
||||
DeviceCount int `json:"device_count"`
|
||||
MigrationInfo *MigrationInfo `json:"migration_info,omitempty"`
|
||||
BoseAccountID string `json:"bose_account_id,omitempty"`
|
||||
DataSources DataSourceConfig `json:"data_sources"`
|
||||
Settings AccountSettings `json:"settings"`
|
||||
}
|
||||
|
||||
type AccountStatus string
|
||||
const (
|
||||
AccountStatusActive AccountStatus = "active"
|
||||
AccountStatusMigrating AccountStatus = "migrating"
|
||||
AccountStatusSuspended AccountStatus = "suspended"
|
||||
AccountStatusArchived AccountStatus = "archived"
|
||||
)
|
||||
|
||||
type MigrationInfo struct {
|
||||
StartedAt time.Time `json:"started_at"`
|
||||
CompletedAt *time.Time `json:"completed_at,omitempty"`
|
||||
DevicesMigrated int `json:"devices_migrated"`
|
||||
DevicesPending int `json:"devices_pending"`
|
||||
MirrorActive bool `json:"mirror_active"`
|
||||
Strategy string `json:"strategy"`
|
||||
RollbackData string `json:"rollback_data,omitempty"`
|
||||
}
|
||||
|
||||
type DataSourceConfig struct {
|
||||
Local bool `json:"local"`
|
||||
BoseMirror bool `json:"bose_mirror"`
|
||||
Primary string `json:"primary"` // "local" or "bose"
|
||||
}
|
||||
|
||||
type AccountSettings struct {
|
||||
AutoMigration bool `json:"auto_migration"`
|
||||
MirrorEndpoints []string `json:"mirror_endpoints"`
|
||||
RetentionDays int `json:"retention_days"`
|
||||
}
|
||||
```
|
||||
|
||||
### Device Lifecycle Model
|
||||
|
||||
```go
|
||||
type DeviceLifecycle struct {
|
||||
DeviceID string `json:"device_id"`
|
||||
AccountID string `json:"account_id"`
|
||||
State DeviceState `json:"state"`
|
||||
CreatedAt time.Time `json:"created_at"`
|
||||
UpdatedAt time.Time `json:"updated_at"`
|
||||
StateHistory []StateTransition `json:"state_history"`
|
||||
Metadata DeviceMetadata `json:"metadata"`
|
||||
DataSources DataSourceConfig `json:"data_sources"`
|
||||
Migration *DeviceMigration `json:"migration,omitempty"`
|
||||
Health DeviceHealth `json:"health"`
|
||||
}
|
||||
|
||||
type DeviceState string
|
||||
const (
|
||||
DeviceStateUnregistered DeviceState = "unregistered"
|
||||
DeviceStateDiscovered DeviceState = "discovered"
|
||||
DeviceStateRegistering DeviceState = "registering"
|
||||
DeviceStateActive DeviceState = "active"
|
||||
DeviceStateMigrating DeviceState = "migrating"
|
||||
DeviceStateOffline DeviceState = "offline"
|
||||
DeviceStateError DeviceState = "error"
|
||||
DeviceStateRetired DeviceState = "retired"
|
||||
)
|
||||
|
||||
type StateTransition struct {
|
||||
From DeviceState `json:"from"`
|
||||
To DeviceState `json:"to"`
|
||||
Timestamp time.Time `json:"timestamp"`
|
||||
Reason string `json:"reason"`
|
||||
Source string `json:"source"`
|
||||
Context map[string]interface{} `json:"context,omitempty"`
|
||||
}
|
||||
|
||||
type DeviceMetadata struct {
|
||||
Name string `json:"name"`
|
||||
Type string `json:"type"`
|
||||
SerialNumber string `json:"serial_number"`
|
||||
FirmwareVersion string `json:"firmware_version"`
|
||||
MACAddress string `json:"mac_address"`
|
||||
IPAddress string `json:"ip_address"`
|
||||
LastSeen time.Time `json:"last_seen"`
|
||||
IsLegacyID bool `json:"is_legacy_id"`
|
||||
Capabilities []string `json:"capabilities,omitempty"`
|
||||
}
|
||||
|
||||
type DeviceMigration struct {
|
||||
FromBoseAccount string `json:"from_bose_account,omitempty"`
|
||||
MigratedAt *time.Time `json:"migrated_at,omitempty"`
|
||||
Method string `json:"method"`
|
||||
RollbackAvailable bool `json:"rollback_available"`
|
||||
DataPreserved []string `json:"data_preserved"`
|
||||
}
|
||||
|
||||
type DeviceHealth struct {
|
||||
Status string `json:"status"` // "healthy", "warning", "error"
|
||||
LastCheck time.Time `json:"last_check"`
|
||||
ResponseTime int `json:"response_time_ms"`
|
||||
Connectivity string `json:"connectivity"` // "online", "offline", "intermittent"
|
||||
ErrorCount int `json:"error_count"`
|
||||
LastError string `json:"last_error,omitempty"`
|
||||
}
|
||||
```
|
||||
|
||||
### Event Model
|
||||
|
||||
```go
|
||||
type DeviceEvent struct {
|
||||
ID string `json:"id"`
|
||||
DeviceID string `json:"device_id"`
|
||||
AccountID string `json:"account_id"`
|
||||
Type DeviceEventType `json:"type"`
|
||||
Data map[string]interface{} `json:"data"`
|
||||
Timestamp time.Time `json:"timestamp"`
|
||||
Source EventSource `json:"source"`
|
||||
Processed bool `json:"processed"`
|
||||
Context EventContext `json:"context"`
|
||||
}
|
||||
|
||||
type DeviceEventType string
|
||||
const (
|
||||
EventTypeNowPlaying DeviceEventType = "now_playing"
|
||||
EventTypePresetChanged DeviceEventType = "preset_changed"
|
||||
EventTypeVolumeChanged DeviceEventType = "volume_changed"
|
||||
EventTypeSourceChanged DeviceEventType = "source_changed"
|
||||
EventTypeDeviceOnline DeviceEventType = "device_online"
|
||||
EventTypeDeviceOffline DeviceEventType = "device_offline"
|
||||
EventTypeZoneChanged DeviceEventType = "zone_changed"
|
||||
EventTypeDisparityFound DeviceEventType = "disparity_found"
|
||||
EventTypeMigrationStart DeviceEventType = "migration_start"
|
||||
EventTypeMigrationEnd DeviceEventType = "migration_end"
|
||||
EventTypeHealthCheck DeviceEventType = "health_check"
|
||||
EventTypeErrorOccurred DeviceEventType = "error_occurred"
|
||||
)
|
||||
|
||||
type EventSource string
|
||||
const (
|
||||
EventSourceWebSocket EventSource = "websocket"
|
||||
EventSourceDiscovery EventSource = "discovery"
|
||||
EventSourceMirror EventSource = "mirror"
|
||||
EventSourceSystem EventSource = "system"
|
||||
EventSourceAPI EventSource = "api"
|
||||
EventSourceUser EventSource = "user"
|
||||
)
|
||||
|
||||
type EventContext struct {
|
||||
RequestID string `json:"request_id,omitempty"`
|
||||
UserAgent string `json:"user_agent,omitempty"`
|
||||
IPAddress string `json:"ip_address,omitempty"`
|
||||
Endpoint string `json:"endpoint,omitempty"`
|
||||
Additional map[string]interface{} `json:"additional,omitempty"`
|
||||
}
|
||||
```
|
||||
|
||||
### Disparity Model
|
||||
|
||||
```go
|
||||
type Disparity struct {
|
||||
ID string `json:"id"`
|
||||
Timestamp time.Time `json:"timestamp"`
|
||||
DeviceID string `json:"device_id"`
|
||||
AccountID string `json:"account_id"`
|
||||
Endpoint string `json:"endpoint"`
|
||||
Type DisparityType `json:"type"`
|
||||
Severity DisparitySeverity `json:"severity"`
|
||||
LocalHash string `json:"local_hash"`
|
||||
UpstreamHash string `json:"upstream_hash"`
|
||||
Details DisparityDetails `json:"details"`
|
||||
Context map[string]interface{} `json:"context"`
|
||||
Resolved bool `json:"resolved"`
|
||||
}
|
||||
|
||||
type DisparityType string
|
||||
const (
|
||||
DisparityTypeContentMismatch DisparityType = "content_mismatch"
|
||||
DisparityTypeStructureDiff DisparityType = "structure_diff"
|
||||
DisparityTypeTimestampFormat DisparityType = "timestamp_format"
|
||||
DisparityTypeFieldMissing DisparityType = "field_missing"
|
||||
DisparityTypeValueMismatch DisparityType = "value_mismatch"
|
||||
DisparityTypeCountMismatch DisparityType = "count_mismatch"
|
||||
)
|
||||
|
||||
type DisparitySeverity string
|
||||
const (
|
||||
DisparitySeverityLow DisparitySeverity = "low"
|
||||
DisparitySeverityMedium DisparitySeverity = "medium"
|
||||
DisparitySeverityHigh DisparitySeverity = "high"
|
||||
DisparitySeverityCritical DisparitySeverity = "critical"
|
||||
)
|
||||
|
||||
type DisparityDetails struct {
|
||||
FieldPath string `json:"field_path"`
|
||||
LocalValue interface{} `json:"local_value"`
|
||||
UpstreamValue interface{} `json:"upstream_value"`
|
||||
Description string `json:"description"`
|
||||
}
|
||||
```
|
||||
|
||||
## API Specifications
|
||||
|
||||
### Account Management APIs
|
||||
|
||||
#### Create Account
|
||||
```http
|
||||
POST /api/v1/accounts
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"name": "User Account",
|
||||
"email": "user@example.com",
|
||||
"settings": {
|
||||
"auto_migration": false,
|
||||
"retention_days": 30
|
||||
}
|
||||
}
|
||||
|
||||
Response: 201 Created
|
||||
{
|
||||
"id": "acc_12345",
|
||||
"name": "User Account",
|
||||
"email": "user@example.com",
|
||||
"created_at": "2024-01-20T10:00:00Z",
|
||||
"status": "active",
|
||||
"device_count": 0
|
||||
}
|
||||
```
|
||||
|
||||
#### Get Account
|
||||
```http
|
||||
GET /api/v1/accounts/{account_id}
|
||||
|
||||
Response: 200 OK
|
||||
{
|
||||
"id": "acc_12345",
|
||||
"name": "User Account",
|
||||
"status": "active",
|
||||
"device_count": 2,
|
||||
"migration_info": {
|
||||
"started_at": "2024-01-18T09:00:00Z",
|
||||
"devices_migrated": 1,
|
||||
"devices_pending": 1,
|
||||
"mirror_active": true
|
||||
},
|
||||
"data_sources": {
|
||||
"local": true,
|
||||
"bose_mirror": true,
|
||||
"primary": "bose"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### List Accounts
|
||||
```http
|
||||
GET /api/v1/accounts?status=active&limit=10&offset=0
|
||||
|
||||
Response: 200 OK
|
||||
{
|
||||
"accounts": [...],
|
||||
"total": 5,
|
||||
"limit": 10,
|
||||
"offset": 0
|
||||
}
|
||||
```
|
||||
|
||||
### Device Lifecycle APIs
|
||||
|
||||
#### Register Device
|
||||
```http
|
||||
POST /api/v1/accounts/{account_id}/devices
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"device_id": "A81B6A536A98",
|
||||
"name": "Living Room Speaker",
|
||||
"registration_type": "fresh"
|
||||
}
|
||||
|
||||
Response: 201 Created
|
||||
{
|
||||
"device_id": "A81B6A536A98",
|
||||
"account_id": "acc_12345",
|
||||
"state": "registering",
|
||||
"created_at": "2024-01-20T10:00:00Z"
|
||||
}
|
||||
```
|
||||
|
||||
#### Get Device State
|
||||
```http
|
||||
GET /api/v1/accounts/{account_id}/devices/{device_id}/state
|
||||
|
||||
Response: 200 OK
|
||||
{
|
||||
"device_id": "A81B6A536A98",
|
||||
"account_id": "acc_12345",
|
||||
"state": "active",
|
||||
"metadata": {
|
||||
"name": "Living Room Speaker",
|
||||
"type": "SoundTouch 30",
|
||||
"last_seen": "2024-01-20T15:30:00Z"
|
||||
},
|
||||
"health": {
|
||||
"status": "healthy",
|
||||
"connectivity": "online",
|
||||
"response_time": 45
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Migrate Device
|
||||
```http
|
||||
POST /api/v1/accounts/{account_id}/devices/{device_id}/migrate
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"from_bose_account": "bose-acc-xyz",
|
||||
"preserve_data": true,
|
||||
"method": "gradual"
|
||||
}
|
||||
|
||||
Response: 202 Accepted
|
||||
{
|
||||
"migration_id": "mig_67890",
|
||||
"status": "started",
|
||||
"estimated_completion": "2024-01-20T11:00:00Z"
|
||||
}
|
||||
```
|
||||
|
||||
### Event APIs
|
||||
|
||||
#### Get Device Events
|
||||
```http
|
||||
GET /api/v1/accounts/{account_id}/devices/{device_id}/events?since=2024-01-20T00:00:00Z&type=now_playing&limit=50
|
||||
|
||||
Response: 200 OK
|
||||
{
|
||||
"events": [
|
||||
{
|
||||
"id": "evt_12345",
|
||||
"type": "now_playing",
|
||||
"timestamp": "2024-01-20T15:30:00Z",
|
||||
"data": {
|
||||
"source": "SPOTIFY",
|
||||
"track": "Song Name",
|
||||
"artist": "Artist Name"
|
||||
}
|
||||
}
|
||||
],
|
||||
"total": 125,
|
||||
"has_more": true
|
||||
}
|
||||
```
|
||||
|
||||
#### Stream Events
|
||||
```http
|
||||
GET /api/v1/accounts/{account_id}/devices/{device_id}/events/stream
|
||||
Accept: text/event-stream
|
||||
|
||||
Response: 200 OK
|
||||
Content-Type: text/event-stream
|
||||
|
||||
data: {"id":"evt_12346","type":"volume_changed","timestamp":"2024-01-20T15:31:00Z","data":{"volume":50}}
|
||||
|
||||
data: {"id":"evt_12347","type":"now_playing","timestamp":"2024-01-20T15:32:00Z","data":{"source":"TUNEIN"}}
|
||||
```
|
||||
|
||||
### Monitoring APIs
|
||||
|
||||
#### System Health
|
||||
```http
|
||||
GET /api/v1/system/health
|
||||
|
||||
Response: 200 OK
|
||||
{
|
||||
"status": "healthy",
|
||||
"timestamp": "2024-01-20T15:30:00Z",
|
||||
"services": {
|
||||
"account_manager": "healthy",
|
||||
"lifecycle_manager": "healthy",
|
||||
"event_processor": "healthy",
|
||||
"mirror_service": "warning"
|
||||
},
|
||||
"statistics": {
|
||||
"total_accounts": 5,
|
||||
"total_devices": 12,
|
||||
"active_devices": 10,
|
||||
"events_processed_24h": 1547
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Disparity Analysis
|
||||
```http
|
||||
GET /api/v1/system/disparities?since=2024-01-20T00:00:00Z&severity=high
|
||||
|
||||
Response: 200 OK
|
||||
{
|
||||
"disparities": [
|
||||
{
|
||||
"id": "disp_12345",
|
||||
"timestamp": "2024-01-20T14:30:00Z",
|
||||
"endpoint": "/v1/presets",
|
||||
"type": "count_mismatch",
|
||||
"severity": "high",
|
||||
"details": {
|
||||
"field_path": "preset_count",
|
||||
"local_value": 5,
|
||||
"upstream_value": 4
|
||||
}
|
||||
}
|
||||
],
|
||||
"summary": {
|
||||
"total": 15,
|
||||
"by_severity": {
|
||||
"high": 2,
|
||||
"medium": 8,
|
||||
"low": 5
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## File Format Specifications
|
||||
|
||||
### Account Metadata (account.json)
|
||||
```json
|
||||
{
|
||||
"version": "1.0",
|
||||
"id": "acc_12345",
|
||||
"name": "User Account",
|
||||
"email": "user@example.com",
|
||||
"created_at": "2024-01-20T10:00:00Z",
|
||||
"updated_at": "2024-01-20T15:30:00Z",
|
||||
"status": "active",
|
||||
"device_count": 2,
|
||||
"migration_info": {
|
||||
"started_at": "2024-01-18T09:00:00Z",
|
||||
"devices_migrated": 1,
|
||||
"devices_pending": 1,
|
||||
"mirror_active": true,
|
||||
"strategy": "gradual"
|
||||
},
|
||||
"bose_account_id": "bose-original-id",
|
||||
"data_sources": {
|
||||
"local": true,
|
||||
"bose_mirror": true,
|
||||
"primary": "bose"
|
||||
},
|
||||
"settings": {
|
||||
"auto_migration": false,
|
||||
"mirror_endpoints": ["/v1/presets", "/v1/recents"],
|
||||
"retention_days": 30
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Device Lifecycle (lifecycle.json)
|
||||
```json
|
||||
{
|
||||
"version": "1.0",
|
||||
"device_id": "A81B6A536A98",
|
||||
"account_id": "acc_12345",
|
||||
"state": "active",
|
||||
"created_at": "2024-01-20T10:00:00Z",
|
||||
"updated_at": "2024-01-20T15:30:00Z",
|
||||
"state_history": [
|
||||
{
|
||||
"from": "unregistered",
|
||||
"to": "discovered",
|
||||
"timestamp": "2024-01-20T10:00:00Z",
|
||||
"reason": "mdns_discovery",
|
||||
"source": "discovery",
|
||||
"context": {
|
||||
"ip_address": "192.168.1.100",
|
||||
"discovery_method": "mdns"
|
||||
}
|
||||
},
|
||||
{
|
||||
"from": "discovered",
|
||||
"to": "active",
|
||||
"timestamp": "2024-01-20T10:05:00Z",
|
||||
"reason": "registration_complete",
|
||||
"source": "system"
|
||||
}
|
||||
],
|
||||
"metadata": {
|
||||
"name": "Living Room Speaker",
|
||||
"type": "SoundTouch 30",
|
||||
"serial_number": "I6332527703739342000020",
|
||||
"firmware_version": "4.8.1.25341.2677643.1597353330",
|
||||
"mac_address": "A8:1B:6A:53:6A:98",
|
||||
"ip_address": "192.168.1.100",
|
||||
"last_seen": "2024-01-20T15:30:00Z",
|
||||
"is_legacy_id": false,
|
||||
"capabilities": ["multiroom", "bluetooth", "aux"]
|
||||
},
|
||||
"data_sources": {
|
||||
"presets": "local",
|
||||
"recents": "mirror_primary",
|
||||
"sources": "local"
|
||||
},
|
||||
"migration": {
|
||||
"from_bose_account": "bose-acc-xyz",
|
||||
"migrated_at": "2024-01-18T14:30:00Z",
|
||||
"method": "gradual",
|
||||
"rollback_available": true,
|
||||
"data_preserved": ["presets", "recents", "sources"]
|
||||
},
|
||||
"health": {
|
||||
"status": "healthy",
|
||||
"last_check": "2024-01-20T15:30:00Z",
|
||||
"response_time": 45,
|
||||
"connectivity": "online",
|
||||
"error_count": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Event Log Format (events.log)
|
||||
```
|
||||
# SoundTouch Service Event Log - Device A81B6A536A98
|
||||
# Format: TIMESTAMP|EVENT_ID|EVENT_TYPE|SOURCE|DATA_JSON
|
||||
# Version: 1.0
|
||||
|
||||
2024-01-20T15:30:00.123Z|evt_12345|now_playing|websocket|{"source":"SPOTIFY","track":"Song Name","artist":"Artist Name","album":"Album Name"}
|
||||
2024-01-20T15:30:30.456Z|evt_12346|volume_changed|websocket|{"volume":45,"muted":false,"previous_volume":40}
|
||||
2024-01-20T15:31:00.789Z|evt_12347|preset_selected|websocket|{"preset":1,"source":"SPOTIFY","location":"spotify:track:123abc"}
|
||||
2024-01-20T15:31:15.012Z|evt_12348|disparity_detected|mirror|{"endpoint":"/v1/presets","local_hash":"abc123","upstream_hash":"def456","severity":"medium"}
|
||||
2024-01-20T15:32:00.345Z|evt_12349|health_check|system|{"response_time":42,"status":"healthy","connectivity":"online"}
|
||||
```
|
||||
|
||||
### Disparity Log Format (disparities.log)
|
||||
```
|
||||
# SoundTouch Service Disparity Log
|
||||
# Format: TIMESTAMP|DISPARITY_ID|DEVICE_ID|ACCOUNT_ID|ENDPOINT|TYPE|SEVERITY|DETAILS_JSON
|
||||
# Version: 1.0
|
||||
|
||||
2024-01-20T15:31:15.012Z|disp_12345|A81B6A536A98|acc_12345|/v1/presets|count_mismatch|medium|{"field_path":"preset_count","local_value":5,"upstream_value":4,"description":"Local has one additional preset"}
|
||||
2024-01-20T15:32:45.678Z|disp_12346|A81B6A536A98|acc_12345|/v1/recents|timestamp_format|low|{"field_path":"recent[0].utc_time","local_value":"2024-01-20T15:30:00Z","upstream_value":"1705761000","description":"Timestamp format difference"}
|
||||
2024-01-20T15:35:20.901Z|disp_12347|B92C7B647B09|acc_12345|/v1/account/full|structure_diff|high|{"field_path":"device[1].ip_address","local_value":"present","upstream_value":"missing","description":"IP address field missing in upstream response"}
|
||||
```
|
||||
|
||||
## State Machine Definitions
|
||||
|
||||
### Device State Transitions
|
||||
|
||||
```
|
||||
Unregistered → Discovered (via discovery)
|
||||
Discovered → Registering (via user action/auto-registration)
|
||||
Registering → Active (via successful registration)
|
||||
Registering → Error (via registration failure)
|
||||
Active → Migrating (via migration start)
|
||||
Active → Offline (via connectivity loss)
|
||||
Migrating → Active (via migration success)
|
||||
Migrating → Error (via migration failure)
|
||||
Offline → Active (via connectivity restored)
|
||||
Error → Active (via error resolution)
|
||||
Any State → Retired (via explicit retirement)
|
||||
```
|
||||
|
||||
### State Transition Rules
|
||||
|
||||
```go
|
||||
var StateTransitionRules = map[DeviceState][]DeviceState{
|
||||
DeviceStateUnregistered: {DeviceStateDiscovered},
|
||||
DeviceStateDiscovered: {DeviceStateRegistering, DeviceStateOffline},
|
||||
DeviceStateRegistering: {DeviceStateActive, DeviceStateError},
|
||||
DeviceStateActive: {DeviceStateMigrating, DeviceStateOffline, DeviceStateRetired},
|
||||
DeviceStateMigrating: {DeviceStateActive, DeviceStateError},
|
||||
DeviceStateOffline: {DeviceStateActive, DeviceStateError, DeviceStateRetired},
|
||||
DeviceStateError: {DeviceStateActive, DeviceStateOffline, DeviceStateRetired},
|
||||
DeviceStateRetired: {}, // Terminal state
|
||||
}
|
||||
```
|
||||
|
||||
### Transition Triggers
|
||||
|
||||
```go
|
||||
type TransitionTrigger struct {
|
||||
Event DeviceEventType
|
||||
Condition func(*DeviceLifecycle, *DeviceEvent) bool
|
||||
Target DeviceState
|
||||
Reason string
|
||||
}
|
||||
|
||||
var TransitionTriggers = []TransitionTrigger{
|
||||
{
|
||||
Event: EventTypeDeviceOnline,
|
||||
Condition: isOfflineDevice,
|
||||
Target: DeviceStateActive,
|
||||
Reason: "connectivity_restored",
|
||||
},
|
||||
{
|
||||
Event: EventTypeDeviceOffline,
|
||||
Condition: isActiveDevice,
|
||||
Target: DeviceStateOffline,
|
||||
Reason: "connectivity_lost",
|
||||
},
|
||||
{
|
||||
Event: EventTypeMigrationStart,
|
||||
Condition: isActiveDevice,
|
||||
Target: DeviceStateMigrating,
|
||||
Reason: "migration_initiated",
|
||||
},
|
||||
// ... additional triggers
|
||||
}
|
||||
```
|
||||
|
||||
## Event Processing
|
||||
|
||||
### Event Queue Implementation
|
||||
|
||||
```go
|
||||
type EventQueue struct {
|
||||
buffer chan DeviceEvent
|
||||
processors []EventProcessor
|
||||
storage EventStorage
|
||||
config EventQueueConfig
|
||||
}
|
||||
|
||||
type EventQueueConfig struct {
|
||||
BufferSize int `json:"buffer_size"`
|
||||
ProcessorCount int `json:"processor_count"`
|
||||
FlushInterval time.Duration `json:"flush_interval"`
|
||||
RetryAttempts int `json:"retry_attempts"`
|
||||
DeadLetterQueue bool `json:"dead_letter_queue"`
|
||||
}
|
||||
|
||||
type EventProcessor interface {
|
||||
ProcessEvent(event DeviceEvent) error
|
||||
CanHandle(eventType DeviceEventType) bool
|
||||
}
|
||||
```
|
||||
|
||||
### Event Processing Flow
|
||||
|
||||
```
|
||||
Event Input → Validation → Queue → Processing → Storage → Notification
|
||||
↓ ↓ ↓ ↓ ↓ ↓
|
||||
Websocket Schema Buffer Parallel Files Webhooks
|
||||
Discovery Check Memory Workers Logs SSE
|
||||
API Call Format Retry DB Metrics
|
||||
System Enrich DLQ
|
||||
```
|
||||
|
||||
### Event Retention Policy
|
||||
|
||||
```go
|
||||
type RetentionPolicy struct {
|
||||
EventType DeviceEventType `json:"event_type"`
|
||||
RetentionDays int `json:"retention_days"`
|
||||
MaxCount int `json:"max_count"`
|
||||
Compression bool `json:"compression"`
|
||||
}
|
||||
|
||||
var DefaultRetentionPolicies = []RetentionPolicy{
|
||||
{EventTypeNowPlaying, 7, 1000, true},
|
||||
{EventTypeVolumeChanged, 1, 100, false},
|
||||
{EventTypeDisparityFound, 30, 10000, true},
|
||||
{EventTypeMigrationStart, 365, -1, false}, // Keep forever
|
||||
{EventTypeHealthCheck, 7, 1000, true},
|
||||
}
|
||||
```
|
||||
|
||||
### Development Requirements
|
||||
|
||||
#### KISS Principle (Keep It Simple, Stupid)
|
||||
- Prioritize simplicity and readability over performance optimization
|
||||
- Use standard Go idioms and patterns
|
||||
- Avoid premature abstraction and optimization
|
||||
- Build the simplest thing that works first
|
||||
|
||||
#### Quality Gates
|
||||
Every change must pass these checks:
|
||||
- `golangci-lint run --fix` - no linting issues
|
||||
- `go test ./...` - all tests pass with no failures
|
||||
- Integration tests verify existing functionality intact
|
||||
- Code coverage maintained or improved
|
||||
|
||||
#### Testing Requirements
|
||||
- Unit tests for all new functions
|
||||
- Integration tests for modified workflows
|
||||
- Regression tests for existing functionality
|
||||
- Mock external dependencies appropriately
|
||||
|
||||
### Simplicity-First Performance Approach
|
||||
|
||||
| Aspect | Simple Approach | Optimization Only When Needed |
|
||||
|--------|----------------|-------------------------------|
|
||||
| Memory Usage | Direct file operations, minimal caching | Add caching if performance issues arise |
|
||||
| CPU Usage | Synchronous processing initially | Add async processing if bottlenecks occur |
|
||||
| Storage | Simple append operations | Add rotation/compression when files grow large |
|
||||
| Networking | Reuse existing patterns | Optimize only if latency becomes problematic |
|
||||
|
||||
## Quality Assurance
|
||||
|
||||
### Testing Strategy
|
||||
|
||||
#### Unit Testing
|
||||
```go
|
||||
// Example test structure
|
||||
func TestAccountManager_CreateAccount(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
input CreateAccountRequest
|
||||
want *Account
|
||||
wantErr bool
|
||||
}{
|
||||
{
|
||||
name: "valid account creation",
|
||||
input: CreateAccountRequest{Name: "Test Account"},
|
||||
want: &Account{Name: "Test Account", Status: "active"},
|
||||
wantErr: false,
|
||||
},
|
||||
{
|
||||
name: "empty name should fail",
|
||||
input: CreateAccountRequest{Name: ""},
|
||||
want: nil,
|
||||
wantErr: true,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := manager.CreateAccount(tt.input)
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("CreateAccount() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
// Additional assertions...
|
||||
})
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Integration Testing
|
||||
- Test with real file operations in temporary directories
|
||||
- Verify HTTP endpoints work with actual HTTP requests
|
||||
- Test interaction with existing WebSocket system
|
||||
- Ensure existing XML endpoints remain functional
|
||||
|
||||
#### Quality Gates
|
||||
```bash
|
||||
# Required before each commit
|
||||
golangci-lint run --fix
|
||||
go test ./...
|
||||
go test -race ./...
|
||||
|
||||
# Required before milestone completion
|
||||
go test ./... -v -cover
|
||||
go test -bench=. ./...
|
||||
```
|
||||
|
||||
### Security Considerations
|
||||
|
||||
#### Simple Security Model
|
||||
- Reuse existing authentication mechanisms
|
||||
- Basic input validation with standard Go validation
|
||||
- Simple file permissions (0755 for directories, 0644 for files)
|
||||
- No complex authorization initially - build incrementally
|
||||
|
||||
#### Input Validation
|
||||
```go
|
||||
// Simple validation approach
|
||||
func ValidateAccount(account *Account) error {
|
||||
if account.Name == "" {
|
||||
return errors.New("account name cannot be empty")
|
||||
}
|
||||
if len(account.Name) > 100 {
|
||||
return errors.New("account name too long")
|
||||
}
|
||||
if account.Email != "" && !isValidEmail(account.Email) {
|
||||
return errors.New("invalid email format")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
```
|
||||
|
||||
## Error Handling
|
||||
|
||||
### Error Categories
|
||||
|
||||
```go
|
||||
type ErrorCategory string
|
||||
const (
|
||||
ErrorCategoryValidation ErrorCategory = "validation"
|
||||
ErrorCategorySystem ErrorCategory = "system"
|
||||
ErrorCategoryNetwork ErrorCategory = "network"
|
||||
ErrorCategoryStorage ErrorCategory = "storage"
|
||||
ErrorCategoryTimeout ErrorCategory = "timeout"
|
||||
ErrorCategoryAuth ErrorCategory = "authentication"
|
||||
)
|
||||
|
||||
type ServiceError struct {
|
||||
Code string `json:"code"`
|
||||
Message string `json:"message"`
|
||||
Category ErrorCategory `json:"category"`
|
||||
Timestamp time.Time `json:"timestamp"`
|
||||
Context map[string]interface{} `json:"context"`
|
||||
Retryable bool `json:"retryable"`
|
||||
Severity string `json:"severity"`
|
||||
}
|
||||
```
|
||||
|
||||
### Error Recovery Strategies
|
||||
|
||||
1. **Transient Errors**: Exponential backoff retry (3 attempts)
|
||||
2. **Storage Errors**: Graceful degradation with in-memory fallback
|
||||
3. **Network Errors**: Circuit breaker pattern with fallback data
|
||||
4. **Validation Errors**: Immediate response with detailed feedback
|
||||
5. **System Errors**: Alerting and automatic recovery attempts
|
||||
|
||||
### Error Response Format
|
||||
|
||||
```json
|
||||
{
|
||||
"error": {
|
||||
"code": "DEVICE_NOT_FOUND",
|
||||
"message": "Device with ID 'A81B6A536A98' not found in account 'acc_12345'",
|
||||
"category": "validation",
|
||||
"timestamp": "2024-01-20T15:30:00Z",
|
||||
"context": {
|
||||
"account_id": "acc_12345",
|
||||
"device_id": "A81B6A536A98",
|
||||
"request_id": "req_67890"
|
||||
},
|
||||
"retryable": false,
|
||||
"severity": "error"
|
||||
},
|
||||
"request_id": "req_67890"
|
||||
}
|
||||
```
|
||||
|
||||
## Monitoring and Observability
|
||||
|
||||
### Simple Monitoring Approach
|
||||
|
||||
#### Basic Health Check
|
||||
```go
|
||||
// Simple health check implementation
|
||||
type HealthStatus struct {
|
||||
Status string `json:"status"` // "healthy", "warning", "error"
|
||||
Timestamp time.Time `json:"timestamp"`
|
||||
Version string `json:"version"`
|
||||
Uptime string `json:"uptime"`
|
||||
}
|
||||
|
||||
func (s *Server) HandleHealthCheck(w http.ResponseWriter, r *http.Request) {
|
||||
health := HealthStatus{
|
||||
Status: "healthy",
|
||||
Timestamp: time.Now(),
|
||||
Version: version,
|
||||
Uptime: time.Since(startTime).String(),
|
||||
}
|
||||
|
||||
// Simple checks
|
||||
if !s.canWriteToDataDir() {
|
||||
health.Status = "error"
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
json.NewEncoder(w).Encode(health)
|
||||
}
|
||||
```
|
||||
|
||||
#### Leverage Existing Systems
|
||||
- Extend existing parity mismatch logging for disparity detection
|
||||
- Reuse existing interaction recording for request/response tracking
|
||||
- Build upon current discovery and migration event logging
|
||||
- Use existing WebSocket event system for device state changes
|
||||
|
||||
#### Simple Metrics
|
||||
```go
|
||||
// Basic counters - no complex metrics initially
|
||||
type SimpleMetrics struct {
|
||||
AccountsCreated int `json:"accounts_created"`
|
||||
DevicesActive int `json:"devices_active"`
|
||||
EventsProcessed int `json:"events_processed_today"`
|
||||
LastUpdate time.Time `json:"last_update"`
|
||||
}
|
||||
|
||||
// Update metrics in simple text file
|
||||
func (m *SimpleMetrics) Save(dataDir string) error {
|
||||
data, err := json.MarshalIndent(m, "", " ")
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return os.WriteFile(filepath.Join(dataDir, "metrics.json"), data, 0644)
|
||||
}
|
||||
```
|
||||
|
||||
This technical specification provides comprehensive details for implementing the enhanced state management system while maintaining compatibility with existing SoundTouch service functionality and meeting the performance requirements for small hardware deployments.
|
||||
@@ -0,0 +1,393 @@
|
||||
# Upstream Bose Service Simulation - State Management Concept
|
||||
|
||||
## Overview
|
||||
|
||||
This document outlines the concept for simulating and replacing upstream Bose services with enhanced state management capabilities. The goal is to create a comprehensive local replacement that can handle device lifecycles, account management, and state synchronization while maintaining compatibility with existing SoundTouch devices.
|
||||
|
||||
## Use Cases
|
||||
|
||||
### Case 0: Account Management
|
||||
- **Explicit Account Creation**: Accounts must be created through deliberate action (web UI, API call)
|
||||
- **Mirror-Enhanced Creation**: Account creation can be enriched using mirrored data from upstream Bose endpoints when devices make requests
|
||||
- **Data Recording**: Passively record account information during normal device operations for future use
|
||||
|
||||
### Case 1a: Fresh Device Registration
|
||||
- Initial setup/registration of a factory-reset or new device
|
||||
- Device has no prior Bose account association
|
||||
- Full local initialization with default configurations
|
||||
|
||||
### Case 1b: Device Migration from Bose Account
|
||||
- Migrate existing registered device from Bose services to local management
|
||||
- Preserve existing device data (presets, recents, sources)
|
||||
- Support gradual migration while maintaining Bose compatibility
|
||||
- Mirror Bose account data for seamless transition
|
||||
|
||||
### Case 2: Device Lifecycle and State Management
|
||||
- Track and manage device lifecycle states and activities
|
||||
- Maintain internal state based on incoming events from devices
|
||||
- Detect disparities between local and upstream behavior
|
||||
- Provide visibility into state changes and system health
|
||||
|
||||
## Architecture Principles
|
||||
|
||||
### 1. **Text-Based Storage for Debugging**
|
||||
- Maintain all state in human-readable text formats (XML, JSON, plain text)
|
||||
- Use small, focused files for each data aspect
|
||||
- Enable easy debugging and manual inspection
|
||||
- Optimize for small hardware deployments (Raspberry Pi Zero 2W)
|
||||
|
||||
### 2. **Mirror-First Strategy**
|
||||
- Keep mirror functionality active as long as possible
|
||||
- Primary source switches from upstream to local only during:
|
||||
- Explicit migration
|
||||
- Sufficient local data accumulation
|
||||
- Upstream service unavailability
|
||||
- Record and mirror as much data as possible, even if not immediately used
|
||||
|
||||
### 3. **Disparity Detection**
|
||||
- Track differences between local and upstream responses
|
||||
- Log discrepancies for analysis and improvement
|
||||
- Provide visibility into implementation gaps
|
||||
- Support parity testing and validation
|
||||
|
||||
### 4. **Event-Driven State Management**
|
||||
- Process device events asynchronously
|
||||
- Track comprehensive event history in text files
|
||||
- Support event replay and analysis
|
||||
- Minimize noise while capturing important state changes
|
||||
|
||||
## Enhanced Data Structure
|
||||
|
||||
### Account Management
|
||||
|
||||
```
|
||||
data/
|
||||
├── accounts/
|
||||
│ ├── {account-id}/
|
||||
│ │ ├── account.json # Account metadata
|
||||
│ ├── account-events.log # High-level account behavior tracking
|
||||
│ │ ├── devices/
|
||||
│ │ │ └── {device-id}/
|
||||
│ │ │ ├── lifecycle.json # Device state and history
|
||||
│ │ │ ├── info.xml # Device information
|
||||
│ │ │ ├── presets.xml # Device presets
|
||||
│ │ │ ├── recents.xml # Recent plays
|
||||
│ │ │ ├── sources.xml # Configured sources
|
||||
│ │ │ └── events.log # Device event history
|
||||
│ │ └── sessions/
|
||||
│ │ └── {session-id}/ # Recorded interaction sessions
|
||||
└── system/
|
||||
├── discovery.log # Device discovery events
|
||||
└── migration.log # Migration activities
|
||||
```
|
||||
|
||||
### Account Metadata Format
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "account-12345",
|
||||
"name": "User Account",
|
||||
"email": "user@example.com",
|
||||
"created_at": "2024-01-15T10:30:00Z",
|
||||
"updated_at": "2024-01-20T15:45:00Z",
|
||||
"status": "active",
|
||||
"device_count": 3,
|
||||
"migration_status": {
|
||||
"started_at": "2024-01-18T09:00:00Z",
|
||||
"devices_migrated": 1,
|
||||
"devices_pending": 2,
|
||||
"mirror_active": true
|
||||
},
|
||||
"bose_account_id": "bose-original-id",
|
||||
"data_sources": {
|
||||
"local": true,
|
||||
"bose_mirror": true,
|
||||
"primary": "bose"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Device Lifecycle Format
|
||||
|
||||
```json
|
||||
{
|
||||
"device_id": "A81B6A536A98",
|
||||
"account_id": "account-12345",
|
||||
"state": "active",
|
||||
"created_at": "2024-01-15T10:30:00Z",
|
||||
"updated_at": "2024-01-20T16:22:00Z",
|
||||
"state_history": [
|
||||
{
|
||||
"from": "unregistered",
|
||||
"to": "registering",
|
||||
"timestamp": "2024-01-15T10:30:00Z",
|
||||
"reason": "fresh_device_setup",
|
||||
"source": "discovery"
|
||||
},
|
||||
{
|
||||
"from": "registering",
|
||||
"to": "active",
|
||||
"timestamp": "2024-01-15T10:35:00Z",
|
||||
"reason": "registration_complete",
|
||||
"source": "system"
|
||||
}
|
||||
],
|
||||
"metadata": {
|
||||
"name": "Living Room Speaker",
|
||||
"type": "SoundTouch 30",
|
||||
"serial_number": "I6332527703739342000020",
|
||||
"firmware_version": "4.8.1.25341.2677643.1597353330",
|
||||
"mac_address": "A8:1B:6A:53:6A:98",
|
||||
"ip_address": "192.168.1.100",
|
||||
"last_seen": "2024-01-20T16:20:00Z",
|
||||
"is_legacy_id": false
|
||||
},
|
||||
"data_sources": {
|
||||
"presets": "local",
|
||||
"recents": "mirror_primary",
|
||||
"sources": "local"
|
||||
},
|
||||
"migration": {
|
||||
"from_bose_account": "bose-account-xyz",
|
||||
"migrated_at": "2024-01-18T14:30:00Z",
|
||||
"method": "gradual",
|
||||
"rollback_available": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Event Log Format
|
||||
|
||||
```
|
||||
# Device Events Log - A81B6A536A98
|
||||
# Format: TIMESTAMP|EVENT_TYPE|SOURCE|DATA
|
||||
|
||||
2024-01-20T16:15:00Z|now_playing|websocket|{"source":"SPOTIFY","track":"Song Name","artist":"Artist Name"}
|
||||
2024-01-20T16:15:30Z|volume_changed|websocket|{"volume":45,"muted":false}
|
||||
2024-01-20T16:16:00Z|preset_selected|websocket|{"preset":1,"source":"SPOTIFY","location":"spotify:track:123"}
|
||||
2024-01-20T16:18:00Z|disparity_detected|mirror|{"endpoint":"/v1/account/full","local_hash":"abc123","upstream_hash":"def456"}
|
||||
2024-01-20T16:20:00Z|device_online|discovery|{"ip":"192.168.1.100","method":"mdns"}
|
||||
```
|
||||
|
||||
### Disparity Log Format
|
||||
|
||||
```
|
||||
# Parity Analysis Log
|
||||
# Format: TIMESTAMP|ENDPOINT|DEVICE|ACCOUNT|DISPARITY_TYPE|DETAILS
|
||||
|
||||
2024-01-20T16:18:00Z|/v1/account/full|A81B6A536A98|account-12345|content_mismatch|preset_count:local=5,upstream=4
|
||||
2024-01-20T16:19:15Z|/v1/presets|A81B6A536A98|account-12345|xml_structure|missing_container_art_in_local
|
||||
2024-01-20T16:20:30Z|/v1/recents|A81B6A536A98|account-12345|timestamp_format|local=RFC3339,upstream=custom
|
||||
```
|
||||
|
||||
## Implementation Strategy
|
||||
|
||||
### Phase 1: Enhanced State Tracking
|
||||
|
||||
1. **Account Management Service**
|
||||
- Explicit account creation API
|
||||
- Mirror-enhanced account initialization
|
||||
- Account status and migration tracking
|
||||
|
||||
2. **Device Lifecycle Manager**
|
||||
- Comprehensive state machine for device lifecycle
|
||||
- Event-driven state transitions
|
||||
- Text-based state persistence
|
||||
|
||||
3. **Enhanced Mirror System**
|
||||
- Extended mirroring with disparity detection
|
||||
- Selective data source switching
|
||||
- Parity analysis and logging
|
||||
|
||||
### Phase 2: Gradual Migration Support
|
||||
|
||||
1. **Migration Controller**
|
||||
- Device-by-device migration orchestration
|
||||
- Rollback capability with state preservation
|
||||
- Migration progress tracking
|
||||
|
||||
2. **Dual-Source Data Management**
|
||||
- Smart routing between local and upstream data
|
||||
- Graceful fallback mechanisms
|
||||
- Data source preference management
|
||||
|
||||
3. **State Synchronization**
|
||||
- Bidirectional sync capabilities
|
||||
- Conflict resolution strategies
|
||||
- Sync status monitoring
|
||||
|
||||
### Phase 3: Advanced Analytics
|
||||
|
||||
1. **Disparity Analysis Engine**
|
||||
- Automated disparity detection and classification
|
||||
- Trend analysis and reporting
|
||||
- Implementation gap identification
|
||||
|
||||
2. **System Health Monitoring**
|
||||
- Device connectivity monitoring
|
||||
- Service availability tracking
|
||||
- Performance metrics collection
|
||||
|
||||
3. **Data Export and Backup**
|
||||
- Account data export for migration
|
||||
- Incremental backup strategies
|
||||
- Data integrity verification
|
||||
|
||||
## API Enhancements
|
||||
|
||||
### Account Management APIs
|
||||
|
||||
```http
|
||||
# Create account explicitly
|
||||
POST /api/v1/accounts
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"name": "User Account",
|
||||
"email": "user@example.com"
|
||||
}
|
||||
|
||||
# Get account with migration status
|
||||
GET /api/v1/accounts/{account-id}
|
||||
|
||||
# Initiate account migration from Bose
|
||||
POST /api/v1/accounts/{account-id}/migrate
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"bose_account_id": "bose-original-id",
|
||||
"strategy": "gradual"
|
||||
}
|
||||
```
|
||||
|
||||
### Device Lifecycle APIs
|
||||
|
||||
```http
|
||||
# Register fresh device
|
||||
POST /api/v1/accounts/{account-id}/devices
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"device_id": "A81B6A536A98",
|
||||
"name": "Living Room Speaker",
|
||||
"registration_type": "fresh"
|
||||
}
|
||||
|
||||
# Get device state and lifecycle
|
||||
GET /api/v1/accounts/{account-id}/devices/{device-id}/state
|
||||
|
||||
# Migrate device from Bose account
|
||||
POST /api/v1/accounts/{account-id}/devices/{device-id}/migrate
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"from_bose_account": "bose-account-xyz",
|
||||
"preserve_data": true
|
||||
}
|
||||
```
|
||||
|
||||
### Monitoring and Analysis APIs
|
||||
|
||||
```http
|
||||
# Get disparity analysis
|
||||
GET /api/v1/system/disparities?since=2024-01-20T00:00:00Z
|
||||
|
||||
# Get migration status
|
||||
GET /api/v1/system/migration/status
|
||||
|
||||
# Export account data
|
||||
GET /api/v1/accounts/{account-id}/export
|
||||
```
|
||||
|
||||
## Integration with Existing Services
|
||||
|
||||
### Enhanced Marge Service
|
||||
|
||||
- Integrate lifecycle information into account responses
|
||||
- Add migration status to device listings
|
||||
- Support dual-source data routing
|
||||
- Include disparity metadata in responses
|
||||
|
||||
### Enhanced BMX Service
|
||||
|
||||
- Track content source preferences by account
|
||||
- Mirror and compare content recommendations
|
||||
- Log streaming behavior for analysis
|
||||
- Support gradual source migration
|
||||
|
||||
### Discovery Service Integration
|
||||
|
||||
- Link discovered devices to lifecycle manager
|
||||
- Trigger lifecycle state transitions on discovery events
|
||||
- Support both fresh registration and migration flows
|
||||
- Handle legacy device ID migration automatically
|
||||
|
||||
## Performance Considerations
|
||||
|
||||
### Simplicity First (KISS Principle)
|
||||
|
||||
- Favor simple, readable code over premature optimization
|
||||
- Use straightforward algorithms and data structures
|
||||
- Minimize complexity in favor of maintainability
|
||||
- Build incrementally with small, testable changes
|
||||
|
||||
### Quality Assurance
|
||||
|
||||
- Complete test coverage for all new functionality
|
||||
- Comprehensive linting with `golangci-lint run --fix`
|
||||
- Full test suite execution `go test ./...` for each milestone
|
||||
- Integration tests with existing functionality
|
||||
|
||||
### File Management
|
||||
|
||||
- Simple line-based append operations for logs
|
||||
- Basic log rotation when needed
|
||||
- Direct file operations without complex caching
|
||||
- Straightforward data persistence
|
||||
|
||||
## Development Principles
|
||||
|
||||
### KISS (Keep It Simple, Stupid)
|
||||
- Prioritize simplicity and readability over performance optimization
|
||||
- Use standard Go idioms and patterns
|
||||
- Avoid premature abstraction and optimization
|
||||
- Build the simplest thing that works first
|
||||
|
||||
### Quality First
|
||||
- Every milestone must pass `golangci-lint run --fix` without issues
|
||||
- Complete test suite must pass `go test ./...` before proceeding
|
||||
- Integration tests ensure existing functionality remains intact
|
||||
- Code coverage should be maintained or improved
|
||||
|
||||
### Incremental Development
|
||||
- Make small, focused changes that can be easily reviewed
|
||||
- Each step should be independently testable and valuable
|
||||
- Maintain backward compatibility throughout development
|
||||
- Enable rollback at any point in the process
|
||||
|
||||
### Leverage Existing Systems
|
||||
- Reuse existing interaction recording for request/response tracking
|
||||
- Build upon current parity mismatch detection system
|
||||
- Extend existing datastore and handler patterns
|
||||
- Integrate with established discovery and migration workflows
|
||||
|
||||
## Future Enhancements
|
||||
|
||||
Future improvements should maintain the simplicity-first approach:
|
||||
|
||||
1. **Enhanced Web Interface**
|
||||
- Simple dashboard for account and device management
|
||||
- Basic migration progress tracking
|
||||
- Straightforward device health monitoring
|
||||
|
||||
2. **Extended Logging**
|
||||
- Additional high-level behavior tracking
|
||||
- Simple analytics based on existing parity data
|
||||
- Enhanced debugging information
|
||||
|
||||
3. **Community Integration**
|
||||
- Standardized data export formats
|
||||
- Simple reporting mechanisms
|
||||
- Clear documentation for community contributions
|
||||
|
||||
This concept provides a solid, maintainable foundation for replacing Bose's upstream services. The emphasis on simplicity, existing system reuse, and comprehensive testing ensures reliable functionality while maintaining the debugging capabilities needed for small hardware deployments.
|
||||
@@ -0,0 +1,391 @@
|
||||
# Device Lifecycle and /power_on Enhancement
|
||||
|
||||
## Overview
|
||||
|
||||
This document provides a comprehensive analysis of the current SoundTouch device registration and lifecycle management implementation, and proposes enhancements using the `/power_on` endpoint to reduce dependency on local network connectivity.
|
||||
|
||||
## Current Implementation Assessment
|
||||
|
||||
### Device Information Sources
|
||||
|
||||
The current system uses multiple data collection methods to build a complete device profile:
|
||||
|
||||
#### 1. UPnP/SSDP Discovery
|
||||
- **Protocol**: Multicast UDP discovery for `urn:schemas-upnp-org:service:SoundTouch:1`
|
||||
- **Network Scope**: Limited to same network segment
|
||||
- **Data Collected**:
|
||||
```go
|
||||
type DiscoveredDevice struct {
|
||||
Name string // From UPnP friendlyName
|
||||
Host string // IP address
|
||||
Port int // Usually 8090
|
||||
ModelID string // From UPnP modelName
|
||||
SerialNo string // MAC address from UPnP
|
||||
UPnPLocation string // Device description URL
|
||||
UPnPUSN string // Unique service name
|
||||
}
|
||||
```
|
||||
|
||||
#### 2. mDNS/Bonjour Discovery
|
||||
- **Protocol**: Multicast DNS for `_soundtouch._tcp` services
|
||||
- **Network Scope**: Limited to same network segment
|
||||
- **Purpose**: Complements UPnP discovery with hostname resolution
|
||||
|
||||
#### 3. `/info` Endpoint Enrichment
|
||||
- **Protocol**: HTTP GET to `http://device:8090/info`
|
||||
- **Network Scope**: Requires direct connectivity to device
|
||||
- **Data Collected**:
|
||||
```xml
|
||||
<info deviceID="ABCD1234EFGH">
|
||||
<name>My SoundTouch Device</name>
|
||||
<type>SoundTouch 10</type>
|
||||
<margeAccountUUID>3230304</margeAccountUUID>
|
||||
<components>
|
||||
<component>
|
||||
<componentCategory>SCM</componentCategory>
|
||||
<softwareVersion>27.0.6.46330.5043500...</softwareVersion>
|
||||
<serialNumber>I6332527703739342000020</serialNumber>
|
||||
</component>
|
||||
</components>
|
||||
<margeURL>https://streaming.bose.com</margeURL>
|
||||
<networkInfo type="SCM">
|
||||
<macAddress>AA:BB:CC:DD:EE:FF</macAddress>
|
||||
<ipAddress>192.168.1.10</ipAddress>
|
||||
</networkInfo>
|
||||
<moduleType>sm2</moduleType>
|
||||
<variant>rhino</variant>
|
||||
<countryCode>GB</countryCode>
|
||||
</info>
|
||||
```
|
||||
|
||||
### Current Data Flow
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant Service as SoundTouch Service
|
||||
participant UPnP as UPnP Discovery
|
||||
participant mDNS as mDNS Discovery
|
||||
participant Device as SoundTouch Device
|
||||
participant DataStore as Data Store
|
||||
participant User as User/App
|
||||
|
||||
Note over Service,User: Current Device Registration Flow
|
||||
|
||||
Service->>UPnP: Start SSDP Discovery
|
||||
Service->>mDNS: Start mDNS Discovery
|
||||
|
||||
UPnP->>UPnP: Send M-SEARCH multicast
|
||||
Device->>UPnP: Respond with location URL
|
||||
UPnP->>Device: Fetch device description XML
|
||||
Device->>UPnP: Return basic device info
|
||||
|
||||
mDNS->>mDNS: Query _soundtouch._tcp
|
||||
Device->>mDNS: Respond with service info
|
||||
|
||||
Service->>Service: Merge discovery results
|
||||
Service->>Device: GET /info (enrich data)
|
||||
Device->>Service: Return detailed device info
|
||||
Service->>DataStore: Store discovered device
|
||||
|
||||
Note over User,DataStore: User Registration
|
||||
User->>Service: POST /account/{id}/devices
|
||||
Note right of User: deviceId + user-friendly name
|
||||
Service->>DataStore: Link device to account
|
||||
|
||||
Note over Service,DataStore: Migration Process
|
||||
Service->>Device: GET /info (device identification)
|
||||
Device->>Service: Return device details
|
||||
Service->>Service: Build migration summary
|
||||
Service->>Device: Apply configuration changes
|
||||
```
|
||||
|
||||
### Device Registration Points
|
||||
|
||||
The system has distinct phases where device information is collected and enhanced:
|
||||
|
||||
#### Phase 1: Discovery (Network-Dependent)
|
||||
**Trigger**: Automatic network scanning
|
||||
**Data Sources**: UPnP + mDNS + `/info` endpoint
|
||||
**Limitations**: ❌ Requires same network segment
|
||||
|
||||
#### Phase 2: User Registration (User-Controlled)
|
||||
**Trigger**: User adds device to account
|
||||
**Endpoint**: `POST /streaming/account/{accountId}/devices`
|
||||
**Request Format**:
|
||||
```xml
|
||||
<device deviceid="08DF1F0BA325">
|
||||
<name>Living Room Speaker</name>
|
||||
</device>
|
||||
```
|
||||
**Data Added**: ✅ User-friendly name, Account association
|
||||
|
||||
#### Phase 3: Ongoing Updates (Mixed)
|
||||
**Triggers**: Device state changes, firmware updates, network changes
|
||||
**Methods**: Periodic `/info` polling, Discovery refresh, User configuration
|
||||
|
||||
### Current Data Model
|
||||
|
||||
The system maintains comprehensive device information:
|
||||
|
||||
```go
|
||||
type ServiceDeviceInfo struct {
|
||||
DeviceID string `json:"device_id"` // MAC or UUID
|
||||
Name string `json:"name"` // User-friendly name
|
||||
ProductCode string `json:"product_code"` // Device model
|
||||
DeviceSerialNumber string `json:"device_serial_number"` // Hardware serial
|
||||
ProductSerialNumber string `json:"product_serial_number"` // Product serial
|
||||
FirmwareVersion string `json:"firmware_version"` // Software version
|
||||
IPAddress string `json:"ip_address"` // Current IP
|
||||
MacAddress string `json:"mac_address"` // MAC address
|
||||
AccountID string `json:"account_id"` // Account association
|
||||
DiscoveryMethod string `json:"discovery_method"` // How discovered
|
||||
}
|
||||
```
|
||||
|
||||
## Limitations of Current Approach
|
||||
|
||||
### Network Dependency Issues
|
||||
|
||||
| Issue | Impact | Affected Operations |
|
||||
|-------|--------|-------------------|
|
||||
| **Same Network Requirement** | High | Device discovery, Initial setup |
|
||||
| **Direct Connectivity Need** | High | Device enrichment, Migration |
|
||||
| **Firewall/NAT Restrictions** | Medium | Corporate networks, Complex setups |
|
||||
| **Multi-VLAN Environments** | High | Enterprise deployments |
|
||||
| **Remote Management** | Critical | Off-site device support |
|
||||
|
||||
### Service Architecture Limitations
|
||||
|
||||
1. **Geographic Constraints**: Service must be deployed on same network as speakers
|
||||
2. **Scalability Issues**: Cannot centralize device management across multiple locations
|
||||
3. **Discovery Reliability**: Multicast protocols can be unreliable in complex networks
|
||||
4. **Real-time Updates**: No device-initiated communication for state changes
|
||||
|
||||
## /power_on Enhancement Proposal
|
||||
|
||||
### Current /power_on Request Analysis
|
||||
|
||||
The `/power_on` endpoint receives comprehensive device data that could replace many network-dependent operations:
|
||||
|
||||
```xml
|
||||
<device-data>
|
||||
<device id="A81B6A536A98">
|
||||
<serialnumber>I6332527703739342000020</serialnumber>
|
||||
<firmware-version>27.0.6.46330.5043500 epdbuild.trunk.hepdswbld04.2022-08-04T11:20:29</firmware-version>
|
||||
<product product_code="SoundTouch 10 sm2" type="5">
|
||||
<serialnumber>069231P63364828AE</serialnumber>
|
||||
</product>
|
||||
</device>
|
||||
<diagnostic-data>
|
||||
<device-landscape>
|
||||
<rssi>Excellent</rssi>
|
||||
<gateway-ip-address>192.168.178.1</gateway-ip-address>
|
||||
<macaddresses>
|
||||
<macaddress>A81B6A536A98</macaddress>
|
||||
<macaddress>A81B6A849D99</macaddress>
|
||||
</macaddresses>
|
||||
<ip-address>192.168.178.35</ip-address>
|
||||
<network-connection-type>Wireless</network-connection-type>
|
||||
</device-landscape>
|
||||
<network-landscape>
|
||||
<network-data xmlns="http://www.Bose.com/Schemas/2012-12/NetworkMonitor/"/>
|
||||
</network-landscape>
|
||||
</diagnostic-data>
|
||||
</device-data>
|
||||
```
|
||||
|
||||
### Data Completeness Comparison
|
||||
|
||||
| Data Field | Current `/info` | `/power_on` | Gap Assessment |
|
||||
|------------|----------------|-------------|----------------|
|
||||
| **Device ID** | ✅ UUID format | ✅ MAC format | Different format |
|
||||
| **Device Name** | ✅ Internal name | ❌ Missing | **Critical Gap** |
|
||||
| **Device Type** | ✅ Model string | ✅ Product code | ✅ Available |
|
||||
| **Account ID** | ✅ marge UUID | ❌ Missing | **Critical Gap** |
|
||||
| **Service URL** | ✅ marge URL | ❌ Missing | **Important Gap** |
|
||||
| **Firmware Version** | ✅ Full version | ✅ Full version | ✅ Available |
|
||||
| **Serial Numbers** | ✅ Component serials | ✅ Device + Product | ✅ Available |
|
||||
| **MAC Addresses** | ✅ Interface-specific | ✅ Multiple MACs | ✅ Enhanced |
|
||||
| **IP Address** | ✅ Interface IPs | ✅ Current IP | ✅ Available |
|
||||
| **Network Status** | ❌ Basic | ✅ Rich diagnostics | ✅ **Enhanced** |
|
||||
| **Regional Settings** | ✅ Country/Region | ❌ Missing | **Important Gap** |
|
||||
|
||||
### Enhancement Benefits
|
||||
|
||||
#### 1. Network Independence
|
||||
- ✅ Works across internet/WAN connections
|
||||
- ✅ No multicast/broadcast requirements
|
||||
- ✅ Firewall/NAT friendly
|
||||
- ✅ Supports remote device management
|
||||
|
||||
#### 2. Real-time Device State
|
||||
- ✅ Device-initiated communication
|
||||
- ✅ Power-on event notifications
|
||||
- ✅ Network status updates
|
||||
- ✅ Firmware change detection
|
||||
|
||||
#### 3. Enhanced Diagnostics
|
||||
- ✅ Signal strength (RSSI)
|
||||
- ✅ Gateway information
|
||||
- ✅ Connection type details
|
||||
- ✅ Real-time network status
|
||||
|
||||
### Implementation Strategy
|
||||
|
||||
#### Phase 1: Hybrid Approach
|
||||
Implement `/power_on` processing while maintaining existing discovery methods:
|
||||
|
||||
```go
|
||||
func (s *Server) HandleMargePowerOn(w http.ResponseWriter, r *http.Request) {
|
||||
// Parse power_on request
|
||||
var powerOnData models.CustomerSupportRequest
|
||||
if err := xml.Unmarshal(body, &powerOnData); err != nil {
|
||||
// Fallback to existing discovery
|
||||
return s.fallbackToDiscovery(r.RemoteAddr)
|
||||
}
|
||||
|
||||
// Extract device information
|
||||
deviceMAC := powerOnData.Device.ID
|
||||
deviceIP := powerOnData.DiagnosticData.DeviceLandscape.IPAddress
|
||||
|
||||
// Lookup existing device data
|
||||
deviceInfo := s.lookupDeviceByMAC(deviceMAC)
|
||||
if deviceInfo == nil {
|
||||
// New device - trigger registration flow
|
||||
deviceInfo = s.createDeviceFromPowerOn(powerOnData)
|
||||
}
|
||||
|
||||
// Update with power_on data
|
||||
s.updateDeviceFromPowerOn(deviceInfo, powerOnData)
|
||||
|
||||
// Determine response actions
|
||||
response := s.buildPowerOnResponse(deviceInfo)
|
||||
s.sendResponse(w, response)
|
||||
}
|
||||
```
|
||||
|
||||
#### Phase 2: Gap Resolution
|
||||
Address missing data through complementary mechanisms:
|
||||
|
||||
1. **User-Friendly Names**: Maintain registration process for name assignment
|
||||
2. **Account Association**: Enhance registration to link MAC addresses to accounts
|
||||
3. **Service URLs**: Implement account-based service URL resolution
|
||||
4. **Regional Settings**: Use IP geolocation or account preferences
|
||||
|
||||
#### Phase 3: Enhanced Device Lifecycle
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant Device as SoundTouch Device
|
||||
participant Service as SoundTouch Service
|
||||
participant DataStore as Data Store
|
||||
participant User as User/App
|
||||
|
||||
Note over Device,User: Enhanced Device Lifecycle
|
||||
|
||||
rect rgb(248, 255, 248)
|
||||
Note over Device,DataStore: 1. Power-On Registration
|
||||
Device->>Service: POST /power_on (rich device data)
|
||||
Service->>DataStore: Lookup device by MAC
|
||||
alt Device Unknown
|
||||
Service->>DataStore: Create device record
|
||||
Service->>User: Notify new device found
|
||||
else Device Known
|
||||
Service->>DataStore: Update device status
|
||||
end
|
||||
Service->>Device: Configuration response
|
||||
end
|
||||
|
||||
rect rgb(255, 248, 240)
|
||||
Note over User,DataStore: 2. User Registration (Optional)
|
||||
User->>Service: POST /setup/devices (name + preferences)
|
||||
Service->>DataStore: Add user metadata to device
|
||||
Service->>Device: Updated configuration (on next power_on)
|
||||
end
|
||||
|
||||
rect rgb(240, 248, 255)
|
||||
Note over Device,DataStore: 3. Ongoing Updates
|
||||
Device->>Service: POST /power_on (status changes)
|
||||
Service->>Service: Detect firmware/network changes
|
||||
Service->>DataStore: Update device record
|
||||
alt Migration Needed
|
||||
Service->>Device: Migration instructions
|
||||
Device->>Device: Apply configuration
|
||||
Device->>Service: POST /power_on (confirm changes)
|
||||
end
|
||||
end
|
||||
|
||||
rect rgb(255, 248, 255)
|
||||
Note over Service,User: 4. Remote Management
|
||||
User->>Service: Management request (any location)
|
||||
Service->>DataStore: Lookup device status
|
||||
Service->>User: Current device state
|
||||
Note over Service: No local network required
|
||||
end
|
||||
```
|
||||
|
||||
### Migration Strategy
|
||||
|
||||
#### Current Migration Flow Issues
|
||||
- Requires `/info` endpoint access for device identification
|
||||
- Must be on same network for configuration changes
|
||||
- Limited to devices discoverable via UPnP/mDNS
|
||||
|
||||
#### Enhanced Migration with /power_on
|
||||
|
||||
1. **Device Identification**: Use MAC address from `/power_on` instead of IP-based `/info`
|
||||
2. **Configuration Delivery**: Send migration instructions in `/power_on` response
|
||||
3. **Status Confirmation**: Device confirms changes via subsequent `/power_on` requests
|
||||
4. **Remote Capability**: Manage devices from any network location
|
||||
|
||||
```go
|
||||
type PowerOnResponse struct {
|
||||
ConfigurationUpdates []ConfigUpdate `json:"configuration_updates,omitempty"`
|
||||
MigrationInstructions *Migration `json:"migration,omitempty"`
|
||||
RegistrationRequired bool `json:"registration_required,omitempty"`
|
||||
}
|
||||
|
||||
type Migration struct {
|
||||
Method string `json:"method"` // xml, hosts, resolv_conf
|
||||
TargetURL string `json:"target_url"`
|
||||
ProxyURL string `json:"proxy_url,omitempty"`
|
||||
Options map[string]string `json:"options"`
|
||||
}
|
||||
```
|
||||
|
||||
## Recommendations
|
||||
|
||||
### Immediate Actions (Phase 1)
|
||||
1. **Enhance `/power_on` handler** to extract and store comprehensive device data
|
||||
2. **Implement device lookup by MAC address** as primary identification method
|
||||
3. **Create hybrid discovery system** using both `/power_on` and existing methods
|
||||
4. **Add network-independent device management** capabilities
|
||||
|
||||
### Medium-term Improvements (Phase 2)
|
||||
1. **Implement account-device MAC mapping** for automatic association
|
||||
2. **Add IP geolocation** for regional settings inference
|
||||
3. **Create device registration UI** optimized for `/power_on` discovered devices
|
||||
4. **Enhance migration system** to use `/power_on` response mechanism
|
||||
|
||||
### Long-term Enhancements (Phase 3)
|
||||
1. **Request firmware enhancement** to include missing data in `/power_on`
|
||||
2. **Implement real-time device monitoring** via `/power_on` events
|
||||
3. **Create centralized device management** independent of network topology
|
||||
4. **Add predictive migration** based on device status patterns
|
||||
|
||||
### Risk Mitigation
|
||||
- **Maintain backward compatibility** with existing discovery methods
|
||||
- **Implement graceful fallbacks** when `/power_on` data is incomplete
|
||||
- **Preserve existing user workflows** while adding enhanced capabilities
|
||||
- **Add comprehensive logging** for troubleshooting hybrid approach
|
||||
|
||||
## Conclusion
|
||||
|
||||
The `/power_on` endpoint provides a significant opportunity to reduce network dependencies while enhancing device management capabilities. By implementing a hybrid approach that leverages `/power_on` data for primary device identification and status updates while maintaining existing registration workflows for user-controlled metadata, the system can achieve:
|
||||
|
||||
- **Network independence** for core device management
|
||||
- **Enhanced real-time capabilities** through device-initiated communication
|
||||
- **Improved scalability** across diverse network topologies
|
||||
- **Better user experience** with automatic device discovery and status updates
|
||||
|
||||
The proposed implementation strategy provides a clear path to achieve these benefits while maintaining system reliability and user workflow compatibility.
|
||||
@@ -0,0 +1,150 @@
|
||||
# Device Lifecycle Analysis - Executive Summary
|
||||
|
||||
## Current State Assessment
|
||||
|
||||
The SoundTouch service currently relies heavily on local network connectivity for device discovery and management:
|
||||
|
||||
### ✅ Strengths
|
||||
- **Comprehensive device data** through `/info` endpoint
|
||||
- **Robust discovery** via UPnP/SSDP + mDNS
|
||||
- **User-controlled registration** with friendly names
|
||||
- **Complete device lifecycle management**
|
||||
|
||||
### ❌ Limitations
|
||||
- **Network dependency**: Requires same network segment for discovery
|
||||
- **Geographic constraints**: Service must be co-located with devices
|
||||
- **Firewall/NAT issues**: Multicast protocols unreliable in complex networks
|
||||
- **No remote management**: Cannot manage devices from external networks
|
||||
|
||||
## /power_on Enhancement Opportunity
|
||||
|
||||
The `/power_on` endpoint provides rich device data that could eliminate network dependencies:
|
||||
|
||||
### Current /power_on Data
|
||||
```xml
|
||||
<device-data>
|
||||
<device id="A81B6A536A98"> <!-- ✅ Device MAC -->
|
||||
<serialnumber>I6332527703739342000020</serialnumber> <!-- ✅ Serial -->
|
||||
<firmware-version>27.0.6.46330.5043500...</firmware-version> <!-- ✅ FW -->
|
||||
<product product_code="SoundTouch 10 sm2" type="5"> <!-- ✅ Model -->
|
||||
<serialnumber>069231P63364828AE</serialnumber> <!-- ✅ Product Serial -->
|
||||
</product>
|
||||
</device>
|
||||
<diagnostic-data>
|
||||
<device-landscape>
|
||||
<rssi>Excellent</rssi> <!-- ✅ Signal -->
|
||||
<gateway-ip-address>192.168.178.1</gateway-ip-address> <!-- ✅ Network -->
|
||||
<macaddresses> <!-- ✅ All MACs -->
|
||||
<macaddress>A81B6A536A98</macaddress>
|
||||
<macaddress>A81B6A849D99</macaddress>
|
||||
</macaddresses>
|
||||
<ip-address>192.168.178.35</ip-address> <!-- ✅ Current IP -->
|
||||
<network-connection-type>Wireless</network-connection-type> <!-- ✅ Connection -->
|
||||
</device-landscape>
|
||||
</diagnostic-data>
|
||||
</device-data>
|
||||
```
|
||||
|
||||
### Missing Data Gaps
|
||||
| Data | Current Source | Available in /power_on | Impact |
|
||||
|------|----------------|----------------------|---------|
|
||||
| **User-friendly name** | Registration | ❌ Missing | **High** - UI/UX |
|
||||
| **Account association** | Registration | ❌ Missing | **Critical** - Authorization |
|
||||
| **Service URLs** | `/info` | ❌ Missing | **High** - Migration |
|
||||
| **Regional settings** | `/info` | ❌ Missing | **Medium** - Localization |
|
||||
|
||||
## Recommended Implementation Strategy
|
||||
|
||||
### Phase 1: Hybrid Enhancement (Immediate)
|
||||
- **Enhance `/power_on` handler** to process full device data
|
||||
- **Implement MAC-based device lookup** for identification
|
||||
- **Maintain existing registration flow** for user metadata
|
||||
- **Add network-independent capabilities** as primary features
|
||||
|
||||
```go
|
||||
// Enhanced flow
|
||||
Device -> POST /power_on -> Service identifies by MAC -> Update/Create device record
|
||||
```
|
||||
|
||||
### Phase 2: Gap Resolution (Short-term)
|
||||
- **Account-device MAC mapping** for automatic association
|
||||
- **IP geolocation** for regional settings inference
|
||||
- **Registration UI optimization** for /power_on discovered devices
|
||||
- **Migration via response payload** instead of direct device access
|
||||
|
||||
### Phase 3: Full Network Independence (Medium-term)
|
||||
- **Centralized device management** across multiple networks
|
||||
- **Real-time device monitoring** via /power_on events
|
||||
- **Predictive migration** based on device status patterns
|
||||
- **Enhanced firmware integration** with additional /power_on data
|
||||
|
||||
## Key Benefits
|
||||
|
||||
### ✅ Immediate Gains
|
||||
- **Network independence**: Manage devices from any location
|
||||
- **Real-time updates**: Device-initiated status reporting
|
||||
- **Enhanced diagnostics**: Signal strength, connection type, network status
|
||||
- **Simplified deployment**: No multicast/broadcast requirements
|
||||
|
||||
### ✅ Long-term Advantages
|
||||
- **Scalable architecture**: Centralized management across sites
|
||||
- **Improved reliability**: Eliminates discovery protocol dependencies
|
||||
- **Better user experience**: Automatic device detection and status
|
||||
- **Future-proof design**: Device-driven communication model
|
||||
|
||||
## Implementation Approach
|
||||
|
||||
### Hybrid Strategy
|
||||
```mermaid
|
||||
graph TD
|
||||
PowerOn[Device /power_on] --> Identify[MAC-based Identification]
|
||||
Identify --> New{New Device?}
|
||||
|
||||
New -->|Yes| Create[Create Device Record]
|
||||
New -->|No| Update[Update Existing Record]
|
||||
|
||||
Create --> CheckAccount{Account Known?}
|
||||
CheckAccount -->|No| RegisterFlow[Trigger Registration]
|
||||
CheckAccount -->|Yes| LinkAccount[Link to Account]
|
||||
|
||||
Update --> DetectChanges[Detect Changes]
|
||||
DetectChanges --> Migration{Migration Needed?}
|
||||
Migration -->|Yes| SendInstructions[Send Migration Instructions]
|
||||
|
||||
LinkAccount --> Response[Send Configuration Response]
|
||||
SendInstructions --> Response
|
||||
RegisterFlow --> Response
|
||||
```
|
||||
|
||||
### Risk Mitigation
|
||||
- **Maintain backward compatibility** with existing discovery
|
||||
- **Graceful fallbacks** when /power_on data incomplete
|
||||
- **Preserve user workflows** while adding enhanced capabilities
|
||||
- **Comprehensive logging** for troubleshooting
|
||||
|
||||
## Success Metrics
|
||||
|
||||
### Technical Metrics
|
||||
- **Network independence**: % of operations not requiring local network
|
||||
- **Real-time capability**: Power-on event processing latency < 2s
|
||||
- **Data completeness**: % of devices with full metadata via /power_on
|
||||
- **Migration success**: % of successful remote migrations
|
||||
|
||||
### User Experience Metrics
|
||||
- **Discovery reliability**: % of devices automatically detected
|
||||
- **Setup time**: Time from device power-on to full management
|
||||
- **Management accessibility**: % of operations available remotely
|
||||
- **Error reduction**: Decrease in network-related issues
|
||||
|
||||
## Conclusion
|
||||
|
||||
The `/power_on` enhancement represents a strategic opportunity to:
|
||||
|
||||
1. **Eliminate network dependencies** while maintaining full functionality
|
||||
2. **Enable remote device management** across diverse network topologies
|
||||
3. **Improve user experience** through automatic device detection
|
||||
4. **Future-proof the architecture** for scalable device management
|
||||
|
||||
**Recommendation**: Proceed with hybrid implementation approach, prioritizing network independence while preserving existing user workflows and system reliability.
|
||||
|
||||
**Timeline**: Phase 1 implementation feasible within 2-3 sprints, with Phases 2-3 extending capabilities based on user feedback and firmware enhancement opportunities.
|
||||
@@ -0,0 +1,222 @@
|
||||
# Migration Flow Diagrams
|
||||
|
||||
This document specifies the diagrams needed for the migration guide, with descriptions that can be used to create actual visual diagrams.
|
||||
|
||||
## 1. Overall Migration Process Flow
|
||||
|
||||
### Description
|
||||
A flowchart showing the complete migration journey from start to finish.
|
||||
|
||||
### Elements
|
||||
```
|
||||
[Start] → [Install SoundTouch Service] → [Create Account] → [Prepare Devices]
|
||||
↓
|
||||
[Enable Remote Services] → [Discover Devices] → [Register Devices]
|
||||
↓
|
||||
[Start Migration] → [Data Collection Phase] → [Testing Phase] → [Full Local Phase]
|
||||
↓
|
||||
[Verify Migration] → [Complete] → [Post-Migration Setup]
|
||||
```
|
||||
|
||||
### Decision Points
|
||||
- Multiple devices? → Repeat device steps
|
||||
- Migration issues? → Rollback option
|
||||
- All devices complete? → Account fully migrated
|
||||
|
||||
### Color Coding
|
||||
- **Blue**: Service setup steps
|
||||
- **Green**: Successful completion states
|
||||
- **Orange**: In-progress/testing states
|
||||
- **Red**: Error handling/rollback paths
|
||||
- **Gray**: Optional steps
|
||||
|
||||
## 2. Network Topology Diagram
|
||||
|
||||
### Description
|
||||
Shows the network layout with Raspberry Pi, router, and SoundTouch devices.
|
||||
|
||||
### Components
|
||||
```
|
||||
Internet Cloud
|
||||
↑↓ (Optional - during migration)
|
||||
Home Router (192.168.1.1)
|
||||
├── Raspberry Pi (192.168.1.10) [SoundTouch Service]
|
||||
├── Living Room Speaker (192.168.1.100)
|
||||
├── Kitchen Speaker (192.168.1.101)
|
||||
├── Bedroom Speaker (192.168.1.102)
|
||||
└── Office Speaker (192.168.1.103)
|
||||
```
|
||||
|
||||
### Connections
|
||||
- **Solid lines**: Active connections
|
||||
- **Dashed lines**: Migration-phase connections to Bose cloud
|
||||
- **Thick lines**: Primary data flow to local service
|
||||
|
||||
## 3. Device State Lifecycle
|
||||
|
||||
### Description
|
||||
State machine showing device progression through migration phases.
|
||||
|
||||
### States and Transitions
|
||||
```
|
||||
[Unregistered] → [Discovered] → [Registered] → [Migrating]
|
||||
↓
|
||||
[Active - Local Only] ← [Active - Testing] ← [Active - Data Collection]
|
||||
↑ ↓
|
||||
[Error/Rollback] ← ← ← ← ← ← ← ← ← ← ← ← ← ← ← ← ← [Migration Failed]
|
||||
```
|
||||
|
||||
### State Descriptions
|
||||
- **Unregistered**: Device not known to service
|
||||
- **Discovered**: Found on network, remote services enabled
|
||||
- **Registered**: Added to account, ready for migration
|
||||
- **Migrating - Data Collection**: Building local database
|
||||
- **Migrating - Testing**: Using local service with fallback
|
||||
- **Active - Local Only**: Full independence achieved
|
||||
- **Error/Rollback**: Issues detected, can revert to Bose
|
||||
|
||||
## 4. Data Flow During Migration
|
||||
|
||||
### Description
|
||||
Shows how data flows between components during different migration phases.
|
||||
|
||||
### Phase 1 - Data Collection
|
||||
```
|
||||
SoundTouch Device → Bose Cloud Services
|
||||
↓ (mirror)
|
||||
Local Service (collecting data)
|
||||
```
|
||||
|
||||
### Phase 2 - Testing
|
||||
```
|
||||
SoundTouch Device ↔ Local Service (primary)
|
||||
↕ (fallback when needed)
|
||||
Bose Cloud Services
|
||||
```
|
||||
|
||||
### Phase 3 - Full Local
|
||||
```
|
||||
SoundTouch Device ↔ Local Service (only)
|
||||
|
||||
Bose Cloud Services (disconnected)
|
||||
```
|
||||
|
||||
### Data Types
|
||||
- **Presets**: Station favorites and custom sources
|
||||
- **Recents**: Play history and recently accessed content
|
||||
- **Sources**: Configured music services (Spotify, etc.)
|
||||
- **Device Config**: Network settings, capabilities, metadata
|
||||
|
||||
## 5. Migration Timeline Visualization
|
||||
|
||||
### Description
|
||||
Gantt-chart style timeline showing typical migration schedule.
|
||||
|
||||
### Timeline (7-day example)
|
||||
```
|
||||
Day 1-2: Data Collection Phase
|
||||
████████████████████████████████████████
|
||||
|
||||
Day 3-4: Data Validation
|
||||
████████████████████████████
|
||||
|
||||
Day 5-6: Testing Phase
|
||||
████████████████████████
|
||||
|
||||
Day 7+: Full Local Operation
|
||||
████████████████████████→
|
||||
```
|
||||
|
||||
### Parallel Activities
|
||||
- Multiple devices can be in different phases
|
||||
- Service continues operating throughout
|
||||
- User can interact normally during process
|
||||
|
||||
## 6. Service Architecture Overview
|
||||
|
||||
### Description
|
||||
High-level architecture showing enhanced SoundTouch service components.
|
||||
|
||||
### Components
|
||||
```
|
||||
Web Dashboard ← → HTTP API ← → REST Endpoints
|
||||
↑ ↑ ↑
|
||||
└─── User ──────┼──── Devices ─┘
|
||||
↓
|
||||
Service Core
|
||||
├── Account Manager
|
||||
├── Device Lifecycle
|
||||
├── Event Processor
|
||||
├── Migration Controller
|
||||
└── Data Store
|
||||
↓
|
||||
File System Storage
|
||||
├── accounts/
|
||||
├── devices/
|
||||
├── sessions/ (existing)
|
||||
└── system/
|
||||
```
|
||||
|
||||
### External Integrations
|
||||
- **Bose Cloud** (during migration)
|
||||
- **Music Services** (Spotify, TuneIn, etc.)
|
||||
- **Discovery Services** (mDNS, UPnP)
|
||||
|
||||
## 7. Error Handling and Rollback Flow
|
||||
|
||||
### Description
|
||||
Decision tree for handling migration issues and rollback scenarios.
|
||||
|
||||
### Error Detection
|
||||
```
|
||||
Migration Issue Detected
|
||||
├── Device Unresponsive → Retry → Success/Rollback
|
||||
├── Data Corruption → Restore from Backup → Continue/Rollback
|
||||
├── Service Unavailable → Wait/Restart → Continue/Rollback
|
||||
└── User Dissatisfaction → Manual Rollback → Restore Bose Config
|
||||
```
|
||||
|
||||
### Rollback Process
|
||||
```
|
||||
[Rollback Initiated]
|
||||
↓
|
||||
[Disable Local Services]
|
||||
↓
|
||||
[Restore Original Device Config]
|
||||
↓
|
||||
[Re-enable Bose Services]
|
||||
↓
|
||||
[Verify Functionality]
|
||||
↓
|
||||
[Rollback Complete]
|
||||
```
|
||||
|
||||
## Implementation Notes
|
||||
|
||||
### For Diagram Creation
|
||||
1. Use consistent colors as specified in main color scheme
|
||||
2. Include clear labels for all components
|
||||
3. Show directional flow with appropriate arrows
|
||||
4. Use standard flowchart symbols where applicable
|
||||
5. Ensure text is readable at various sizes
|
||||
|
||||
### Tools Recommended
|
||||
- **Lucidchart**: Professional flowcharts and network diagrams
|
||||
- **Draw.io**: Free online diagram tool
|
||||
- **Miro**: Collaborative whiteboarding
|
||||
- **PlantUML**: Code-based diagram generation
|
||||
|
||||
### File Naming Convention
|
||||
- `migration-flow-overview.svg` - Overall process flow
|
||||
- `network-topology.svg` - Network layout
|
||||
- `device-lifecycle.svg` - State machine
|
||||
- `data-flow-phases.svg` - Data flow during migration
|
||||
- `migration-timeline.svg` - Timeline visualization
|
||||
- `service-architecture.svg` - System architecture
|
||||
- `error-rollback-flow.svg` - Error handling
|
||||
|
||||
### Accessibility
|
||||
- Include alt-text descriptions
|
||||
- Use patterns/textures in addition to colors
|
||||
- Ensure sufficient contrast
|
||||
- Provide text-based versions for screen readers
|
||||
@@ -394,6 +394,9 @@ soundtouch-cli --host <device> source spotify
|
||||
soundtouch-cli --host <device> source bluetooth
|
||||
soundtouch-cli --host <device> source aux
|
||||
|
||||
# Custom radio selection (via soundtouch-service)
|
||||
soundtouch-cli --host <device> source custom-radio --url <STREAM_URL> [--name <NAME>] [--artwork <ARTWORK>] [--service-url <SERVICE_URL>]
|
||||
|
||||
# Advanced content selection
|
||||
soundtouch-cli --host <device> source internet-radio --location <URL> [--name <NAME>]
|
||||
soundtouch-cli --host <device> source local-music --location <LOCATION> --account <ACCOUNT>
|
||||
@@ -482,6 +485,7 @@ soundtouch-cli --host 192.168.1.10 source compare
|
||||
| Command | Description | Requirements |
|
||||
|---------|-------------|--------------|
|
||||
| `internet-radio` | Select internet radio stream (LOCAL_INTERNET_RADIO) | Stream URL |
|
||||
| `custom-radio` | Select custom radio stream via soundtouch-service | Stream URL and service URL |
|
||||
| `local-music` | Select local music content (LOCAL_MUSIC) | SoundTouch App Media Server |
|
||||
| `stored-music` | Select stored music content (STORED_MUSIC) | UPnP/DLNA media server |
|
||||
| `content` | Generic content selection (advanced) | Source and location |
|
||||
@@ -495,6 +499,12 @@ The `internet-radio` command supports the streamUrl proxy format from the [Sound
|
||||
soundtouch-cli --host 192.168.1.10 source internet-radio \
|
||||
--location "http://contentapi.gmuth.de/station.php?name=Antenne%20Chillout&streamUrl=https://stream.antenne.de/chillout/stream/aacp" \
|
||||
--name "Antenne Chillout"
|
||||
|
||||
# Using local soundtouch-service for custom streams
|
||||
soundtouch-cli --host 192.168.1.10 source custom-radio \
|
||||
--url "https://stream.antenne.de/chillout/stream/aacp" \
|
||||
--name "Antenne Chillout" \
|
||||
--service-url "http://localhost:8080"
|
||||
```
|
||||
|
||||
#### Service Introspection
|
||||
@@ -1044,7 +1054,7 @@ soundtouch-cli --host 192.168.1.10 speaker beep
|
||||
|
||||
**Supported Languages for TTS:**
|
||||
- `EN` - English (default)
|
||||
- `DE` - German
|
||||
- `DE` - German
|
||||
- `ES` - Spanish
|
||||
- `FR` - French
|
||||
- `IT` - Italian
|
||||
@@ -1085,7 +1095,7 @@ soundtouch-cli --host <device> events subscribe [flags]
|
||||
|
||||
**Event Types:**
|
||||
- `nowPlaying` - Track changes, playback status
|
||||
- `volume` - Volume and mute changes
|
||||
- `volume` - Volume and mute changes
|
||||
- `connection` - Network connectivity status
|
||||
- `preset` - Preset configuration changes
|
||||
- `zone` - Multiroom zone changes
|
||||
|
||||
@@ -33,16 +33,23 @@ The `soundtouch-service` now includes a built-in HTTPS listener. This simplifies
|
||||
|
||||
- **HTTPS Port**: Configurable via `HTTPS_PORT` environment variable (defaults to `8443`).
|
||||
- **HTTPS Server URL**: Configurable via `HTTPS_SERVER_URL` (e.g., `https://mysoundtouch.local:8443`). If not set, the service attempts to guess it using the system hostname.
|
||||
- **Domain Coverage**: Automatically presents a certificate for `streaming.bose.com`, `updates.bose.com`, `stats.bose.com`, `bmx.bose.com`, and `content.api.bose.io`.
|
||||
- **Domain Coverage**: Automatically presents a certificate with comprehensive coverage using wildcard certificates (`*.api.bose.io`, `*.api.bosecm.com`) plus specific domains (`streaming.bose.com`, `updates.bose.com`, `stats.bose.com`, `bmx.bose.com`, `worldwide.bose.com`, `bose-prod.apigee.net`, etc.).
|
||||
- **Wildcard Support**: Uses RFC-compliant wildcard certificates for automatic coverage of all API subdomains, including event analytics endpoints like `events.api.bosecm.com`, `eventsdev.api.bosecm.com`, and future API services.
|
||||
- **TLS Error Logging**: Comprehensive logging of TLS handshake attempts, certificate matching, and connection failures for debugging DNS redirection issues.
|
||||
- **Automatic Setup**: On first start, it generates a server certificate signed by your AfterTouch local Root CA.
|
||||
|
||||
#### TLS Security
|
||||
#### TLS Security & Debugging
|
||||
|
||||
The built-in HTTPS listener is configured to use modern and secure TLS settings while maintaining compatibility with SoundTouch devices (which support up to TLS 1.2 with OpenSSL 1.0.2).
|
||||
|
||||
- **Minimum TLS Version**: TLS 1.2
|
||||
- **Preferred Cipher Suites**:
|
||||
- `ECDHE-RSA-AES128-GCM-SHA256`
|
||||
- **TLS Debugging**: Detailed logging of:
|
||||
- Certificate requests by domain (`[TLS] Certificate request for ServerName: events.api.bosecm.com`)
|
||||
- Wildcard certificate matching (`[TLS] ✅ Serving certificate for events.api.bosecm.com (matched *.api.bosecm.com)`)
|
||||
- Handshake failures (`[TLS] ❌ Handshake failed from 192.168.1.50: tls: certificate not found`)
|
||||
- Successful connections (`[TLS] ✅ Successful connection from 192.168.1.50`)
|
||||
- `ECDHE-RSA-AES256-GCM-SHA384`
|
||||
- `ECDHE-RSA-CHACHA20-POLY1305`
|
||||
- `RSA-AES128-GCM-SHA256` (Legacy support)
|
||||
|
||||
@@ -0,0 +1,753 @@
|
||||
# IoT Implementation Guide
|
||||
|
||||
## Overview
|
||||
|
||||
This guide provides technical implementation details for integrating with the Bose SoundTouch IoT configuration system. It covers the AWS IoT Core integration, certificate management, and device shadow operations.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- AWS IoT Core account and permissions
|
||||
- Understanding of MQTT protocol
|
||||
- Knowledge of X.509 certificate management
|
||||
- Familiarity with JSON and protobuf serialization
|
||||
|
||||
## Architecture Components
|
||||
|
||||
### Core System Design
|
||||
|
||||
```
|
||||
┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
|
||||
│ Mobile App │ │ Alexa Voice │ │ Web Interface │
|
||||
│ │ │ Assistant │ │ │
|
||||
└─────────┬───────┘ └─────────┬────────┘ └─────────┬───────┘
|
||||
│ │ │
|
||||
└──────────────────────┼───────────────────────┘
|
||||
│
|
||||
┌────────────▼──────────────┐
|
||||
│ AWS IoT Core │
|
||||
│ (MQTT Broker + │
|
||||
│ Device Shadows) │
|
||||
└────────────┬──────────────┘
|
||||
│ MQTT/TLS
|
||||
┌────────────▼──────────────┐
|
||||
│ SoundTouch Device │
|
||||
│ │
|
||||
│ ┌─────────────────────┐ │
|
||||
│ │ IoT Service │ │
|
||||
│ │ (/opt/Bose/IoT) │ │
|
||||
│ └─────────────────────┘ │
|
||||
│ ┌─────────────────────┐ │
|
||||
│ │ BoseApp Service │ │
|
||||
│ │ (/opt/Bose/BoseApp) │ │
|
||||
│ └─────────────────────┘ │
|
||||
└───────────────────────────┘
|
||||
```
|
||||
|
||||
### Configuration Flow
|
||||
|
||||
```
|
||||
1. Device Boot
|
||||
│
|
||||
▼
|
||||
2. Read IoT.xml (/mnt/nv/BoseApp-Persistence/1/IoT.xml)
|
||||
│
|
||||
▼
|
||||
3. Load Certificates (/mnt/nv/IoTCerts/)
|
||||
│
|
||||
▼
|
||||
4. Establish MQTT/TLS Connection
|
||||
│
|
||||
▼
|
||||
5. Subscribe to Device Shadow Topics
|
||||
│
|
||||
▼
|
||||
6. Publish Current Device State
|
||||
│
|
||||
▼
|
||||
7. Listen for Delta Messages
|
||||
```
|
||||
|
||||
## Implementation Details
|
||||
|
||||
### 1. Configuration File Management
|
||||
|
||||
#### IoT.xml Structure
|
||||
```xml
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<Configuration
|
||||
clientID="{device-unique-uuid}"
|
||||
iotEndpoint="{aws-iot-endpoint}"
|
||||
deployment="{PROD|DEV|TEST}" />
|
||||
```
|
||||
|
||||
#### Loading Configuration (C++ Implementation)
|
||||
```cpp
|
||||
#include <rapidxml/rapidxml.hpp>
|
||||
#include <fstream>
|
||||
|
||||
struct IoTConfig {
|
||||
std::string clientID;
|
||||
std::string iotEndpoint;
|
||||
std::string deployment;
|
||||
};
|
||||
|
||||
IoTConfig loadIoTConfig(const std::string& configPath) {
|
||||
std::ifstream file(configPath);
|
||||
std::string content((std::istreambuf_iterator<char>(file)),
|
||||
std::istreambuf_iterator<char>());
|
||||
|
||||
rapidxml::xml_document<> doc;
|
||||
doc.parse<0>(&content[0]);
|
||||
|
||||
auto configNode = doc.first_node("Configuration");
|
||||
|
||||
IoTConfig config;
|
||||
config.clientID = configNode->first_attribute("clientID")->value();
|
||||
config.iotEndpoint = configNode->first_attribute("iotEndpoint")->value();
|
||||
config.deployment = configNode->first_attribute("deployment")->value();
|
||||
|
||||
return config;
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Certificate Management
|
||||
|
||||
#### Certificate Files Structure
|
||||
```
|
||||
/mnt/nv/IoTCerts/
|
||||
├── iot-cert.pem.crt # Device client certificate
|
||||
├── iot-private.pem.key # Device private key
|
||||
└── default.pem # Additional cert data
|
||||
|
||||
/var/lib/iot/
|
||||
└── rootCA.crt # AWS IoT Root CA
|
||||
```
|
||||
|
||||
#### Certificate Registration Process
|
||||
```cpp
|
||||
#include <openssl/x509.h>
|
||||
#include <openssl/rsa.h>
|
||||
#include <openssl/pem.h>
|
||||
|
||||
class IoTCertificateManager {
|
||||
private:
|
||||
static const std::string CERT_ENDPOINT;
|
||||
static const std::string CERT_PATH;
|
||||
static const std::string KEY_PATH;
|
||||
|
||||
public:
|
||||
bool generateCSR() {
|
||||
// Generate EC key pair
|
||||
EC_KEY* eckey = EC_KEY_new_by_curve_name(NID_X9_62_prime256v1);
|
||||
EC_KEY_generate_key(eckey);
|
||||
|
||||
// Create certificate request
|
||||
X509_REQ* req = X509_REQ_new();
|
||||
X509_REQ_set_version(req, 0);
|
||||
|
||||
// Set subject name
|
||||
X509_NAME* name = X509_NAME_new();
|
||||
X509_NAME_add_entry_by_txt(name, "CN", MBSTRING_ASC,
|
||||
(unsigned char*)clientID.c_str(), -1, -1, 0);
|
||||
X509_REQ_set_subject_name(req, name);
|
||||
|
||||
// Set public key
|
||||
EVP_PKEY* pkey = EVP_PKEY_new();
|
||||
EVP_PKEY_set1_EC_KEY(pkey, eckey);
|
||||
X509_REQ_set_pubkey(req, pkey);
|
||||
|
||||
// Sign request
|
||||
X509_REQ_sign(req, pkey, EVP_sha256());
|
||||
|
||||
return sendCSRToEndpoint(req, pkey);
|
||||
}
|
||||
|
||||
bool sendCSRToEndpoint(X509_REQ* req, EVP_PKEY* pkey) {
|
||||
// Send CSR to voice.api.bose.io/alexa/certificate
|
||||
// Receive certificate response
|
||||
// Store certificate and private key
|
||||
return true;
|
||||
}
|
||||
};
|
||||
|
||||
const std::string IoTCertificateManager::CERT_ENDPOINT =
|
||||
"https://voice.api.bose.io/alexa/certificate";
|
||||
const std::string IoTCertificateManager::CERT_PATH =
|
||||
"/mnt/nv/IoTCerts/iot-cert.pem.crt";
|
||||
const std::string IoTCertificateManager::KEY_PATH =
|
||||
"/mnt/nv/IoTCerts/iot-private.pem.key";
|
||||
```
|
||||
|
||||
### 3. MQTT Connection Implementation
|
||||
|
||||
#### AWS IoT SDK Integration
|
||||
```cpp
|
||||
#include <aws/iot/MqttClient.h>
|
||||
#include <aws/iot/ShadowClient.h>
|
||||
|
||||
class IoTConnectionManager {
|
||||
private:
|
||||
std::unique_ptr<awsiotsdk::MqttClient> mqttClient;
|
||||
std::unique_ptr<awsiotsdk::Shadow> shadowClient;
|
||||
IoTConfig config;
|
||||
|
||||
public:
|
||||
awsiotsdk::ResponseCode connect() {
|
||||
// Setup connection parameters
|
||||
std::string endpoint = config.iotEndpoint;
|
||||
uint16_t port = 8883; // MQTT over SSL
|
||||
|
||||
// Load certificates
|
||||
std::string certPath = "/mnt/nv/IoTCerts/iot-cert.pem.crt";
|
||||
std::string keyPath = "/mnt/nv/IoTCerts/iot-private.pem.key";
|
||||
std::string rootCaPath = "/var/lib/iot/rootCA.crt";
|
||||
|
||||
// Create network connection
|
||||
auto networkConnection = std::make_shared<awsiotsdk::network::MbedTLSConnection>(
|
||||
endpoint, port, rootCaPath, certPath, keyPath
|
||||
);
|
||||
|
||||
// Create MQTT client
|
||||
mqttClient = awsiotsdk::MqttClient::Create(networkConnection);
|
||||
if (!mqttClient) {
|
||||
return awsiotsdk::ResponseCode::FAILURE;
|
||||
}
|
||||
|
||||
// Connect with client ID
|
||||
auto connectPacket = awsiotsdk::mqtt::ConnectPacket::Create(
|
||||
config.clientID,
|
||||
true, // cleanSession
|
||||
awsiotsdk::mqtt::QoS::QOS0,
|
||||
nullptr // will options
|
||||
);
|
||||
|
||||
return mqttClient->Connect(std::chrono::milliseconds(5000), connectPacket);
|
||||
}
|
||||
|
||||
awsiotsdk::ResponseCode initializeShadow() {
|
||||
shadowClient = awsiotsdk::Shadow::Create(mqttClient);
|
||||
if (!shadowClient) {
|
||||
return awsiotsdk::ResponseCode::FAILURE;
|
||||
}
|
||||
|
||||
// Subscribe to shadow delta
|
||||
auto deltaHandler = [this](const std::string& thingName,
|
||||
const std::string& payload) {
|
||||
handleShadowDelta(thingName, payload);
|
||||
};
|
||||
|
||||
return shadowClient->PerformUpdateAsync(
|
||||
config.clientID,
|
||||
"", // jsonString
|
||||
deltaHandler,
|
||||
std::chrono::seconds(10)
|
||||
);
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
### 4. Device Shadow Operations
|
||||
|
||||
#### Shadow Message Structures
|
||||
```cpp
|
||||
#include <rapidjson/document.h>
|
||||
#include <rapidjson/writer.h>
|
||||
#include <rapidjson/stringbuffer.h>
|
||||
|
||||
struct DeviceState {
|
||||
std::string deviceState; // "CONNECTED" | "DISCONNECTED"
|
||||
std::string powerState; // "ON" | "OFF"
|
||||
std::string zoneState; // Zone configuration
|
||||
std::string groupState; // Multi-room group info
|
||||
};
|
||||
|
||||
class ShadowMessageBuilder {
|
||||
public:
|
||||
static std::string createReportedState(const DeviceState& state) {
|
||||
rapidjson::Document doc;
|
||||
doc.SetObject();
|
||||
auto& allocator = doc.GetAllocator();
|
||||
|
||||
// Create state object
|
||||
rapidjson::Value stateObj(rapidjson::kObjectType);
|
||||
rapidjson::Value reportedObj(rapidjson::kObjectType);
|
||||
|
||||
// Add reported state fields
|
||||
reportedObj.AddMember("deviceState",
|
||||
rapidjson::Value(state.deviceState.c_str(), allocator),
|
||||
allocator);
|
||||
reportedObj.AddMember("powerState",
|
||||
rapidjson::Value(state.powerState.c_str(), allocator),
|
||||
allocator);
|
||||
reportedObj.AddMember("zoneState",
|
||||
rapidjson::Value(state.zoneState.c_str(), allocator),
|
||||
allocator);
|
||||
reportedObj.AddMember("groupState",
|
||||
rapidjson::Value(state.groupState.c_str(), allocator),
|
||||
allocator);
|
||||
|
||||
stateObj.AddMember("reported", reportedObj, allocator);
|
||||
doc.AddMember("state", stateObj, allocator);
|
||||
|
||||
// Serialize to string
|
||||
rapidjson::StringBuffer buffer;
|
||||
rapidjson::Writer<rapidjson::StringBuffer> writer(buffer);
|
||||
doc.Accept(writer);
|
||||
|
||||
return buffer.GetString();
|
||||
}
|
||||
|
||||
static DeviceState parseDesiredState(const std::string& json) {
|
||||
rapidjson::Document doc;
|
||||
doc.Parse(json.c_str());
|
||||
|
||||
DeviceState state;
|
||||
if (doc.HasMember("state") && doc["state"].HasMember("desired")) {
|
||||
auto& desired = doc["state"]["desired"];
|
||||
|
||||
if (desired.HasMember("powerState")) {
|
||||
state.powerState = desired["powerState"].GetString();
|
||||
}
|
||||
if (desired.HasMember("zoneState")) {
|
||||
state.zoneState = desired["zoneState"].GetString();
|
||||
}
|
||||
if (desired.HasMember("groupState")) {
|
||||
state.groupState = desired["groupState"].GetString();
|
||||
}
|
||||
}
|
||||
|
||||
return state;
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
#### Shadow Update Implementation
|
||||
```cpp
|
||||
class IoTShadowManager {
|
||||
private:
|
||||
std::shared_ptr<awsiotsdk::Shadow> shadowClient;
|
||||
std::string thingName;
|
||||
DeviceState currentState;
|
||||
|
||||
public:
|
||||
awsiotsdk::ResponseCode updateDeviceState(const DeviceState& newState) {
|
||||
currentState = newState;
|
||||
|
||||
std::string payload = ShadowMessageBuilder::createReportedState(newState);
|
||||
|
||||
auto responseHandler = [](const std::string& thingName,
|
||||
awsiotsdk::ShadowRequestType requestType,
|
||||
awsiotsdk::ShadowResponseType responseType,
|
||||
rapidjson::Document& payload) {
|
||||
if (responseType == awsiotsdk::ShadowResponseType::Accepted) {
|
||||
// Shadow update successful
|
||||
std::cout << "Shadow updated successfully" << std::endl;
|
||||
} else {
|
||||
// Handle rejection
|
||||
std::cout << "Shadow update rejected" << std::endl;
|
||||
}
|
||||
};
|
||||
|
||||
return shadowClient->PerformUpdateAsync(
|
||||
thingName,
|
||||
payload,
|
||||
responseHandler,
|
||||
std::chrono::seconds(10)
|
||||
);
|
||||
}
|
||||
|
||||
void handleShadowDelta(const std::string& thingName,
|
||||
const std::string& payload) {
|
||||
DeviceState desiredState = ShadowMessageBuilder::parseDesiredState(payload);
|
||||
|
||||
// Apply desired state changes to device
|
||||
if (!desiredState.powerState.empty()) {
|
||||
applyPowerStateChange(desiredState.powerState);
|
||||
}
|
||||
|
||||
if (!desiredState.zoneState.empty()) {
|
||||
applyZoneStateChange(desiredState.zoneState);
|
||||
}
|
||||
|
||||
if (!desiredState.groupState.empty()) {
|
||||
applyGroupStateChange(desiredState.groupState);
|
||||
}
|
||||
|
||||
// Report updated state back to shadow
|
||||
updateDeviceState(currentState);
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
### 5. Service Integration
|
||||
|
||||
#### Shepherd Service Configuration
|
||||
```xml
|
||||
<!-- /opt/Bose/etc/Shepherd-noncore.xml -->
|
||||
<ShepherdConfig>
|
||||
<daemon name="STSCertified"/>
|
||||
<daemon name="IoT">
|
||||
<env name="IOT_CONFIG_PATH">/mnt/nv/BoseApp-Persistence/1/IoT.xml</env>
|
||||
<env name="IOT_CERT_PATH">/mnt/nv/IoTCerts</env>
|
||||
</daemon>
|
||||
<daemon name="TPDA">
|
||||
<arg>-c</arg>
|
||||
<arg>/opt/Bose/etc/Voice.xml</arg>
|
||||
</daemon>
|
||||
</ShepherdConfig>
|
||||
```
|
||||
|
||||
#### System Startup Integration
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# /etc/init.d/SoundTouch fragment
|
||||
|
||||
# Create IoT directories
|
||||
mkdir -p /mnt/nv/BoseLog /mnt/nv/IoTCerts /mnt/nv/BoseApp-Persistence/1
|
||||
mkdir -m 700 -p /mnt/nv/BoseApp-Persistence/1/Keys
|
||||
|
||||
# Set proper permissions for certificate storage
|
||||
chmod 700 /mnt/nv/IoTCerts
|
||||
chown iot:iot /mnt/nv/IoTCerts
|
||||
|
||||
# Start shepherd daemon manager
|
||||
shepherdd --config-dir /opt/Bose/etc --run-dir /var/run/shepherd
|
||||
```
|
||||
|
||||
## Error Handling and Debugging
|
||||
|
||||
### Connection Retry Logic
|
||||
```cpp
|
||||
class ConnectionRetryManager {
|
||||
private:
|
||||
int maxRetries = 10;
|
||||
int retryDelaySeconds = 5;
|
||||
|
||||
public:
|
||||
awsiotsdk::ResponseCode connectWithRetry(IoTConnectionManager& manager) {
|
||||
for (int attempt = 1; attempt <= maxRetries; ++attempt) {
|
||||
std::cout << "Connection attempt " << attempt
|
||||
<< " to MQTT port at host " << config.iotEndpoint << std::endl;
|
||||
|
||||
auto result = manager.connect();
|
||||
if (result == awsiotsdk::ResponseCode::SUCCESS) {
|
||||
std::cout << "Successfully connected to MQTT server" << std::endl;
|
||||
return result;
|
||||
}
|
||||
|
||||
std::cout << "MQTT port not available. Retrying in "
|
||||
<< retryDelaySeconds << " seconds" << std::endl;
|
||||
|
||||
std::this_thread::sleep_for(std::chrono::seconds(retryDelaySeconds));
|
||||
retryDelaySeconds *= 2; // Exponential backoff
|
||||
}
|
||||
|
||||
std::cerr << "Failed to connect after " << maxRetries << " attempts" << std::endl;
|
||||
return awsiotsdk::ResponseCode::FAILURE;
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
### Logging and Monitoring
|
||||
```cpp
|
||||
class IoTLogger {
|
||||
public:
|
||||
static void logConnectionStatus(const std::string& status) {
|
||||
std::cout << "[IoT] Connection status: " << status << std::endl;
|
||||
}
|
||||
|
||||
static void logShadowResponse(awsiotsdk::ShadowResponseType response,
|
||||
const std::string& payload) {
|
||||
if (response == awsiotsdk::ShadowResponseType::Accepted) {
|
||||
std::cout << "[IoT] Shadow response: accepted. Payload: " << payload << std::endl;
|
||||
} else {
|
||||
std::cout << "[IoT] Shadow response: rejected" << std::endl;
|
||||
}
|
||||
}
|
||||
|
||||
static void logCertificateStatus(bool success) {
|
||||
if (success) {
|
||||
std::cout << "[IoT] Certificate generated successfully" << std::endl;
|
||||
} else {
|
||||
std::cerr << "[IoT] Failed to generate iot certificate" << std::endl;
|
||||
}
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## Testing and Validation
|
||||
|
||||
### Unit Test Example
|
||||
```cpp
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
class IoTConfigTest : public ::testing::Test {
|
||||
protected:
|
||||
void SetUp() override {
|
||||
// Create test configuration file
|
||||
std::ofstream file("/tmp/test_iot.xml");
|
||||
file << R"(<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<Configuration clientID="test-client-id"
|
||||
iotEndpoint="test.iot.amazonaws.com"
|
||||
deployment="TEST" />)";
|
||||
file.close();
|
||||
}
|
||||
};
|
||||
|
||||
TEST_F(IoTConfigTest, LoadConfiguration) {
|
||||
auto config = loadIoTConfig("/tmp/test_iot.xml");
|
||||
|
||||
EXPECT_EQ(config.clientID, "test-client-id");
|
||||
EXPECT_EQ(config.iotEndpoint, "test.iot.amazonaws.com");
|
||||
EXPECT_EQ(config.deployment, "TEST");
|
||||
}
|
||||
|
||||
TEST_F(IoTConfigTest, ShadowMessageBuilder) {
|
||||
DeviceState state;
|
||||
state.deviceState = "CONNECTED";
|
||||
state.powerState = "ON";
|
||||
|
||||
std::string json = ShadowMessageBuilder::createReportedState(state);
|
||||
|
||||
// Verify JSON contains expected fields
|
||||
EXPECT_TRUE(json.find("\"deviceState\":\"CONNECTED\"") != std::string::npos);
|
||||
EXPECT_TRUE(json.find("\"powerState\":\"ON\"") != std::string::npos);
|
||||
}
|
||||
```
|
||||
|
||||
## Security Best Practices
|
||||
|
||||
1. **Certificate Management**
|
||||
- Store private keys with 600 permissions
|
||||
- Rotate certificates regularly
|
||||
- Use hardware security modules when available
|
||||
|
||||
2. **Network Security**
|
||||
- Always use TLS 1.2 or higher
|
||||
- Validate certificate chains
|
||||
- Implement certificate pinning
|
||||
|
||||
3. **Configuration Security**
|
||||
- Encrypt sensitive configuration data
|
||||
- Use secure storage for credentials
|
||||
- Implement configuration validation
|
||||
|
||||
## Troubleshooting Common Issues
|
||||
|
||||
### Certificate Problems
|
||||
```bash
|
||||
# Check certificate validity
|
||||
openssl x509 -in /mnt/nv/IoTCerts/iot-cert.pem.crt -text -noout
|
||||
|
||||
# Verify private key matches certificate
|
||||
openssl x509 -noout -modulus -in /mnt/nv/IoTCerts/iot-cert.pem.crt | openssl md5
|
||||
openssl rsa -noout -modulus -in /mnt/nv/IoTCerts/iot-private.pem.key | openssl md5
|
||||
```
|
||||
|
||||
### Connection Issues
|
||||
```bash
|
||||
# Test MQTT connectivity
|
||||
mosquitto_pub -h a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com \
|
||||
-p 8883 --cafile /var/lib/iot/rootCA.crt \
|
||||
--cert /mnt/nv/IoTCerts/iot-cert.pem.crt \
|
||||
--key /mnt/nv/IoTCerts/iot-private.pem.key \
|
||||
-t '$aws/things/test/shadow/update' \
|
||||
-m '{"state":{"reported":{"test":"value"}}}'
|
||||
```
|
||||
|
||||
### Service Debugging
|
||||
```bash
|
||||
# Check service status
|
||||
ps aux | grep IoT
|
||||
|
||||
# Monitor system logs
|
||||
tail -f /mnt/nv/BoseLog/IoT.log
|
||||
|
||||
# Check Shepherd status
|
||||
shepherdd --status
|
||||
```
|
||||
|
||||
## MQTT Monitoring and Research
|
||||
|
||||
### Direct Device Credential Access
|
||||
|
||||
With device certificates and private keys available from firmware backups, it's technically possible to monitor MQTT traffic:
|
||||
|
||||
```bash
|
||||
# Subscribe to your device's shadow events only
|
||||
CLIENT_ID="577ecfcc-2db3-4989-92c9-76d7704f9fb3" # Your device's UUID
|
||||
mosquitto_sub -h a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com \
|
||||
-p 8883 --cafile /var/lib/iot/rootCA.crt \
|
||||
--cert /mnt/nv/IoTCerts/iot-cert.pem.crt \
|
||||
--key /mnt/nv/IoTCerts/iot-private.pem.key \
|
||||
-t "\$aws/things/$CLIENT_ID/shadow/update/accepted"
|
||||
```
|
||||
|
||||
### Security Constraints and Limitations
|
||||
|
||||
#### AWS IoT Policy Restrictions
|
||||
Device certificates are bound to restrictive policies:
|
||||
|
||||
```json
|
||||
{
|
||||
"Version": "2012-10-17",
|
||||
"Statement": [
|
||||
{
|
||||
"Effect": "Allow",
|
||||
"Action": "iot:Connect",
|
||||
"Resource": "arn:aws:iot:us-east-1:*:client/${iot:ClientId}"
|
||||
},
|
||||
{
|
||||
"Effect": "Allow",
|
||||
"Action": ["iot:Publish", "iot:Subscribe", "iot:Receive"],
|
||||
"Resource": [
|
||||
"arn:aws:iot:us-east-1:*:topic/$aws/things/${iot:ClientId}/shadow/*"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**Limitations:**
|
||||
- Access only to your specific device topics
|
||||
- No wildcard subscriptions (`+` or `#`)
|
||||
- No cross-device monitoring
|
||||
- Potential IP geolocation restrictions
|
||||
- Certificate revocation for unusual activity
|
||||
|
||||
### Alternative Monitoring Approaches
|
||||
|
||||
#### Network Traffic Capture (Recommended)
|
||||
```bash
|
||||
# Capture MQTT traffic patterns without authentication
|
||||
tcpdump -i eth0 -s0 -w soundtouch_iot.pcap host a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com
|
||||
|
||||
# Monitor connection patterns in real-time
|
||||
tcpdump -i eth0 -n -A "host a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com and port 8883"
|
||||
|
||||
# Extract timing and packet size information
|
||||
tcpdump -i eth0 -ttt -s0 "host a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com"
|
||||
```
|
||||
|
||||
#### Local MQTT Broker for Testing
|
||||
```bash
|
||||
# Set up local Mosquitto broker
|
||||
sudo apt-get install mosquitto mosquitto-clients
|
||||
|
||||
# Configure TLS (optional)
|
||||
cat > /etc/mosquitto/conf.d/tls.conf << EOF
|
||||
port 8883
|
||||
cafile /path/to/ca.crt
|
||||
certfile /path/to/server.crt
|
||||
keyfile /path/to/server.key
|
||||
require_certificate true
|
||||
use_identity_as_username true
|
||||
EOF
|
||||
|
||||
# Test local shadow operations
|
||||
mosquitto_pub -h localhost -p 8883 \
|
||||
-t '$aws/things/test-device/shadow/update' \
|
||||
-m '{"state":{"reported":{"deviceState":"CONNECTED"}}}'
|
||||
```
|
||||
|
||||
### Message Analysis and Documentation
|
||||
|
||||
Expected shadow message patterns:
|
||||
|
||||
```cpp
|
||||
// Power state transitions
|
||||
{
|
||||
"state": {
|
||||
"reported": {
|
||||
"deviceState": "CONNECTED",
|
||||
"powerState": "ON|OFF"
|
||||
}
|
||||
},
|
||||
"timestamp": 1703875200
|
||||
}
|
||||
|
||||
// Audio control updates
|
||||
{
|
||||
"state": {
|
||||
"reported": {
|
||||
"volume": 25,
|
||||
"muted": false,
|
||||
"source": "SPOTIFY"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Multi-room coordination
|
||||
{
|
||||
"state": {
|
||||
"reported": {
|
||||
"zoneState": "master|slave",
|
||||
"groupMembers": ["device1", "device2"],
|
||||
"groupName": "Living Room"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Legal and Ethical Guidelines
|
||||
|
||||
**Important Warnings:**
|
||||
- Only monitor devices you personally own
|
||||
- Using device credentials outside the device may violate Bose Terms of Service
|
||||
- Accessing Bose's AWS infrastructure could be considered unauthorized
|
||||
- Certificate abuse may result in device blacklisting
|
||||
- Service shutdown in May 2026 makes this a temporary research opportunity
|
||||
|
||||
**Recommended Usage:**
|
||||
- Document message formats for local alternative development
|
||||
- Understand state transition patterns
|
||||
- Test compatibility with local MQTT brokers
|
||||
- Prepare migration strategies before cloud shutdown
|
||||
|
||||
### Research Implementation Example
|
||||
|
||||
```cpp
|
||||
class IoTResearchMonitor {
|
||||
private:
|
||||
std::string deviceClientId;
|
||||
std::ofstream messageLog;
|
||||
|
||||
public:
|
||||
void captureMessagePatterns() {
|
||||
// Subscribe only to owned device topics
|
||||
std::string topic = "$aws/things/" + deviceClientId + "/shadow/update/accepted";
|
||||
|
||||
auto messageHandler = [this](const std::string& topic, const std::string& payload) {
|
||||
// Log message structure for analysis
|
||||
messageLog << "Topic: " << topic << std::endl;
|
||||
messageLog << "Payload: " << payload << std::endl;
|
||||
messageLog << "Timestamp: " << getCurrentTimestamp() << std::endl;
|
||||
messageLog << "---" << std::endl;
|
||||
|
||||
// Parse and document state transitions
|
||||
documentStateTransition(payload);
|
||||
};
|
||||
|
||||
// WARNING: Only use with your own device certificates
|
||||
connectToAWSIoT(messageHandler);
|
||||
}
|
||||
|
||||
void documentStateTransition(const std::string& json) {
|
||||
// Analyze JSON structure for local implementation
|
||||
rapidjson::Document doc;
|
||||
doc.Parse(json.c_str());
|
||||
|
||||
if (doc.HasMember("state") && doc["state"].HasMember("reported")) {
|
||||
// Document field types and value ranges
|
||||
auto& reported = doc["state"]["reported"];
|
||||
|
||||
for (auto& field : reported.GetObject()) {
|
||||
std::cout << "Field: " << field.name.GetString()
|
||||
<< ", Type: " << getJSONType(field.value) << std::endl;
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
This implementation guide provides the foundation for integrating with the Bose SoundTouch IoT system using AWS IoT Core, certificate-based authentication, and device shadow operations. The monitoring capabilities should be used responsibly and only for research purposes to develop local alternatives.
|
||||
@@ -0,0 +1,218 @@
|
||||
# MAC Address to Serial Number Mapping
|
||||
|
||||
**Understanding and troubleshooting device identification in SoundTouch service**
|
||||
|
||||
This guide explains how the SoundTouch service handles device identification through MAC address to serial number mapping, and how to troubleshoot related issues.
|
||||
|
||||
## 📋 **Overview**
|
||||
|
||||
The SoundTouch service uses two different identifiers for devices:
|
||||
|
||||
- **MAC Address** (`A81B6A536A98`) - Used in HTTP API requests and UPnP discovery
|
||||
- **Serial Number** (`I6332527703739342000020`) - Used for internal file storage
|
||||
|
||||
The service automatically maps between these identifiers so that API requests using MAC addresses can access files stored using serial numbers.
|
||||
|
||||
## 🔍 **How It Works**
|
||||
|
||||
### Request Flow
|
||||
```
|
||||
1. HTTP Request: GET /streaming/account/3230304/device/A81B6A536A98/presets
|
||||
2. MAC Resolution: A81B6A536A98 → I6332527703739342000020
|
||||
3. File Access: accounts/3230304/devices/I6332527703739342000020/Presets.xml
|
||||
```
|
||||
|
||||
### UPnP Discovery Integration
|
||||
The service extracts MAC addresses from UPnP device descriptions:
|
||||
|
||||
```xml
|
||||
<!-- From http://192.168.1.100:8091/XD/BO5EBO5E-F00D-F00D-FEED-A81B6A536A98.xml -->
|
||||
<root xmlns="urn:schemas-upnp-org:device-1-0">
|
||||
<device>
|
||||
<friendlyName>Sound Machinery</friendlyName>
|
||||
<modelName>SoundTouch 10</modelName>
|
||||
<serialNumber>A81B6A536A98</serialNumber> <!-- MAC address here -->
|
||||
</device>
|
||||
</root>
|
||||
```
|
||||
|
||||
## ⚙️ **Automatic Setup**
|
||||
|
||||
The mapping is created automatically when the service starts:
|
||||
|
||||
1. **Directory Scan**: Service scans `data/accounts/{account}/devices/{serial}/`
|
||||
2. **DeviceInfo.xml**: Reads MAC address from each device's info file
|
||||
3. **Mapping Creation**: Creates MAC → Serial mapping in memory
|
||||
4. **Normalization**: Handles different MAC address formats automatically
|
||||
|
||||
## 🛠️ **Supported MAC Address Formats**
|
||||
|
||||
The service handles all common MAC address formats automatically:
|
||||
|
||||
| Format | Example | Status |
|
||||
|-------------|---------------------|-------------|
|
||||
| Standard | `A81B6A536A98` | ✅ Supported |
|
||||
| Lowercase | `a81b6a536a98` | ✅ Supported |
|
||||
| With Colons | `A8:1B:6A:53:6A:98` | ✅ Supported |
|
||||
| With Dashes | `A8-1B-6A-53-6A-98` | ✅ Supported |
|
||||
| Mixed Case | `a81B6a536A98` | ✅ Supported |
|
||||
| With Spaces | ` A81B6A536A98 ` | ✅ Supported |
|
||||
|
||||
## 🔧 **Troubleshooting**
|
||||
|
||||
### Problem: API requests fail with "file not found" errors
|
||||
|
||||
**Symptoms:**
|
||||
```
|
||||
GET /streaming/account/3230304/device/A81B6A536A98/presets
|
||||
→ 500 Internal Server Error
|
||||
→ Log: "open .../devices/A81B6A536A98/Presets.xml: no such file or directory"
|
||||
```
|
||||
|
||||
**Diagnosis:**
|
||||
1. Check if mapping exists:
|
||||
```bash
|
||||
# Look for device directory
|
||||
ls data/accounts/3230304/devices/
|
||||
# Should show serial numbers like: I6332527703739342000020
|
||||
```
|
||||
|
||||
2. Check DeviceInfo.xml:
|
||||
```bash
|
||||
cat data/accounts/3230304/devices/I6332527703739342000020/DeviceInfo.xml
|
||||
# Look for <macAddress> field
|
||||
```
|
||||
|
||||
**Solutions:**
|
||||
|
||||
#### Solution 1: Restart the Service
|
||||
The mapping is created at startup. Simply restart:
|
||||
```bash
|
||||
sudo systemctl restart soundtouch-service
|
||||
```
|
||||
|
||||
#### Solution 2: Check DeviceInfo.xml Format
|
||||
Ensure the MAC address is present:
|
||||
```xml
|
||||
<info deviceID="I6332527703739342000020">
|
||||
<networkInfo type="SCM">
|
||||
<macAddress>A81B6A536A98</macAddress> <!-- Must be present -->
|
||||
<ipAddress>192.168.178.35</ipAddress>
|
||||
</networkInfo>
|
||||
</info>
|
||||
```
|
||||
|
||||
#### Solution 3: Manual Device Addition
|
||||
If the device was added manually, ensure proper structure:
|
||||
```bash
|
||||
# Create device directory using serial number
|
||||
mkdir -p data/accounts/3230304/devices/I6332527703739342000020
|
||||
|
||||
# Create DeviceInfo.xml with MAC address
|
||||
cat > data/accounts/3230304/devices/I6332527703739342000020/DeviceInfo.xml << EOF
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<info deviceID="I6332527703739342000020">
|
||||
<name>My SoundTouch Device</name>
|
||||
<networkInfo type="SCM">
|
||||
<macAddress>A81B6A536A98</macAddress>
|
||||
<ipAddress>192.168.1.100</ipAddress>
|
||||
</networkInfo>
|
||||
</info>
|
||||
EOF
|
||||
```
|
||||
|
||||
### Problem: UPnP discovery not creating mappings
|
||||
|
||||
**Check UPnP accessibility:**
|
||||
```bash
|
||||
# Test UPnP endpoint directly
|
||||
curl http://192.168.1.100:8091/XD/BO5EBO5E-F00D-F00D-FEED-A81B6A536A98.xml
|
||||
|
||||
# Should return XML with <serialNumber> field
|
||||
```
|
||||
|
||||
**Enable debug logging:**
|
||||
```bash
|
||||
# Check service logs for UPnP activity
|
||||
journalctl -u soundtouch-service -f | grep UPnP
|
||||
```
|
||||
|
||||
### Problem: Case or format mismatches
|
||||
|
||||
This should be handled automatically, but you can verify:
|
||||
|
||||
**Test different formats:**
|
||||
```bash
|
||||
# All of these should work the same:
|
||||
curl http://localhost:8000/streaming/account/3230304/device/A81B6A536A98/presets
|
||||
curl http://localhost:8000/streaming/account/3230304/device/a81b6a536a98/presets
|
||||
curl http://localhost:8000/streaming/account/3230304/device/A8:1B:6A:53:6A:98/presets
|
||||
```
|
||||
|
||||
## 📊 **Monitoring and Diagnostics**
|
||||
|
||||
### Check Current Mappings
|
||||
The service logs mapping creation at startup:
|
||||
```bash
|
||||
journalctl -u soundtouch-service | grep "MAC.*serial"
|
||||
```
|
||||
|
||||
### Verify File Structure
|
||||
Ensure proper directory organization:
|
||||
```
|
||||
data/
|
||||
└── accounts/
|
||||
└── 3230304/
|
||||
└── devices/
|
||||
└── I6332527703739342000020/ # Serial number directory
|
||||
├── DeviceInfo.xml # Contains MAC address
|
||||
├── Presets.xml
|
||||
└── Sources.xml
|
||||
```
|
||||
|
||||
## 🔗 **Related Documentation**
|
||||
|
||||
- [Device Initial Setup](DEVICE-INITIAL-SETUP.md) - Setting up new devices
|
||||
- [Troubleshooting Guide](TROUBLESHOOTING.md) - General troubleshooting steps
|
||||
- [SoundTouch Service](SOUNDTOUCH-SERVICE.md) - Service configuration and management
|
||||
|
||||
## 🏗️ **Technical Implementation**
|
||||
|
||||
For developers interested in the technical details:
|
||||
|
||||
### Normalization Algorithm
|
||||
```go
|
||||
// MAC addresses are normalized by:
|
||||
// 1. Removing spaces, colons, and dashes
|
||||
// 2. Converting to uppercase
|
||||
// Examples:
|
||||
// "a8:1b:6a:53:6a:98" → "A81B6A536A98"
|
||||
// "A8-1B-6A-53-6A-98" → "A81B6A536A98"
|
||||
```
|
||||
|
||||
### Lookup Process
|
||||
```go
|
||||
// 1. Try exact match first
|
||||
// 2. If not found, try normalized version
|
||||
// 3. Return serial number for file access
|
||||
```
|
||||
|
||||
### Performance
|
||||
- **Lookup Time**: O(1) - Hash map lookup
|
||||
- **Memory Usage**: ~40 bytes per device mapping
|
||||
- **Initialization**: Scans all devices once at startup
|
||||
|
||||
## 📝 **Best Practices**
|
||||
|
||||
1. **Use Discovery**: Let UPnP discovery create mappings automatically
|
||||
2. **Consistent Format**: Store MAC addresses consistently in DeviceInfo.xml
|
||||
3. **Service Restart**: Restart service after manual device additions
|
||||
4. **Monitoring**: Check logs for mapping creation during startup
|
||||
5. **Backup**: Keep DeviceInfo.xml files backed up
|
||||
|
||||
## ⚠️ **Known Limitations**
|
||||
|
||||
- Mappings are created only at service startup
|
||||
- Manual device additions require service restart
|
||||
- MAC addresses must be present in DeviceInfo.xml
|
||||
- No automatic cleanup of stale mappings (restart required)
|
||||
@@ -0,0 +1,418 @@
|
||||
# THIS IS A PLANNED TO BE THE MIGRATION GUIDE
|
||||
|
||||
> This migration guide is not finalized, yet.
|
||||
> We're using it as an orientation for the required implementation.
|
||||
|
||||
---
|
||||
|
||||
# Complete Migration Guide - From Bose Cloud to Local SoundTouch Service
|
||||
|
||||
## Overview
|
||||
|
||||
This guide will walk you through migrating your Bose SoundTouch speakers from Bose's cloud services to AfterTouch, your own local SoundTouch service. By the end of this process, your speakers will be completely independent of Bose's servers while retaining all their functionality.
|
||||
|
||||
> **💡 Why Migrate?** Bose announced the shutdown of their SoundTouch cloud services in May 2026. This migration ensures your speakers continue working indefinitely with enhanced local control and monitoring.
|
||||
|
||||
## What You'll Need
|
||||
|
||||
### Hardware Requirements
|
||||
- **Raspberry Pi 4 or similar** (minimum: Raspberry Pi Zero 2W)
|
||||
- **MicroSD card** (16GB or larger)
|
||||
- **USB drive** (for device preparation)
|
||||
- **Network connection** for your Raspberry Pi
|
||||
|
||||
### Before You Start
|
||||
- **List all your SoundTouch devices** and their current locations
|
||||
- **Note your current presets and favorites** (they will be preserved)
|
||||
- **Ensure devices are on the same network** as your future SoundTouch service
|
||||
- **Basic computer skills** (following instructions, using a web browser)
|
||||
|
||||
### Time Estimate
|
||||
- **Setup**: 30-60 minutes for the service installation
|
||||
- **Per Device**: 10-15 minutes for each speaker migration
|
||||
- **Total**: 1-3 hours depending on number of devices
|
||||
|
||||
## Step 1: Install SoundTouch Service
|
||||
|
||||
### Option A: Raspberry Pi Installation (Recommended)
|
||||
|
||||
#### 1.1 Prepare Your Raspberry Pi
|
||||
|
||||
1. **Flash Raspberry Pi OS** to your SD card using Raspberry Pi Imager (see the raspberrypi.com documentation)
|
||||
2. **Enable SSH** during imaging or create an empty `ssh` file on the boot partition
|
||||
3. **Boot your Pi** and connect it to your network
|
||||
4. **Find your Pi's IP address** (check your router or use `ping raspberrypi.local`)
|
||||
|
||||
#### 1.2 Install SoundTouch Service
|
||||
|
||||
Connect to your Pi via SSH and run:
|
||||
|
||||
```bash
|
||||
# Download and install
|
||||
curl -sSL https://github.com/gesellix/Bose-SoundTouch/releases/latest/download/install.sh | bash
|
||||
|
||||
# Start the service
|
||||
sudo systemctl enable soundtouch-service
|
||||
sudo systemctl start soundtouch-service
|
||||
```
|
||||
|
||||
#### 1.3 Verify Installation
|
||||
|
||||
1. Open your web browser
|
||||
2. Go to `http://[PI_IP_ADDRESS]:8000` (replace with your Pi's IP)
|
||||
3. You should see the **SoundTouch Service Dashboard**
|
||||
|
||||

|
||||
*Example: SoundTouch Service main dashboard*
|
||||
|
||||
### Option B: Docker Installation
|
||||
|
||||
If you prefer Docker, run:
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
--name soundtouch-service \
|
||||
--restart unless-stopped \
|
||||
-p 8000:8000 \
|
||||
-p 8443:8443 \
|
||||
-v soundtouch-data:/data \
|
||||
gesellix/soundtouch-service:latest
|
||||
```
|
||||
|
||||
## Step 2: Create Your Account
|
||||
|
||||
### 2.1 Initial Setup
|
||||
|
||||
1. **Open the dashboard** at `http://[SERVICE_IP]:8000`
|
||||
2. Click **"Create New Account"**
|
||||
3. **Fill in your details**:
|
||||
- Account Name: `My Home Audio`
|
||||
- Email: `your@email.com` (optional, for notifications)
|
||||
- Migration Strategy: `Gradual` (recommended)
|
||||
|
||||

|
||||
*Example: Account creation form*
|
||||
|
||||
### 2.2 Account Configuration
|
||||
|
||||
After creation, you'll see your **Account Dashboard**:
|
||||
- **Account ID**: Unique identifier (e.g., `acc_home_audio_001`)
|
||||
- **Status**: `Active - Ready for Migration`
|
||||
- **Device Count**: Initially 0
|
||||
- **Migration Status**: `Prepared`
|
||||
|
||||

|
||||
*Example: Fresh account dashboard ready for device migration*
|
||||
|
||||
### 2.3 Initial Settings
|
||||
|
||||
Once your account is created, configure the global settings:
|
||||
1. **Settings**:
|
||||
- Check **Target Domain**: Ensure it's reachable from the speaker (e.g., `soundtouch.fritz.box`).
|
||||
- **DNS Discovery**: Enable DNS discovery on port `:53`. This is crucial for the DNS hook migration method.
|
||||
2. **Devices**:
|
||||
- Go to the **"Device Discovery"** tab.
|
||||
- Click **"Scan Network"** or manually add a speaker via IP address.
|
||||
- Your devices should appear with **SSH Status**: `Enabled`.
|
||||
|
||||

|
||||
*Example: Discovered devices with remote access enabled*
|
||||
|
||||
## Step 3: Prepare Your Devices
|
||||
|
||||
> **⚠️ Important**: This step temporarily enables SSH access on your speakers. SSH will be automatically disabled after migration unless you choose to keep it enabled.
|
||||
|
||||
### 3.1 Enable Remote Services
|
||||
|
||||
For each SoundTouch device:
|
||||
|
||||
1. **Prepare a USB drive**:
|
||||
- Format as FAT32
|
||||
- Create an empty file named `remote_services` (no extension)
|
||||
- (Optional) Firmware update/reset, see [Bose SoundTouch USB Update](https://downloads.bose.com/ced/soundtouch/soundtouch_usb/index.html)
|
||||
|
||||
2. **Insert USB drive** into your SoundTouch speaker
|
||||
3. **Power cycle** the device (unplug for 10 seconds, then reconnect)
|
||||
|
||||

|
||||
*Example: USB drive setup for enabling remote services*
|
||||
|
||||
## Step 4: Discover and Register Devices
|
||||
|
||||
### 4.1 Automatic Discovery
|
||||
|
||||
The service automatically scans for SoundTouch devices every 5 minutes. To trigger immediate discovery:
|
||||
|
||||
1. **Dashboard** → **"Devices"** → **"Discover Devices"**
|
||||
2. **Wait 30-60 seconds** for scan completion
|
||||
3. **Review discovered devices** in the list
|
||||
|
||||
### 4.2 Register Devices to Your Account
|
||||
|
||||
For each discovered device:
|
||||
|
||||
1. **Click device name** in the discovery list
|
||||
2. **Verify device information**:
|
||||
- Name: `Living Room Speaker`
|
||||
- Model: `SoundTouch 30`
|
||||
- MAC Address: `A8:1B:6A:53:6A:98`
|
||||
- IP Address: `192.168.1.100`
|
||||
- Status: `Discovered - Ready for Registration`
|
||||
|
||||
3. **Click "Register to Account"**
|
||||
4. **Choose registration type**:
|
||||
- **Fresh Setup**: For new or factory-reset devices
|
||||
- **Migrate from Bose**: For devices with existing Bose account (recommended)
|
||||
|
||||

|
||||
*Example: Device registration dialog with migration options*
|
||||
|
||||
### 4.3 Device Registration Results
|
||||
|
||||
After registration, you'll see:
|
||||
- **Device Status**: `Registered - Active`
|
||||
- **Account Association**: Your account name
|
||||
- **Lifecycle State**: `Active`
|
||||
- **Data Sources**: `Mirror Primary` (initially uses Bose, falls back to local)
|
||||
|
||||
## Step 5: Migrate Individual Devices
|
||||
|
||||
### 5.1 Step 3: Data Sync
|
||||
|
||||
1. **Dashboard** → **"Devices"** → Select your device
|
||||
2. Click **"Data Sync"**
|
||||
3. This fetches configuration (presets, recents, sources) from the speaker to the SoundTouch service.
|
||||
|
||||
### 5.2 Step 4: Migration
|
||||
|
||||
Once data is synced, proceed to the migration tab for the device:
|
||||
|
||||
1. **Backup XML**: Create an off-device backup of the current configuration.
|
||||
2. **Enable Persistent Remote Service**: This ensures SSH remains available after reboots.
|
||||
- *Note*: If you see `'rw: command not found'`, you can safely ignore it.
|
||||
3. **CA Certificate Configuration**:
|
||||
- **Test with explicit CA**: Verify the speaker can communicate using the local CA.
|
||||
- **Trust CA now**: Inject the local Root CA into the speaker's trust store.
|
||||
- **Test with shared trust store**: Verify general HTTPS communication.
|
||||
4. **Migration Method**:
|
||||
- Select **"Redirect via DNS hook"**.
|
||||
- **Test DNS Redirection**: Ensure the speaker correctly resolves the service domain.
|
||||
5. **Confirm Migration**: Apply the final changes to the speaker.
|
||||
|
||||
#### Example Migration Output:
|
||||
```text
|
||||
Successfully created off-device backup of current configuration.
|
||||
Pre-flight: Write access verified.
|
||||
Resolved soundtouch.fritz.box to 192.168.1.100
|
||||
Uploaded /mnt/nv/soundtouch-service/aftertouch.resolv.conf
|
||||
/mnt/nv/rc.local already contains Aftertouch hook logic
|
||||
(rw || mount -o remount,rw /): sh: rw: command not found
|
||||
|
||||
cp /etc/udhcpc.d/50default /etc/udhcpc.d/50default.original:
|
||||
Applied patch to /etc/udhcpc.d/50default
|
||||
Verified patch on /etc/udhcpc.d/50default
|
||||
cp /opt/Bose/udhcpc.script /opt/Bose/udhcpc.script.original:
|
||||
Applied patch to /opt/Bose/udhcpc.script
|
||||
Verified patch on /opt/Bose/udhcpc.script
|
||||
CA certificate already trusted, skipping injection
|
||||
```
|
||||
|
||||
## Step 7: Complete Account Migration
|
||||
|
||||
### 7.1 Migrate All Devices
|
||||
|
||||
Repeat the migration process for each of your SoundTouch devices. You can migrate multiple devices simultaneously, but we recommend doing 1-2 at a time to monitor progress.
|
||||
|
||||
**Migration Dashboard** shows overall progress:
|
||||
- **Devices Migrated**: `2 of 4 completed`
|
||||
- **Currently Migrating**: `Living Room Speaker, Kitchen Speaker`
|
||||
- **Pending Migration**: `Bedroom Speaker, Office Speaker`
|
||||
- **Estimated Completion**: `3 days remaining`
|
||||
|
||||

|
||||
*Example: Account-wide migration progress*
|
||||
|
||||
### 7.2 Verify Complete Migration
|
||||
|
||||
When all devices are migrated:
|
||||
|
||||
1. **Account Status**: `Active - Fully Migrated`
|
||||
2. **Bose Dependency**: `None`
|
||||
3. **Local Control**: `100%`
|
||||
4. **Device Health**: All devices show `Healthy - Local Only`
|
||||
|
||||

|
||||
*Example: Completed migration dashboard*
|
||||
|
||||
## Step 8: Post-Migration Tasks
|
||||
|
||||
1. **Remove USB stick** from the speaker.
|
||||
2. **Reboot** the device to apply all changes.
|
||||
|
||||
### 8.1 Disable Remote Services (Optional)
|
||||
|
||||
For enhanced security, you can disable SSH on migrated devices. However, keeping it enabled allows for easier future maintenance or reverts.
|
||||
|
||||
### 8.2 Configure Backups
|
||||
|
||||
Set up automatic backups of your device configurations:
|
||||
|
||||
1. **Dashboard** → **"Settings"** → **"Backup"**
|
||||
2. **Enable Automatic Backups**: ✅
|
||||
3. **Backup Schedule**: `Daily at 2 AM`
|
||||
4. **Retention**: `Keep 30 days`
|
||||
5. **Export Location**: `/data/backups` or external storage
|
||||
|
||||

|
||||
*Example: Backup configuration settings*
|
||||
|
||||
### 8.3 Set Up Monitoring Alerts (Optional)
|
||||
|
||||
Configure notifications for important events:
|
||||
|
||||
1. **Dashboard** → **"Settings"** → **"Notifications"**
|
||||
2. **Email Notifications**: Enter your email
|
||||
3. **Alert Types**:
|
||||
- ✅ Device goes offline
|
||||
- ✅ Migration failures
|
||||
- ✅ Service errors
|
||||
- ✅ Daily health summary
|
||||
|
||||
## Troubleshooting Common Issues
|
||||
|
||||
### Device Not Discovered
|
||||
|
||||
**Problem**: Device doesn't appear in discovery scan
|
||||
|
||||
**Solutions**:
|
||||
1. **Check network**: Ensure device and service are on same network
|
||||
2. **Verify USB setup**: Confirm `remote_services` file was processed
|
||||
3. **Power cycle**: Unplug device for 30 seconds, reconnect
|
||||
4. **Manual add**: Dashboard → "Devices" → "Add Manually" with IP address
|
||||
|
||||
### Migration Stuck
|
||||
|
||||
**Problem**: Device stuck in "Migrating" status
|
||||
|
||||
**Solutions**:
|
||||
1. **Check device health**: Dashboard → Device → "Health Status"
|
||||
2. **Review logs**: Dashboard → Device → "View Logs"
|
||||
3. **Restart migration**: Device → "Migration" → "Restart Process"
|
||||
4. **Rollback**: Device → "Migration" → "Rollback to Bose"
|
||||
|
||||
### Presets Not Working
|
||||
|
||||
**Problem**: Saved presets don't work after migration
|
||||
|
||||
**Solutions**:
|
||||
1. **Verify sources**: Check configured sources are still available
|
||||
2. **Re-authenticate**: Re-login to music services (Spotify, etc.)
|
||||
3. **Rebuild presets**: Dashboard → Device → "Presets" → "Rebuild from Backup"
|
||||
|
||||
### Service Unreachable
|
||||
|
||||
**Problem**: Cannot access SoundTouch Service dashboard
|
||||
|
||||
**Solutions**:
|
||||
1. **Check service status**: `sudo systemctl status soundtouch-service`
|
||||
2. **Restart service**: `sudo systemctl restart soundtouch-service`
|
||||
3. **Check network**: Verify Pi is connected and accessible
|
||||
4. **Check ports**: Ensure ports 8000 and 8443 are not blocked
|
||||
|
||||
## Advanced Features
|
||||
|
||||
### Multi-Zone Management
|
||||
|
||||
After migration, your multi-zone setups work seamlessly:
|
||||
|
||||
1. **Dashboard** → **"Zones"**
|
||||
2. **Create Zone**: Select primary device and slaves
|
||||
3. **Zone Control**: Play, pause, volume control for entire zone
|
||||
4. **Individual Control**: Override individual speakers in zone
|
||||
|
||||
### Custom Sources
|
||||
|
||||
Add custom streaming sources:
|
||||
|
||||
1. **Dashboard** → **"Sources"** → **"Add Custom"**
|
||||
2. **Configure**:
|
||||
- Name: `Local Radio Station`
|
||||
- Stream URL: `http://stream.example.com:8000`
|
||||
- Image URL: `http://example.com/logo.png`
|
||||
3. **Assign to devices**: Select which devices can access this source
|
||||
|
||||
### API Access
|
||||
|
||||
For developers and advanced users:
|
||||
|
||||
- **REST API**: `http://[SERVICE_IP]:8000/api/v1/`
|
||||
- **Documentation**: `http://[SERVICE_IP]:8000/docs`
|
||||
- **WebSocket Events**: Real-time device status updates
|
||||
- **Export Data**: JSON/XML export of all device configurations
|
||||
|
||||
## Maintenance and Monitoring
|
||||
|
||||
### Daily Monitoring
|
||||
|
||||
Check your **Dashboard Summary**:
|
||||
- **All Devices Online**: ✅ Green indicators
|
||||
- **Response Times**: < 100ms average
|
||||
- **Error Rate**: < 1%
|
||||
- **Storage Usage**: Monitor disk space
|
||||
|
||||
### Weekly Tasks
|
||||
|
||||
1. **Review Health Reports**: Check weekly device health summaries
|
||||
2. **Update Service**: Check for SoundTouch service updates
|
||||
3. **Backup Verification**: Ensure backups are completing successfully
|
||||
4. **Log Review**: Check for any recurring issues or warnings
|
||||
|
||||
### Monthly Tasks
|
||||
|
||||
1. **Full System Backup**: Export complete account and device data
|
||||
2. **Performance Review**: Analyze response times and error patterns
|
||||
3. **Security Update**: Update Raspberry Pi OS and service
|
||||
4. **Capacity Planning**: Monitor storage and consider expansion
|
||||
|
||||
## Getting Help
|
||||
|
||||
### Documentation Resources
|
||||
|
||||
- **Technical Reference**: `/docs/reference/` - Detailed API and configuration docs
|
||||
- **Troubleshooting Guide**: `/docs/guides/TROUBLESHOOTING.md` - Common issues and solutions
|
||||
- **Community Forum**: GitHub Discussions for community support
|
||||
|
||||
### Diagnostic Information
|
||||
|
||||
When seeking help, provide:
|
||||
|
||||
1. **System Information**: Dashboard → "System" → "Download Diagnostic Report"
|
||||
2. **Device Logs**: Dashboard → Device → "Export Logs"
|
||||
3. **Migration History**: Dashboard → "Migration" → "Export Timeline"
|
||||
4. **Current Status**: Screenshot of main dashboard
|
||||
|
||||
### Support Channels
|
||||
|
||||
- **GitHub Issues**: Technical bugs and feature requests
|
||||
- **Community Discussions**: User questions and experiences
|
||||
- **Documentation Updates**: Corrections and improvements
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
Congratulations! 🎉 You've successfully migrated your SoundTouch speakers to local control. Your devices are now:
|
||||
|
||||
- ✅ **Independent** of Bose cloud services
|
||||
- ✅ **Fully functional** with all original features preserved
|
||||
- ✅ **Enhanced** with better monitoring and control
|
||||
- ✅ **Future-proof** against service shutdowns
|
||||
|
||||
**What's Next?**
|
||||
|
||||
- **Enjoy your music** with enhanced local control
|
||||
- **Monitor your system** through the dashboard
|
||||
- **Share your experience** with the community
|
||||
- **Explore advanced features** as you become more comfortable
|
||||
|
||||
Your SoundTouch speakers will now continue working indefinitely, regardless of external service availability. Welcome to true audio independence! 🔊
|
||||
@@ -0,0 +1,764 @@
|
||||
# MQTT Integration Design for SoundTouch Service
|
||||
|
||||
## Overview
|
||||
|
||||
This document outlines the design for integrating MQTT support into the existing SoundTouch service to simulate AWS IoT Core functionality. The integration will provide real-time device communication, shadow state management, and prepare for the AWS IoT service shutdown in May 2026.
|
||||
|
||||
## Current Architecture Analysis
|
||||
|
||||
### Existing Service Structure
|
||||
```
|
||||
Bose-SoundTouch/
|
||||
├── cmd/soundtouch-service/main.go # Main service entry point
|
||||
├── pkg/
|
||||
│ ├── client/ # HTTP client for devices
|
||||
│ ├── config/ # Configuration management
|
||||
│ ├── discovery/ # Device discovery (UPnP, mDNS)
|
||||
│ ├── models/ # Data structures
|
||||
│ └── service/
|
||||
│ ├── handlers/ # HTTP request handlers
|
||||
│ │ └── server.go # Main server struct
|
||||
│ ├── datastore/ # Data persistence
|
||||
│ ├── proxy/ # HTTP proxying
|
||||
│ └── [other services]
|
||||
```
|
||||
|
||||
### Key Components
|
||||
- **Server Struct**: Central HTTP handler in `pkg/service/handlers/server.go`
|
||||
- **Discovery Service**: UPnP/mDNS device discovery in `pkg/discovery/`
|
||||
- **DataStore**: Device state persistence in `pkg/service/datastore/`
|
||||
- **Device Models**: Data structures in `pkg/models/`
|
||||
|
||||
## MQTT Integration Design
|
||||
|
||||
### 1. New Package Structure
|
||||
|
||||
```
|
||||
pkg/service/mqtt/
|
||||
├── broker.go # MQTT broker implementation
|
||||
├── shadow.go # AWS IoT Shadow simulation
|
||||
├── auth.go # Certificate-based authentication
|
||||
├── topics.go # Topic routing and handlers
|
||||
├── bridge.go # HTTP ↔ MQTT state bridging
|
||||
├── config.go # MQTT configuration
|
||||
└── client.go # MQTT client utilities
|
||||
```
|
||||
|
||||
### 2. Core Components
|
||||
|
||||
#### A. MQTT Broker (`pkg/service/mqtt/broker.go`)
|
||||
```go
|
||||
package mqtt
|
||||
|
||||
import (
|
||||
"crypto/tls"
|
||||
"fmt"
|
||||
"log"
|
||||
"sync"
|
||||
|
||||
"github.com/mochi-co/mqtt/v2"
|
||||
"github.com/mochi-co/mqtt/v2/hooks/auth"
|
||||
"github.com/mochi-co/mqtt/v2/listeners"
|
||||
)
|
||||
|
||||
type Broker struct {
|
||||
server *mqtt.Server
|
||||
shadowStore *ShadowStore
|
||||
bridge *HTTPBridge
|
||||
authHook *AuthHook
|
||||
config *Config
|
||||
running bool
|
||||
mu sync.RWMutex
|
||||
}
|
||||
|
||||
type Config struct {
|
||||
Enabled bool `json:"enabled"`
|
||||
Port int `json:"port"`
|
||||
TLSEnabled bool `json:"tls_enabled"`
|
||||
CertFile string `json:"cert_file"`
|
||||
KeyFile string `json:"key_file"`
|
||||
DeviceCertPath string `json:"device_cert_path"`
|
||||
ShadowPersist bool `json:"shadow_persist"`
|
||||
}
|
||||
|
||||
func NewBroker(config *Config) (*Broker, error) {
|
||||
server := mqtt.New(nil)
|
||||
|
||||
shadowStore := NewShadowStore()
|
||||
authHook := NewAuthHook(config.DeviceCertPath)
|
||||
|
||||
return &Broker{
|
||||
server: server,
|
||||
shadowStore: shadowStore,
|
||||
authHook: authHook,
|
||||
config: config,
|
||||
}, nil
|
||||
}
|
||||
|
||||
func (b *Broker) Start() error {
|
||||
// Add TLS listener
|
||||
tlsConfig := &tls.Config{
|
||||
Certificates: []tls.Certificate{b.loadServerCert()},
|
||||
ClientAuth: tls.RequireAndVerifyClientCert,
|
||||
ClientCAs: b.loadDeviceCAs(),
|
||||
}
|
||||
|
||||
tcp := listeners.NewTCP("mqtt-tls", fmt.Sprintf(":%d", b.config.Port), &listeners.Config{
|
||||
TLSConfig: tlsConfig,
|
||||
})
|
||||
|
||||
b.server.AddListener(tcp)
|
||||
|
||||
// Add hooks
|
||||
b.server.AddHook(b.authHook, nil)
|
||||
b.server.AddHook(NewShadowHook(b.shadowStore), nil)
|
||||
|
||||
return b.server.Serve()
|
||||
}
|
||||
```
|
||||
|
||||
#### B. Shadow State Management (`pkg/service/mqtt/shadow.go`)
|
||||
```go
|
||||
package mqtt
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"sync"
|
||||
"time"
|
||||
)
|
||||
|
||||
type ShadowStore struct {
|
||||
shadows map[string]*DeviceShadow
|
||||
mu sync.RWMutex
|
||||
}
|
||||
|
||||
type DeviceShadow struct {
|
||||
State struct {
|
||||
Desired map[string]interface{} `json:"desired"`
|
||||
Reported map[string]interface{} `json:"reported"`
|
||||
Delta map[string]interface{} `json:"delta,omitempty"`
|
||||
} `json:"state"`
|
||||
Version int `json:"version"`
|
||||
Timestamp int64 `json:"timestamp"`
|
||||
ClientToken string `json:"clientToken,omitempty"`
|
||||
}
|
||||
|
||||
func NewShadowStore() *ShadowStore {
|
||||
return &ShadowStore{
|
||||
shadows: make(map[string]*DeviceShadow),
|
||||
}
|
||||
}
|
||||
|
||||
func (s *ShadowStore) UpdateShadow(clientID string, payload []byte) (*DeviceShadow, error) {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
|
||||
var update DeviceShadow
|
||||
if err := json.Unmarshal(payload, &update); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
shadow := s.shadows[clientID]
|
||||
if shadow == nil {
|
||||
shadow = &DeviceShadow{
|
||||
State: struct {
|
||||
Desired map[string]interface{} `json:"desired"`
|
||||
Reported map[string]interface{} `json:"reported"`
|
||||
Delta map[string]interface{} `json:"delta,omitempty"`
|
||||
}{
|
||||
Desired: make(map[string]interface{}),
|
||||
Reported: make(map[string]interface{}),
|
||||
Delta: make(map[string]interface{}),
|
||||
},
|
||||
}
|
||||
s.shadows[clientID] = shadow
|
||||
}
|
||||
|
||||
// Update reported state
|
||||
if update.State.Reported != nil {
|
||||
for key, value := range update.State.Reported {
|
||||
shadow.State.Reported[key] = value
|
||||
}
|
||||
}
|
||||
|
||||
// Update desired state
|
||||
if update.State.Desired != nil {
|
||||
for key, value := range update.State.Desired {
|
||||
shadow.State.Desired[key] = value
|
||||
}
|
||||
}
|
||||
|
||||
// Calculate delta
|
||||
shadow.calculateDelta()
|
||||
shadow.Version++
|
||||
shadow.Timestamp = time.Now().Unix()
|
||||
shadow.ClientToken = update.ClientToken
|
||||
|
||||
return shadow, nil
|
||||
}
|
||||
|
||||
func (s *DeviceShadow) calculateDelta() {
|
||||
s.State.Delta = make(map[string]interface{})
|
||||
|
||||
for key, desired := range s.State.Desired {
|
||||
if reported, exists := s.State.Reported[key]; !exists || reported != desired {
|
||||
s.State.Delta[key] = desired
|
||||
}
|
||||
}
|
||||
|
||||
if len(s.State.Delta) == 0 {
|
||||
s.State.Delta = nil
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### C. HTTP ↔ MQTT Bridge (`pkg/service/mqtt/bridge.go`)
|
||||
```go
|
||||
package mqtt
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"log"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/models"
|
||||
"github.com/gesellix/bose-soundtouch/pkg/service/datastore"
|
||||
)
|
||||
|
||||
type HTTPBridge struct {
|
||||
shadowStore *ShadowStore
|
||||
dataStore *datastore.DataStore
|
||||
deviceMap map[string]string // clientID -> deviceID mapping
|
||||
}
|
||||
|
||||
func NewHTTPBridge(shadowStore *ShadowStore, dataStore *datastore.DataStore) *HTTPBridge {
|
||||
return &HTTPBridge{
|
||||
shadowStore: shadowStore,
|
||||
dataStore: dataStore,
|
||||
deviceMap: make(map[string]string),
|
||||
}
|
||||
}
|
||||
|
||||
// ShadowToHTTP converts MQTT shadow updates to HTTP API calls
|
||||
func (b *HTTPBridge) ShadowToHTTP(clientID string, shadow *DeviceShadow) error {
|
||||
deviceID, exists := b.deviceMap[clientID]
|
||||
if !exists {
|
||||
log.Printf("Unknown device clientID: %s", clientID)
|
||||
return fmt.Errorf("unknown device: %s", clientID)
|
||||
}
|
||||
|
||||
// Handle power state changes
|
||||
if powerState, ok := shadow.State.Reported["powerState"].(string); ok {
|
||||
if err := b.updateDevicePower(deviceID, powerState == "ON"); err != nil {
|
||||
return fmt.Errorf("power update failed: %w", err)
|
||||
}
|
||||
}
|
||||
|
||||
// Handle volume changes
|
||||
if volume, ok := shadow.State.Reported["volume"].(float64); ok {
|
||||
if err := b.updateDeviceVolume(deviceID, int(volume)); err != nil {
|
||||
return fmt.Errorf("volume update failed: %w", err)
|
||||
}
|
||||
}
|
||||
|
||||
// Handle source changes
|
||||
if source, ok := shadow.State.Reported["source"].(string); ok {
|
||||
if err := b.updateDeviceSource(deviceID, source); err != nil {
|
||||
return fmt.Errorf("source update failed: %w", err)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// HTTPToShadow converts HTTP device state to MQTT shadow updates
|
||||
func (b *HTTPBridge) HTTPToShadow(deviceID string, deviceInfo *models.DeviceInfo) error {
|
||||
clientID, exists := b.getClientIDForDevice(deviceID)
|
||||
if !exists {
|
||||
return nil // Device not connected via MQTT
|
||||
}
|
||||
|
||||
// Create shadow state from device info
|
||||
shadowState := map[string]interface{}{
|
||||
"deviceState": "CONNECTED",
|
||||
"deviceID": deviceInfo.DeviceID,
|
||||
"name": deviceInfo.Name,
|
||||
"type": deviceInfo.Type,
|
||||
}
|
||||
|
||||
// Add additional state if available
|
||||
if status := b.getDeviceStatus(deviceID); status != nil {
|
||||
shadowState["powerState"] = status.PowerState
|
||||
shadowState["volume"] = status.Volume
|
||||
shadowState["source"] = status.Source
|
||||
}
|
||||
|
||||
// Update shadow
|
||||
shadowUpdate := DeviceShadow{
|
||||
State: struct {
|
||||
Desired map[string]interface{} `json:"desired"`
|
||||
Reported map[string]interface{} `json:"reported"`
|
||||
Delta map[string]interface{} `json:"delta,omitempty"`
|
||||
}{
|
||||
Reported: shadowState,
|
||||
},
|
||||
}
|
||||
|
||||
payload, _ := json.Marshal(shadowUpdate)
|
||||
_, err := b.shadowStore.UpdateShadow(clientID, payload)
|
||||
return err
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Integration with Existing Server
|
||||
|
||||
#### A. Extend Server Struct (`pkg/service/handlers/server.go`)
|
||||
```go
|
||||
// Add to existing Server struct
|
||||
type Server struct {
|
||||
// ... existing fields ...
|
||||
|
||||
// New MQTT fields
|
||||
mqttBroker *mqtt.Broker
|
||||
mqttEnabled bool
|
||||
mqttConfig *mqtt.Config
|
||||
deviceClientIDs map[string]string // deviceID -> clientID mapping
|
||||
}
|
||||
|
||||
// New initialization method
|
||||
func (s *Server) initMQTTBroker(config *mqtt.Config) error {
|
||||
if !config.Enabled {
|
||||
return nil
|
||||
}
|
||||
|
||||
broker, err := mqtt.NewBroker(config)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to create MQTT broker: %w", err)
|
||||
}
|
||||
|
||||
// Set up HTTP ↔ MQTT bridge
|
||||
bridge := mqtt.NewHTTPBridge(broker.ShadowStore(), s.ds)
|
||||
broker.SetBridge(bridge)
|
||||
|
||||
s.mqttBroker = broker
|
||||
s.mqttEnabled = true
|
||||
s.mqttConfig = config
|
||||
s.deviceClientIDs = make(map[string]string)
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Start MQTT broker alongside HTTP server
|
||||
func (s *Server) StartMQTT() error {
|
||||
if !s.mqttEnabled {
|
||||
return nil
|
||||
}
|
||||
|
||||
go func() {
|
||||
if err := s.mqttBroker.Start(); err != nil {
|
||||
log.Printf("MQTT broker error: %v", err)
|
||||
}
|
||||
}()
|
||||
|
||||
return nil
|
||||
}
|
||||
```
|
||||
|
||||
#### B. Configuration Integration (`cmd/soundtouch-service/main.go`)
|
||||
```go
|
||||
// Add to serviceConfig struct
|
||||
type serviceConfig struct {
|
||||
// ... existing fields ...
|
||||
|
||||
// New MQTT configuration fields
|
||||
mqttEnabled bool `mapstructure:"mqtt_enabled"`
|
||||
mqttPort int `mapstructure:"mqtt_port"`
|
||||
mqttTLSCert string `mapstructure:"mqtt_tls_cert"`
|
||||
mqttTLSKey string `mapstructure:"mqtt_tls_key"`
|
||||
mqttDeviceCertPath string `mapstructure:"mqtt_device_cert_path"`
|
||||
mqttShadowPersist bool `mapstructure:"mqtt_shadow_persist"`
|
||||
}
|
||||
|
||||
// Update main function to initialize MQTT
|
||||
func main() {
|
||||
// ... existing initialization ...
|
||||
|
||||
// Initialize MQTT if enabled
|
||||
if cfg.mqttEnabled {
|
||||
mqttConfig := &mqtt.Config{
|
||||
Enabled: cfg.mqttEnabled,
|
||||
Port: cfg.mqttPort,
|
||||
TLSEnabled: true,
|
||||
CertFile: cfg.mqttTLSCert,
|
||||
KeyFile: cfg.mqttTLSKey,
|
||||
DeviceCertPath: cfg.mqttDeviceCertPath,
|
||||
ShadowPersist: cfg.mqttShadowPersist,
|
||||
}
|
||||
|
||||
if err := server.InitMQTTBroker(mqttConfig); err != nil {
|
||||
log.Fatalf("Failed to initialize MQTT broker: %v", err)
|
||||
}
|
||||
|
||||
if err := server.StartMQTT(); err != nil {
|
||||
log.Fatalf("Failed to start MQTT broker: %v", err)
|
||||
}
|
||||
|
||||
log.Printf("MQTT broker started on port %d", cfg.mqttPort)
|
||||
}
|
||||
|
||||
// ... rest of existing main function ...
|
||||
}
|
||||
```
|
||||
|
||||
### 4. Enhanced Device Discovery
|
||||
|
||||
#### A. MQTT Device Discovery (`pkg/service/mqtt/discovery.go`)
|
||||
```go
|
||||
package mqtt
|
||||
|
||||
import (
|
||||
"log"
|
||||
"time"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/models"
|
||||
"github.com/mochi-co/mqtt/v2/packets"
|
||||
)
|
||||
|
||||
type DeviceDiscoveryHook struct {
|
||||
deviceRegistry map[string]*models.Device
|
||||
onDeviceFound func(*models.Device)
|
||||
}
|
||||
|
||||
func NewDeviceDiscoveryHook() *DeviceDiscoveryHook {
|
||||
return &DeviceDiscoveryHook{
|
||||
deviceRegistry: make(map[string]*models.Device),
|
||||
}
|
||||
}
|
||||
|
||||
func (h *DeviceDiscoveryHook) ID() string {
|
||||
return "device-discovery"
|
||||
}
|
||||
|
||||
func (h *DeviceDiscoveryHook) OnConnect(cl *packets.Client, pk packets.Packet) error {
|
||||
clientID := pk.Connect.ClientIdentifier
|
||||
|
||||
log.Printf("MQTT device connected: %s", clientID)
|
||||
|
||||
// Create device entry
|
||||
device := &models.Device{
|
||||
ID: clientID,
|
||||
ClientID: clientID,
|
||||
Name: "MQTT Device",
|
||||
LastSeen: time.Now(),
|
||||
MQTTOnline: true,
|
||||
Source: "mqtt",
|
||||
}
|
||||
|
||||
h.deviceRegistry[clientID] = device
|
||||
|
||||
if h.onDeviceFound != nil {
|
||||
h.onDeviceFound(device)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (h *DeviceDiscoveryHook) OnDisconnect(cl *packets.Client, err error) {
|
||||
clientID := cl.ID
|
||||
|
||||
log.Printf("MQTT device disconnected: %s", clientID)
|
||||
|
||||
if device, exists := h.deviceRegistry[clientID]; exists {
|
||||
device.MQTTOnline = false
|
||||
device.LastSeen = time.Now()
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### B. Integration with Existing Discovery (`pkg/discovery/mqtt.go`)
|
||||
```go
|
||||
package discovery
|
||||
|
||||
import (
|
||||
"context"
|
||||
"time"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/models"
|
||||
)
|
||||
|
||||
type MQTTDiscovery struct {
|
||||
deviceRegistry map[string]*models.Device
|
||||
enabled bool
|
||||
}
|
||||
|
||||
func NewMQTTDiscovery() *MQTTDiscovery {
|
||||
return &MQTTDiscovery{
|
||||
deviceRegistry: make(map[string]*models.Device),
|
||||
enabled: true,
|
||||
}
|
||||
}
|
||||
|
||||
func (d *MQTTDiscovery) DiscoverDevices(ctx context.Context, timeout time.Duration) ([]*models.Device, error) {
|
||||
if !d.enabled {
|
||||
return []*models.Device{}, nil
|
||||
}
|
||||
|
||||
var devices []*models.Device
|
||||
for _, device := range d.deviceRegistry {
|
||||
if device.MQTTOnline {
|
||||
devices = append(devices, device)
|
||||
}
|
||||
}
|
||||
|
||||
return devices, nil
|
||||
}
|
||||
|
||||
func (d *MQTTDiscovery) AddDevice(device *models.Device) {
|
||||
d.deviceRegistry[device.ClientID] = device
|
||||
}
|
||||
|
||||
func (d *MQTTDiscovery) RemoveDevice(clientID string) {
|
||||
delete(d.deviceRegistry, clientID)
|
||||
}
|
||||
```
|
||||
|
||||
### 5. Configuration File Extensions
|
||||
|
||||
#### A. Default Configuration (`config.yaml`)
|
||||
```yaml
|
||||
# Existing configuration...
|
||||
|
||||
# MQTT Configuration
|
||||
mqtt:
|
||||
enabled: false
|
||||
port: 8883
|
||||
tls:
|
||||
cert_file: "/etc/ssl/certs/soundtouch-mqtt.crt"
|
||||
key_file: "/etc/ssl/private/soundtouch-mqtt.key"
|
||||
|
||||
# Device certificate validation
|
||||
device_certs:
|
||||
path: "/etc/soundtouch/device-certs"
|
||||
auto_load: true
|
||||
|
||||
# Shadow state management
|
||||
shadow:
|
||||
persist: true
|
||||
ttl: 86400 # 24 hours
|
||||
|
||||
# Bridge configuration
|
||||
bridge:
|
||||
enabled: true
|
||||
sync_interval: 30s
|
||||
```
|
||||
|
||||
#### B. Environment Variable Support
|
||||
```bash
|
||||
# MQTT configuration via environment variables
|
||||
SOUNDTOUCH_MQTT_ENABLED=true
|
||||
SOUNDTOUCH_MQTT_PORT=8883
|
||||
SOUNDTOUCH_MQTT_TLS_CERT=/path/to/cert.pem
|
||||
SOUNDTOUCH_MQTT_TLS_KEY=/path/to/key.pem
|
||||
SOUNDTOUCH_MQTT_DEVICE_CERT_PATH=/path/to/device/certs
|
||||
SOUNDTOUCH_MQTT_SHADOW_PERSIST=true
|
||||
```
|
||||
|
||||
### 6. API Extensions
|
||||
|
||||
#### A. MQTT Status Endpoints
|
||||
```go
|
||||
// Add to handlers
|
||||
func (s *Server) handleMQTTStatus(c *gin.Context) {
|
||||
if !s.mqttEnabled {
|
||||
c.JSON(http.StatusNotImplemented, gin.H{
|
||||
"error": "MQTT not enabled",
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
status := gin.H{
|
||||
"enabled": s.mqttEnabled,
|
||||
"port": s.mqttConfig.Port,
|
||||
"connected_devices": len(s.deviceClientIDs),
|
||||
"shadow_count": s.mqttBroker.ShadowStore().Count(),
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, status)
|
||||
}
|
||||
|
||||
// Device shadow endpoint
|
||||
func (s *Server) handleDeviceShadow(c *gin.Context) {
|
||||
deviceID := c.Param("deviceId")
|
||||
clientID, exists := s.deviceClientIDs[deviceID]
|
||||
if !exists {
|
||||
c.JSON(http.StatusNotFound, gin.H{
|
||||
"error": "Device not connected via MQTT",
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
shadow := s.mqttBroker.ShadowStore().GetShadow(clientID)
|
||||
if shadow == nil {
|
||||
c.JSON(http.StatusNotFound, gin.H{
|
||||
"error": "Shadow not found",
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, shadow)
|
||||
}
|
||||
```
|
||||
|
||||
### 7. Testing Strategy
|
||||
|
||||
#### A. Unit Tests
|
||||
```go
|
||||
// pkg/service/mqtt/shadow_test.go
|
||||
func TestShadowStore_UpdateShadow(t *testing.T) {
|
||||
store := NewShadowStore()
|
||||
|
||||
payload := []byte(`{
|
||||
"state": {
|
||||
"reported": {
|
||||
"powerState": "ON",
|
||||
"volume": 25
|
||||
}
|
||||
}
|
||||
}`)
|
||||
|
||||
shadow, err := store.UpdateShadow("test-client", payload)
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, "ON", shadow.State.Reported["powerState"])
|
||||
assert.Equal(t, 25.0, shadow.State.Reported["volume"])
|
||||
assert.Equal(t, 1, shadow.Version)
|
||||
}
|
||||
```
|
||||
|
||||
#### B. Integration Tests
|
||||
```go
|
||||
// pkg/service/mqtt/integration_test.go
|
||||
func TestMQTTBrokerIntegration(t *testing.T) {
|
||||
// Start test broker
|
||||
broker := setupTestBroker(t)
|
||||
go broker.Start()
|
||||
defer broker.Stop()
|
||||
|
||||
// Connect test client
|
||||
client := mqtt.NewClient(mqtt.NewClientOptions().
|
||||
AddBroker("tls://localhost:8883").
|
||||
SetClientID("test-device"))
|
||||
|
||||
// Test shadow operations
|
||||
testShadowUpdate(t, client)
|
||||
testShadowGet(t, client)
|
||||
}
|
||||
```
|
||||
|
||||
### 8. Migration Path
|
||||
|
||||
#### A. Gradual Rollout
|
||||
1. **Phase 1**: Deploy MQTT broker alongside existing HTTP service (disabled by default)
|
||||
2. **Phase 2**: Enable MQTT for testing with specific devices
|
||||
3. **Phase 3**: Enable bidirectional HTTP ↔ MQTT bridging
|
||||
4. **Phase 4**: Full MQTT support for all discovered devices
|
||||
5. **Phase 5**: Prepare for AWS IoT shutdown (May 2026)
|
||||
|
||||
#### B. Backward Compatibility
|
||||
- All existing HTTP API endpoints continue to work
|
||||
- MQTT is purely additive functionality
|
||||
- Devices can be discovered via HTTP even with MQTT enabled
|
||||
- Configuration remains optional
|
||||
|
||||
### 9. Monitoring and Logging
|
||||
|
||||
#### A. MQTT Metrics
|
||||
```go
|
||||
type MQTTMetrics struct {
|
||||
ConnectedDevices int64
|
||||
MessagesReceived int64
|
||||
MessagesSent int64
|
||||
ShadowUpdates int64
|
||||
AuthenticationFails int64
|
||||
Uptime time.Duration
|
||||
}
|
||||
|
||||
func (b *Broker) GetMetrics() *MQTTMetrics {
|
||||
return &MQTTMetrics{
|
||||
ConnectedDevices: int64(len(b.server.Clients)),
|
||||
MessagesReceived: b.server.Stats.MessagesReceived,
|
||||
MessagesSent: b.server.Stats.MessagesSent,
|
||||
ShadowUpdates: b.shadowStore.UpdateCount(),
|
||||
AuthenticationFails: b.authHook.FailCount(),
|
||||
Uptime: time.Since(b.startTime),
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### B. Logging Integration
|
||||
```go
|
||||
import "github.com/sirupsen/logrus"
|
||||
|
||||
func (b *Broker) setupLogging() {
|
||||
log := logrus.WithFields(logrus.Fields{
|
||||
"component": "mqtt-broker",
|
||||
"port": b.config.Port,
|
||||
})
|
||||
|
||||
b.server.AddHook(&LoggingHook{logger: log}, nil)
|
||||
}
|
||||
```
|
||||
|
||||
### 10. Security Considerations
|
||||
|
||||
#### A. Certificate Validation
|
||||
- Validate device certificates against known device list
|
||||
- Implement certificate revocation checking
|
||||
- Support certificate rotation
|
||||
|
||||
#### B. Access Control
|
||||
- Restrict topic access per device certificate
|
||||
- Implement rate limiting per client
|
||||
- Monitor for unusual connection patterns
|
||||
|
||||
#### C. Data Protection
|
||||
- Encrypt shadow data at rest
|
||||
- Implement secure certificate storage
|
||||
- Audit logging for security events
|
||||
|
||||
## Implementation Timeline
|
||||
|
||||
### Week 1: Core Infrastructure
|
||||
- [ ] Create MQTT package structure
|
||||
- [ ] Implement basic MQTT broker
|
||||
- [ ] Add TLS configuration
|
||||
- [ ] Basic shadow state management
|
||||
|
||||
### Week 2: Integration & Bridging
|
||||
- [ ] Integrate with existing Server struct
|
||||
- [ ] Implement HTTP ↔ MQTT bridge
|
||||
- [ ] Device discovery integration
|
||||
- [ ] Configuration management
|
||||
|
||||
### Week 3: Testing & Polish
|
||||
- [ ] Unit test coverage
|
||||
- [ ] Integration testing
|
||||
- [ ] Documentation updates
|
||||
- [ ] Performance optimization
|
||||
|
||||
### Week 4: Deployment & Monitoring
|
||||
- [ ] Docker container updates
|
||||
- [ ] Monitoring and metrics
|
||||
- [ ] Security hardening
|
||||
- [ ] Production readiness
|
||||
|
||||
## Success Criteria
|
||||
|
||||
1. **Functional**: MQTT broker accepts device connections using extracted certificates
|
||||
2. **Compatible**: All existing HTTP functionality continues to work unchanged
|
||||
3. **Performant**: MQTT operations don't impact HTTP API performance
|
||||
4. **Secure**: Device authentication and authorization properly implemented
|
||||
5. **Observable**: Comprehensive logging and metrics for MQTT operations
|
||||
6. **Maintainable**: Clean separation of MQTT code from existing HTTP logic
|
||||
|
||||
This design provides a comprehensive path to add MQTT support while maintaining the existing architecture and ensuring smooth integration with current functionality.
|
||||
@@ -13,6 +13,8 @@ The service provides:
|
||||
- **🌐 Web Management UI**: Browser-based interface for device management
|
||||
- **💾 Persistent Data**: Store device configurations, presets, and usage statistics
|
||||
- **📝 HTTP Recording**: Persist all interactions as re-playable `.http` files
|
||||
- **🔄 Endpoint Mirroring**: Asynchronously mirror local requests to Bose cloud for parity testing
|
||||
- **⚖️ Parity Logging**: Detect and record discrepancies between local and official Bose responses
|
||||
- **📥 Session Archiving**: Download entire interaction sessions as `.tar.gz` for offline analysis
|
||||
- **🔍 Auto-Discovery**: Automatically detect and configure SoundTouch devices
|
||||
- **🔒 Offline Operation**: Continue using full device functionality without internet
|
||||
@@ -24,10 +26,11 @@ The service consists of several key components:
|
||||
|
||||
### BMX Services (Bose Media eXchange)
|
||||
- **TuneIn Integration**: Direct playback of radio stations and podcasts
|
||||
- **Custom Streams**: Flexible playback of any internet radio URL via dynamic proxy
|
||||
- **Service Registry**: Media service discovery and configuration
|
||||
- **Playback Control**: Stream URL resolution and audio metadata
|
||||
|
||||
### Marge Services (Account & Device Management)
|
||||
### Marge Services (Account & Device Management)
|
||||
- **Account Management**: User account simulation and device association
|
||||
- **Preset Synchronization**: Cross-device preset storage and sync
|
||||
- **Recent Items**: Playback history tracking and management
|
||||
@@ -55,7 +58,7 @@ go build -o soundtouch-service ./cmd/soundtouch-service
|
||||
|
||||
### Docker Support
|
||||
|
||||
You can run the SoundTouch service using Docker or Docker Compose.
|
||||
You can run the SoundTouch service using Docker or Docker Compose.
|
||||
|
||||
> **Note for macOS and Windows users**: The `--net host` option is only supported on Linux. On macOS and Windows, service discovery (mDNS, UPnP) will not work automatically within the container. You will need to manually enter your device's IP address in the management UI, and the service will communicate with it directly.
|
||||
|
||||
@@ -167,6 +170,9 @@ The service supports multiple ways to configure its behavior. When multiple sour
|
||||
| `ENABLE_DNS_DISCOVERY` | `--dns-discovery` | Enable DNS discovery server | `false` |
|
||||
| `DNS_UPSTREAM` | `--dns-upstream` | Upstream DNS server for non-Bose queries | `8.8.8.8` |
|
||||
| `DNS_BIND_ADDR` | `--dns-bind` | Bind address for the DNS discovery server (standard port `:53` is required for `resolv.conf` migration) | `:53` |
|
||||
| `MIRROR_ENABLED` | | Enable background mirroring of specific endpoints to Bose cloud | `false` |
|
||||
| `MIRROR_ENDPOINTS` | | Comma-separated list of path patterns to mirror (e.g., `/streaming/account/*/device/*/recent`) | `[]` |
|
||||
| `INTERNAL_PATHS` | `--internal-paths` | Paths for internal requests to exclude from recording (e.g., `/setup/*`, `/web/*`) | `[]` |
|
||||
| `DISCOVERY_DISABLED` | | Disable automated device discovery | `false` |
|
||||
|
||||
### Configuration Examples
|
||||
@@ -310,6 +316,34 @@ You can enable and configure the DNS server via the Web UI or environment variab
|
||||
#### Manual Discovery via DNS
|
||||
Even without migrating a device, you can use the DNS server to discover what a device is querying by manually setting your router's DNS or the device's DNS to point to the AfterTouch service.
|
||||
|
||||
## Endpoint Mirroring & Parity Logging
|
||||
|
||||
The SoundTouch service includes a powerful **Mirroring** feature that allows you to handle requests locally while simultaneously forwarding them to the official Bose cloud in the background. This is primarily used for maintaining long-term compatibility and verifying the accuracy of the local emulation.
|
||||
|
||||
### How Mirroring Works
|
||||
|
||||
When an endpoint is configured for mirroring:
|
||||
1. **GET Requests**: Handled locally first (Primary). The response is returned to the speaker immediately. In the background, the same request is sent to Bose.
|
||||
2. **POST/PUT/DELETE Requests**: Handled locally first. The service then synchronously (but without blocking the speaker's response) forwards the request to Bose to ensure the "official" account state stays in sync with your local changes (e.g., updating a preset).
|
||||
|
||||
### Parity Logging
|
||||
|
||||
The **Parity Logger** automatically compares the response from your local service with the one received from Bose. If it detects any discrepancies, it:
|
||||
1. Logs a warning to the console: `[PARITY] Mismatch detected for GET /...`
|
||||
2. Saves a detailed JSON report to `data/parity_mismatches/`.
|
||||
|
||||
Each report includes the full request, both response bodies, and a summary of what differed (status codes, content types, or missing/different XML tags).
|
||||
|
||||
### Configuration
|
||||
|
||||
Mirroring is configured via the **Settings** tab in the Web UI or through global settings:
|
||||
- **Mirror Enabled**: Master switch for the mirroring infrastructure.
|
||||
- **Mirror Endpoints**: A list of URL path patterns to mirror. You can use wildcards (`*`) to match variable parts like account or device IDs.
|
||||
- Example: `/streaming/account/*/device/*/recent`
|
||||
- Example: `/accounts/*/devices/*/presets/*`
|
||||
|
||||
Mirrored requests are also recorded in the **Interaction Log** under the category `upstream-mirror`, allowing you to see side-by-side exactly how our service's behavior compares to the official one.
|
||||
|
||||
## API Reference
|
||||
|
||||
### Discovery & Setup
|
||||
@@ -360,7 +394,7 @@ Migrates device to use local services.
|
||||
|
||||
**Query Parameters:**
|
||||
- `target_url`: Custom service URL (optional)
|
||||
- `proxy_url`: Proxy URL for fallback (optional)
|
||||
- `proxy_url`: Proxy URL for fallback (optional)
|
||||
- `marge`: Set to "original" to proxy Marge requests (optional)
|
||||
- `stats`: Set to "original" to proxy stats requests (optional)
|
||||
- `sw_update`: Set to "original" to proxy update requests (optional)
|
||||
@@ -470,6 +504,17 @@ The web management interface provides a comprehensive dashboard for managing you
|
||||
|
||||
The service automatically records all HTTP interactions (both those handled locally and those proxied upstream) as `.http` files. These files are compatible with the [IntelliJ IDEA HTTP Client](https://www.jetbrains.com/help/idea/exploring-http-syntax.html).
|
||||
|
||||
### Internal Paths (Excluding Traffic)
|
||||
|
||||
To prevent internal management traffic (like the Web UI or setup API calls) from cluttering your interaction logs, you can configure **Internal Paths**. Requests matching these patterns will be processed normally but will **not** be recorded by the `RecordMiddleware`.
|
||||
|
||||
By default, we recommend adding:
|
||||
- `/setup/*`: Management API calls
|
||||
- `/web/*`: Static Web UI resources
|
||||
- `/media/*`: Icons and static media
|
||||
|
||||
You can configure these via the **Settings** tab in the Web UI or using the `--internal-paths` flag.
|
||||
|
||||
### Key Features
|
||||
|
||||
- **Session Grouping**: All interactions from a single server session are stored in a dedicated directory named `{timestamp}-{pid}`.
|
||||
@@ -720,7 +765,7 @@ ls -la data/events/
|
||||
This service implementation is based on and inspired by several excellent community projects:
|
||||
|
||||
### SoundCork
|
||||
- **Project**: [SoundCork](https://github.com/deborahgu/soundcork)
|
||||
- **Project**: [SoundCork](https://github.com/deborahgu/soundcork)
|
||||
- **Authors**: Deborah Gu and contributors
|
||||
- **Contribution**: The architecture and service emulation approach in this Go implementation is heavily based on SoundCork's pioneering Python implementation. SoundCork provided the foundation for understanding Bose's service architecture and migration strategies.
|
||||
|
||||
@@ -752,7 +797,7 @@ func customBMXHandler(w http.ResponseWriter, r *http.Request) {
|
||||
|
||||
func main() {
|
||||
r := chi.NewRouter()
|
||||
r.Get("/bmx/custom/endpoint", customBMXHandler)
|
||||
r.Get("/custom/endpoint", customBMXHandler)
|
||||
http.ListenAndServe(":8000", r)
|
||||
}
|
||||
```
|
||||
@@ -765,7 +810,7 @@ soundtouch:
|
||||
- host: 192.168.1.100
|
||||
port: 8090
|
||||
name: "Living Room Speaker"
|
||||
|
||||
|
||||
rest:
|
||||
- resource: "http://localhost:8000/setup/devices"
|
||||
scan_interval: 60
|
||||
|
||||
@@ -43,7 +43,7 @@ To migrate your speakers, the service needs SSH access. You can enable it by:
|
||||
3. Rebooting the speaker (unplug/replug).
|
||||
|
||||
**Verify SSH Access:**
|
||||
- Confirm the device responds to SSH without a password: `ssh -oHostKeyAlgorithms=+ssh-rsa root@<IP>`
|
||||
- Confirm the device responds to SSH without a password: `ssh -o HostKeyAlgorithms=+ssh-rsa -o PubkeyAcceptedAlgorithms=+ssh-rsa root@<IP>`
|
||||
- Or use the **Migration** tab in the Web UI to see if the device shows a "✅ Success" status for SSH.
|
||||
Once enabled, you can log in as `root` (no password).
|
||||
|
||||
|
||||
@@ -817,6 +817,42 @@ Use this checklist to systematically troubleshoot issues:
|
||||
|
||||
---
|
||||
|
||||
## 🆔 **Device Identification & Mapping Issues**
|
||||
|
||||
### ❌ "File not found" errors with MAC addresses
|
||||
|
||||
**Symptoms:**
|
||||
```
|
||||
GET /streaming/account/3230304/device/A81B6A536A98/presets
|
||||
→ 500 Internal Server Error
|
||||
→ Log: "open .../devices/A81B6A536A98/Presets.xml: no such file or directory"
|
||||
```
|
||||
|
||||
**Cause:** The service uses MAC addresses in API requests but stores files using device serial numbers. A mapping system resolves MAC addresses to serial numbers automatically.
|
||||
|
||||
**Quick Solutions:**
|
||||
|
||||
1. **Restart the service** (mappings are created at startup):
|
||||
```bash
|
||||
sudo systemctl restart soundtouch-service
|
||||
```
|
||||
|
||||
2. **Check device directory structure**:
|
||||
```bash
|
||||
# Files should be stored by serial number, not MAC
|
||||
ls data/accounts/3230304/devices/
|
||||
# Should show: I6332527703739342000020/ (not A81B6A536A98/)
|
||||
```
|
||||
|
||||
3. **Verify DeviceInfo.xml contains MAC address**:
|
||||
```bash
|
||||
cat data/accounts/3230304/devices/*/DeviceInfo.xml | grep macAddress
|
||||
```
|
||||
|
||||
**For detailed diagnosis and solutions**, see: [**MAC Address Mapping Guide**](MAC-ADDRESS-MAPPING.md)
|
||||
|
||||
---
|
||||
|
||||
## 🛟 **Getting More Help**
|
||||
|
||||
### Information to Gather
|
||||
|
||||
@@ -0,0 +1,90 @@
|
||||
# Images for Migration Guide
|
||||
|
||||
This directory contains images, screenshots, and diagrams referenced in the migration guide and other documentation.
|
||||
|
||||
## Required Images for Migration Guide
|
||||
|
||||
The following images need to be created to complete the migration guide:
|
||||
|
||||
### Dashboard Screenshots
|
||||
- **dashboard-home.png** - Main SoundTouch Service dashboard homepage
|
||||
- **account-creation.png** - Account creation form with fields filled
|
||||
- **account-dashboard.png** - Fresh account dashboard showing ready state
|
||||
- **device-discovery.png** - Device discovery page showing found speakers
|
||||
- **device-registration.png** - Device registration dialog with options
|
||||
- **migration-setup.png** - Migration configuration dialog
|
||||
- **migration-progress.png** - Migration progress tracker showing phases
|
||||
- **migration-health.png** - Migration health monitoring dashboard
|
||||
- **account-migration.png** - Account-wide migration progress overview
|
||||
- **migration-complete.png** - Completed migration dashboard view
|
||||
- **backup-setup.png** - Backup configuration settings page
|
||||
|
||||
### Setup and Preparation
|
||||
- **usb-remote-services.png** - USB drive setup showing file structure
|
||||
- **raspberry-pi-setup.png** - Raspberry Pi with connected cables (optional)
|
||||
|
||||
### Process Diagrams
|
||||
- **migration-flow-diagram.png** - Flow chart showing migration phases
|
||||
- **network-topology.png** - Network diagram showing Pi, router, speakers
|
||||
- **data-flow-diagram.png** - How data flows between components
|
||||
|
||||
## Image Requirements
|
||||
|
||||
### Technical Specifications
|
||||
- **Format**: PNG preferred for screenshots, SVG for diagrams
|
||||
- **Resolution**: Minimum 1200px width for screenshots
|
||||
- **File Size**: Keep under 500KB when possible for fast loading
|
||||
- **Naming**: Use descriptive kebab-case names as shown above
|
||||
|
||||
### Content Guidelines
|
||||
- **Clean Interface**: Show realistic but clean interface states
|
||||
- **Consistent Styling**: Use consistent colors and styling across images
|
||||
- **Readable Text**: Ensure all text in screenshots is legible
|
||||
- **Example Data**: Use realistic example data (Living Room Speaker, etc.)
|
||||
- **Status Indicators**: Show clear success/error states with appropriate colors
|
||||
|
||||
### Placeholder Content
|
||||
Until real screenshots are available, consider:
|
||||
- **Mockups**: Create simple mockups showing the expected interface
|
||||
- **Wireframes**: Basic wireframes indicating layout and content
|
||||
- **Diagrams**: Technical diagrams can be created immediately
|
||||
- **Text Placeholders**: Use `[Image: Description]` in documentation
|
||||
|
||||
## Creating the Images
|
||||
|
||||
### For Dashboard Screenshots
|
||||
1. Set up the enhanced SoundTouch service
|
||||
2. Create sample account and register devices
|
||||
3. Take screenshots at key points in the migration process
|
||||
4. Edit for clarity (highlight important elements, add annotations)
|
||||
|
||||
### For Diagrams
|
||||
1. Use tools like Lucidchart, draw.io, or similar
|
||||
2. Follow consistent color scheme:
|
||||
- Blue: SoundTouch Service components
|
||||
- Green: Healthy/successful states
|
||||
- Orange: Warning/in-progress states
|
||||
- Red: Error/problematic states
|
||||
- Gray: External/third-party components
|
||||
|
||||
### For Physical Setup
|
||||
1. Take photos of actual hardware setup
|
||||
2. Show USB drive preparation process
|
||||
3. Demonstrate network connections if helpful
|
||||
|
||||
## Alternative Text Requirements
|
||||
|
||||
Each image should have appropriate alt text for accessibility:
|
||||
|
||||
```markdown
|
||||

|
||||
*Caption: Additional context or explanation*
|
||||
```
|
||||
|
||||
## Future Enhancements
|
||||
|
||||
Consider adding:
|
||||
- **Video Walkthroughs**: Screen recordings of key processes
|
||||
- **Interactive Demos**: Web-based interactive guides
|
||||
- **Troubleshooting Screenshots**: Common error states and solutions
|
||||
- **Mobile Views**: How to access from mobile devices
|
||||
@@ -0,0 +1,599 @@
|
||||
# /power_on Implementation Guide
|
||||
|
||||
## Overview
|
||||
|
||||
This guide provides detailed technical specifications for implementing `/power_on` endpoint enhancements to reduce network dependency and improve device lifecycle management in the SoundTouch service.
|
||||
|
||||
## Current /power_on Handler Analysis
|
||||
|
||||
### Existing Implementation
|
||||
Located in `pkg/service/handlers/handlers_marge.go`:
|
||||
|
||||
```go
|
||||
func (s *Server) HandleMargePowerOn(w http.ResponseWriter, r *http.Request) {
|
||||
body, err := io.ReadAll(r.Body)
|
||||
if err != nil {
|
||||
log.Printf("[Marge] Failed to read power_on body: %v", err)
|
||||
w.WriteHeader(http.StatusOK)
|
||||
return
|
||||
}
|
||||
|
||||
var req models.CustomerSupportRequest
|
||||
if err := xml.Unmarshal(body, &req); err != nil {
|
||||
log.Printf("[Marge] Failed to parse power_on body: %v", err)
|
||||
// Fallback to remote address
|
||||
if host, _, err := net.SplitHostPort(r.RemoteAddr); err == nil {
|
||||
go s.PrimeDeviceWithSpotify(host)
|
||||
}
|
||||
w.WriteHeader(http.StatusOK)
|
||||
return
|
||||
}
|
||||
|
||||
deviceID := req.Device.ID
|
||||
deviceIP := req.DiagnosticData.DeviceLandscape.IPAddress
|
||||
|
||||
log.Printf("[Marge] Device %s powered on (IP: %s)", deviceID, deviceIP)
|
||||
|
||||
if deviceIP != "" {
|
||||
go s.PrimeDeviceWithSpotify(deviceIP)
|
||||
} else {
|
||||
// Fallback to remote address
|
||||
if host, _, err := net.SplitHostPort(r.RemoteAddr); err == nil {
|
||||
go s.PrimeDeviceWithSpotify(host)
|
||||
}
|
||||
}
|
||||
|
||||
w.WriteHeader(http.StatusOK)
|
||||
}
|
||||
```
|
||||
|
||||
**Current Limitations:**
|
||||
- Only extracts basic device ID and IP
|
||||
- No device state management
|
||||
- No data persistence
|
||||
- No response payload
|
||||
- Limited to Spotify priming
|
||||
|
||||
## Enhanced Implementation Design
|
||||
|
||||
### 1. Extended Data Models
|
||||
|
||||
#### Enhanced Power-On Request Model
|
||||
```go
|
||||
// PowerOnRequest represents the enhanced power_on request structure
|
||||
type PowerOnRequest struct {
|
||||
XMLName xml.Name `xml:"device-data"`
|
||||
Device PowerOnDevice `xml:"device"`
|
||||
DiagnosticData DiagnosticData `xml:"diagnostic-data"`
|
||||
}
|
||||
|
||||
type PowerOnDevice struct {
|
||||
ID string `xml:"id,attr"`
|
||||
SerialNumber string `xml:"serialnumber"`
|
||||
FirmwareVersion string `xml:"firmware-version"`
|
||||
Product PowerOnProduct `xml:"product"`
|
||||
}
|
||||
|
||||
type PowerOnProduct struct {
|
||||
ProductCode string `xml:"product_code,attr"`
|
||||
Type string `xml:"type,attr"`
|
||||
SerialNumber string `xml:"serialnumber"`
|
||||
}
|
||||
|
||||
type DiagnosticData struct {
|
||||
DeviceLandscape DeviceLandscape `xml:"device-landscape"`
|
||||
NetworkData NetworkData `xml:"network-landscape>network-data"`
|
||||
}
|
||||
|
||||
type DeviceLandscape struct {
|
||||
RSSI string `xml:"rssi"`
|
||||
GatewayIP string `xml:"gateway-ip-address"`
|
||||
MacAddresses []string `xml:"macaddresses>macaddress"`
|
||||
IPAddress string `xml:"ip-address"`
|
||||
ConnectionType string `xml:"network-connection-type"`
|
||||
}
|
||||
```
|
||||
|
||||
#### Enhanced Response Model
|
||||
```go
|
||||
// PowerOnResponse represents the response sent back to the device
|
||||
type PowerOnResponse struct {
|
||||
XMLName xml.Name `xml:"power-on-response"`
|
||||
Status string `xml:"status"`
|
||||
DeviceID string `xml:"device-id"`
|
||||
ConfigurationUpdates []ConfigurationUpdate `xml:"configuration-updates>update,omitempty"`
|
||||
MigrationInstructions *MigrationInstruction `xml:"migration,omitempty"`
|
||||
RegistrationRequired bool `xml:"registration-required,omitempty"`
|
||||
Timestamp string `xml:"timestamp"`
|
||||
}
|
||||
|
||||
type ConfigurationUpdate struct {
|
||||
Type string `xml:"type,attr"`
|
||||
Key string `xml:"key"`
|
||||
Value string `xml:"value"`
|
||||
Priority int `xml:"priority,attr"`
|
||||
}
|
||||
|
||||
type MigrationInstruction struct {
|
||||
Method string `xml:"method,attr"`
|
||||
TargetURL string `xml:"target-url"`
|
||||
ProxyURL string `xml:"proxy-url,omitempty"`
|
||||
Options map[string]string `xml:"options>option"`
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Enhanced PowerOn Handler
|
||||
|
||||
```go
|
||||
// HandleMargePowerOnEnhanced processes power_on requests with full device lifecycle management
|
||||
func (s *Server) HandleMargePowerOnEnhanced(w http.ResponseWriter, r *http.Request) {
|
||||
startTime := time.Now()
|
||||
|
||||
// Parse the power_on request
|
||||
powerOnReq, err := s.parsePowerOnRequest(r)
|
||||
if err != nil {
|
||||
s.handlePowerOnError(w, r, "Failed to parse request", err)
|
||||
return
|
||||
}
|
||||
|
||||
// Process device information
|
||||
deviceInfo, isNewDevice, err := s.processDeviceFromPowerOn(powerOnReq)
|
||||
if err != nil {
|
||||
s.handlePowerOnError(w, r, "Failed to process device", err)
|
||||
return
|
||||
}
|
||||
|
||||
// Build response based on device state
|
||||
response := s.buildPowerOnResponse(deviceInfo, isNewDevice, powerOnReq)
|
||||
|
||||
// Log the interaction
|
||||
s.logPowerOnInteraction(deviceInfo, powerOnReq, response, startTime)
|
||||
|
||||
// Send response
|
||||
if err := s.sendPowerOnResponse(w, response); err != nil {
|
||||
log.Printf("[PowerOn] Failed to send response for device %s: %v", deviceInfo.DeviceID, err)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Device Processing Logic
|
||||
|
||||
```go
|
||||
// processDeviceFromPowerOn handles device identification and data updates
|
||||
func (s *Server) processDeviceFromPowerOn(req *PowerOnRequest) (*models.ServiceDeviceInfo, bool, error) {
|
||||
deviceMAC := req.Device.ID
|
||||
deviceIP := req.DiagnosticData.DeviceLandscape.IPAddress
|
||||
|
||||
// Try to find existing device by MAC address (primary identifier)
|
||||
existingDevice, err := s.ds.GetDeviceByMAC(deviceMAC)
|
||||
if err != nil && err != datastore.ErrDeviceNotFound {
|
||||
return nil, false, fmt.Errorf("failed to lookup device: %w", err)
|
||||
}
|
||||
|
||||
var deviceInfo *models.ServiceDeviceInfo
|
||||
isNewDevice := existingDevice == nil
|
||||
|
||||
if isNewDevice {
|
||||
// Create new device record from power_on data
|
||||
deviceInfo = s.createDeviceFromPowerOn(req)
|
||||
|
||||
// Store in datastore
|
||||
if err := s.ds.SaveDeviceInfo("", deviceMAC, deviceInfo); err != nil {
|
||||
return nil, false, fmt.Errorf("failed to save new device: %w", err)
|
||||
}
|
||||
|
||||
log.Printf("[PowerOn] New device registered: %s (IP: %s, Model: %s)",
|
||||
deviceMAC, deviceIP, deviceInfo.ProductCode)
|
||||
} else {
|
||||
// Update existing device with power_on data
|
||||
deviceInfo = existingDevice
|
||||
s.updateDeviceFromPowerOn(deviceInfo, req)
|
||||
|
||||
// Detect significant changes
|
||||
if s.hasSignificantChanges(existingDevice, deviceInfo) {
|
||||
log.Printf("[PowerOn] Device %s updated: IP %s->%s, FW %s->%s",
|
||||
deviceMAC, existingDevice.IPAddress, deviceInfo.IPAddress,
|
||||
existingDevice.FirmwareVersion, deviceInfo.FirmwareVersion)
|
||||
}
|
||||
|
||||
// Save updated device info
|
||||
if err := s.ds.SaveDeviceInfo(deviceInfo.AccountID, deviceMAC, deviceInfo); err != nil {
|
||||
return nil, false, fmt.Errorf("failed to update device: %w", err)
|
||||
}
|
||||
}
|
||||
|
||||
// Update device mappings for lookup optimization
|
||||
s.ds.UpdateDeviceMappings(*deviceInfo)
|
||||
|
||||
return deviceInfo, isNewDevice, nil
|
||||
}
|
||||
```
|
||||
|
||||
### 4. Device Creation from Power-On Data
|
||||
|
||||
```go
|
||||
// createDeviceFromPowerOn creates a new ServiceDeviceInfo from power_on request
|
||||
func (s *Server) createDeviceFromPowerOn(req *PowerOnRequest) *models.ServiceDeviceInfo {
|
||||
now := time.Now()
|
||||
|
||||
deviceInfo := &models.ServiceDeviceInfo{
|
||||
DeviceID: req.Device.ID, // MAC address
|
||||
ProductCode: req.Device.Product.ProductCode,
|
||||
DeviceSerialNumber: req.Device.SerialNumber,
|
||||
ProductSerialNumber: req.Device.Product.SerialNumber,
|
||||
FirmwareVersion: req.Device.FirmwareVersion,
|
||||
IPAddress: req.DiagnosticData.DeviceLandscape.IPAddress,
|
||||
MacAddress: req.Device.ID, // Primary MAC
|
||||
DiscoveryMethod: "power_on",
|
||||
LastSeen: now,
|
||||
CreatedAt: now,
|
||||
UpdatedAt: now,
|
||||
}
|
||||
|
||||
// Generate default name if not provided
|
||||
if deviceInfo.Name == "" {
|
||||
deviceInfo.Name = s.generateDefaultDeviceName(deviceInfo)
|
||||
}
|
||||
|
||||
// Add power_on specific metadata
|
||||
deviceInfo.Metadata = map[string]string{
|
||||
"rssi": req.DiagnosticData.DeviceLandscape.RSSI,
|
||||
"gateway_ip": req.DiagnosticData.DeviceLandscape.GatewayIP,
|
||||
"connection_type": req.DiagnosticData.DeviceLandscape.ConnectionType,
|
||||
"power_on_count": "1",
|
||||
}
|
||||
|
||||
// Store additional MAC addresses if available
|
||||
if len(req.DiagnosticData.DeviceLandscape.MacAddresses) > 1 {
|
||||
additionalMACs := make([]string, 0, len(req.DiagnosticData.DeviceLandscape.MacAddresses)-1)
|
||||
for _, mac := range req.DiagnosticData.DeviceLandscape.MacAddresses {
|
||||
if mac != req.Device.ID {
|
||||
additionalMACs = append(additionalMACs, mac)
|
||||
}
|
||||
}
|
||||
if len(additionalMACs) > 0 {
|
||||
deviceInfo.Metadata["additional_macs"] = strings.Join(additionalMACs, ",")
|
||||
}
|
||||
}
|
||||
|
||||
return deviceInfo
|
||||
}
|
||||
```
|
||||
|
||||
### 5. Response Generation Logic
|
||||
|
||||
```go
|
||||
// buildPowerOnResponse creates appropriate response based on device state
|
||||
func (s *Server) buildPowerOnResponse(deviceInfo *models.ServiceDeviceInfo, isNewDevice bool, req *PowerOnRequest) *PowerOnResponse {
|
||||
response := &PowerOnResponse{
|
||||
Status: "ok",
|
||||
DeviceID: deviceInfo.DeviceID,
|
||||
Timestamp: time.Now().Format(time.RFC3339),
|
||||
}
|
||||
|
||||
// Handle new device registration
|
||||
if isNewDevice {
|
||||
response.RegistrationRequired = deviceInfo.AccountID == ""
|
||||
|
||||
// Add welcome configuration for new devices
|
||||
response.ConfigurationUpdates = []ConfigurationUpdate{
|
||||
{
|
||||
Type: "welcome",
|
||||
Key: "device_registered",
|
||||
Value: "true",
|
||||
Priority: 1,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// Check if migration is needed
|
||||
if s.needsMigration(deviceInfo) {
|
||||
migration := s.getMigrationInstructions(deviceInfo)
|
||||
response.MigrationInstructions = migration
|
||||
|
||||
log.Printf("[PowerOn] Migration required for device %s: %s",
|
||||
deviceInfo.DeviceID, migration.Method)
|
||||
}
|
||||
|
||||
// Add any pending configuration updates
|
||||
pendingUpdates := s.getPendingConfigurationUpdates(deviceInfo)
|
||||
response.ConfigurationUpdates = append(response.ConfigurationUpdates, pendingUpdates...)
|
||||
|
||||
return response
|
||||
}
|
||||
```
|
||||
|
||||
### 6. Device Lookup Enhancements
|
||||
|
||||
#### Enhanced DataStore Methods
|
||||
```go
|
||||
// GetDeviceByMAC finds a device by MAC address across all accounts
|
||||
func (ds *DataStore) GetDeviceByMAC(macAddress string) (*models.ServiceDeviceInfo, error) {
|
||||
normalizedMAC := normalizeMAC(macAddress)
|
||||
|
||||
// Check device mappings first (for performance)
|
||||
ds.idMutex.RLock()
|
||||
deviceID, exists := ds.deviceMappings[normalizedMAC]
|
||||
ds.idMutex.RUnlock()
|
||||
|
||||
if exists {
|
||||
// Try to find device by mapped ID
|
||||
device, err := ds.findDeviceByID(deviceID)
|
||||
if err == nil {
|
||||
return device, nil
|
||||
}
|
||||
}
|
||||
|
||||
// Fallback to full scan
|
||||
devices, err := ds.ListAllDevices()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
for _, device := range devices {
|
||||
if normalizeMAC(device.MacAddress) == normalizedMAC ||
|
||||
normalizeMAC(device.DeviceID) == normalizedMAC {
|
||||
return &device, nil
|
||||
}
|
||||
|
||||
// Check additional MAC addresses in metadata
|
||||
if additionalMACs, exists := device.Metadata["additional_macs"]; exists {
|
||||
for _, mac := range strings.Split(additionalMACs, ",") {
|
||||
if normalizeMAC(mac) == normalizedMAC {
|
||||
return &device, nil
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return nil, datastore.ErrDeviceNotFound
|
||||
}
|
||||
```
|
||||
|
||||
### 7. Migration Integration
|
||||
|
||||
```go
|
||||
// needsMigration determines if device requires configuration migration
|
||||
func (s *Server) needsMigration(deviceInfo *models.ServiceDeviceInfo) bool {
|
||||
if deviceInfo.AccountID == "" {
|
||||
return false // Cannot migrate without account
|
||||
}
|
||||
|
||||
// Check if device is already migrated
|
||||
if s.sm != nil {
|
||||
summary, err := s.sm.GetMigrationSummary(deviceInfo.IPAddress, s.ServerURL, "", nil)
|
||||
if err == nil && summary.IsMigrated {
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
// getMigrationInstructions creates migration instructions for device
|
||||
func (s *Server) getMigrationInstructions(deviceInfo *models.ServiceDeviceInfo) *MigrationInstruction {
|
||||
return &MigrationInstruction{
|
||||
Method: "xml", // Default to XML-based migration
|
||||
TargetURL: s.ServerURL,
|
||||
Options: map[string]string{
|
||||
"marge": "true",
|
||||
"stats": "true",
|
||||
"sw_update": "true",
|
||||
},
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 8. Error Handling and Fallbacks
|
||||
|
||||
```go
|
||||
// handlePowerOnError provides graceful error handling with fallbacks
|
||||
func (s *Server) handlePowerOnError(w http.ResponseWriter, r *http.Request, message string, err error) {
|
||||
log.Printf("[PowerOn] %s: %v", message, err)
|
||||
|
||||
// Try to extract IP from request for fallback processing
|
||||
if host, _, err := net.SplitHostPort(r.RemoteAddr); err == nil {
|
||||
// Fallback to existing discovery mechanism
|
||||
go s.PrimeDeviceWithSpotify(host)
|
||||
log.Printf("[PowerOn] Falling back to legacy processing for IP %s", host)
|
||||
}
|
||||
|
||||
// Always return 200 OK to avoid device retry loops
|
||||
w.WriteHeader(http.StatusOK)
|
||||
}
|
||||
|
||||
// parsePowerOnRequest safely parses the power_on request with validation
|
||||
func (s *Server) parsePowerOnRequest(r *http.Request) (*PowerOnRequest, error) {
|
||||
body, err := io.ReadAll(r.Body)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to read request body: %w", err)
|
||||
}
|
||||
|
||||
if len(body) == 0 {
|
||||
return nil, fmt.Errorf("empty request body")
|
||||
}
|
||||
|
||||
var req PowerOnRequest
|
||||
if err := xml.Unmarshal(body, &req); err != nil {
|
||||
return nil, fmt.Errorf("failed to parse XML: %w", err)
|
||||
}
|
||||
|
||||
// Validate required fields
|
||||
if req.Device.ID == "" {
|
||||
return nil, fmt.Errorf("missing device ID")
|
||||
}
|
||||
|
||||
if req.DiagnosticData.DeviceLandscape.IPAddress == "" {
|
||||
return nil, fmt.Errorf("missing device IP address")
|
||||
}
|
||||
|
||||
return &req, nil
|
||||
}
|
||||
```
|
||||
|
||||
### 9. Logging and Monitoring
|
||||
|
||||
```go
|
||||
// logPowerOnInteraction records detailed interaction logs for debugging
|
||||
func (s *Server) logPowerOnInteraction(deviceInfo *models.ServiceDeviceInfo, req *PowerOnRequest, resp *PowerOnResponse, startTime time.Time) {
|
||||
duration := time.Since(startTime)
|
||||
|
||||
log.Printf("[PowerOn] Device: %s, IP: %s, Duration: %v, Status: %s, NewDevice: %t, Migration: %t",
|
||||
deviceInfo.DeviceID,
|
||||
req.DiagnosticData.DeviceLandscape.IPAddress,
|
||||
duration,
|
||||
resp.Status,
|
||||
resp.RegistrationRequired,
|
||||
resp.MigrationInstructions != nil)
|
||||
|
||||
// Store interaction for debugging (if enabled)
|
||||
if s.config.RecordInteractions {
|
||||
interaction := models.DeviceInteraction{
|
||||
Timestamp: startTime,
|
||||
DeviceID: deviceInfo.DeviceID,
|
||||
Type: "power_on",
|
||||
Request: req,
|
||||
Response: resp,
|
||||
Duration: duration,
|
||||
IPAddress: req.DiagnosticData.DeviceLandscape.IPAddress,
|
||||
UserAgent: r.Header.Get("User-Agent"),
|
||||
}
|
||||
|
||||
if err := s.ds.SaveInteraction(interaction); err != nil {
|
||||
log.Printf("[PowerOn] Failed to save interaction: %v", err)
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 10. Configuration and Feature Flags
|
||||
|
||||
```go
|
||||
// PowerOnConfig controls behavior of enhanced power_on processing
|
||||
type PowerOnConfig struct {
|
||||
EnableEnhancedProcessing bool `json:"enable_enhanced_processing"`
|
||||
AutoMigration bool `json:"auto_migration"`
|
||||
RecordInteractions bool `json:"record_interactions"`
|
||||
DefaultResponseTimeout time.Duration `json:"default_response_timeout"`
|
||||
FallbackToLegacy bool `json:"fallback_to_legacy"`
|
||||
}
|
||||
|
||||
// loadPowerOnConfig loads configuration with defaults
|
||||
func loadPowerOnConfig() *PowerOnConfig {
|
||||
return &PowerOnConfig{
|
||||
EnableEnhancedProcessing: true,
|
||||
AutoMigration: false, // Conservative default
|
||||
RecordInteractions: false,
|
||||
DefaultResponseTimeout: 5 * time.Second,
|
||||
FallbackToLegacy: true,
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
### 1. Unit Tests
|
||||
```go
|
||||
func TestHandleMargePowerOnEnhanced(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
requestBody string
|
||||
existingDevice *models.ServiceDeviceInfo
|
||||
expectedStatus string
|
||||
expectMigration bool
|
||||
}{
|
||||
{
|
||||
name: "new_device_registration",
|
||||
requestBody: `<device-data><device id="A81B6A536A98">...</device></device-data>`,
|
||||
existingDevice: nil,
|
||||
expectedStatus: "ok",
|
||||
expectMigration: false,
|
||||
},
|
||||
{
|
||||
name: "existing_device_update",
|
||||
requestBody: `<device-data><device id="A81B6A536A98">...</device></device-data>`,
|
||||
existingDevice: &models.ServiceDeviceInfo{DeviceID: "A81B6A536A98"},
|
||||
expectedStatus: "ok",
|
||||
expectMigration: true,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
// Test implementation
|
||||
})
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Integration Tests
|
||||
```go
|
||||
func TestPowerOnDeviceLifecycle(t *testing.T) {
|
||||
// Test complete device lifecycle through power_on events
|
||||
// 1. New device power_on
|
||||
// 2. Device registration
|
||||
// 3. Configuration changes
|
||||
// 4. Migration
|
||||
// 5. Subsequent power_on events
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Load Testing
|
||||
```go
|
||||
func BenchmarkPowerOnProcessing(b *testing.B) {
|
||||
// Benchmark power_on processing performance
|
||||
// Test concurrent device registrations
|
||||
// Measure response times
|
||||
}
|
||||
```
|
||||
|
||||
## Deployment Strategy
|
||||
|
||||
### Phase 1: Parallel Implementation
|
||||
- Implement enhanced handler alongside existing handler
|
||||
- Use feature flag to control which handler processes requests
|
||||
- Maintain full backward compatibility
|
||||
|
||||
### Phase 2: Gradual Rollout
|
||||
- Enable enhanced processing for subset of devices
|
||||
- Monitor performance and error rates
|
||||
- Collect metrics on data completeness
|
||||
|
||||
### Phase 3: Full Migration
|
||||
- Default to enhanced processing for all devices
|
||||
- Remove legacy fallbacks
|
||||
- Optimize performance based on production data
|
||||
|
||||
## Monitoring and Metrics
|
||||
|
||||
### Key Metrics to Track
|
||||
- Power-on event frequency per device
|
||||
- New device registration rate via power_on
|
||||
- Migration success rate via power_on response
|
||||
- Response time distribution
|
||||
- Error rates and types
|
||||
- Data completeness metrics
|
||||
|
||||
### Alerting Thresholds
|
||||
- Power-on processing failures > 5%
|
||||
- Average response time > 2 seconds
|
||||
- New device registration failures > 1%
|
||||
- Migration instruction delivery failures > 2%
|
||||
|
||||
## Security Considerations
|
||||
|
||||
### Input Validation
|
||||
- XML parsing security (prevent XXE attacks)
|
||||
- Device ID format validation
|
||||
- IP address validation
|
||||
- Request size limits
|
||||
|
||||
### Authentication
|
||||
- Device authentication via MAC address verification
|
||||
- Request signing (if available)
|
||||
- Rate limiting per device/IP
|
||||
|
||||
### Data Privacy
|
||||
- Sensitive data handling in diagnostic information
|
||||
- Logging data retention policies
|
||||
- Compliance with data protection regulations
|
||||
@@ -68,14 +68,14 @@ func main() {
|
||||
|
||||
client := client.NewClient(config)
|
||||
|
||||
// Play TTS at current volume
|
||||
err := client.PlayTTS("Hello, this is a test message", "YOUR_APP_KEY")
|
||||
// Play TTS at current volume (language code "EN", "DE", etc.)
|
||||
err := client.PlayTTS("Hello, this is a test message", "YOUR_APP_KEY", "EN")
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
// Play TTS at specific volume (70)
|
||||
err = client.PlayTTS("Volume test message", "YOUR_APP_KEY", 70)
|
||||
err = client.PlayTTS("Volume test message", "YOUR_APP_KEY", "EN", 70)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
@@ -277,7 +277,7 @@ You'll need to provide your own application key. The format and generation metho
|
||||
|
||||
```go
|
||||
// Doorbell notification
|
||||
client.PlayTTS("Someone is at the front door", "home-automation-key", 80)
|
||||
client.PlayTTS("Someone is at the front door", "home-automation-key", "EN", 80)
|
||||
|
||||
// Security alert
|
||||
client.PlayURL(
|
||||
@@ -311,4 +311,4 @@ soundtouch-cli speaker url --url "https://www.soundjay.com/misc/sounds/bell-ring
|
||||
4. **URL content fails**: Ensure URL is accessible and contains valid audio
|
||||
5. **Volume not restored**: May occur if device is powered off during playback
|
||||
|
||||
For more information, see the [SoundTouch WebServices API documentation](https://github.com/thlucas1/homeassistantcomponent_soundtouchplus/wiki/SoundTouch-WebServices-API).
|
||||
For more information, see the [SoundTouch WebServices API documentation](https://github.com/thlucas1/homeassistantcomponent_soundtouchplus/wiki/SoundTouch-WebServices-API).
|
||||
|
||||
@@ -0,0 +1,140 @@
|
||||
# SCMUDC Events Analysis
|
||||
|
||||
## Overview
|
||||
|
||||
SCMUDC (Sound Control Management Usage Data Collection) events are telemetry data sent from SoundTouch devices to `events.api.bosecm.com` via `/v1/scmudc/{deviceId}` endpoints. These events track user interactions and device behaviors for analytics and monitoring.
|
||||
|
||||
## Event Origins
|
||||
|
||||
Analysis of recorded interactions reveals three distinct origins for device events:
|
||||
|
||||
### 1. `"gabbo"` - SoundTouch App (Mobile/Desktop)
|
||||
- **Source**: Remote control via SoundTouch mobile/desktop applications
|
||||
- **Frequency**: Highest (primary control method)
|
||||
- **Event Types**: User-initiated actions through app interface
|
||||
- **Button Abstraction**: App UI elements (not physical buttons)
|
||||
|
||||
**Common Events**:
|
||||
- `power-pressed` → Power on/off via app
|
||||
- `play-pressed` → Play control
|
||||
- `pause-pressed` → Pause control
|
||||
- `skip-forward-pressed` → Next track
|
||||
- `stop-pressed` → Stop playback
|
||||
|
||||
### 2. `"console"` - Device Hardware Controls
|
||||
- **Source**: Physical buttons and controls on the speaker device
|
||||
- **Frequency**: Lower (secondary control method)
|
||||
- **Event Types**: Direct hardware interaction
|
||||
- **Physical Controls**: Actual buttons, knobs, or touch interfaces on device
|
||||
|
||||
**Common Events**:
|
||||
- `preset-pressed` → Physical preset buttons (PRESET_1, PRESET_5, etc.)
|
||||
- `power-pressed` → Hardware power button
|
||||
|
||||
### 3. `"device"` - Internal System Actions
|
||||
- **Source**: Device's internal software systems
|
||||
- **Frequency**: Automatic responses to user actions
|
||||
- **Event Types**: System-generated events, content playback
|
||||
- **Rich Content**: Base64-encoded XML with detailed metadata
|
||||
|
||||
**Common Events**:
|
||||
- `play-item` → Automatic content playback responses
|
||||
- `preset-assigned` → System preset assignments
|
||||
|
||||
## Event Data Structure
|
||||
|
||||
### Standard Button Events (gabbo/console)
|
||||
```json
|
||||
{
|
||||
"data": {
|
||||
"buttonId": "POWER|PLAY|PAUSE|PRESET_5|etc",
|
||||
"origin": "gabbo|console"
|
||||
},
|
||||
"type": "power-pressed|play-pressed|pause-pressed|preset-pressed|etc"
|
||||
}
|
||||
```
|
||||
|
||||
### Device Content Events
|
||||
```json
|
||||
{
|
||||
"data": {
|
||||
"contentItem": "PD94bWwgdmVyc2lvbj0...", // Base64-encoded XML
|
||||
"origin": "device",
|
||||
"preset": "none|P1|P5|etc"
|
||||
},
|
||||
"type": "play-item|preset-assigned"
|
||||
}
|
||||
```
|
||||
|
||||
## Content Item Structure
|
||||
|
||||
Device events include Base64-encoded XML with rich content metadata:
|
||||
|
||||
```xml
|
||||
<ContentItem source="SPOTIFY" type="tracklisturl"
|
||||
location="/playback/container/c3BvdGlmeTpwbGF5bGlzdDox..."
|
||||
sourceAccount="gesellix" isPresetable="true">
|
||||
<itemName>Billie Eilish - bad guy (instrumental version)</itemName>
|
||||
<containerArt>https://i.scdn.co/image/ab67616d0000b273...</containerArt>
|
||||
</ContentItem>
|
||||
```
|
||||
|
||||
**Key Fields**:
|
||||
- `source`: Music service (SPOTIFY, PANDORA, etc.)
|
||||
- `itemName`: Track/playlist/station name
|
||||
- `sourceAccount`: User account on the service
|
||||
- `location`: Service-specific content identifier
|
||||
- `containerArt`: Album/playlist artwork URL
|
||||
- `isPresetable`: Whether content can be saved as preset
|
||||
|
||||
## Usage Patterns
|
||||
|
||||
### Control Method Preferences
|
||||
1. **Primary**: SoundTouch App (`gabbo`) - Most frequent interactions
|
||||
2. **Secondary**: Device Hardware (`console`) - Occasional direct control
|
||||
3. **Automatic**: Internal System (`device`) - Background responses
|
||||
|
||||
### Event Flow
|
||||
1. User triggers action via app or hardware
|
||||
2. Device processes request and begins playback
|
||||
3. Device sends content event with full metadata
|
||||
4. System continues tracking playback state
|
||||
|
||||
## Telemetry Insights
|
||||
|
||||
### User Behavior Analytics
|
||||
- **Interface Preference**: App vs. hardware control usage ratios
|
||||
- **Feature Usage**: Most/least used controls and functions
|
||||
- **Content Patterns**: Music service preferences, playlist usage
|
||||
|
||||
### Device Health Monitoring
|
||||
- **Interaction Frequency**: Normal vs. abnormal usage patterns
|
||||
- **Error Detection**: Failed commands or unusual event sequences
|
||||
- **Performance**: Response times between user action and system response
|
||||
|
||||
### Service Integration Analysis
|
||||
- **Music Services**: Spotify dominance, other service usage
|
||||
- **Account Mapping**: User accounts across different services
|
||||
- **Content Types**: Music vs. radio vs. podcast preferences
|
||||
|
||||
## Data Quality Notes
|
||||
|
||||
- All events include comprehensive device information (deviceID, serialNumber, softwareVersion)
|
||||
- Timestamps include both UTC time and device monotonic time
|
||||
- Events are batched and sent with consistent protocol versioning
|
||||
- Content metadata is rich and includes artwork URLs for UI enhancement
|
||||
|
||||
## Security Considerations
|
||||
|
||||
- Events include user account information and listening habits
|
||||
- Device serial numbers and unique identifiers are transmitted
|
||||
- Content location data could reveal usage patterns
|
||||
- Data should be handled according to privacy regulations
|
||||
|
||||
## Technical Implementation Notes
|
||||
|
||||
- Endpoint: `POST /v1/scmudc/{deviceId}`
|
||||
- Protocol Version: 3.1 (current)
|
||||
- Encoding: JSON with Base64-encoded XML payloads
|
||||
- Authentication: Bearer token authorization
|
||||
- Content-Type: `text/json; charset=utf-8`
|
||||
@@ -1,8 +1,8 @@
|
||||
module navigation-station-demo
|
||||
|
||||
go 1.25.7
|
||||
go 1.26.1
|
||||
|
||||
require github.com/gesellix/bose-soundtouch v0.0.0
|
||||
require github.com/gesellix/bose-soundtouch v0.43.0
|
||||
|
||||
require github.com/gorilla/websocket v1.5.3 // indirect
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
module preset-management-example
|
||||
|
||||
go 1.25.7
|
||||
go 1.26.1
|
||||
|
||||
require github.com/gesellix/bose-soundtouch v0.0.0
|
||||
require github.com/gesellix/bose-soundtouch v0.43.0
|
||||
|
||||
require github.com/gorilla/websocket v1.5.3 // indirect
|
||||
|
||||
|
||||
@@ -0,0 +1,181 @@
|
||||
// Package main demonstrates the new recording filename format that includes date information.
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
"net/http"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/service/proxy"
|
||||
)
|
||||
|
||||
func main() {
|
||||
fmt.Println("=== Recording Filename Format Demo ===")
|
||||
fmt.Println()
|
||||
|
||||
// Create a temporary directory for the demo
|
||||
tmpDir, err := os.MkdirTemp("", "recording-filename-demo")
|
||||
if err != nil {
|
||||
log.Fatalf("Failed to create temp directory: %v", err)
|
||||
}
|
||||
|
||||
defer func() {
|
||||
if removeErr := os.RemoveAll(tmpDir); removeErr != nil {
|
||||
log.Printf("Failed to remove temp directory: %v", removeErr)
|
||||
}
|
||||
}()
|
||||
|
||||
fmt.Printf("Demo recordings will be saved to: %s\n\n", tmpDir)
|
||||
|
||||
// Create a recorder with async disabled for predictable demo output
|
||||
if envErr := os.Setenv("RECORDER_ASYNC", "false"); envErr != nil {
|
||||
log.Printf("Failed to set environment variable: %v", envErr)
|
||||
}
|
||||
|
||||
recorder := proxy.NewRecorder(tmpDir)
|
||||
defer recorder.Close()
|
||||
|
||||
fmt.Printf("Recorder session ID: %s\n", recorder.SessionID)
|
||||
fmt.Println()
|
||||
|
||||
// Create some sample HTTP requests to record
|
||||
requests := []struct {
|
||||
method string
|
||||
path string
|
||||
category string
|
||||
}{
|
||||
{"GET", "/info", "self"},
|
||||
{"POST", "/volume", "self"},
|
||||
{"GET", "/nowPlaying", "self"},
|
||||
{"PUT", "/preset_1", "self"},
|
||||
}
|
||||
|
||||
fmt.Println("Recording sample HTTP interactions...")
|
||||
fmt.Println()
|
||||
|
||||
for i, req := range requests {
|
||||
// Create a mock HTTP request
|
||||
httpReq, reqErr := http.NewRequest(req.method, "http://soundtouch.local:8090"+req.path, nil)
|
||||
if reqErr != nil {
|
||||
log.Printf("Failed to create request: %v", reqErr)
|
||||
continue
|
||||
}
|
||||
|
||||
// Create a mock response
|
||||
httpRes := &http.Response{
|
||||
StatusCode: 200,
|
||||
Header: make(http.Header),
|
||||
Request: httpReq,
|
||||
}
|
||||
httpRes.Header.Set("Content-Type", "application/xml")
|
||||
|
||||
// Record the interaction
|
||||
err = recorder.Record(req.category, httpReq, httpRes)
|
||||
if err != nil {
|
||||
log.Printf("Failed to record interaction: %v", err)
|
||||
continue
|
||||
}
|
||||
|
||||
fmt.Printf("%d. Recorded: %s %s\n", i+1, req.method, req.path)
|
||||
|
||||
// Small delay to show different timestamps
|
||||
time.Sleep(100 * time.Millisecond)
|
||||
}
|
||||
|
||||
fmt.Println()
|
||||
fmt.Println("=== Generated Filenames ===")
|
||||
fmt.Println()
|
||||
|
||||
// Walk through the recordings directory to show the generated filenames
|
||||
interactionsDir := filepath.Join(tmpDir, "interactions")
|
||||
|
||||
err = filepath.Walk(interactionsDir, func(path string, info os.FileInfo, err error) error {
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if strings.HasSuffix(info.Name(), ".http") {
|
||||
// Get relative path from interactions directory
|
||||
rel, _ := filepath.Rel(interactionsDir, path)
|
||||
fmt.Printf("📁 %s\n", rel)
|
||||
|
||||
// Parse and explain the filename format
|
||||
filename := info.Name()
|
||||
parts := strings.Split(strings.TrimSuffix(filename, ".http"), "-")
|
||||
|
||||
if len(parts) == 4 && len(parts[1]) == 8 {
|
||||
// New format: count-yyyyMMdd-HHMMSS.sss-method.http
|
||||
counter := parts[0]
|
||||
dateStr := parts[1]
|
||||
timeStr := parts[2]
|
||||
method := parts[3]
|
||||
|
||||
// Format for display
|
||||
date := dateStr[0:4] + "-" + dateStr[4:6] + "-" + dateStr[6:8]
|
||||
time := timeStr[0:2] + ":" + timeStr[2:4] + ":" + timeStr[4:]
|
||||
|
||||
fmt.Printf(" 📋 Format: count-yyyyMMdd-HHMMSS.sss-method.http\n")
|
||||
fmt.Printf(" 🔢 Counter: %s\n", counter)
|
||||
fmt.Printf(" 📅 Date: %s (from %s)\n", date, dateStr)
|
||||
fmt.Printf(" 🕒 Time: %s (from %s)\n", time, timeStr)
|
||||
fmt.Printf(" 🔧 Method: %s\n", method)
|
||||
fmt.Printf(" ✨ Full timestamp: %s %s\n", date, time)
|
||||
} else {
|
||||
fmt.Printf(" ⚠️ Legacy format or unexpected structure\n")
|
||||
}
|
||||
|
||||
fmt.Println()
|
||||
}
|
||||
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
log.Printf("Error walking directory: %v", err)
|
||||
}
|
||||
|
||||
fmt.Println("=== Comparison with Old Format ===")
|
||||
fmt.Println()
|
||||
fmt.Println("🔴 OLD format (time only): 0047-21-53-06.128-GET.http")
|
||||
fmt.Println(" - No date information in filename")
|
||||
fmt.Println(" - Date extracted from session ID directory")
|
||||
fmt.Println(" - Confusing when recordings span midnight")
|
||||
fmt.Println()
|
||||
fmt.Println("🟢 NEW format (date + time): 0047-20260223-215306.128-GET.http")
|
||||
fmt.Println(" - Complete timestamp in filename")
|
||||
fmt.Println(" - Self-contained, no need to check directory")
|
||||
fmt.Println(" - Clear chronological ordering")
|
||||
fmt.Println()
|
||||
|
||||
fmt.Println("=== Benefits ===")
|
||||
fmt.Println("✅ No confusion when recordings cross midnight")
|
||||
fmt.Println("✅ Complete timestamp visible at a glance")
|
||||
fmt.Println("✅ Better sorting and organization")
|
||||
fmt.Println("✅ Backwards compatible with existing parsing logic")
|
||||
fmt.Println()
|
||||
|
||||
// Test the list interactions functionality
|
||||
fmt.Println("=== Using ListInteractions API ===")
|
||||
fmt.Println()
|
||||
|
||||
interactions, err := recorder.ListInteractions("", "", "")
|
||||
if err != nil {
|
||||
log.Printf("Failed to list interactions: %v", err)
|
||||
return
|
||||
}
|
||||
|
||||
fmt.Printf("Found %d recorded interactions:\n", len(interactions))
|
||||
|
||||
for i := range interactions {
|
||||
interaction := &interactions[i]
|
||||
fmt.Printf("%d. %s %s - %s (File: %s)\n",
|
||||
i+1, interaction.Method, interaction.Path,
|
||||
interaction.Timestamp, interaction.ID)
|
||||
}
|
||||
|
||||
fmt.Printf("\nDemo completed! Recordings saved in: %s\n", tmpDir)
|
||||
fmt.Println("You can explore the generated files to see the new format in action.")
|
||||
}
|
||||
@@ -1,6 +1,6 @@
|
||||
module github.com/gesellix/bose-soundtouch
|
||||
|
||||
go 1.25.7
|
||||
go 1.26.1
|
||||
|
||||
require (
|
||||
github.com/go-chi/chi/v5 v5.2.5
|
||||
@@ -9,15 +9,15 @@ require (
|
||||
github.com/miekg/dns v1.1.72
|
||||
github.com/russross/blackfriday/v2 v2.1.0
|
||||
github.com/urfave/cli/v2 v2.27.7
|
||||
golang.org/x/crypto v0.48.0
|
||||
golang.org/x/crypto v0.49.0
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/cpuguy83/go-md2man/v2 v2.0.7 // indirect
|
||||
github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 // indirect
|
||||
golang.org/x/mod v0.33.0 // indirect
|
||||
golang.org/x/net v0.50.0 // indirect
|
||||
golang.org/x/sync v0.19.0 // indirect
|
||||
golang.org/x/sys v0.41.0 // indirect
|
||||
golang.org/x/tools v0.42.0 // indirect
|
||||
github.com/xrash/smetrics v0.0.0-20250705151800-55b8f293f342 // indirect
|
||||
golang.org/x/mod v0.34.0 // indirect
|
||||
golang.org/x/net v0.52.0 // indirect
|
||||
golang.org/x/sync v0.20.0 // indirect
|
||||
golang.org/x/sys v0.42.0 // indirect
|
||||
golang.org/x/tools v0.43.0 // indirect
|
||||
)
|
||||
|
||||
@@ -15,8 +15,8 @@ github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf
|
||||
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
|
||||
github.com/urfave/cli/v2 v2.27.7 h1:bH59vdhbjLv3LAvIu6gd0usJHgoTTPhCFib8qqOwXYU=
|
||||
github.com/urfave/cli/v2 v2.27.7/go.mod h1:CyNAG/xg+iAOg0N4MPGZqVmv2rCoP267496AOXUZjA4=
|
||||
github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 h1:gEOO8jv9F4OT7lGCjxCBTO/36wtF6j2nSip77qHd4x4=
|
||||
github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1/go.mod h1:Ohn+xnUBiLI6FVj/9LpzZWtj1/D6lUovWYBkxHVV3aM=
|
||||
github.com/xrash/smetrics v0.0.0-20250705151800-55b8f293f342 h1:FnBeRrxr7OU4VvAzt5X7s6266i6cSVkkFPS0TuXWbIg=
|
||||
github.com/xrash/smetrics v0.0.0-20250705151800-55b8f293f342/go.mod h1:Ohn+xnUBiLI6FVj/9LpzZWtj1/D6lUovWYBkxHVV3aM=
|
||||
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
|
||||
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
|
||||
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
|
||||
@@ -24,16 +24,16 @@ golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliY
|
||||
golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU=
|
||||
golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8=
|
||||
golang.org/x/crypto v0.32.0/go.mod h1:ZnnJkOaASj8g0AjIduWNlq2NRxL0PlBrbKVyZ6V/Ugc=
|
||||
golang.org/x/crypto v0.48.0 h1:/VRzVqiRSggnhY7gNRxPauEQ5Drw9haKdM0jqfcCFts=
|
||||
golang.org/x/crypto v0.48.0/go.mod h1:r0kV5h3qnFPlQnBSrULhlsRfryS2pmewsg+XfMgkVos=
|
||||
golang.org/x/crypto v0.49.0 h1:+Ng2ULVvLHnJ/ZFEq4KdcDd/cfjrrjjNSXNzxg0Y4U4=
|
||||
golang.org/x/crypto v0.49.0/go.mod h1:ErX4dUh2UM+CFYiXZRTcMpEcN8b/1gxEuv3nODoYtCA=
|
||||
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
|
||||
golang.org/x/mod v0.7.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
|
||||
golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
|
||||
golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
|
||||
golang.org/x/mod v0.15.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
|
||||
golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
|
||||
golang.org/x/mod v0.33.0 h1:tHFzIWbBifEmbwtGz65eaWyGiGZatSrT9prnU8DbVL8=
|
||||
golang.org/x/mod v0.33.0/go.mod h1:swjeQEj+6r7fODbD2cqrnje9PnziFuw4bmLbBZFrQ5w=
|
||||
golang.org/x/mod v0.34.0 h1:xIHgNUUnW6sYkcM5Jleh05DvLOtwc6RitGHbDk4akRI=
|
||||
golang.org/x/mod v0.34.0/go.mod h1:ykgH52iCZe79kzLLMhyCUzhMci+nQj+0XkbXpNYtVjY=
|
||||
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
||||
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
|
||||
golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
|
||||
@@ -44,8 +44,8 @@ golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk=
|
||||
golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44=
|
||||
golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM=
|
||||
golang.org/x/net v0.34.0/go.mod h1:di0qlW3YNM5oh6GqDGQr92MyTozJPmybPK4Ev/Gm31k=
|
||||
golang.org/x/net v0.50.0 h1:ucWh9eiCGyDR3vtzso0WMQinm2Dnt8cFMuQa9K33J60=
|
||||
golang.org/x/net v0.50.0/go.mod h1:UgoSli3F/pBgdJBHCTc+tp3gmrU4XswgGRgtnwWTfyM=
|
||||
golang.org/x/net v0.52.0 h1:He/TN1l0e4mmR3QqHMT2Xab3Aj3L9qjbhRm78/6jrW0=
|
||||
golang.org/x/net v0.52.0/go.mod h1:R1MAz7uMZxVMualyPXb+VaqGSa3LIaUqk0eEt3w36Sw=
|
||||
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
@@ -53,8 +53,8 @@ golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y=
|
||||
golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
|
||||
golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
|
||||
golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
|
||||
golang.org/x/sync v0.19.0 h1:vV+1eWNmZ5geRlYjzm2adRgW2/mcpevXNg50YZtPCE4=
|
||||
golang.org/x/sync v0.19.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI=
|
||||
golang.org/x/sync v0.20.0 h1:e0PTpb7pjO8GAtTs2dQ6jYa5BWYlMuX047Dco/pItO4=
|
||||
golang.org/x/sync v0.20.0/go.mod h1:9xrNwdLfx4jkKbNva9FpL6vEN7evnE43NNNJQ2LF3+0=
|
||||
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
@@ -67,8 +67,8 @@ golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||
golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||
golang.org/x/sys v0.29.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||
golang.org/x/sys v0.41.0 h1:Ivj+2Cp/ylzLiEU89QhWblYnOE9zerudt9Ftecq2C6k=
|
||||
golang.org/x/sys v0.41.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
|
||||
golang.org/x/sys v0.42.0 h1:omrd2nAlyT5ESRdCLYdm3+fMfNFE/+Rf4bDIQImRJeo=
|
||||
golang.org/x/sys v0.42.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
|
||||
golang.org/x/telemetry v0.0.0-20240228155512-f48c80bd79b2/go.mod h1:TeRTkGYfJXctD9OcfyVLyj2J3IxLnKwHJR8f4D8a3YE=
|
||||
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
|
||||
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
|
||||
@@ -79,8 +79,8 @@ golang.org/x/term v0.12.0/go.mod h1:owVbMEjm3cBLCHdkQu9b1opXd4ETQWc3BhuQGKgXgvU=
|
||||
golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk=
|
||||
golang.org/x/term v0.20.0/go.mod h1:8UkIAJTvZgivsXaD6/pH6U9ecQzZ45awqEOzuCvwpFY=
|
||||
golang.org/x/term v0.28.0/go.mod h1:Sw/lC2IAUZ92udQNf3WodGtn4k/XoLyZoh8v/8uiwek=
|
||||
golang.org/x/term v0.40.0 h1:36e4zGLqU4yhjlmxEaagx2KuYbJq3EwY8K943ZsHcvg=
|
||||
golang.org/x/term v0.40.0/go.mod h1:w2P8uVp06p2iyKKuvXIm7N/y0UCRt3UfJTfZ7oOpglM=
|
||||
golang.org/x/term v0.41.0 h1:QCgPso/Q3RTJx2Th4bDLqML4W6iJiaXFq2/ftQF13YU=
|
||||
golang.org/x/term v0.41.0/go.mod h1:3pfBgksrReYfZ5lvYM0kSO0LIkAl4Yl2bXOkKP7Ec2A=
|
||||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
||||
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
||||
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
|
||||
@@ -98,6 +98,6 @@ golang.org/x/tools v0.3.0/go.mod h1:/rWhSS2+zyEVwoJf8YAX6L2f0ntZ7Kn/mGgAWcipA5k=
|
||||
golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU=
|
||||
golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58=
|
||||
golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk=
|
||||
golang.org/x/tools v0.42.0 h1:uNgphsn75Tdz5Ji2q36v/nsFSfR/9BRFvqhGBaJGd5k=
|
||||
golang.org/x/tools v0.42.0/go.mod h1:Ma6lCIwGZvHK6XtgbswSoWroEkhugApmsXyrUmBhfr0=
|
||||
golang.org/x/tools v0.43.0 h1:12BdW9CeB3Z+J/I/wj34VMl8X+fEXBxVR90JeMX5E7s=
|
||||
golang.org/x/tools v0.43.0/go.mod h1:uHkMso649BX2cZK6+RpuIPXS3ho2hZo4FVwfoy1vIk0=
|
||||
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
|
||||
@@ -1769,8 +1769,8 @@ func (c *Client) hasCapability(capabilities *models.Capabilities, capability str
|
||||
}
|
||||
|
||||
// PlayTTS plays a Text-To-Speech message using Google TTS on the speaker
|
||||
func (c *Client) PlayTTS(text, appKey string, volume ...int) error {
|
||||
playInfo := models.NewTTSPlayInfo(text, appKey, volume...)
|
||||
func (c *Client) PlayTTS(text, appKey, language string, volume ...int) error {
|
||||
playInfo := models.NewTTSPlayInfo(text, appKey, language, volume...)
|
||||
|
||||
if err := playInfo.Validate(); err != nil {
|
||||
return fmt.Errorf("invalid TTS request: %w", err)
|
||||
|
||||
@@ -30,6 +30,10 @@ type Config struct {
|
||||
// Cache settings
|
||||
CacheEnabled bool `env:"CACHE_ENABLED" default:"true"`
|
||||
CacheTTL time.Duration `env:"CACHE_TTL" default:"30s"`
|
||||
|
||||
// Migration settings (TODO: Remove after 3-4 releases when all devices are migrated)
|
||||
MigrationEnabled bool `env:"MIGRATION_ENABLED" default:"true"`
|
||||
MigrationDryRun bool `env:"MIGRATION_DRY_RUN" default:"false"`
|
||||
}
|
||||
|
||||
// DeviceConfig represents a configured SoundTouch device
|
||||
@@ -48,6 +52,8 @@ func DefaultConfig() *Config {
|
||||
PreferredDevices: []DeviceConfig{},
|
||||
HTTPTimeout: 10 * time.Second,
|
||||
UserAgent: "Bose-SoundTouch-Go-Client/1.0",
|
||||
MigrationEnabled: true, // TODO: Change to false after 3-4 releases
|
||||
MigrationDryRun: false,
|
||||
CacheEnabled: true,
|
||||
CacheTTL: 30 * time.Second,
|
||||
}
|
||||
|
||||
+117
-45
@@ -4,6 +4,7 @@ package discovery
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
"net"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
@@ -14,7 +15,7 @@ import (
|
||||
// DNSDiscovery handles DNS queries and records discovered hosts.
|
||||
type DNSDiscovery struct {
|
||||
// Configuration
|
||||
upstreamDNS string
|
||||
upstreamDNS []string
|
||||
serviceIP string
|
||||
|
||||
// State
|
||||
@@ -31,6 +32,9 @@ type DNSDiscovery struct {
|
||||
// Address for loop prevention
|
||||
bindAddr string
|
||||
|
||||
// Forward timeout
|
||||
timeout time.Duration
|
||||
|
||||
// Log throttling
|
||||
lastLog map[string]time.Time
|
||||
lastLogMu sync.Mutex
|
||||
@@ -48,11 +52,12 @@ type DiscoveredHost struct {
|
||||
}
|
||||
|
||||
// NewDNSDiscovery creates a new DNSDiscovery instance.
|
||||
func NewDNSDiscovery(upstreamDNS, serviceIP string) *DNSDiscovery {
|
||||
func NewDNSDiscovery(upstreamDNS []string, serviceIP string) *DNSDiscovery {
|
||||
return &DNSDiscovery{
|
||||
upstreamDNS: upstreamDNS,
|
||||
serviceIP: serviceIP,
|
||||
discovered: make(map[string]*DiscoveredHost),
|
||||
timeout: 2 * time.Second,
|
||||
lastLog: make(map[string]time.Time),
|
||||
}
|
||||
}
|
||||
@@ -83,7 +88,7 @@ func (d *DNSDiscovery) ServeDNS(w dns.ResponseWriter, r *dns.Msg) {
|
||||
d.throttledLog(fmt.Sprintf("[DNS] Intercepting %s (type %d) -> %s", hostname, q.Qtype, d.serviceIP))
|
||||
} else {
|
||||
// Forward to real DNS
|
||||
if d.upstreamDNS == "" {
|
||||
if len(d.upstreamDNS) == 0 {
|
||||
d.throttledLog("[DNS ERROR] No upstream DNS configured, cannot forward")
|
||||
|
||||
m := new(dns.Msg)
|
||||
@@ -94,7 +99,7 @@ func (d *DNSDiscovery) ServeDNS(w dns.ResponseWriter, r *dns.Msg) {
|
||||
return
|
||||
}
|
||||
|
||||
d.throttledLog(fmt.Sprintf("[DNS] Forwarding %s (type %d) to %s", hostname, q.Qtype, d.upstreamDNS))
|
||||
d.throttledLog(fmt.Sprintf("[DNS] Forwarding %s (type %d) to %v", hostname, q.Qtype, d.upstreamDNS))
|
||||
d.forward(w, r)
|
||||
}
|
||||
}
|
||||
@@ -155,13 +160,17 @@ func (d *DNSDiscovery) shouldIntercept(hostname string) bool {
|
||||
"marge.bose.com",
|
||||
"bmx.bose.com",
|
||||
"streaming.bose.com",
|
||||
"streamingoauth.bose.com",
|
||||
"updates.bose.com",
|
||||
"stats.bose.com",
|
||||
"content.api.bose.io",
|
||||
"events.api.bosecm.com",
|
||||
"bose-prod.apigee.net",
|
||||
"bose-test.apigee.net",
|
||||
"worldwide.bose.com",
|
||||
"music.api.bose.com",
|
||||
"bosecm.com",
|
||||
"bose.io",
|
||||
}
|
||||
|
||||
for _, service := range interceptList {
|
||||
@@ -188,19 +197,78 @@ func (d *DNSDiscovery) respondWithIP(w dns.ResponseWriter, r *dns.Msg, ip string
|
||||
q := r.Question[0]
|
||||
log.Printf("[DNS] Intercepted query for %s (type %d) from %s", q.Name, q.Qtype, w.RemoteAddr())
|
||||
|
||||
resolvedIP := ip
|
||||
if net.ParseIP(ip) == nil {
|
||||
// Attempt resolution if it's not a numeric IP
|
||||
ips, err := net.LookupIP(ip)
|
||||
if err == nil && len(ips) > 0 {
|
||||
for _, rIP := range ips {
|
||||
if rIP.To4() != nil {
|
||||
resolvedIP = rIP.String()
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if resolvedIP == ip && len(ips) > 0 {
|
||||
resolvedIP = ips[0].String()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
switch q.Qtype {
|
||||
case dns.TypeA, dns.TypeANY:
|
||||
rr, err := dns.NewRR(fmt.Sprintf("%s 60 IN A %s", q.Name, ip))
|
||||
if err == nil {
|
||||
m.Answer = append(m.Answer, rr)
|
||||
if net.ParseIP(resolvedIP) == nil || strings.Contains(resolvedIP, ":") {
|
||||
// If it's still not a valid IPv4 address, we can't create an A record.
|
||||
// Try CNAME as a fallback if it looks like a hostname.
|
||||
if !strings.Contains(resolvedIP, ":") {
|
||||
// Normalize hostname for CNAME
|
||||
target := resolvedIP
|
||||
if !strings.HasSuffix(target, ".") {
|
||||
target += "."
|
||||
}
|
||||
|
||||
log.Printf("[DNS] Returning A record %s -> %s", q.Name, ip)
|
||||
rr, err := dns.NewRR(fmt.Sprintf("%s 60 IN CNAME %s", q.Name, target))
|
||||
if err == nil {
|
||||
m.Answer = append(m.Answer, rr)
|
||||
|
||||
log.Printf("[DNS] Returning CNAME record %s -> %s", q.Name, target)
|
||||
} else {
|
||||
log.Printf("[DNS] Error creating CNAME fallback for %s: %v", target, err)
|
||||
|
||||
m.Rcode = dns.RcodeServerFailure
|
||||
}
|
||||
} else {
|
||||
m.Rcode = dns.RcodeServerFailure
|
||||
}
|
||||
} else {
|
||||
log.Printf("[DNS] Error creating A record: %v", err)
|
||||
rr, err := dns.NewRR(fmt.Sprintf("%s 60 IN A %s", q.Name, resolvedIP))
|
||||
if err == nil {
|
||||
m.Answer = append(m.Answer, rr)
|
||||
|
||||
log.Printf("[DNS] Returning A record %s -> %s", q.Name, resolvedIP)
|
||||
} else {
|
||||
log.Printf("[DNS] Error creating A record for %s: %v", resolvedIP, err)
|
||||
|
||||
m.Rcode = dns.RcodeServerFailure
|
||||
}
|
||||
}
|
||||
case dns.TypeAAAA:
|
||||
// Explicitly return SUCCESS with no data for AAAA to prevent fallback issues
|
||||
log.Printf("[DNS] Returning empty AAAA success (NODATA) for %s", q.Name)
|
||||
// Check if we have an IPv6 address
|
||||
if net.ParseIP(resolvedIP) != nil && strings.Contains(resolvedIP, ":") {
|
||||
rr, err := dns.NewRR(fmt.Sprintf("%s 60 IN AAAA %s", q.Name, resolvedIP))
|
||||
if err == nil {
|
||||
m.Answer = append(m.Answer, rr)
|
||||
|
||||
log.Printf("[DNS] Returning AAAA record %s -> %s", q.Name, resolvedIP)
|
||||
} else {
|
||||
log.Printf("[DNS] Error creating AAAA record for %s: %v", resolvedIP, err)
|
||||
|
||||
m.Rcode = dns.RcodeServerFailure
|
||||
}
|
||||
} else {
|
||||
// Explicitly return SUCCESS with no data for AAAA to prevent fallback issues if no IPv6
|
||||
log.Printf("[DNS] Returning empty AAAA success (NODATA) for %s", q.Name)
|
||||
}
|
||||
default:
|
||||
log.Printf("[DNS] Returning empty success for type %d", q.Qtype)
|
||||
}
|
||||
@@ -230,44 +298,44 @@ func (d *DNSDiscovery) forward(w dns.ResponseWriter, r *dns.Msg) {
|
||||
return
|
||||
}
|
||||
|
||||
// Add port 53 if not present
|
||||
upstream := d.upstreamDNS
|
||||
if !strings.Contains(upstream, ":") {
|
||||
upstream += ":53"
|
||||
}
|
||||
|
||||
// Loop prevention: don't forward to ourselves
|
||||
if upstream == d.bindAddr || (strings.HasPrefix(upstream, "127.0.0.1:") && strings.HasSuffix(d.bindAddr, upstream[9:])) {
|
||||
d.throttledLog(fmt.Sprintf("[DNS ERROR] Refusing to forward %s to ourselves (%s)", q.Name, upstream))
|
||||
|
||||
m := new(dns.Msg)
|
||||
m.SetReply(r)
|
||||
m.Rcode = dns.RcodeServerFailure
|
||||
_ = w.WriteMsg(m)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
c := new(dns.Client)
|
||||
c.Timeout = 2 * time.Second
|
||||
c.Timeout = d.timeout
|
||||
|
||||
in, _, err := c.Exchange(r, upstream)
|
||||
if err != nil {
|
||||
d.throttledLog(fmt.Sprintf("[DNS ERROR] Forward failed for %s (type %d): %v", q.Name, q.Qtype, err))
|
||||
// Return a failure response instead of just dropping
|
||||
m := new(dns.Msg)
|
||||
m.SetReply(r)
|
||||
|
||||
m.Rcode = dns.RcodeServerFailure
|
||||
if err := w.WriteMsg(m); err != nil {
|
||||
log.Printf("[DNS ERROR] Failed to write failure response: %v", err)
|
||||
for _, upstream := range d.upstreamDNS {
|
||||
// Add port 53 if not present
|
||||
if !strings.Contains(upstream, ":") {
|
||||
upstream += ":53"
|
||||
}
|
||||
|
||||
return
|
||||
// Loop prevention: don't forward to ourselves
|
||||
if upstream == d.bindAddr || (strings.HasPrefix(upstream, "127.0.0.1:") && strings.HasSuffix(d.bindAddr, upstream[9:])) {
|
||||
d.throttledLog(fmt.Sprintf("[DNS ERROR] Refusing to forward %s to ourselves (%s)", q.Name, upstream))
|
||||
continue
|
||||
}
|
||||
|
||||
in, _, err := c.Exchange(r, upstream)
|
||||
if err == nil {
|
||||
if in.Rcode == dns.RcodeSuccess {
|
||||
if writeErr := w.WriteMsg(in); writeErr != nil {
|
||||
log.Printf("[DNS ERROR] Failed to write forwarded response from %s: %v", upstream, writeErr)
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
d.throttledLog(fmt.Sprintf("[DNS] Upstream %s returned %s for %s, trying next", upstream, dns.RcodeToString[in.Rcode], q.Name))
|
||||
} else {
|
||||
d.throttledLog(fmt.Sprintf("[DNS ERROR] Forward failed for %s (type %d) via %s: %v", q.Name, q.Qtype, upstream, err))
|
||||
}
|
||||
}
|
||||
|
||||
if err := w.WriteMsg(in); err != nil {
|
||||
log.Printf("[DNS ERROR] Failed to write forwarded response: %v", err)
|
||||
// If we reach here, all upstreams failed
|
||||
m := new(dns.Msg)
|
||||
m.SetReply(r)
|
||||
m.Rcode = dns.RcodeServerFailure
|
||||
|
||||
if err := w.WriteMsg(m); err != nil {
|
||||
log.Printf("[DNS ERROR] Failed to write failure response: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -327,6 +395,10 @@ func (d *DNSDiscovery) Start(addr string) error {
|
||||
Net: "tcp",
|
||||
Handler: mux,
|
||||
}
|
||||
|
||||
// Capture server references before releasing mutex to avoid race condition
|
||||
udpServer := d.udpServer
|
||||
tcpServer := d.tcpServer
|
||||
d.mu.Unlock()
|
||||
|
||||
errChan := make(chan error, 2)
|
||||
@@ -334,7 +406,7 @@ func (d *DNSDiscovery) Start(addr string) error {
|
||||
go func() {
|
||||
log.Printf("[DNS] UDP Discovery server starting on %s", addr)
|
||||
|
||||
if err := d.udpServer.ListenAndServe(); err != nil {
|
||||
if err := udpServer.ListenAndServe(); err != nil {
|
||||
errChan <- fmt.Errorf("UDP server failed: %w", err)
|
||||
}
|
||||
}()
|
||||
@@ -342,7 +414,7 @@ func (d *DNSDiscovery) Start(addr string) error {
|
||||
go func() {
|
||||
log.Printf("[DNS] TCP Discovery server starting on %s", addr)
|
||||
|
||||
if err := d.tcpServer.ListenAndServe(); err != nil {
|
||||
if err := tcpServer.ListenAndServe(); err != nil {
|
||||
errChan <- fmt.Errorf("TCP server failed: %w", err)
|
||||
}
|
||||
}()
|
||||
|
||||
+237
-10
@@ -12,7 +12,7 @@ import (
|
||||
|
||||
func TestDNSDiscovery_Interception(t *testing.T) {
|
||||
serviceIP := "192.168.1.100"
|
||||
upstreamDNS := "8.8.8.8"
|
||||
upstreamDNS := []string{"8.8.8.8"}
|
||||
d := NewDNSDiscovery(upstreamDNS, serviceIP)
|
||||
|
||||
// Test intercepting Bose service
|
||||
@@ -38,6 +38,11 @@ func TestDNSDiscovery_Interception(t *testing.T) {
|
||||
t.Errorf("Expected A record, got %T", rw.msg.Answer[0])
|
||||
}
|
||||
|
||||
// Test intercepting streamingoauth.bose.com
|
||||
if !d.shouldIntercept("streamingoauth.bose.com") {
|
||||
t.Error("Expected streamingoauth.bose.com to be intercepted")
|
||||
}
|
||||
|
||||
// Test aftertouch.test
|
||||
m2 := new(dns.Msg)
|
||||
m2.SetQuestion("aftertouch.test.", dns.TypeA)
|
||||
@@ -61,7 +66,7 @@ func TestDNSDiscovery_Forwarding(t *testing.T) {
|
||||
// This test is harder because it needs a real upstream or a mock.
|
||||
// For now, let's just test that it calls forward and record.
|
||||
serviceIP := "192.168.1.100"
|
||||
upstreamDNS := "127.0.0.1:5353" // Use a port that is likely closed or we can mock
|
||||
upstreamDNS := []string{"127.0.0.1:5353"} // Use a port that is likely closed or we can mock
|
||||
d := NewDNSDiscovery(upstreamDNS, serviceIP)
|
||||
|
||||
m := new(dns.Msg)
|
||||
@@ -102,7 +107,7 @@ func TestDNSDiscovery_Forwarding(t *testing.T) {
|
||||
|
||||
func TestDNSDiscovery_StartTCP(t *testing.T) {
|
||||
serviceIP := "192.168.1.100"
|
||||
upstreamDNS := "8.8.8.8"
|
||||
upstreamDNS := []string{"8.8.8.8"}
|
||||
d := NewDNSDiscovery(upstreamDNS, serviceIP)
|
||||
|
||||
addr := "127.0.0.1:5354"
|
||||
@@ -149,9 +154,109 @@ func TestDNSDiscovery_StartTCP(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestDNSDiscovery_SelfForwarding(t *testing.T) {
|
||||
serviceIP := "soundtouch.local"
|
||||
upstreamDNS := []string{"127.0.0.1:5357"}
|
||||
d := NewDNSDiscovery(upstreamDNS, serviceIP)
|
||||
|
||||
// Mock upstream DNS server for soundtouch.local
|
||||
mux := dns.NewServeMux()
|
||||
mux.HandleFunc("soundtouch.local.", func(w dns.ResponseWriter, r *dns.Msg) {
|
||||
m := new(dns.Msg)
|
||||
m.SetReply(r)
|
||||
rr, _ := dns.NewRR("soundtouch.local. 60 IN A 192.168.178.10")
|
||||
m.Answer = append(m.Answer, rr)
|
||||
_ = w.WriteMsg(m)
|
||||
})
|
||||
ts := &dns.Server{Addr: "127.0.0.1:5357", Net: "udp", Handler: mux, ReadTimeout: 100 * time.Millisecond, WriteTimeout: 100 * time.Millisecond}
|
||||
go func() {
|
||||
_ = ts.ListenAndServe()
|
||||
}()
|
||||
defer func() { _ = ts.Shutdown() }()
|
||||
|
||||
time.Sleep(100 * time.Millisecond)
|
||||
|
||||
m := new(dns.Msg)
|
||||
m.SetQuestion("soundtouch.local.", dns.TypeA)
|
||||
rw := &mockResponseWriter{}
|
||||
d.ServeDNS(rw, m)
|
||||
|
||||
if rw.msg == nil {
|
||||
t.Fatal("Expected a response for soundtouch.local")
|
||||
}
|
||||
|
||||
if rw.msg.Rcode != dns.RcodeSuccess {
|
||||
t.Errorf("Expected Success (0) for soundtouch.local being forwarded, got %d", rw.msg.Rcode)
|
||||
}
|
||||
|
||||
if len(rw.msg.Answer) == 0 {
|
||||
t.Fatal("Expected an answer in the response")
|
||||
}
|
||||
|
||||
if a, ok := rw.msg.Answer[0].(*dns.A); ok {
|
||||
if a.A.String() != "192.168.178.10" {
|
||||
t.Errorf("Expected IP 192.168.178.10, got %s", a.A.String())
|
||||
}
|
||||
}
|
||||
|
||||
// Check if d.recordQuery logged it correctly.
|
||||
d.mu.RLock()
|
||||
host, exists := d.discovered["soundtouch.local"]
|
||||
d.mu.RUnlock()
|
||||
|
||||
if !exists {
|
||||
t.Error("Expected soundtouch.local to be recorded")
|
||||
}
|
||||
// It should NOT be intercepted anymore
|
||||
if host != nil && host.IsIntercepted {
|
||||
t.Error("Expected soundtouch.local NOT to be intercepted anymore, but forwarded")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDNSDiscovery_ForwardLocal(t *testing.T) {
|
||||
serviceIP := "192.168.1.100"
|
||||
upstreamDNS := []string{"127.0.0.1:5356"}
|
||||
d := NewDNSDiscovery(upstreamDNS, serviceIP)
|
||||
|
||||
m := new(dns.Msg)
|
||||
m.SetQuestion("someone-else.local.", dns.TypeA)
|
||||
rw := &mockResponseWriter{}
|
||||
|
||||
// Start a mock upstream DNS server that returns SUCCESS for .local
|
||||
mux := dns.NewServeMux()
|
||||
mux.HandleFunc("someone-else.local.", func(w dns.ResponseWriter, r *dns.Msg) {
|
||||
m := new(dns.Msg)
|
||||
m.SetReply(r)
|
||||
rr, _ := dns.NewRR("someone-else.local. 60 IN A 192.168.1.50")
|
||||
m.Answer = append(m.Answer, rr)
|
||||
_ = w.WriteMsg(m)
|
||||
})
|
||||
ts := &dns.Server{Addr: "127.0.0.1:5356", Net: "udp", Handler: mux, ReadTimeout: 100 * time.Millisecond, WriteTimeout: 100 * time.Millisecond}
|
||||
go func() {
|
||||
_ = ts.ListenAndServe()
|
||||
}()
|
||||
defer func() { _ = ts.Shutdown() }()
|
||||
|
||||
time.Sleep(100 * time.Millisecond)
|
||||
|
||||
d.ServeDNS(rw, m)
|
||||
|
||||
if rw.msg == nil {
|
||||
t.Fatal("Expected a response message")
|
||||
}
|
||||
|
||||
if rw.msg.Rcode != dns.RcodeSuccess {
|
||||
t.Errorf("Expected Success (0) for .local being forwarded, got %d", rw.msg.Rcode)
|
||||
}
|
||||
|
||||
if len(rw.msg.Answer) == 0 {
|
||||
t.Fatal("Expected an answer in the response")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDNSDiscovery_IsRunning(t *testing.T) {
|
||||
serviceIP := "192.168.1.100"
|
||||
upstreamDNS := "8.8.8.8"
|
||||
upstreamDNS := []string{"8.8.8.8"}
|
||||
d := NewDNSDiscovery(upstreamDNS, serviceIP)
|
||||
|
||||
addr := "127.0.0.1:5355"
|
||||
@@ -196,7 +301,7 @@ func (m *mockResponseWriter) TsigTimersOnly(bool) {}
|
||||
func (m *mockResponseWriter) Hijack() {}
|
||||
|
||||
func TestDNSDiscovery_LogThrottling(t *testing.T) {
|
||||
d := NewDNSDiscovery("8.8.8.8", "192.168.1.100")
|
||||
d := NewDNSDiscovery([]string{"8.8.8.8"}, "192.168.1.100")
|
||||
|
||||
// Capture log output
|
||||
var logBuf strings.Builder
|
||||
@@ -229,7 +334,7 @@ func TestDNSDiscovery_LogThrottling(t *testing.T) {
|
||||
func TestDNSDiscovery_LoopPrevention(t *testing.T) {
|
||||
serviceIP := "192.168.1.100"
|
||||
bindAddr := "127.0.0.1:53"
|
||||
upstreamDNS := "127.0.0.1:53"
|
||||
upstreamDNS := []string{"127.0.0.1:53"}
|
||||
d := NewDNSDiscovery(upstreamDNS, serviceIP)
|
||||
d.bindAddr = bindAddr
|
||||
|
||||
@@ -256,7 +361,7 @@ func TestDNSDiscovery_LoopPrevention(t *testing.T) {
|
||||
|
||||
func TestDNSDiscovery_EmptyUpstream(t *testing.T) {
|
||||
serviceIP := "192.168.1.100"
|
||||
upstreamDNS := "" // Empty upstream
|
||||
var upstreamDNS []string // Empty upstream
|
||||
d := NewDNSDiscovery(upstreamDNS, serviceIP)
|
||||
d.bindAddr = ":53"
|
||||
|
||||
@@ -280,8 +385,9 @@ func TestDNSDiscovery_EmptyUpstream(t *testing.T) {
|
||||
func TestDNSDiscovery_ForwardTimeout(t *testing.T) {
|
||||
serviceIP := "192.168.1.100"
|
||||
// Use an IP that is unroutable or doesn't exist on the network to ensure timeout
|
||||
upstreamDNS := "192.0.2.1:53" // TEST-NET-1, usually non-routable
|
||||
upstreamDNS := []string{"192.0.2.1:53"} // TEST-NET-1, usually non-routable
|
||||
d := NewDNSDiscovery(upstreamDNS, serviceIP)
|
||||
d.timeout = 100 * time.Millisecond
|
||||
|
||||
m := new(dns.Msg)
|
||||
m.SetQuestion("google.com.", dns.TypeA)
|
||||
@@ -292,11 +398,132 @@ func TestDNSDiscovery_ForwardTimeout(t *testing.T) {
|
||||
d.forward(rw, m)
|
||||
duration := time.Since(start)
|
||||
|
||||
if duration < 2*time.Second {
|
||||
t.Errorf("Expected forward to take at least 2 seconds (timeout), but took %v", duration)
|
||||
if duration < 100*time.Millisecond {
|
||||
t.Errorf("Expected forward to take at least 100ms (timeout), but took %v", duration)
|
||||
}
|
||||
|
||||
if rw.msg == nil || rw.msg.Rcode != dns.RcodeServerFailure {
|
||||
t.Errorf("Expected RcodeServerFailure after timeout")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDNSDiscovery_MultipleUpstreams(t *testing.T) {
|
||||
serviceIP := "192.168.1.100"
|
||||
|
||||
// Mock server 1: returns NXDOMAIN
|
||||
mux1 := dns.NewServeMux()
|
||||
mux1.HandleFunc("test.com.", func(w dns.ResponseWriter, r *dns.Msg) {
|
||||
m := new(dns.Msg)
|
||||
m.SetReply(r)
|
||||
m.Rcode = dns.RcodeNameError
|
||||
_ = w.WriteMsg(m)
|
||||
})
|
||||
ts1 := &dns.Server{Addr: "127.0.0.1:5356", Net: "udp", Handler: mux1}
|
||||
go func() { _ = ts1.ListenAndServe() }()
|
||||
defer func() { _ = ts1.Shutdown() }()
|
||||
|
||||
// Mock server 2: succeeds
|
||||
mux2 := dns.NewServeMux()
|
||||
mux2.HandleFunc("test.com.", func(w dns.ResponseWriter, r *dns.Msg) {
|
||||
m := new(dns.Msg)
|
||||
m.SetReply(r)
|
||||
m.Answer = append(m.Answer, &dns.A{
|
||||
Hdr: dns.RR_Header{Name: r.Question[0].Name, Rrtype: dns.TypeA, Class: dns.ClassINET, Ttl: 300},
|
||||
A: net.ParseIP("1.2.3.4"),
|
||||
})
|
||||
_ = w.WriteMsg(m)
|
||||
})
|
||||
ts2 := &dns.Server{Addr: "127.0.0.1:5357", Net: "udp", Handler: mux2}
|
||||
go func() { _ = ts2.ListenAndServe() }()
|
||||
defer func() { _ = ts2.Shutdown() }()
|
||||
|
||||
time.Sleep(100 * time.Millisecond)
|
||||
|
||||
upstreamDNS := []string{"127.0.0.1:5356", "127.0.0.1:5357"}
|
||||
d := NewDNSDiscovery(upstreamDNS, serviceIP)
|
||||
|
||||
m := new(dns.Msg)
|
||||
m.SetQuestion("test.com.", dns.TypeA)
|
||||
rw := &mockResponseWriter{}
|
||||
|
||||
d.forward(rw, m)
|
||||
|
||||
if rw.msg == nil {
|
||||
t.Fatal("Expected a response message")
|
||||
}
|
||||
|
||||
// It should succeed because it falls back to the second upstream
|
||||
if rw.msg.Rcode != dns.RcodeSuccess {
|
||||
t.Errorf("Expected RcodeSuccess (0), got %d. Fallback failed.", rw.msg.Rcode)
|
||||
}
|
||||
|
||||
if len(rw.msg.Answer) == 0 {
|
||||
t.Fatal("Expected an answer from the second upstream")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDNSDiscovery_HostnameServiceIP(t *testing.T) {
|
||||
// Use localhost which should resolve to 127.0.0.1
|
||||
serviceIP := "localhost"
|
||||
upstreamDNS := []string{"8.8.8.8"}
|
||||
d := NewDNSDiscovery(upstreamDNS, serviceIP)
|
||||
|
||||
m := new(dns.Msg)
|
||||
m.SetQuestion("api.bose.com.", dns.TypeA)
|
||||
|
||||
rw := &mockResponseWriter{}
|
||||
d.ServeDNS(rw, m)
|
||||
|
||||
if rw.msg == nil {
|
||||
t.Fatal("Expected a response message, got nil")
|
||||
}
|
||||
|
||||
if len(rw.msg.Answer) == 0 {
|
||||
t.Fatal("Expected an answer in the response")
|
||||
}
|
||||
|
||||
if a, ok := rw.msg.Answer[0].(*dns.A); ok {
|
||||
// It should be resolved to 127.0.0.1 (or whatever localhost resolves to)
|
||||
if a.A.String() == "" {
|
||||
t.Error("Expected a non-empty IP address")
|
||||
}
|
||||
log.Printf("Resolved localhost to %s", a.A.String())
|
||||
} else if cname, ok := rw.msg.Answer[0].(*dns.CNAME); ok {
|
||||
// Fallback to CNAME is also acceptable if resolution failed but it shouldn't for localhost
|
||||
if cname.Target != "localhost." {
|
||||
t.Errorf("Expected CNAME to localhost., got %s", cname.Target)
|
||||
}
|
||||
} else {
|
||||
t.Errorf("Expected A or CNAME record, got %T", rw.msg.Answer[0])
|
||||
}
|
||||
}
|
||||
|
||||
func TestDNSDiscovery_UnresolvableHostname(t *testing.T) {
|
||||
// Use a likely unresolvable hostname
|
||||
serviceIP := "this.hostname.does.not.exist.at.all.invalid"
|
||||
upstreamDNS := []string{"8.8.8.8"}
|
||||
d := NewDNSDiscovery(upstreamDNS, serviceIP)
|
||||
|
||||
m := new(dns.Msg)
|
||||
m.SetQuestion("api.bose.com.", dns.TypeA)
|
||||
|
||||
rw := &mockResponseWriter{}
|
||||
d.ServeDNS(rw, m)
|
||||
|
||||
if rw.msg == nil {
|
||||
t.Fatal("Expected a response message, got nil")
|
||||
}
|
||||
|
||||
if len(rw.msg.Answer) == 0 {
|
||||
t.Fatal("Expected an answer in the response (CNAME fallback)")
|
||||
}
|
||||
|
||||
if cname, ok := rw.msg.Answer[0].(*dns.CNAME); ok {
|
||||
expected := serviceIP + "."
|
||||
if cname.Target != expected {
|
||||
t.Errorf("Expected CNAME to %s, got %s", expected, cname.Target)
|
||||
}
|
||||
} else {
|
||||
t.Errorf("Expected CNAME record for unresolvable hostname, got %T", rw.msg.Answer[0])
|
||||
}
|
||||
}
|
||||
|
||||
@@ -21,9 +21,9 @@ func TestNewMDNSDiscoveryService(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestMDNSDiscoverDevices(t *testing.T) {
|
||||
service := NewMDNSDiscoveryService(2 * time.Second)
|
||||
service := NewMDNSDiscoveryService(100 * time.Millisecond)
|
||||
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 200*time.Millisecond)
|
||||
defer cancel()
|
||||
|
||||
// Note: This test will attempt actual mDNS discovery
|
||||
|
||||
@@ -78,11 +78,11 @@ func TestUnifiedDiscoveryWithCustomConfig(t *testing.T) {
|
||||
|
||||
func TestUnifiedDiscoverDevices(t *testing.T) {
|
||||
cfg := config.DefaultConfig()
|
||||
cfg.DiscoveryTimeout = 2 * time.Second
|
||||
cfg.DiscoveryTimeout = 100 * time.Millisecond
|
||||
cfg.CacheEnabled = false // Disable cache for testing
|
||||
service := NewUnifiedDiscoveryService(cfg)
|
||||
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 200*time.Millisecond)
|
||||
defer cancel()
|
||||
|
||||
devices, err := service.DiscoverDevices(ctx)
|
||||
@@ -119,13 +119,13 @@ func TestUnifiedDiscoverDevices(t *testing.T) {
|
||||
|
||||
func TestUnifiedDiscoveryOnlyMDNS(t *testing.T) {
|
||||
cfg := config.DefaultConfig()
|
||||
cfg.DiscoveryTimeout = 1 * time.Second
|
||||
cfg.DiscoveryTimeout = 100 * time.Millisecond
|
||||
cfg.UPnPEnabled = false // Disable UPnP
|
||||
cfg.MDNSEnabled = true // Enable only mDNS
|
||||
cfg.CacheEnabled = false
|
||||
service := NewUnifiedDiscoveryService(cfg)
|
||||
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 200*time.Millisecond)
|
||||
defer cancel()
|
||||
|
||||
devices, err := service.DiscoverDevices(ctx)
|
||||
@@ -141,13 +141,13 @@ func TestUnifiedDiscoveryOnlyMDNS(t *testing.T) {
|
||||
|
||||
func TestUnifiedDiscoveryOnlySSDP(t *testing.T) {
|
||||
cfg := config.DefaultConfig()
|
||||
cfg.DiscoveryTimeout = 1 * time.Second
|
||||
cfg.DiscoveryTimeout = 100 * time.Millisecond
|
||||
cfg.UPnPEnabled = true // Enable only UPnP
|
||||
cfg.MDNSEnabled = false // Disable mDNS
|
||||
cfg.CacheEnabled = false
|
||||
service := NewUnifiedDiscoveryService(cfg)
|
||||
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 200*time.Millisecond)
|
||||
defer cancel()
|
||||
|
||||
devices, err := service.DiscoverDevices(ctx)
|
||||
|
||||
+72
-26
@@ -2,8 +2,10 @@ package discovery
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/xml"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"log"
|
||||
"net"
|
||||
"net/http"
|
||||
@@ -18,11 +20,12 @@ import (
|
||||
|
||||
// Service handles UPnP SSDP discovery of SoundTouch devices
|
||||
type Service struct {
|
||||
timeout time.Duration
|
||||
cache map[string]*models.DiscoveredDevice
|
||||
cacheTTL time.Duration
|
||||
mutex sync.RWMutex
|
||||
config *config.Config
|
||||
timeout time.Duration
|
||||
cache map[string]*models.DiscoveredDevice
|
||||
cacheTTL time.Duration
|
||||
mutex sync.RWMutex
|
||||
config *config.Config
|
||||
httpClient *http.Client
|
||||
}
|
||||
|
||||
// NewService creates a new UPnP discovery service
|
||||
@@ -32,11 +35,12 @@ func NewService(timeout time.Duration) *Service {
|
||||
}
|
||||
|
||||
return &Service{
|
||||
timeout: timeout,
|
||||
cache: make(map[string]*models.DiscoveredDevice),
|
||||
cacheTTL: defaultCacheTTL,
|
||||
mutex: sync.RWMutex{},
|
||||
config: config.DefaultConfig(),
|
||||
timeout: timeout,
|
||||
cache: make(map[string]*models.DiscoveredDevice),
|
||||
cacheTTL: defaultCacheTTL,
|
||||
mutex: sync.RWMutex{},
|
||||
config: config.DefaultConfig(),
|
||||
httpClient: &http.Client{Timeout: 5 * time.Second},
|
||||
}
|
||||
}
|
||||
|
||||
@@ -53,11 +57,12 @@ func NewServiceWithConfig(cfg *config.Config) *Service {
|
||||
}
|
||||
|
||||
return &Service{
|
||||
timeout: timeout,
|
||||
cache: make(map[string]*models.DiscoveredDevice),
|
||||
cacheTTL: cacheTTL,
|
||||
mutex: sync.RWMutex{},
|
||||
config: cfg,
|
||||
timeout: timeout,
|
||||
cache: make(map[string]*models.DiscoveredDevice),
|
||||
cacheTTL: cacheTTL,
|
||||
mutex: sync.RWMutex{},
|
||||
config: cfg,
|
||||
httpClient: &http.Client{Timeout: 5 * time.Second},
|
||||
}
|
||||
}
|
||||
|
||||
@@ -284,6 +289,15 @@ func (d *Service) listenForResponses(ctx context.Context, listener *net.UDPConn,
|
||||
|
||||
// buildMSearchRequest builds the M-SEARCH request for SoundTouch devices
|
||||
func (d *Service) buildMSearchRequest() string {
|
||||
mx := int(d.timeout.Seconds())
|
||||
if mx < 1 {
|
||||
mx = 1
|
||||
}
|
||||
|
||||
if mx > 5 {
|
||||
mx = 5
|
||||
}
|
||||
|
||||
return fmt.Sprintf(
|
||||
"M-SEARCH * HTTP/1.1\r\n"+
|
||||
"HOST: %s\r\n"+
|
||||
@@ -293,7 +307,7 @@ func (d *Service) buildMSearchRequest() string {
|
||||
"\r\n",
|
||||
ssdpAddr,
|
||||
soundTouchURN,
|
||||
int(d.timeout.Seconds()),
|
||||
mx,
|
||||
)
|
||||
}
|
||||
|
||||
@@ -374,7 +388,7 @@ func (d *Service) parseResponse(response string) (*models.DiscoveredDevice, erro
|
||||
log.Printf("UPnP: Successfully parsed device from location: %s at %s:%d", device.Name, device.Host, device.Port)
|
||||
|
||||
// Try to get more device info from the location URL
|
||||
if err := d.enrichDeviceInfo(device, location); err != nil {
|
||||
if err := d.EnrichDeviceInfo(device, location); err != nil {
|
||||
log.Printf("UPnP: Could not enrich device info from location '%s': %v", location, err)
|
||||
// Don't fail if we can't get additional info
|
||||
// The basic info from URL parsing should be sufficient
|
||||
@@ -417,15 +431,11 @@ func (d *Service) parseLocationURL(location, usn string) (*models.DiscoveredDevi
|
||||
return device, nil
|
||||
}
|
||||
|
||||
// enrichDeviceInfo tries to get additional device information from the device description
|
||||
func (d *Service) enrichDeviceInfo(_ *models.DiscoveredDevice, location string) error {
|
||||
// EnrichDeviceInfo tries to get additional device information from the device description
|
||||
func (d *Service) EnrichDeviceInfo(device *models.DiscoveredDevice, location string) error {
|
||||
log.Printf("UPnP: Attempting to enrich device info by fetching %s", location)
|
||||
|
||||
client := &http.Client{
|
||||
Timeout: 5 * time.Second,
|
||||
}
|
||||
|
||||
resp, err := client.Get(location)
|
||||
resp, err := d.httpClient.Get(location)
|
||||
if err != nil {
|
||||
log.Printf("UPnP: Failed to fetch device description from %s: %v", location, err)
|
||||
return err
|
||||
@@ -437,8 +447,44 @@ func (d *Service) enrichDeviceInfo(_ *models.DiscoveredDevice, location string)
|
||||
|
||||
log.Printf("UPnP: Successfully fetched device description from %s (Status: %s)", location, resp.Status)
|
||||
|
||||
// For now, we'll keep it simple and not parse the full UPnP device description
|
||||
// This can be enhanced later to extract more detailed device information
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return fmt.Errorf("unexpected status code: %d", resp.StatusCode)
|
||||
}
|
||||
|
||||
data, err := io.ReadAll(resp.Body)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to read body: %w", err)
|
||||
}
|
||||
|
||||
var upnpRoot struct {
|
||||
XMLName xml.Name `xml:"root"`
|
||||
Device struct {
|
||||
FriendlyName string `xml:"friendlyName"`
|
||||
ModelName string `xml:"modelName"`
|
||||
SerialNumber string `xml:"serialNumber"`
|
||||
} `xml:"device"`
|
||||
}
|
||||
|
||||
if err := xml.Unmarshal(data, &upnpRoot); err != nil {
|
||||
log.Printf("UPnP: Failed to parse device description from %s: %v", location, err)
|
||||
return err
|
||||
}
|
||||
|
||||
if upnpRoot.Device.FriendlyName != "" {
|
||||
device.Name = upnpRoot.Device.FriendlyName
|
||||
}
|
||||
|
||||
if upnpRoot.Device.ModelName != "" {
|
||||
device.ModelID = upnpRoot.Device.ModelName
|
||||
}
|
||||
|
||||
if upnpRoot.Device.SerialNumber != "" {
|
||||
device.UPnPSerial = upnpRoot.Device.SerialNumber
|
||||
}
|
||||
|
||||
log.Printf("UPnP: Enriched device info: Name='%s', Model='%s', UPnPSerial='%s'",
|
||||
device.Name, device.ModelID, device.UPnPSerial)
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,90 @@
|
||||
package discovery
|
||||
|
||||
import (
|
||||
"encoding/xml"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/models"
|
||||
)
|
||||
|
||||
func TestEnrichDeviceInfo(t *testing.T) {
|
||||
// Mock UPnP device description XML
|
||||
xmlData := `<?xml version="1.0" encoding="utf-8"?>
|
||||
<root xmlns="urn:schemas-upnp-org:device-1-0">
|
||||
<device>
|
||||
<friendlyName>Sound Machinery</friendlyName>
|
||||
<modelName>SoundTouch 10</modelName>
|
||||
<serialNumber>A81B6A536A09</serialNumber>
|
||||
</device>
|
||||
</root>`
|
||||
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/xml")
|
||||
fmt.Fprint(w, xmlData)
|
||||
}))
|
||||
defer server.Close()
|
||||
|
||||
device := &models.DiscoveredDevice{
|
||||
Host: "127.0.0.1",
|
||||
Name: "Initial Name",
|
||||
}
|
||||
|
||||
service := NewService(1 * time.Second)
|
||||
service.httpClient = server.Client()
|
||||
err := service.EnrichDeviceInfo(device, server.URL)
|
||||
|
||||
if err != nil {
|
||||
t.Fatalf("enrichDeviceInfo failed: %v", err)
|
||||
}
|
||||
|
||||
if device.Name != "Sound Machinery" {
|
||||
t.Errorf("expected Name 'Sound Machinery', got '%s'", device.Name)
|
||||
}
|
||||
|
||||
if device.ModelID != "SoundTouch 10" {
|
||||
t.Errorf("expected ModelID 'SoundTouch 10', got '%s'", device.ModelID)
|
||||
}
|
||||
|
||||
if device.UPnPSerial != "A81B6A536A09" {
|
||||
t.Errorf("expected UPnPSerial 'A81B6A536A09', got '%s'", device.UPnPSerial)
|
||||
}
|
||||
}
|
||||
|
||||
func TestUPnP_Unmarshal(t *testing.T) {
|
||||
data := `<?xml version="1.0" encoding="utf-8"?>
|
||||
<root xmlns="urn:schemas-upnp-org:device-1-0">
|
||||
<device>
|
||||
<friendlyName>Sound Machinery</friendlyName>
|
||||
<modelName>SoundTouch 10</modelName>
|
||||
<serialNumber>A81B6A536A09</serialNumber>
|
||||
</device>
|
||||
</root>`
|
||||
|
||||
var upnpRoot struct {
|
||||
XMLName xml.Name `xml:"root"`
|
||||
Device struct {
|
||||
FriendlyName string `xml:"friendlyName"`
|
||||
ModelName string `xml:"modelName"`
|
||||
SerialNumber string `xml:"serialNumber"`
|
||||
} `xml:"device"`
|
||||
}
|
||||
|
||||
err := xml.Unmarshal([]byte(data), &upnpRoot)
|
||||
if err != nil {
|
||||
t.Fatalf("Unmarshal failed: %v", err)
|
||||
}
|
||||
|
||||
if upnpRoot.Device.FriendlyName != "Sound Machinery" {
|
||||
t.Errorf("expected FriendlyName 'Sound Machinery', got '%s'", upnpRoot.Device.FriendlyName)
|
||||
}
|
||||
if upnpRoot.Device.ModelName != "SoundTouch 10" {
|
||||
t.Errorf("expected ModelName 'SoundTouch 10', got '%s'", upnpRoot.Device.ModelName)
|
||||
}
|
||||
if upnpRoot.Device.SerialNumber != "A81B6A536A09" {
|
||||
t.Errorf("expected SerialNumber 'A81B6A536A09', got '%s'", upnpRoot.Device.SerialNumber)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,319 @@
|
||||
package discovery
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/models"
|
||||
)
|
||||
|
||||
func TestUPnP_EnrichDeviceInfo_RealDeviceXML(t *testing.T) {
|
||||
// This tests the exact UPnP XML format provided by the user
|
||||
realDeviceXML := `<?xml version="1.0" encoding="utf-8"?>
|
||||
<root xmlns="urn:schemas-upnp-org:device-1-0">
|
||||
<specVersion>
|
||||
<major>1</major>
|
||||
<minor>0</minor>
|
||||
</specVersion>
|
||||
<device>
|
||||
<deviceType>urn:schemas-upnp-org:device:MediaRenderer:1</deviceType>
|
||||
<friendlyName>Sound Machinechen</friendlyName>
|
||||
<qq:X_QPlay_SoftwareCapability xmlns:qq="http://www.tencent.com">QPlay:2</qq:X_QPlay_SoftwareCapability>
|
||||
<manufacturer>Bose Corporation</manufacturer>
|
||||
<manufacturerURL>http://www.bose.com</manufacturerURL>
|
||||
<modelName>SoundTouch 10</modelName>
|
||||
<modelNumber></modelNumber>
|
||||
<modelDescription>Bose SoundTouch Wireless Streaming Audio Device</modelDescription>
|
||||
<modelURL>http://www.bose.com</modelURL>
|
||||
<serialNumber>A81B6A536A98</serialNumber>
|
||||
<UDN>uuid:BO5EBO5E-F00D-F00D-FEED-A81B6A536A98</UDN>
|
||||
<serviceList>
|
||||
<service>
|
||||
<serviceType>urn:schemas-upnp-org:service:AVTransport:1</serviceType>
|
||||
<serviceId>urn:upnp-org:serviceId:AVTransport</serviceId>
|
||||
<SCPDURL>/Xml/AVTransport3.xml</SCPDURL>
|
||||
<controlURL>/AVTransport/Control</controlURL>
|
||||
<eventSubURL>/AVTransport/Event</eventSubURL>
|
||||
</service>
|
||||
<service>
|
||||
<serviceType>urn:schemas-upnp-org:service:ConnectionManager:1</serviceType>
|
||||
<serviceId>urn:upnp-org:serviceId:ConnectionManager</serviceId>
|
||||
<SCPDURL>/Xml/ConnectionManager3.xml</SCPDURL>
|
||||
<controlURL>/ConnectionManager/Control</controlURL>
|
||||
<eventSubURL>/ConnectionManager/Event</eventSubURL>
|
||||
</service>
|
||||
<service>
|
||||
<serviceType>urn:schemas-upnp-org:service:RenderingControl:1</serviceType>
|
||||
<serviceId>urn:upnp-org:serviceId:RenderingControl</serviceId>
|
||||
<SCPDURL>/Xml/RenderingControl3.xml</SCPDURL>
|
||||
<controlURL>/RenderingControl/Control</controlURL>
|
||||
<eventSubURL>/RenderingControl/Event</eventSubURL>
|
||||
</service>
|
||||
<service>
|
||||
<serviceType>urn:schemas-tencent-com:service:QPlay:2</serviceType>
|
||||
<serviceId>urn:tencent-com:serviceId:QPlay</serviceId>
|
||||
<controlURL>/QPlay/Control</controlURL>
|
||||
<eventSubURL>/QPlay/Event</eventSubURL>
|
||||
<SCPDURL>/Xml/QPlay.xml</SCPDURL>
|
||||
</service>
|
||||
</serviceList>
|
||||
</device>
|
||||
</root>`
|
||||
|
||||
// Create a test server that serves the UPnP XML
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/xml; charset=utf-8")
|
||||
fmt.Fprint(w, realDeviceXML)
|
||||
}))
|
||||
defer server.Close()
|
||||
|
||||
// Create a discovered device to enrich
|
||||
device := &models.DiscoveredDevice{
|
||||
Host: "192.168.1.100",
|
||||
Port: 8091,
|
||||
Name: "Initial Device Name",
|
||||
}
|
||||
|
||||
// Create discovery service and enrich the device
|
||||
service := NewService(5 * time.Second)
|
||||
err := service.EnrichDeviceInfo(device, server.URL)
|
||||
|
||||
if err != nil {
|
||||
t.Fatalf("enrichDeviceInfo failed: %v", err)
|
||||
}
|
||||
|
||||
// Verify that the MAC address was extracted correctly from serialNumber
|
||||
expectedMAC := "A81B6A536A98"
|
||||
if device.UPnPSerial != expectedMAC {
|
||||
t.Errorf("Expected UPnPSerial '%s', got '%s'", expectedMAC, device.UPnPSerial)
|
||||
}
|
||||
|
||||
// Verify other enriched fields
|
||||
expectedName := "Sound Machinechen"
|
||||
if device.Name != expectedName {
|
||||
t.Errorf("Expected Name '%s', got '%s'", expectedName, device.Name)
|
||||
}
|
||||
|
||||
expectedModel := "SoundTouch 10"
|
||||
if device.ModelID != expectedModel {
|
||||
t.Errorf("Expected ModelID '%s', got '%s'", expectedModel, device.ModelID)
|
||||
}
|
||||
|
||||
t.Logf("✓ Successfully extracted MAC address '%s' from UPnP serialNumber field", device.UPnPSerial)
|
||||
t.Logf("✓ Device name: '%s'", device.Name)
|
||||
t.Logf("✓ Device model: '%s'", device.ModelID)
|
||||
}
|
||||
|
||||
func TestUPnP_MACAddressDiscovery_Integration(t *testing.T) {
|
||||
// Test various MAC address formats that might appear in serialNumber
|
||||
testCases := []struct {
|
||||
name string
|
||||
serialNumberInXML string
|
||||
expectedUPnPSerial string
|
||||
description string
|
||||
}{
|
||||
{
|
||||
name: "StandardMAC",
|
||||
serialNumberInXML: "A81B6A536A98",
|
||||
expectedUPnPSerial: "A81B6A536A98",
|
||||
description: "Standard MAC address format without separators",
|
||||
},
|
||||
{
|
||||
name: "MACWithColons",
|
||||
serialNumberInXML: "A8:1B:6A:53:6A:98",
|
||||
expectedUPnPSerial: "A8:1B:6A:53:6A:98",
|
||||
description: "MAC address with colon separators",
|
||||
},
|
||||
{
|
||||
name: "MACWithDashes",
|
||||
serialNumberInXML: "A8-1B-6A-53-6A-98",
|
||||
expectedUPnPSerial: "A8-1B-6A-53-6A-98",
|
||||
description: "MAC address with dash separators",
|
||||
},
|
||||
{
|
||||
name: "LowercaseMAC",
|
||||
serialNumberInXML: "a81b6a536a98",
|
||||
expectedUPnPSerial: "a81b6a536a98",
|
||||
description: "Lowercase MAC address",
|
||||
},
|
||||
{
|
||||
name: "MixedCaseMAC",
|
||||
serialNumberInXML: "a81B6a536A98",
|
||||
expectedUPnPSerial: "a81B6a536A98",
|
||||
description: "Mixed case MAC address",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range testCases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
// Create UPnP XML with the specific serialNumber format
|
||||
xmlTemplate := `<?xml version="1.0" encoding="utf-8"?>
|
||||
<root xmlns="urn:schemas-upnp-org:device-1-0">
|
||||
<device>
|
||||
<deviceType>urn:schemas-upnp-org:device:MediaRenderer:1</deviceType>
|
||||
<friendlyName>Test Device</friendlyName>
|
||||
<manufacturer>Bose Corporation</manufacturer>
|
||||
<modelName>SoundTouch 10</modelName>
|
||||
<serialNumber>%s</serialNumber>
|
||||
<UDN>uuid:BO5EBO5E-F00D-F00D-FEED-TEST</UDN>
|
||||
</device>
|
||||
</root>`
|
||||
|
||||
deviceXML := fmt.Sprintf(xmlTemplate, tc.serialNumberInXML)
|
||||
|
||||
// Create test server
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/xml")
|
||||
fmt.Fprint(w, deviceXML)
|
||||
}))
|
||||
defer server.Close()
|
||||
|
||||
// Create and enrich device
|
||||
device := &models.DiscoveredDevice{
|
||||
Host: "192.168.1.100",
|
||||
Port: 8090,
|
||||
}
|
||||
|
||||
service := NewService(5 * time.Second)
|
||||
err := service.EnrichDeviceInfo(device, server.URL)
|
||||
|
||||
if err != nil {
|
||||
t.Errorf("%s: enrichDeviceInfo failed: %v", tc.description, err)
|
||||
return
|
||||
}
|
||||
|
||||
if device.UPnPSerial != tc.expectedUPnPSerial {
|
||||
t.Errorf("%s: Expected UPnPSerial '%s', got '%s'",
|
||||
tc.description, tc.expectedUPnPSerial, device.UPnPSerial)
|
||||
} else {
|
||||
t.Logf("✓ %s: Successfully extracted '%s'", tc.description, device.UPnPSerial)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestUPnP_URLPattern_Realistic(t *testing.T) {
|
||||
// Test the exact URL pattern mentioned:
|
||||
// http://192.168.1.100:8091/XD/BO5EBO5E-F00D-F00D-FEED-A81B6A536A98.xml
|
||||
|
||||
realDeviceXML := `<?xml version="1.0" encoding="utf-8"?>
|
||||
<root xmlns="urn:schemas-upnp-org:device-1-0">
|
||||
<device>
|
||||
<deviceType>urn:schemas-upnp-org:device:MediaRenderer:1</deviceType>
|
||||
<friendlyName>Sound Machinechen</friendlyName>
|
||||
<manufacturer>Bose Corporation</manufacturer>
|
||||
<modelName>SoundTouch 10</modelName>
|
||||
<serialNumber>A81B6A536A98</serialNumber>
|
||||
<UDN>uuid:BO5EBO5E-F00D-F00D-FEED-A81B6A536A98</UDN>
|
||||
</device>
|
||||
</root>`
|
||||
|
||||
// Create server that responds to the specific path
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.URL.Path == "/XD/BO5EBO5E-F00D-F00D-FEED-A81B6A536A98.xml" {
|
||||
w.Header().Set("Content-Type", "text/xml")
|
||||
fmt.Fprint(w, realDeviceXML)
|
||||
} else {
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
}
|
||||
}))
|
||||
defer server.Close()
|
||||
|
||||
// Test enrichment using the realistic URL path
|
||||
device := &models.DiscoveredDevice{
|
||||
Host: "192.168.1.100",
|
||||
Port: 8091,
|
||||
Name: "Initial Name",
|
||||
}
|
||||
|
||||
service := NewService(5 * time.Second)
|
||||
locationURL := server.URL + "/XD/BO5EBO5E-F00D-F00D-FEED-A81B6A536A98.xml"
|
||||
err := service.EnrichDeviceInfo(device, locationURL)
|
||||
|
||||
if err != nil {
|
||||
t.Fatalf("enrichDeviceInfo failed for realistic URL: %v", err)
|
||||
}
|
||||
|
||||
// Verify MAC address extraction
|
||||
expectedMAC := "A81B6A536A98"
|
||||
if device.UPnPSerial != expectedMAC {
|
||||
t.Errorf("Expected MAC '%s', got '%s'", expectedMAC, device.UPnPSerial)
|
||||
}
|
||||
|
||||
// Note: The MAC address in the URL and in the XML serialNumber should match
|
||||
if device.UPnPSerial == expectedMAC {
|
||||
t.Logf("✓ MAC address '%s' extracted from UPnP XML matches expected value", device.UPnPSerial)
|
||||
t.Logf("✓ This MAC can now be used for datastore mapping")
|
||||
t.Logf("✓ Request URL pattern: GET /streaming/account/{account}/device/%s/presets", device.UPnPSerial)
|
||||
}
|
||||
}
|
||||
|
||||
func TestUPnP_ErrorHandling(t *testing.T) {
|
||||
service := NewService(5 * time.Second)
|
||||
device := &models.DiscoveredDevice{
|
||||
Host: "192.168.1.100",
|
||||
Name: "Test Device",
|
||||
}
|
||||
|
||||
t.Run("InvalidXML", func(t *testing.T) {
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/xml")
|
||||
fmt.Fprint(w, "invalid xml content")
|
||||
}))
|
||||
defer server.Close()
|
||||
|
||||
err := service.EnrichDeviceInfo(device, server.URL)
|
||||
if err == nil {
|
||||
t.Error("Expected error for invalid XML, got nil")
|
||||
} else {
|
||||
t.Logf("✓ Correctly handled invalid XML: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("HTTPError", func(t *testing.T) {
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
w.WriteHeader(http.StatusInternalServerError)
|
||||
}))
|
||||
defer server.Close()
|
||||
|
||||
err := service.EnrichDeviceInfo(device, server.URL)
|
||||
if err == nil {
|
||||
t.Error("Expected error for HTTP 500, got nil")
|
||||
} else {
|
||||
t.Logf("✓ Correctly handled HTTP error: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("MissingSerialNumber", func(t *testing.T) {
|
||||
xmlWithoutSerial := `<?xml version="1.0" encoding="utf-8"?>
|
||||
<root xmlns="urn:schemas-upnp-org:device-1-0">
|
||||
<device>
|
||||
<friendlyName>Test Device</friendlyName>
|
||||
<modelName>Test Model</modelName>
|
||||
</device>
|
||||
</root>`
|
||||
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/xml")
|
||||
fmt.Fprint(w, xmlWithoutSerial)
|
||||
}))
|
||||
defer server.Close()
|
||||
|
||||
deviceCopy := *device // Make a copy to avoid modifying the original
|
||||
err := service.EnrichDeviceInfo(&deviceCopy, server.URL)
|
||||
|
||||
// Should not error, but UPnPSerial should be empty
|
||||
if err != nil {
|
||||
t.Errorf("Unexpected error for missing serialNumber: %v", err)
|
||||
}
|
||||
|
||||
if deviceCopy.UPnPSerial != "" {
|
||||
t.Errorf("Expected empty UPnPSerial, got '%s'", deviceCopy.UPnPSerial)
|
||||
} else {
|
||||
t.Logf("✓ Correctly handled missing serialNumber (empty UPnPSerial)")
|
||||
}
|
||||
})
|
||||
}
|
||||
+63
-31
@@ -2,6 +2,9 @@ package discovery
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
@@ -36,27 +39,48 @@ func TestNewDiscoveryServiceWithDefaultTimeout(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestBuildMSearchRequest(t *testing.T) {
|
||||
service := NewService(5 * time.Second)
|
||||
request := service.buildMSearchRequest()
|
||||
t.Run("DefaultTimeout", func(t *testing.T) {
|
||||
service := NewService(5 * time.Second)
|
||||
request := service.buildMSearchRequest()
|
||||
|
||||
expectedLines := []string{
|
||||
"M-SEARCH * HTTP/1.1",
|
||||
"HOST: 239.255.255.250:1900",
|
||||
"MAN: \"ssdp:discover\"",
|
||||
"ST: urn:schemas-upnp-org:device:MediaRenderer:1",
|
||||
"MX: 5",
|
||||
}
|
||||
|
||||
for _, expectedLine := range expectedLines {
|
||||
if !contains(request, expectedLine) {
|
||||
t.Errorf("Expected M-SEARCH request to contain '%s'", expectedLine)
|
||||
expectedLines := []string{
|
||||
"M-SEARCH * HTTP/1.1",
|
||||
"HOST: 239.255.255.250:1900",
|
||||
"MAN: \"ssdp:discover\"",
|
||||
"ST: urn:schemas-upnp-org:device:MediaRenderer:1",
|
||||
"MX: 5",
|
||||
}
|
||||
}
|
||||
|
||||
// Check that request ends with double CRLF
|
||||
if !contains(request, "\r\n\r\n") {
|
||||
t.Error("Expected M-SEARCH request to end with double CRLF")
|
||||
}
|
||||
for _, expectedLine := range expectedLines {
|
||||
if !contains(request, expectedLine) {
|
||||
t.Errorf("Expected M-SEARCH request to contain '%s'", expectedLine)
|
||||
}
|
||||
}
|
||||
|
||||
if !contains(request, "\r\n\r\n") {
|
||||
t.Error("Expected M-SEARCH request to end with double CRLF")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("LowTimeout", func(t *testing.T) {
|
||||
// If timeout is less than 1 second, it should still use MX: 1
|
||||
service := NewService(500 * time.Millisecond)
|
||||
request := service.buildMSearchRequest()
|
||||
|
||||
if !contains(request, "MX: 1") {
|
||||
t.Errorf("Expected low timeout (500ms) to result in MX: 1, but got something else. Request:\n%s", request)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("VeryHighTimeout", func(t *testing.T) {
|
||||
// MX should probably be capped at 5 for UPnP compatibility
|
||||
service := NewService(10 * time.Second)
|
||||
request := service.buildMSearchRequest()
|
||||
|
||||
if !contains(request, "MX: 5") {
|
||||
t.Errorf("Expected high timeout (10s) to result in MX: 5, but got something else. Request:\n%s", request)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestParseLocationURL_Valid(t *testing.T) {
|
||||
@@ -109,18 +133,30 @@ func TestParseLocationURL_Invalid(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestParseResponse_ValidMediaRenderer(t *testing.T) {
|
||||
service := NewService(1 * time.Second)
|
||||
xmlPayload := `<?xml version="1.0" encoding="utf-8"?>
|
||||
<root xmlns="urn:schemas-upnp-org:device-1-0">
|
||||
<device>
|
||||
<friendlyName>Test Device</friendlyName>
|
||||
<modelName>SoundTouch 10</modelName>
|
||||
<serialNumber>AABBCCDDEEFF</serialNumber>
|
||||
</device>
|
||||
</root>`
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/xml")
|
||||
fmt.Fprint(w, xmlPayload)
|
||||
}))
|
||||
defer server.Close()
|
||||
|
||||
validResponse := `HTTP/1.1 200 OK
|
||||
service := NewService(1 * time.Second)
|
||||
service.httpClient = server.Client()
|
||||
|
||||
validResponse := fmt.Sprintf(`HTTP/1.1 200 OK
|
||||
Cache-Control: max-age=1800
|
||||
Date: Mon, 22 Jun 1998 09:55:21 GMT
|
||||
EXT:
|
||||
Location: http://192.168.1.100:8090/device.xml
|
||||
Server: Linux/3.14.0 UPnP/1.0 Bose-SoundTouch/1.0
|
||||
Location: %s
|
||||
ST: urn:schemas-upnp-org:device:MediaRenderer:1
|
||||
USN: uuid:12345678-1234-5678-9012-123456789012::urn:schemas-upnp-org:device:MediaRenderer:1
|
||||
|
||||
`
|
||||
`, server.URL)
|
||||
|
||||
device, err := service.parseResponse(validResponse)
|
||||
if err != nil {
|
||||
@@ -131,12 +167,8 @@ USN: uuid:12345678-1234-5678-9012-123456789012::urn:schemas-upnp-org:device:Medi
|
||||
t.Fatal("Expected device, got nil")
|
||||
}
|
||||
|
||||
if device.Host != "192.168.1.100" {
|
||||
t.Errorf("Expected host '192.168.1.100', got '%s'", device.Host)
|
||||
}
|
||||
|
||||
if device.UPnPLocation != "http://192.168.1.100:8090/device.xml" {
|
||||
t.Errorf("Expected UPnP location 'http://192.168.1.100:8090/device.xml', got '%s'", device.UPnPLocation)
|
||||
if device.Name != "Test Device" {
|
||||
t.Errorf("Expected name 'Test Device', got '%s'", device.Name)
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -70,6 +70,7 @@ type DiscoveredDevice struct {
|
||||
// Protocol-specific details
|
||||
UPnPLocation string `json:"upnp_location,omitempty"` // UPnP device description XML URL
|
||||
UPnPUSN string `json:"upnp_usn,omitempty"` // UPnP Unique Service Name
|
||||
UPnPSerial string `json:"upnp_serial,omitempty"` // Serial number from UPnP (MAC address)
|
||||
MDNSHostname string `json:"mdns_hostname,omitempty"` // mDNS hostname (e.g., "device.local.")
|
||||
MDNSService string `json:"mdns_service,omitempty"` // mDNS service name
|
||||
ConfigName string `json:"config_name,omitempty"` // Original name from config
|
||||
@@ -94,6 +95,7 @@ func (d *DiscoveredDevice) GetProtocolSpecificData() map[string]interface{} {
|
||||
data["upnp"] = map[string]string{
|
||||
"location": d.UPnPLocation,
|
||||
"usn": d.UPnPUSN,
|
||||
"serial": d.UPnPSerial,
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
+165
-28
@@ -132,42 +132,61 @@ type SourceProvider struct {
|
||||
|
||||
// ServiceContentItem represents a media content item with source and location details.
|
||||
type ServiceContentItem struct {
|
||||
ID string `json:"id" xml:"id,attr"`
|
||||
Name string `json:"name" xml:"itemName"`
|
||||
Source string `json:"source,omitempty" xml:"source,attr,omitempty"`
|
||||
Type string `json:"type" xml:"type,attr"`
|
||||
Location string `json:"location" xml:"location,attr"`
|
||||
SourceAccount string `json:"source_account,omitempty" xml:"sourceAccount,attr,omitempty"`
|
||||
SourceID string `json:"source_id,omitempty" xml:"sourceid,omitempty"`
|
||||
IsPresetable string `json:"is_presetable,omitempty" xml:"isPresetable,attr,omitempty"`
|
||||
ID string `json:"id" xml:"id,attr"`
|
||||
Name string `json:"name" xml:"name"`
|
||||
Source string `json:"source,omitempty" xml:"source,attr,omitempty"`
|
||||
Type string `json:"type" xml:"type,attr"`
|
||||
ContentItemType string `json:"content_item_type" xml:"contentItemType"`
|
||||
Location string `json:"location" xml:"location"`
|
||||
SourceAccount string `json:"source_account,omitempty" xml:"sourceAccount,attr,omitempty"`
|
||||
SourceID string `json:"source_id,omitempty" xml:"sourceid,omitempty"`
|
||||
IsPresetable string `json:"is_presetable,omitempty" xml:"isPresetable,attr,omitempty"`
|
||||
}
|
||||
|
||||
// ServicePreset represents a user-defined preset for quick access to media content.
|
||||
type ServicePreset struct {
|
||||
ServiceContentItem
|
||||
ContainerArt string `json:"container_art" xml:"containerArt"`
|
||||
CreatedOn string `json:"created_on" xml:"createdOn"`
|
||||
UpdatedOn string `json:"updated_on" xml:"updatedOn"`
|
||||
ContainerArt string `json:"container_art" xml:"containerArt"`
|
||||
CreatedOn string `json:"created_on" xml:"createdOn"`
|
||||
UpdatedOn string `json:"updated_on" xml:"updatedOn"`
|
||||
ButtonNumber string `json:"button_number,omitempty" xml:"buttonNumber,attr,omitempty"`
|
||||
Username string `json:"-" xml:"username,omitempty"`
|
||||
SourceConfig *ConfiguredSource `json:"-" xml:"source,omitempty"`
|
||||
}
|
||||
|
||||
// ServiceRecent represents recently played media content.
|
||||
type ServiceRecent struct {
|
||||
XMLName xml.Name `json:"-" xml:"recent"`
|
||||
ServiceContentItem
|
||||
DeviceID string `json:"device_id" xml:"deviceid"`
|
||||
UtcTime string `json:"utc_time" xml:"utc_time"`
|
||||
ContainerArt string `json:"container_art,omitempty" xml:"containerArt,omitempty"`
|
||||
DeviceID string `json:"device_id" xml:"deviceid,attr"`
|
||||
UtcTime string `json:"utc_time" xml:"utcTime,attr"`
|
||||
CreatedOn string `json:"created_on,omitempty" xml:"createdOn"`
|
||||
UpdatedOn string `json:"updated_on,omitempty" xml:"updatedOn"`
|
||||
ContainerArt string `json:"container_art,omitempty" xml:"containerArt,omitempty"`
|
||||
SourceConfig *ConfiguredSource `json:"-" xml:"source,omitempty"`
|
||||
LastPlayedAt string `json:"last_played_at,omitempty" xml:"lastplayedat"`
|
||||
}
|
||||
|
||||
// ConfiguredSource represents a configured media source with authentication details.
|
||||
type ConfiguredSource struct {
|
||||
DisplayName string `json:"display_name" xml:"displayName,attr"`
|
||||
ID string `json:"id" xml:"id,attr"`
|
||||
Secret string `json:"secret" xml:"secret,attr"`
|
||||
SecretType string `json:"secret_type" xml:"secretType,attr"`
|
||||
XMLName xml.Name `json:"-" xml:"source"`
|
||||
DisplayName string `json:"display_name" xml:"name"`
|
||||
ID string `json:"id" xml:"id,attr"`
|
||||
Secret string `json:"secret" xml:"credential"`
|
||||
SecretType string `json:"secret_type" xml:"credential_type,attr"`
|
||||
SourceKey struct {
|
||||
Type string `xml:"type,attr"`
|
||||
Account string `xml:"account,attr"`
|
||||
} `json:"source_key" xml:"sourceKey"`
|
||||
} `json:"source_key" xml:"source_key"`
|
||||
Type string `xml:"type,attr"`
|
||||
|
||||
// Parity fields
|
||||
CreatedOn string `json:"created_on,omitempty" xml:"createdOn"`
|
||||
UpdatedOn string `json:"updated_on,omitempty" xml:"updatedOn"`
|
||||
SourceProviderID string `json:"sourceproviderid,omitempty" xml:"sourceproviderid"`
|
||||
Username string `json:"username,omitempty" xml:"username"`
|
||||
SourceName string `json:"source_name,omitempty" xml:"sourcename"`
|
||||
SourceSettings string `json:"-" xml:"sourceSettings"`
|
||||
|
||||
// Legacy fields for backward compatibility in code if needed,
|
||||
// though it's better to update the code to use SourceKey.
|
||||
@@ -175,17 +194,48 @@ type ConfiguredSource struct {
|
||||
SourceKeyAccount string `json:"source_key_account" xml:"-"`
|
||||
}
|
||||
|
||||
// MarshalXML implements the xml.Marshaler interface for custom XML encoding of ConfiguredSource.
|
||||
func (s ConfiguredSource) MarshalXML(e *xml.Encoder, start xml.StartElement) error {
|
||||
type Alias ConfiguredSource
|
||||
|
||||
a := struct {
|
||||
Alias
|
||||
Username string `xml:"username"`
|
||||
SourceName string `xml:"sourcename"`
|
||||
SourceSettings string `xml:"sourceSettings"`
|
||||
}{
|
||||
Alias: Alias(s),
|
||||
}
|
||||
a.Username = s.Username
|
||||
a.SourceName = s.SourceName
|
||||
// We want <sourceSettings/>
|
||||
a.SourceSettings = ""
|
||||
|
||||
return e.EncodeElement(a, start)
|
||||
}
|
||||
|
||||
// ServiceDeviceInfo represents information about a SoundTouch device.
|
||||
type ServiceDeviceInfo struct {
|
||||
DeviceID string `json:"device_id" xml:"deviceID,attr"`
|
||||
ProductCode string `json:"product_code" xml:"type"`
|
||||
DeviceSerialNumber string `json:"device_serial_number" xml:"serialnumber"`
|
||||
ProductSerialNumber string `json:"product_serial_number" xml:"product_serial_number"`
|
||||
FirmwareVersion string `json:"firmware_version" xml:"softwareVersion"`
|
||||
IPAddress string `json:"ip_address" xml:"ipAddress"`
|
||||
Name string `json:"name" xml:"name"`
|
||||
DiscoveryMethod string `json:"discovery_method,omitempty"`
|
||||
AccountID string `json:"account_id,omitempty"`
|
||||
DeviceID string `json:"device_id" xml:"deviceID,attr"`
|
||||
ProductCode string `json:"product_code" xml:"type"`
|
||||
DeviceSerialNumber string `json:"device_serial_number" xml:"serialnumber"`
|
||||
ProductSerialNumber string `json:"product_serial_number" xml:"product_serial_number"`
|
||||
FirmwareVersion string `json:"firmware_version" xml:"softwareVersion"`
|
||||
IPAddress string `json:"ip_address" xml:"ipAddress"`
|
||||
Name string `json:"name" xml:"name"`
|
||||
MacAddress string `json:"mac_address,omitempty" xml:"-"`
|
||||
DiscoveryMethod string `json:"discovery_method,omitempty"`
|
||||
AccountID string `json:"account_id,omitempty"`
|
||||
Components []ServiceComponent `json:"components,omitempty" xml:"-"`
|
||||
}
|
||||
|
||||
// ServiceComponent represents a hardware or software component of a device.
|
||||
type ServiceComponent struct {
|
||||
Type string `xml:"type,attr"`
|
||||
Category string `xml:"category,attr,omitempty"`
|
||||
SoftwareVersion string `xml:"firmware-version"`
|
||||
SerialNumber string `xml:"serialnumber"`
|
||||
Label string `xml:"componentlabel,omitempty"`
|
||||
}
|
||||
|
||||
// CustomerSupportDevice represents device information for customer support purposes.
|
||||
@@ -307,3 +357,90 @@ type EmailAddressResponse struct {
|
||||
XMLName xml.Name `xml:"emailAddress"`
|
||||
Email string `xml:",chardata"`
|
||||
}
|
||||
|
||||
// FullResponseSource represents a configured media source specifically for the /full response.
|
||||
// It follows the specific XML structure and field order of the upstream /full response.
|
||||
type FullResponseSource struct {
|
||||
ID string `xml:"id,attr"`
|
||||
Type string `xml:"type,attr"`
|
||||
CreatedOn string `xml:"createdOn"`
|
||||
Credential struct {
|
||||
Type string `xml:"type,attr"`
|
||||
Value string `xml:",chardata"`
|
||||
} `xml:"credential"`
|
||||
Name string `xml:"name"`
|
||||
SourceProviderID string `xml:"sourceproviderid"`
|
||||
SourceName string `xml:"sourcename"`
|
||||
SourceSettings string `xml:"sourceSettings"`
|
||||
UpdatedOn string `xml:"updatedOn"`
|
||||
Username string `xml:"username"`
|
||||
}
|
||||
|
||||
// FullResponsePreset represents a preset specifically for the /full response.
|
||||
type FullResponsePreset struct {
|
||||
ButtonNumber string `xml:"buttonNumber,attr"`
|
||||
ContainerArt string `xml:"containerArt"`
|
||||
ContentItemType string `xml:"contentItemType"`
|
||||
CreatedOn string `xml:"createdOn"`
|
||||
Location string `xml:"location"`
|
||||
Name string `xml:"name"`
|
||||
Source FullResponseSource `xml:"source"`
|
||||
UpdatedOn string `xml:"updatedOn"`
|
||||
Username string `xml:"username"`
|
||||
}
|
||||
|
||||
// FullResponseRecent represents a recent item specifically for the /full response.
|
||||
type FullResponseRecent struct {
|
||||
ID string `xml:"id,attr"`
|
||||
ContentItemType string `xml:"contentItemType"`
|
||||
CreatedOn string `xml:"createdOn"`
|
||||
LastPlayedAt string `xml:"lastplayedat"`
|
||||
Location string `xml:"location"`
|
||||
Name string `xml:"name"`
|
||||
Source FullResponseSource `xml:"source"`
|
||||
SourceID string `xml:"sourceid"`
|
||||
UpdatedOn string `xml:"updatedOn"`
|
||||
}
|
||||
|
||||
// AccountFullResponse represents the complete account XML structure.
|
||||
type AccountFullResponse struct {
|
||||
XMLName xml.Name `xml:"account"`
|
||||
ID string `xml:"id,attr"`
|
||||
AccountStatus string `xml:"accountStatus"`
|
||||
Devices []AccountDevice `xml:"devices>device"`
|
||||
Mode string `xml:"mode"`
|
||||
PreferredLanguage string `xml:"preferredLanguage"`
|
||||
ProviderSettings []ProviderSetting `xml:"providerSettings>providerSetting"`
|
||||
Sources []FullResponseSource `xml:"sources>source"`
|
||||
}
|
||||
|
||||
// AccountDevice represents a device in the account response.
|
||||
type AccountDevice struct {
|
||||
DeviceID string `xml:"deviceid,attr"`
|
||||
AttachedProduct *AttachedProduct `xml:"attachedProduct"`
|
||||
CreatedOn string `xml:"createdOn"`
|
||||
FirmwareVersion string `xml:"firmwareVersion"`
|
||||
IPAddress string `xml:"ipaddress"`
|
||||
Name string `xml:"name"`
|
||||
Presets []FullResponsePreset `xml:"presets>preset"`
|
||||
Recents []FullResponseRecent `xml:"recents>recent"`
|
||||
SerialNumber string `xml:"serialNumber"`
|
||||
UpdatedOn string `xml:"updatedOn"`
|
||||
}
|
||||
|
||||
// AttachedProduct represents product information for a device.
|
||||
type AttachedProduct struct {
|
||||
ProductCode string `xml:"product_code,attr"`
|
||||
Components []ServiceComponent `xml:"components>component"`
|
||||
ProductLabel string `xml:"productlabel"`
|
||||
SerialNumber string `xml:"serialnumber"`
|
||||
UpdatedOn string `xml:"updatedOn"`
|
||||
}
|
||||
|
||||
// ProviderSetting represents a single provider setting.
|
||||
type ProviderSetting struct {
|
||||
BoseID string `xml:"boseId"`
|
||||
KeyName string `xml:"keyName"`
|
||||
Value string `xml:"value"`
|
||||
ProviderID string `xml:"providerId"`
|
||||
}
|
||||
|
||||
@@ -3,6 +3,8 @@ package models
|
||||
import (
|
||||
"encoding/xml"
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/url"
|
||||
)
|
||||
|
||||
// Error constants for speaker validation
|
||||
@@ -57,9 +59,9 @@ func (p *PlayInfo) SetVolume(volume int) *PlayInfo {
|
||||
}
|
||||
|
||||
// NewTTSPlayInfo creates a PlayInfo for Google TTS playback
|
||||
func NewTTSPlayInfo(text, appKey string, volume ...int) *PlayInfo {
|
||||
func NewTTSPlayInfo(text, appKey, language string, volume ...int) *PlayInfo {
|
||||
// URL encode the text for Google TTS
|
||||
url := "http://translate.google.com/translate_tts?ie=UTF-8&tl=EN&client=tw-ob&q=" + text
|
||||
url := fmt.Sprintf("http://translate.google.com/translate_tts?ie=UTF-8&tl=%s&client=tw-ob&q=%s", language, url.QueryEscape(text))
|
||||
|
||||
playInfo := &PlayInfo{
|
||||
XMLName: xml.Name{Local: "play_info"},
|
||||
|
||||
@@ -35,9 +35,9 @@ func TestNewPlayInfo(t *testing.T) {
|
||||
|
||||
func TestNewTTSPlayInfo(t *testing.T) {
|
||||
// Test without volume
|
||||
playInfo := NewTTSPlayInfo("Hello World", "test-key")
|
||||
playInfo := NewTTSPlayInfo("Hello World", "test-key", "EN")
|
||||
|
||||
expectedURL := "http://translate.google.com/translate_tts?ie=UTF-8&tl=EN&client=tw-ob&q=Hello World"
|
||||
expectedURL := "http://translate.google.com/translate_tts?ie=UTF-8&tl=EN&client=tw-ob&q=Hello+World"
|
||||
if playInfo.URL != expectedURL {
|
||||
t.Errorf("Expected URL '%s', got '%s'", expectedURL, playInfo.URL)
|
||||
}
|
||||
@@ -63,7 +63,7 @@ func TestNewTTSPlayInfo(t *testing.T) {
|
||||
}
|
||||
|
||||
// Test with volume
|
||||
playInfoWithVolume := NewTTSPlayInfo("Hello World", "test-key", 50)
|
||||
playInfoWithVolume := NewTTSPlayInfo("Hello World", "test-key", "EN", 50)
|
||||
if playInfoWithVolume.Volume == nil || *playInfoWithVolume.Volume != 50 {
|
||||
t.Errorf("Expected Volume to be 50, got %v", playInfoWithVolume.Volume)
|
||||
}
|
||||
|
||||
+38
-2
@@ -304,8 +304,9 @@ type SpecialMessageType string
|
||||
|
||||
// Constants for special message types
|
||||
const (
|
||||
MessageTypeSdkInfo SpecialMessageType = "sdkInfo"
|
||||
MessageTypeUserActivity SpecialMessageType = "userActivity"
|
||||
MessageTypeSdkInfo SpecialMessageType = "sdkInfo"
|
||||
MessageTypeUserActivity SpecialMessageType = "userActivity"
|
||||
MessageTypeUserInactivity SpecialMessageType = "userInactivity"
|
||||
)
|
||||
|
||||
// SoundTouchSdkInfo represents the SDK info message sent on connection
|
||||
@@ -321,6 +322,12 @@ type UserActivityUpdate struct {
|
||||
DeviceID string `xml:"deviceID,attr"`
|
||||
}
|
||||
|
||||
// UserInactivityUpdate represents user inactivity notifications
|
||||
type UserInactivityUpdate struct {
|
||||
XMLName xml.Name `xml:"userInactivityUpdate"`
|
||||
DeviceID string `xml:"deviceID,attr"`
|
||||
}
|
||||
|
||||
// SpecialMessage represents non-updates WebSocket messages
|
||||
type SpecialMessage struct {
|
||||
Type SpecialMessageType
|
||||
@@ -604,6 +611,22 @@ func ParseSpecialMessage(data []byte) (*SpecialMessage, error) {
|
||||
}, nil
|
||||
}
|
||||
|
||||
// Check for userInactivityUpdate
|
||||
if strings.Contains(dataStr, "<userInactivityUpdate") {
|
||||
var userInactivity UserInactivityUpdate
|
||||
if err := xml.Unmarshal(data, &userInactivity); err != nil {
|
||||
return nil, fmt.Errorf("failed to parse userInactivityUpdate: %w", err)
|
||||
}
|
||||
|
||||
return &SpecialMessage{
|
||||
Type: MessageTypeUserInactivity,
|
||||
DeviceID: userInactivity.DeviceID,
|
||||
Data: &userInactivity,
|
||||
RawData: data,
|
||||
Timestamp: time.Now(),
|
||||
}, nil
|
||||
}
|
||||
|
||||
return nil, fmt.Errorf("unknown special message type: %s", dataStr)
|
||||
}
|
||||
|
||||
@@ -629,6 +652,17 @@ func (sm *SpecialMessage) GetUserActivity() *UserActivityUpdate {
|
||||
return nil
|
||||
}
|
||||
|
||||
// GetUserInactivity returns the parsed UserInactivity data if the message is of that type
|
||||
func (sm *SpecialMessage) GetUserInactivity() *UserInactivityUpdate {
|
||||
if sm.Type == MessageTypeUserInactivity {
|
||||
if userInactivity, ok := sm.Data.(*UserInactivityUpdate); ok {
|
||||
return userInactivity
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// String returns a string representation of the special message
|
||||
func (sm *SpecialMessage) String() string {
|
||||
switch sm.Type {
|
||||
@@ -638,6 +672,8 @@ func (sm *SpecialMessage) String() string {
|
||||
}
|
||||
case MessageTypeUserActivity:
|
||||
return fmt.Sprintf("User Activity [Device: %s]", sm.DeviceID)
|
||||
case MessageTypeUserInactivity:
|
||||
return fmt.Sprintf("User Inactivity [Device: %s]", sm.DeviceID)
|
||||
}
|
||||
|
||||
return fmt.Sprintf("Unknown Special Message - Type: %s", sm.Type)
|
||||
|
||||
+28
-23
@@ -280,6 +280,33 @@ func TuneInPlaybackPodcast(podcastID string) (*models.BmxPlaybackResponse, error
|
||||
return response, nil
|
||||
}
|
||||
|
||||
// BuildCustomStreamResponse builds a playback response from streamUrl, imageUrl, and name.
|
||||
func BuildCustomStreamResponse(streamURL, imageURL, name string) (*models.BmxPlaybackResponse, error) {
|
||||
streamList := []models.Stream{
|
||||
{
|
||||
HasPlaylist: true,
|
||||
IsRealtime: true,
|
||||
StreamUrl: streamURL,
|
||||
},
|
||||
}
|
||||
|
||||
audio := models.Audio{
|
||||
HasPlaylist: true,
|
||||
IsRealtime: true,
|
||||
StreamUrl: streamURL,
|
||||
Streams: streamList,
|
||||
}
|
||||
|
||||
response := &models.BmxPlaybackResponse{
|
||||
Audio: audio,
|
||||
ImageUrl: imageURL,
|
||||
Name: name,
|
||||
StreamType: "liveRadio",
|
||||
}
|
||||
|
||||
return response, nil
|
||||
}
|
||||
|
||||
// PlayCustomStream builds a playback response from a base64-encoded JSON blob
|
||||
// with fields streamUrl, imageUrl, and name.
|
||||
func PlayCustomStream(data string) (*models.BmxPlaybackResponse, error) {
|
||||
@@ -302,27 +329,5 @@ func PlayCustomStream(data string) (*models.BmxPlaybackResponse, error) {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
streamList := []models.Stream{
|
||||
{
|
||||
HasPlaylist: true,
|
||||
IsRealtime: true,
|
||||
StreamUrl: jsonObj.StreamURL,
|
||||
},
|
||||
}
|
||||
|
||||
audio := models.Audio{
|
||||
HasPlaylist: true,
|
||||
IsRealtime: true,
|
||||
StreamUrl: jsonObj.StreamURL,
|
||||
Streams: streamList,
|
||||
}
|
||||
|
||||
response := &models.BmxPlaybackResponse{
|
||||
Audio: audio,
|
||||
ImageUrl: jsonObj.ImageURL,
|
||||
Name: jsonObj.Name,
|
||||
StreamType: "liveRadio",
|
||||
}
|
||||
|
||||
return response, nil
|
||||
return BuildCustomStreamResponse(jsonObj.StreamURL, jsonObj.ImageURL, jsonObj.Name)
|
||||
}
|
||||
|
||||
@@ -9,6 +9,7 @@ import (
|
||||
"crypto/x509/pkix"
|
||||
"encoding/pem"
|
||||
"math/big"
|
||||
"net"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"time"
|
||||
@@ -80,6 +81,10 @@ func (cm *CertificateManager) GetServerTLSConfig(domains []string) (*tls.Config,
|
||||
domainMap[d] = true
|
||||
}
|
||||
|
||||
for _, ip := range cert.IPAddresses {
|
||||
domainMap[ip.String()] = true
|
||||
}
|
||||
|
||||
for _, d := range domains {
|
||||
if !domainMap[d] {
|
||||
generate = true
|
||||
@@ -237,6 +242,19 @@ func (cm *CertificateManager) GenerateCertificate(domains []string) ([]byte, []b
|
||||
return nil, nil, err
|
||||
}
|
||||
|
||||
var (
|
||||
dnsNames []string
|
||||
ipAddresses []net.IP
|
||||
)
|
||||
|
||||
for _, domain := range domains {
|
||||
if ip := net.ParseIP(domain); ip != nil {
|
||||
ipAddresses = append(ipAddresses, ip)
|
||||
} else {
|
||||
dnsNames = append(dnsNames, domain)
|
||||
}
|
||||
}
|
||||
|
||||
template := x509.Certificate{
|
||||
SerialNumber: serialNumber,
|
||||
Subject: pkix.Name{
|
||||
@@ -247,7 +265,8 @@ func (cm *CertificateManager) GenerateCertificate(domains []string) ([]byte, []b
|
||||
NotAfter: notAfter,
|
||||
KeyUsage: x509.KeyUsageDigitalSignature | x509.KeyUsageKeyEncipherment,
|
||||
ExtKeyUsage: []x509.ExtKeyUsage{x509.ExtKeyUsageServerAuth},
|
||||
DNSNames: domains,
|
||||
DNSNames: dnsNames,
|
||||
IPAddresses: ipAddresses,
|
||||
}
|
||||
|
||||
derBytes, err := x509.CreateCertificate(rand.Reader, &template, caCert, &priv.PublicKey, caKey)
|
||||
|
||||
@@ -103,7 +103,7 @@ func TestCertificateManager(t *testing.T) {
|
||||
}
|
||||
|
||||
// Test certificate regeneration if domains change
|
||||
newDomains := append(domains, "mac.fritz.box")
|
||||
newDomains := append(domains, "foo.local")
|
||||
tlsConfig2, err := cm.GetServerTLSConfig(newDomains)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get updated TLS config: %v", err)
|
||||
@@ -116,7 +116,7 @@ func TestCertificateManager(t *testing.T) {
|
||||
cert, _ := x509.ParseCertificate(block.Bytes)
|
||||
found := false
|
||||
for _, d := range cert.DNSNames {
|
||||
if d == "mac.fritz.box" {
|
||||
if d == "foo.local" {
|
||||
found = true
|
||||
break
|
||||
}
|
||||
@@ -126,3 +126,47 @@ func TestCertificateManager(t *testing.T) {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestCertificateManagerIPAddress(t *testing.T) {
|
||||
tempDir, err := os.MkdirTemp("", "crypto-ip-test")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create temp dir: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tempDir)
|
||||
|
||||
cm := NewCertificateManager(filepath.Join(tempDir, "certs"))
|
||||
|
||||
// Test certificate generation with an IP address
|
||||
domains := []string{"192.168.1.100", "localhost"}
|
||||
certPEM, _, err := cm.GenerateCertificate(domains)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to generate certificate: %v", err)
|
||||
}
|
||||
|
||||
// Verify generated certificate
|
||||
block, _ := pem.Decode(certPEM)
|
||||
cert, err := x509.ParseCertificate(block.Bytes)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to parse certificate: %v", err)
|
||||
}
|
||||
|
||||
// Check IP addresses
|
||||
foundIP := false
|
||||
for _, ip := range cert.IPAddresses {
|
||||
if ip.String() == "192.168.1.100" {
|
||||
foundIP = true
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if !foundIP {
|
||||
t.Errorf("Expected IP address 192.168.1.100 in IPAddresses, but it was not found")
|
||||
}
|
||||
|
||||
// Check if it was mistakenly added to DNSNames
|
||||
for _, dns := range cert.DNSNames {
|
||||
if dns == "192.168.1.100" {
|
||||
t.Errorf("IP address 192.168.1.100 should NOT be in DNSNames")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,6 +1,57 @@
|
||||
// Package constants defines file names, directories, and common values used by the service layer.
|
||||
package constants
|
||||
|
||||
// SourceProvider represents a media source provider configuration.
|
||||
type SourceProvider struct {
|
||||
ID int
|
||||
Name string
|
||||
CreatedOn string
|
||||
UpdatedOn string
|
||||
}
|
||||
|
||||
// StaticProviders lists known source provider identifiers with their metadata.
|
||||
var StaticProviders = []SourceProvider{
|
||||
{ID: 1, Name: "PANDORA", CreatedOn: "2012-09-19T12:43:00.000+00:00", UpdatedOn: "2012-09-19T12:43:00.000+00:00"},
|
||||
{ID: 2, Name: "INTERNET_RADIO", CreatedOn: "2012-09-19T12:43:00.000+00:00", UpdatedOn: "2012-09-19T12:43:00.000+00:00"},
|
||||
{ID: 3, Name: "OFF", CreatedOn: "2012-10-22T16:03:00.000+00:00", UpdatedOn: "2012-10-22T16:03:00.000+00:00"},
|
||||
{ID: 4, Name: "LOCAL", CreatedOn: "2012-10-22T16:04:00.000+00:00", UpdatedOn: "2012-10-22T16:04:00.000+00:00"},
|
||||
{ID: 5, Name: "AIRPLAY", CreatedOn: "2012-10-22T16:04:00.000+00:00", UpdatedOn: "2012-10-22T16:04:00.000+00:00"},
|
||||
{ID: 6, Name: "CURRATED_RADIO", CreatedOn: "2012-10-22T16:04:00.000+00:00", UpdatedOn: "2012-10-22T16:04:00.000+00:00"},
|
||||
{ID: 7, Name: "STORED_MUSIC", CreatedOn: "2012-10-22T16:04:00.000+00:00", UpdatedOn: "2012-10-22T16:04:00.000+00:00"},
|
||||
{ID: 8, Name: "SLAVE_SOURCE", CreatedOn: "2012-10-22T16:04:00.000+00:00", UpdatedOn: "2012-10-22T16:04:00.000+00:00"},
|
||||
{ID: 9, Name: "AUX", CreatedOn: "2012-10-22T16:04:00.000+00:00", UpdatedOn: "2012-10-22T16:04:00.000+00:00"},
|
||||
{ID: 10, Name: "RECOMMENDED_INTERNET_RADIO", CreatedOn: "2013-01-10T09:45:00.000+00:00", UpdatedOn: "2013-01-10T09:45:00.000+00:00"},
|
||||
{ID: 11, Name: "LOCAL_INTERNET_RADIO", CreatedOn: "2013-01-10T09:45:00.000+00:00", UpdatedOn: "2013-01-10T09:45:00.000+00:00"},
|
||||
{ID: 12, Name: "GLOBAL_INTERNET_RADIO", CreatedOn: "2013-01-10T09:45:00.000+00:00", UpdatedOn: "2013-01-10T09:45:00.000+00:00"},
|
||||
{ID: 13, Name: "HELLO", CreatedOn: "2014-03-17T15:30:07.000+00:00", UpdatedOn: "2014-03-17T15:30:07.000+00:00"},
|
||||
{ID: 14, Name: "DEEZER", CreatedOn: "2014-03-17T15:30:27.000+00:00", UpdatedOn: "2014-03-17T15:30:27.000+00:00"},
|
||||
{ID: 15, Name: "SPOTIFY", CreatedOn: "2014-03-17T15:30:27.000+00:00", UpdatedOn: "2014-03-17T15:30:27.000+00:00"},
|
||||
{ID: 16, Name: "IHEART", CreatedOn: "2014-03-17T15:30:27.000+00:00", UpdatedOn: "2014-03-17T15:30:27.000+00:00"},
|
||||
{ID: 17, Name: "SIRIUSXM", CreatedOn: "2014-12-04T19:49:55.000+00:00", UpdatedOn: "2014-12-04T19:49:55.000+00:00"},
|
||||
{ID: 18, Name: "GOOGLE_PLAY_MUSIC", CreatedOn: "2014-12-04T19:49:55.000+00:00", UpdatedOn: "2014-12-04T19:49:55.000+00:00"},
|
||||
{ID: 19, Name: "QQMUSIC", CreatedOn: "2014-12-04T19:49:55.000+00:00", UpdatedOn: "2014-12-04T19:49:55.000+00:00"},
|
||||
{ID: 20, Name: "AMAZON", CreatedOn: "2014-12-04T19:49:55.000+00:00", UpdatedOn: "2014-12-04T19:49:55.000+00:00"},
|
||||
{ID: 21, Name: "LOCAL_MUSIC", CreatedOn: "2015-07-13T12:00:00.000+00:00", UpdatedOn: "2015-07-13T12:00:00.000+00:00"},
|
||||
{ID: 22, Name: "WBMX", CreatedOn: "2016-04-08T17:27:21.000+00:00", UpdatedOn: "2016-04-08T17:27:21.000+00:00"},
|
||||
{ID: 23, Name: "SOUNDCLOUD", CreatedOn: "2016-04-08T17:27:21.000+00:00", UpdatedOn: "2016-04-08T17:27:21.000+00:00"},
|
||||
{ID: 24, Name: "TIDAL", CreatedOn: "2016-04-08T17:27:21.000+00:00", UpdatedOn: "2016-04-08T17:27:21.000+00:00"},
|
||||
{ID: 25, Name: "TUNEIN", CreatedOn: "2016-04-08T17:27:21.000+00:00", UpdatedOn: "2016-04-08T17:27:21.000+00:00"},
|
||||
{ID: 26, Name: "QPLAY", CreatedOn: "2016-06-17T18:00:54.000+00:00", UpdatedOn: "2016-06-17T18:00:54.000+00:00"},
|
||||
{ID: 27, Name: "JUKE", CreatedOn: "2016-08-01T13:53:40.000+00:00", UpdatedOn: "2016-08-01T13:53:40.000+00:00"},
|
||||
{ID: 28, Name: "BBC", CreatedOn: "2016-08-01T13:53:40.000+00:00", UpdatedOn: "2016-08-01T13:53:40.000+00:00"},
|
||||
{ID: 29, Name: "DARFM", CreatedOn: "2016-08-01T13:53:40.000+00:00", UpdatedOn: "2016-08-01T13:53:40.000+00:00"},
|
||||
{ID: 30, Name: "7DIGITAL", CreatedOn: "2016-08-01T13:53:40.000+00:00", UpdatedOn: "2016-08-01T13:53:40.000+00:00"},
|
||||
{ID: 31, Name: "SAAVN", CreatedOn: "2016-08-01T13:53:40.000+00:00", UpdatedOn: "2016-08-01T13:53:40.000+00:00"},
|
||||
{ID: 32, Name: "RDIO", CreatedOn: "2016-08-01T13:53:40.000+00:00", UpdatedOn: "2016-08-01T13:53:40.000+00:00"},
|
||||
{ID: 33, Name: "PHONE_MUSIC", CreatedOn: "2016-10-26T14:42:49.000+00:00", UpdatedOn: "2016-10-26T14:42:49.000+00:00"},
|
||||
{ID: 34, Name: "ALEXA", CreatedOn: "2017-12-04T19:18:47.000+00:00", UpdatedOn: "2017-12-04T19:18:47.000+00:00"},
|
||||
{ID: 35, Name: "RADIOPLAYER", CreatedOn: "2019-05-28T18:21:20.000+00:00", UpdatedOn: "2019-05-28T18:21:20.000+00:00"},
|
||||
{ID: 36, Name: "RADIO.COM", CreatedOn: "2019-05-28T18:21:41.000+00:00", UpdatedOn: "2019-05-28T18:21:41.000+00:00"},
|
||||
{ID: 37, Name: "RADIO_COM", CreatedOn: "2019-06-13T17:30:47.000+00:00", UpdatedOn: "2019-06-13T17:30:47.000+00:00"},
|
||||
{ID: 38, Name: "SIRIUSXM_EVEREST", CreatedOn: "2019-11-25T18:00:33.000+00:00", UpdatedOn: "2019-11-25T18:00:33.000+00:00"},
|
||||
{ID: 39, Name: "RADIO_BROWSER", CreatedOn: "2026-03-14T22:47:00.000+00:00", UpdatedOn: "2026-03-14T22:47:00.000+00:00"},
|
||||
}
|
||||
|
||||
// Providers lists known source provider identifiers used by Bose SoundTouch.
|
||||
var Providers = []string{
|
||||
"PANDORA",
|
||||
@@ -60,4 +111,7 @@ const (
|
||||
|
||||
// DateStr is the hardcoded date used in many Bose XML responses
|
||||
DateStr = "2012-09-19T12:43:00.000+00:00"
|
||||
|
||||
// XMLHeader is the standard XML declaration for Bose SoundTouch responses
|
||||
XMLHeader = `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>`
|
||||
)
|
||||
|
||||
@@ -0,0 +1,296 @@
|
||||
package datastore
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/service/constants"
|
||||
)
|
||||
|
||||
func TestMacAddressCaseSensitivity(t *testing.T) {
|
||||
tmpDir, err := os.MkdirTemp("", "case-sensitivity-test")
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create temp dir: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tmpDir)
|
||||
|
||||
accountID := "3230304"
|
||||
serialNumber := "I6332527703739342000020"
|
||||
|
||||
// Test scenarios that could occur in production
|
||||
testCases := []struct {
|
||||
name string
|
||||
macInDeviceInfo string
|
||||
macInRequest string
|
||||
expectedToWork bool
|
||||
description string
|
||||
}{
|
||||
{
|
||||
name: "ExactMatch",
|
||||
macInDeviceInfo: "A81B6A536A98",
|
||||
macInRequest: "A81B6A536A98",
|
||||
expectedToWork: true,
|
||||
description: "Exact case match should work",
|
||||
},
|
||||
{
|
||||
name: "DeviceInfoUpperRequestLower",
|
||||
macInDeviceInfo: "A81B6A536A98",
|
||||
macInRequest: "a81b6a536a98",
|
||||
expectedToWork: true,
|
||||
description: "DeviceInfo has uppercase, request has lowercase (should work with normalization)",
|
||||
},
|
||||
{
|
||||
name: "DeviceInfoLowerRequestUpper",
|
||||
macInDeviceInfo: "a81b6a536a98",
|
||||
macInRequest: "A81B6A536A98",
|
||||
expectedToWork: true,
|
||||
description: "DeviceInfo has lowercase, request has uppercase (should work with normalization)",
|
||||
},
|
||||
{
|
||||
name: "MixedCaseInDeviceInfo",
|
||||
macInDeviceInfo: "a81B6a536A98",
|
||||
macInRequest: "A81B6A536A98",
|
||||
expectedToWork: true,
|
||||
description: "Mixed case in DeviceInfo vs uppercase request (should work with normalization)",
|
||||
},
|
||||
{
|
||||
name: "WithColonsInDeviceInfo",
|
||||
macInDeviceInfo: "A8:1B:6A:53:6A:98",
|
||||
macInRequest: "A81B6A536A98",
|
||||
expectedToWork: true,
|
||||
description: "DeviceInfo has colons, request without (should work with normalization)",
|
||||
},
|
||||
{
|
||||
name: "WithDashesInDeviceInfo",
|
||||
macInDeviceInfo: "A8-1B-6A-53-6A-98",
|
||||
macInRequest: "A81B6A536A98",
|
||||
expectedToWork: true,
|
||||
description: "DeviceInfo has dashes, request without (should work with normalization)",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range testCases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
// Create separate directory for this test case
|
||||
testDir := filepath.Join(tmpDir, tc.name)
|
||||
deviceDir := filepath.Join(testDir, "accounts", accountID, "devices", serialNumber)
|
||||
if err := os.MkdirAll(deviceDir, 0755); err != nil {
|
||||
t.Fatalf("failed to create device dir: %v", err)
|
||||
}
|
||||
|
||||
// Create DeviceInfo.xml with specific MAC format
|
||||
deviceInfoXML := `<?xml version="1.0" encoding="UTF-8"?>
|
||||
<info deviceID="` + serialNumber + `">
|
||||
<name>Test Device</name>
|
||||
<components>
|
||||
<component>
|
||||
<componentCategory>SCM</componentCategory>
|
||||
<softwareVersion>4.8.1</softwareVersion>
|
||||
<serialNumber>` + serialNumber + `</serialNumber>
|
||||
</component>
|
||||
</components>
|
||||
<networkInfo type="SCM">
|
||||
<macAddress>` + tc.macInDeviceInfo + `</macAddress>
|
||||
<ipAddress>192.168.1.100</ipAddress>
|
||||
</networkInfo>
|
||||
</info>`
|
||||
if err := os.WriteFile(filepath.Join(deviceDir, constants.DeviceInfoFile), []byte(deviceInfoXML), 0644); err != nil {
|
||||
t.Fatalf("failed to write DeviceInfo.xml: %v", err)
|
||||
}
|
||||
|
||||
// Create Presets.xml
|
||||
presetsXML := `<presets><preset id="1">test</preset></presets>`
|
||||
if err := os.WriteFile(filepath.Join(deviceDir, constants.PresetsFile), []byte(presetsXML), 0644); err != nil {
|
||||
t.Fatalf("failed to write Presets.xml: %v", err)
|
||||
}
|
||||
|
||||
// Initialize datastore
|
||||
ds := NewDataStore(testDir)
|
||||
if err := ds.Initialize(); err != nil {
|
||||
t.Fatalf("failed to initialize datastore: %v", err)
|
||||
}
|
||||
|
||||
// Check mapping
|
||||
ds.idMutex.RLock()
|
||||
mappedSerial, hasMappingForRequest := ds.deviceMappings[tc.macInRequest]
|
||||
mappedSerialFromDeviceInfo, hasMappingForDeviceInfo := ds.deviceMappings[tc.macInDeviceInfo]
|
||||
ds.idMutex.RUnlock()
|
||||
|
||||
t.Logf("%s:", tc.description)
|
||||
t.Logf(" MAC in DeviceInfo.xml: '%s'", tc.macInDeviceInfo)
|
||||
t.Logf(" MAC in request: '%s'", tc.macInRequest)
|
||||
t.Logf(" Mapping exists for request MAC: %v", hasMappingForRequest)
|
||||
t.Logf(" Mapping exists for DeviceInfo MAC: %v", hasMappingForDeviceInfo)
|
||||
|
||||
if hasMappingForRequest {
|
||||
t.Logf(" Request MAC '%s' maps to serial: '%s'", tc.macInRequest, mappedSerial)
|
||||
}
|
||||
if hasMappingForDeviceInfo {
|
||||
t.Logf(" DeviceInfo MAC '%s' maps to serial: '%s'", tc.macInDeviceInfo, mappedSerialFromDeviceInfo)
|
||||
}
|
||||
|
||||
// Try GetPresets
|
||||
_, err := ds.GetPresets(accountID, tc.macInRequest)
|
||||
worked := err == nil
|
||||
|
||||
if tc.expectedToWork && !worked {
|
||||
t.Errorf("Expected success but got error: %v", err)
|
||||
} else if !tc.expectedToWork && worked {
|
||||
t.Errorf("Expected failure but got success")
|
||||
} else if worked {
|
||||
t.Logf(" ✓ Successfully resolved MAC '%s'", tc.macInRequest)
|
||||
} else {
|
||||
t.Logf(" ✓ Correctly failed to resolve MAC '%s'", tc.macInRequest)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestProductionScenarioSimulation simulates the exact issue described
|
||||
func TestProductionScenarioSimulation(t *testing.T) {
|
||||
// This test specifically simulates the production scenario where:
|
||||
// Request: GET /streaming/account/3230304/device/A81B6A536A98/presets
|
||||
// File exists at: /var/lib/soundtouch-service/accounts/3230304/devices/I6332527703739342000020/Presets.xml
|
||||
|
||||
tmpDir, err := os.MkdirTemp("", "production-scenario")
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create temp dir: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tmpDir)
|
||||
|
||||
accountID := "3230304"
|
||||
serialNumber := "I6332527703739342000020"
|
||||
requestMAC := "A81B6A536A98"
|
||||
|
||||
// Test different MAC address formats that could be in DeviceInfo.xml
|
||||
possibleMACFormats := []string{
|
||||
"A81B6A536A98", // Exact match
|
||||
"a81b6a536a98", // All lowercase
|
||||
"A81b6a536A98", // Mixed case
|
||||
"A8:1B:6A:53:6A:98", // With colons
|
||||
"A8-1B-6A-53-6A-98", // With dashes
|
||||
"a8:1b:6a:53:6a:98", // Lowercase with colons
|
||||
"a8-1b-6a-53-6a-98", // Lowercase with dashes
|
||||
}
|
||||
|
||||
t.Logf("Production scenario simulation:")
|
||||
t.Logf("Request URL: GET /streaming/account/%s/device/%s/presets", accountID, requestMAC)
|
||||
t.Logf("Expected file location: accounts/%s/devices/%s/Presets.xml", accountID, serialNumber)
|
||||
t.Logf("")
|
||||
|
||||
for i, macFormat := range possibleMACFormats {
|
||||
t.Run(fmt.Sprintf("MACFormat_%d", i), func(t *testing.T) {
|
||||
// Create fresh directory for this test
|
||||
testDir := filepath.Join(tmpDir, fmt.Sprintf("test_%d", i))
|
||||
deviceDir := filepath.Join(testDir, "accounts", accountID, "devices", serialNumber)
|
||||
if err := os.MkdirAll(deviceDir, 0755); err != nil {
|
||||
t.Fatalf("failed to create device dir: %v", err)
|
||||
}
|
||||
|
||||
// Create DeviceInfo.xml with this MAC format
|
||||
deviceInfoXML := `<?xml version="1.0" encoding="UTF-8"?>
|
||||
<info deviceID="` + serialNumber + `">
|
||||
<name>SoundTouch Device</name>
|
||||
<components>
|
||||
<component>
|
||||
<componentCategory>SCM</componentCategory>
|
||||
<softwareVersion>4.8.1</softwareVersion>
|
||||
<serialNumber>` + serialNumber + `</serialNumber>
|
||||
</component>
|
||||
</components>
|
||||
<networkInfo type="SCM">
|
||||
<macAddress>` + macFormat + `</macAddress>
|
||||
<ipAddress>192.168.1.100</ipAddress>
|
||||
</networkInfo>
|
||||
</info>`
|
||||
if err := os.WriteFile(filepath.Join(deviceDir, constants.DeviceInfoFile), []byte(deviceInfoXML), 0644); err != nil {
|
||||
t.Fatalf("failed to write DeviceInfo.xml: %v", err)
|
||||
}
|
||||
|
||||
// Create the target file that should be found
|
||||
presetsXML := `<presets><preset id="1">test</preset></presets>`
|
||||
if err := os.WriteFile(filepath.Join(deviceDir, constants.PresetsFile), []byte(presetsXML), 0644); err != nil {
|
||||
t.Fatalf("failed to write Presets.xml: %v", err)
|
||||
}
|
||||
|
||||
// Initialize datastore
|
||||
ds := NewDataStore(testDir)
|
||||
if err := ds.Initialize(); err != nil {
|
||||
t.Fatalf("failed to initialize datastore: %v", err)
|
||||
}
|
||||
|
||||
// Try to access using the request MAC
|
||||
presets, err := ds.GetPresets(accountID, requestMAC)
|
||||
|
||||
if err == nil {
|
||||
t.Logf("✓ SUCCESS: MAC format '%s' in DeviceInfo allows request with '%s' to work (%d presets found)",
|
||||
macFormat, requestMAC, len(presets))
|
||||
} else {
|
||||
t.Logf("✗ FAILED: MAC format '%s' in DeviceInfo does not allow request with '%s' (error: %v)",
|
||||
macFormat, requestMAC, err)
|
||||
}
|
||||
|
||||
// Check what actually got mapped
|
||||
ds.idMutex.RLock()
|
||||
for mac, serial := range ds.deviceMappings {
|
||||
t.Logf(" Mapping: '%s' -> '%s'", mac, serial)
|
||||
}
|
||||
ds.idMutex.RUnlock()
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestNormalizationSuggestion tests if we should implement MAC address normalization
|
||||
func TestNormalizationSuggestion(t *testing.T) {
|
||||
// This test demonstrates how MAC address normalization could solve the issue
|
||||
|
||||
normalizeMAC := func(mac string) string {
|
||||
// Remove common separators and convert to uppercase
|
||||
mac = strings.ReplaceAll(mac, ":", "")
|
||||
mac = strings.ReplaceAll(mac, "-", "")
|
||||
mac = strings.ToUpper(mac)
|
||||
return mac
|
||||
}
|
||||
|
||||
testCases := []struct {
|
||||
original string
|
||||
normalized string
|
||||
}{
|
||||
{"A81B6A536A98", "A81B6A536A98"},
|
||||
{"a81b6a536a98", "A81B6A536A98"},
|
||||
{"A8:1B:6A:53:6A:98", "A81B6A536A98"},
|
||||
{"a8:1b:6a:53:6a:98", "A81B6A536A98"},
|
||||
{"A8-1B-6A-53-6A-98", "A81B6A536A98"},
|
||||
{"a8-1b-6a-53-6a-98", "A81B6A536A98"},
|
||||
{"a81B6a536A98", "A81B6A536A98"},
|
||||
}
|
||||
|
||||
t.Log("MAC Address Normalization Test:")
|
||||
t.Log("This shows how normalization could solve case/format sensitivity issues")
|
||||
t.Log("")
|
||||
|
||||
allNormalizedSame := true
|
||||
expectedNormalized := "A81B6A536A98"
|
||||
|
||||
for _, tc := range testCases {
|
||||
normalized := normalizeMAC(tc.original)
|
||||
matches := normalized == expectedNormalized
|
||||
|
||||
if !matches {
|
||||
allNormalizedSame = false
|
||||
}
|
||||
|
||||
t.Logf("'%s' -> '%s' (matches expected: %v)", tc.original, normalized, matches)
|
||||
}
|
||||
|
||||
if allNormalizedSame {
|
||||
t.Log("")
|
||||
t.Log("✓ All MAC address formats normalize to the same value")
|
||||
t.Log("✓ Implementing normalization would solve case/format sensitivity issues")
|
||||
} else {
|
||||
t.Error("✗ Normalization failed to produce consistent results")
|
||||
}
|
||||
}
|
||||
+463
-139
@@ -9,6 +9,7 @@ import (
|
||||
"path/filepath"
|
||||
"sort"
|
||||
"strconv"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
@@ -23,9 +24,31 @@ func exists(path string) bool {
|
||||
|
||||
// DataStore represents the device and configuration storage.
|
||||
type DataStore struct {
|
||||
DataDir string
|
||||
eventMutex sync.RWMutex
|
||||
deviceEvents map[string][]models.DeviceEvent
|
||||
// DataDir is the (possibly relative) base directory for all datastore files.
|
||||
DataDir string
|
||||
// baseDir is the absolute, normalized base directory used for path safety checks.
|
||||
baseDir string
|
||||
|
||||
eventMutex sync.RWMutex
|
||||
deviceEvents map[string][]models.DeviceEvent
|
||||
idMutex sync.RWMutex
|
||||
deviceMappings map[string]string
|
||||
fileMutex sync.RWMutex
|
||||
}
|
||||
|
||||
// normalizeMAC normalizes a MAC address to a consistent format
|
||||
func normalizeMAC(mac string) string {
|
||||
if mac == "" {
|
||||
return ""
|
||||
}
|
||||
// Remove spaces and common separators, then convert to uppercase
|
||||
mac = strings.TrimSpace(mac)
|
||||
mac = strings.ReplaceAll(mac, " ", "")
|
||||
mac = strings.ReplaceAll(mac, ":", "")
|
||||
mac = strings.ReplaceAll(mac, "-", "")
|
||||
mac = strings.ToUpper(mac)
|
||||
|
||||
return mac
|
||||
}
|
||||
|
||||
// NewDataStore creates a new DataStore.
|
||||
@@ -35,32 +58,111 @@ func NewDataStore(dataDir string) *DataStore {
|
||||
dataDir = "data"
|
||||
}
|
||||
|
||||
return &DataStore{
|
||||
DataDir: dataDir,
|
||||
deviceEvents: make(map[string][]models.DeviceEvent),
|
||||
absBase, err := filepath.Abs(dataDir)
|
||||
if err != nil {
|
||||
// Fallback to the provided dataDir if Abs fails; this preserves existing behavior.
|
||||
absBase = dataDir
|
||||
}
|
||||
|
||||
return &DataStore{
|
||||
DataDir: dataDir,
|
||||
baseDir: absBase,
|
||||
deviceEvents: make(map[string][]models.DeviceEvent),
|
||||
deviceMappings: make(map[string]string),
|
||||
}
|
||||
}
|
||||
|
||||
// safeJoin joins the given path elements to the datastore baseDir and ensures
|
||||
// that the resulting absolute path stays within baseDir. If the check fails,
|
||||
// baseDir is returned to prevent directory traversal.
|
||||
func (ds *DataStore) safeJoin(elem ...string) string {
|
||||
// Join the base directory with the provided elements.
|
||||
path := filepath.Join(append([]string{ds.baseDir}, elem...)...)
|
||||
|
||||
absPath, err := filepath.Abs(path)
|
||||
if err != nil {
|
||||
// On error, fall back to baseDir to avoid using an unexpected path.
|
||||
return ds.baseDir
|
||||
}
|
||||
|
||||
base := ds.baseDir
|
||||
if base == "" {
|
||||
// If baseDir is not set for some reason, fall back to original path.
|
||||
return absPath
|
||||
}
|
||||
|
||||
// Ensure the resolved path is within the base directory.
|
||||
baseWithSep := base
|
||||
if !strings.HasSuffix(baseWithSep, string(os.PathSeparator)) {
|
||||
baseWithSep += string(os.PathSeparator)
|
||||
}
|
||||
|
||||
if absPath == base || strings.HasPrefix(absPath, baseWithSep) {
|
||||
return absPath
|
||||
}
|
||||
|
||||
// If the path would escape the base directory, return baseDir as a safe default.
|
||||
return base
|
||||
}
|
||||
|
||||
// AccountDir returns the directory path for a specific account.
|
||||
func (ds *DataStore) AccountDir(account string) string {
|
||||
return filepath.Join(ds.DataDir, "accounts", account)
|
||||
return ds.safeJoin("accounts", account)
|
||||
}
|
||||
|
||||
// AccountDevicesDir returns the devices directory path for a specific account.
|
||||
func (ds *DataStore) AccountDevicesDir(account string) string {
|
||||
return filepath.Join(ds.AccountDir(account), constants.DevicesDir)
|
||||
return ds.safeJoin("accounts", account, constants.DevicesDir)
|
||||
}
|
||||
|
||||
// AccountDeviceDir returns the directory path for a specific device within an account.
|
||||
func (ds *DataStore) AccountDeviceDir(account, device string) string {
|
||||
return filepath.Join(ds.AccountDevicesDir(account), device)
|
||||
// First, check if the device directory exists directly with the given deviceID
|
||||
// This prioritizes MAC-based deviceIDs over legacy mappings
|
||||
directPath := ds.safeJoin("accounts", account, constants.DevicesDir, device)
|
||||
if _, err := os.Stat(directPath); err == nil {
|
||||
// Directory exists, use the direct deviceID (preferred for MAC-based IDs)
|
||||
return directPath
|
||||
}
|
||||
|
||||
// If direct path doesn't exist, check device mappings for backward compatibility
|
||||
ds.idMutex.RLock()
|
||||
|
||||
mappedDevice, ok := ds.deviceMappings[device]
|
||||
if !ok {
|
||||
// Try with normalized MAC address
|
||||
normalizedDevice := normalizeMAC(device)
|
||||
mappedDevice, ok = ds.deviceMappings[normalizedDevice]
|
||||
}
|
||||
|
||||
ds.idMutex.RUnlock()
|
||||
|
||||
if ok {
|
||||
// Use the mapped device only if it exists and the direct path doesn't
|
||||
mappedPath := ds.safeJoin("accounts", account, constants.DevicesDir, mappedDevice)
|
||||
if _, err := os.Stat(mappedPath); err == nil {
|
||||
return mappedPath
|
||||
}
|
||||
}
|
||||
|
||||
// If neither direct path nor mapping work, return the direct path
|
||||
// (this allows new devices to be created with MAC-based IDs)
|
||||
return directPath
|
||||
}
|
||||
|
||||
// GetDeviceInfo retrieves device information for the specified account and device.
|
||||
func (ds *DataStore) GetDeviceInfo(account, device string) (*models.ServiceDeviceInfo, error) {
|
||||
path := filepath.Join(ds.AccountDeviceDir(account, device), constants.DeviceInfoFile)
|
||||
ds.fileMutex.RLock()
|
||||
defer ds.fileMutex.RUnlock()
|
||||
|
||||
data, err := os.ReadFile(path)
|
||||
return ds.getDeviceInfoNoLock(account, device)
|
||||
}
|
||||
|
||||
func (ds *DataStore) getDeviceInfoNoLock(account, device string) (*models.ServiceDeviceInfo, error) {
|
||||
path := ds.AccountDeviceDir(account, device)
|
||||
deviceInfoPath := filepath.Join(path, constants.DeviceInfoFile)
|
||||
|
||||
data, err := os.ReadFile(deviceInfoPath)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -77,9 +179,11 @@ func (ds *DataStore) GetDeviceInfo(account, device string) (*models.ServiceDevic
|
||||
SerialNumber string `xml:"serialNumber"`
|
||||
} `xml:"components>component"`
|
||||
NetworkInfo []struct {
|
||||
Type string `xml:"type,attr"`
|
||||
IPAddress string `xml:"ipAddress"`
|
||||
Type string `xml:"type,attr"`
|
||||
IPAddress string `xml:"ipAddress"`
|
||||
MacAddress string `xml:"macAddress"`
|
||||
} `xml:"networkInfo"`
|
||||
DiscoveryMethod string `xml:"discoveryMethod"`
|
||||
}
|
||||
|
||||
if err := xml.Unmarshal(data, &info); err != nil {
|
||||
@@ -87,9 +191,11 @@ func (ds *DataStore) GetDeviceInfo(account, device string) (*models.ServiceDevic
|
||||
}
|
||||
|
||||
deviceInfo := &models.ServiceDeviceInfo{
|
||||
DeviceID: info.DeviceID,
|
||||
ProductCode: fmt.Sprintf("%s %s", info.Type, info.ModuleType),
|
||||
Name: info.Name,
|
||||
DeviceID: info.DeviceID,
|
||||
AccountID: account, // Set AccountID from parameter
|
||||
ProductCode: fmt.Sprintf("%s %s", info.Type, info.ModuleType),
|
||||
Name: info.Name,
|
||||
DiscoveryMethod: info.DiscoveryMethod,
|
||||
}
|
||||
|
||||
for _, comp := range info.Components {
|
||||
@@ -105,6 +211,7 @@ func (ds *DataStore) GetDeviceInfo(account, device string) (*models.ServiceDevic
|
||||
for _, net := range info.NetworkInfo {
|
||||
if net.Type == "SCM" {
|
||||
deviceInfo.IPAddress = net.IPAddress
|
||||
deviceInfo.MacAddress = net.MacAddress
|
||||
}
|
||||
}
|
||||
|
||||
@@ -142,9 +249,21 @@ func (ds *DataStore) ListAllDevices() ([]models.ServiceDeviceInfo, error) {
|
||||
key = info.IPAddress
|
||||
}
|
||||
|
||||
if !seenIDs[key] {
|
||||
devices = append(devices, info)
|
||||
seenIDs[key] = true
|
||||
if !seenIDs[key] || info.Name != "" {
|
||||
if seenIDs[key] && info.Name != "" {
|
||||
// Replace previous empty-named entry with one that has a name
|
||||
for j := range devices {
|
||||
existing := &devices[j]
|
||||
if (existing.DeviceID != "" && existing.DeviceID == info.DeviceID) ||
|
||||
(existing.IPAddress != "" && existing.IPAddress == info.IPAddress) {
|
||||
devices[j] = info
|
||||
break
|
||||
}
|
||||
}
|
||||
} else if !seenIDs[key] {
|
||||
devices = append(devices, info)
|
||||
seenIDs[key] = true
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -155,17 +274,72 @@ func (ds *DataStore) ListAllDevices() ([]models.ServiceDeviceInfo, error) {
|
||||
|
||||
func (ds *DataStore) getPossibleDataDirs() []string {
|
||||
dirs := []string{}
|
||||
if exists(filepath.Join(ds.DataDir, "accounts")) {
|
||||
dirs = append(dirs, filepath.Join(ds.DataDir, "accounts"))
|
||||
// Check primary data directory
|
||||
if ds.DataDir != "" {
|
||||
if exists(filepath.Join(ds.DataDir, "accounts")) {
|
||||
dirs = append(dirs, filepath.Join(ds.DataDir, "accounts"))
|
||||
}
|
||||
// Also check the DataDir itself as a base for account directories
|
||||
if exists(ds.DataDir) && ds.DataDir != "." {
|
||||
dirs = append(dirs, ds.DataDir)
|
||||
}
|
||||
}
|
||||
|
||||
// Also check st-go/data/accounts if it's different and exists
|
||||
altDir := "st-go/data/accounts"
|
||||
if filepath.Join(ds.DataDir, "accounts") != altDir && exists(altDir) {
|
||||
if exists(altDir) {
|
||||
dirs = append(dirs, altDir)
|
||||
}
|
||||
// And st-go/data/accounts/default
|
||||
altDir2 := "st-go/data"
|
||||
if exists(altDir2) {
|
||||
dirs = append(dirs, altDir2)
|
||||
}
|
||||
// And repro_data
|
||||
altDir3 := "repro_data"
|
||||
if exists(altDir3) {
|
||||
dirs = append(dirs, altDir3)
|
||||
}
|
||||
|
||||
return dirs
|
||||
// Add special handling for test environments where we might have account directories
|
||||
// directly in the current working directory or a temp dir.
|
||||
// Walk up from DataDir to find any 'accounts' directory.
|
||||
curr := ds.DataDir
|
||||
for i := 0; i < 3; i++ {
|
||||
absCurr, _ := filepath.Abs(curr)
|
||||
if exists(filepath.Join(absCurr, "accounts")) {
|
||||
dirs = append(dirs, filepath.Join(absCurr, "accounts"))
|
||||
}
|
||||
|
||||
if exists(absCurr) {
|
||||
dirs = append(dirs, absCurr)
|
||||
}
|
||||
|
||||
if curr == "." || curr == "/" || curr == "" {
|
||||
break
|
||||
}
|
||||
|
||||
curr = filepath.Dir(curr)
|
||||
}
|
||||
|
||||
// Remove duplicates and ensure unique directories
|
||||
uniqueDirs := make(map[string]bool)
|
||||
result := []string{}
|
||||
|
||||
for _, dir := range dirs {
|
||||
absDir, err := filepath.Abs(dir)
|
||||
if err != nil {
|
||||
absDir = dir
|
||||
}
|
||||
|
||||
if !uniqueDirs[absDir] {
|
||||
uniqueDirs[absDir] = true
|
||||
|
||||
result = append(result, dir)
|
||||
}
|
||||
}
|
||||
|
||||
return result
|
||||
}
|
||||
|
||||
func (ds *DataStore) listDevicesInAccount(baseDir, accountName string) []models.ServiceDeviceInfo {
|
||||
@@ -195,6 +369,9 @@ func (ds *DataStore) listDevicesInAccount(baseDir, accountName string) []models.
|
||||
}
|
||||
|
||||
if err == nil && info != nil {
|
||||
// Update bidirectional device mappings for resolution
|
||||
ds.updateDeviceMappings(*info)
|
||||
|
||||
devices = append(devices, *info)
|
||||
}
|
||||
}
|
||||
@@ -220,8 +397,9 @@ func (ds *DataStore) parseDeviceInfoFile(path string) (*models.ServiceDeviceInfo
|
||||
SerialNumber string `xml:"serialNumber"`
|
||||
} `xml:"components>component"`
|
||||
NetworkInfo []struct {
|
||||
Type string `xml:"type,attr"`
|
||||
IPAddress string `xml:"ipAddress"`
|
||||
Type string `xml:"type,attr"`
|
||||
IPAddress string `xml:"ipAddress"`
|
||||
MacAddress string `xml:"macAddress"`
|
||||
} `xml:"networkInfo"`
|
||||
DiscoveryMethod string `xml:"discoveryMethod"`
|
||||
}
|
||||
@@ -232,12 +410,18 @@ func (ds *DataStore) parseDeviceInfoFile(path string) (*models.ServiceDeviceInfo
|
||||
|
||||
deviceInfo := &models.ServiceDeviceInfo{
|
||||
DeviceID: info.DeviceID,
|
||||
ProductCode: fmt.Sprintf("%s %s", info.Type, info.ModuleType),
|
||||
ProductCode: info.Type,
|
||||
Name: info.Name,
|
||||
DiscoveryMethod: info.DiscoveryMethod,
|
||||
}
|
||||
|
||||
for _, comp := range info.Components {
|
||||
deviceInfo.Components = append(deviceInfo.Components, models.ServiceComponent{
|
||||
Category: comp.Category,
|
||||
SoftwareVersion: comp.SoftwareVersion,
|
||||
SerialNumber: comp.SerialNumber,
|
||||
})
|
||||
|
||||
switch comp.Category {
|
||||
case "SCM":
|
||||
deviceInfo.FirmwareVersion = comp.SoftwareVersion
|
||||
@@ -250,6 +434,7 @@ func (ds *DataStore) parseDeviceInfoFile(path string) (*models.ServiceDeviceInfo
|
||||
for _, net := range info.NetworkInfo {
|
||||
if net.Type == "SCM" {
|
||||
deviceInfo.IPAddress = net.IPAddress
|
||||
deviceInfo.MacAddress = net.MacAddress
|
||||
}
|
||||
}
|
||||
|
||||
@@ -258,6 +443,9 @@ func (ds *DataStore) parseDeviceInfoFile(path string) (*models.ServiceDeviceInfo
|
||||
|
||||
// GetPresets retrieves all presets for the specified account and device.
|
||||
func (ds *DataStore) GetPresets(account, device string) ([]models.ServicePreset, error) {
|
||||
ds.fileMutex.RLock()
|
||||
defer ds.fileMutex.RUnlock()
|
||||
|
||||
path := filepath.Join(ds.AccountDeviceDir(account, device), constants.PresetsFile)
|
||||
|
||||
data, err := os.ReadFile(path)
|
||||
@@ -271,13 +459,14 @@ func (ds *DataStore) GetPresets(account, device string) ([]models.ServicePreset,
|
||||
CreatedOn string `xml:"createdOn,attr"`
|
||||
UpdatedOn string `xml:"updatedOn,attr"`
|
||||
ContentItem struct {
|
||||
Source string `xml:"source,attr"`
|
||||
Type string `xml:"type,attr"`
|
||||
Location string `xml:"location,attr"`
|
||||
SourceAccount string `xml:"sourceAccount,attr"`
|
||||
IsPresetable string `xml:"isPresetable,attr"`
|
||||
ItemName string `xml:"itemName"`
|
||||
ContainerArt string `xml:"containerArt"`
|
||||
Source string `xml:"source,attr"`
|
||||
Type string `xml:"type,attr"`
|
||||
Location string `xml:"location,attr"`
|
||||
SourceAccount string `xml:"sourceAccount,attr"`
|
||||
IsPresetable string `xml:"isPresetable,attr"`
|
||||
ItemName string `xml:"itemName"`
|
||||
ContentItemType string `xml:"contentItemType"`
|
||||
ContainerArt string `xml:"containerArt"`
|
||||
} `xml:"ContentItem"`
|
||||
} `xml:"preset"`
|
||||
}
|
||||
@@ -290,15 +479,22 @@ func (ds *DataStore) GetPresets(account, device string) ([]models.ServicePreset,
|
||||
|
||||
for i := range presetsWrap.Presets {
|
||||
p := &presetsWrap.Presets[i]
|
||||
|
||||
cit := p.ContentItem.ContentItemType
|
||||
if cit == "" {
|
||||
cit = p.ContentItem.Type
|
||||
}
|
||||
|
||||
presets = append(presets, models.ServicePreset{
|
||||
ServiceContentItem: models.ServiceContentItem{
|
||||
ID: p.ID,
|
||||
Name: p.ContentItem.ItemName,
|
||||
Source: p.ContentItem.Source,
|
||||
Type: p.ContentItem.Type,
|
||||
Location: p.ContentItem.Location,
|
||||
SourceAccount: p.ContentItem.SourceAccount,
|
||||
IsPresetable: p.ContentItem.IsPresetable,
|
||||
ID: p.ID,
|
||||
Name: p.ContentItem.ItemName,
|
||||
Source: p.ContentItem.Source,
|
||||
Type: p.ContentItem.Type,
|
||||
Location: p.ContentItem.Location,
|
||||
SourceAccount: p.ContentItem.SourceAccount,
|
||||
IsPresetable: p.ContentItem.IsPresetable,
|
||||
ContentItemType: cit,
|
||||
},
|
||||
ContainerArt: p.ContentItem.ContainerArt,
|
||||
CreatedOn: p.CreatedOn,
|
||||
@@ -311,6 +507,9 @@ func (ds *DataStore) GetPresets(account, device string) ([]models.ServicePreset,
|
||||
|
||||
// SavePresets saves the preset list for the specified account and device.
|
||||
func (ds *DataStore) SavePresets(account, device string, presets []models.ServicePreset) error {
|
||||
ds.fileMutex.Lock()
|
||||
defer ds.fileMutex.Unlock()
|
||||
|
||||
path := filepath.Join(ds.AccountDeviceDir(account, device), constants.PresetsFile)
|
||||
|
||||
type PresetXML struct {
|
||||
@@ -318,13 +517,14 @@ func (ds *DataStore) SavePresets(account, device string, presets []models.Servic
|
||||
CreatedOn string `xml:"createdOn,attr"`
|
||||
UpdatedOn string `xml:"updatedOn,attr"`
|
||||
ContentItem struct {
|
||||
Source string `xml:"source,attr,omitempty"`
|
||||
Type string `xml:"type,attr"`
|
||||
Location string `xml:"location,attr"`
|
||||
SourceAccount string `xml:"sourceAccount,attr,omitempty"`
|
||||
IsPresetable string `xml:"isPresetable,attr"`
|
||||
ItemName string `xml:"itemName"`
|
||||
ContainerArt string `xml:"containerArt"`
|
||||
Source string `xml:"source,attr,omitempty"`
|
||||
Type string `xml:"type,attr"`
|
||||
Location string `xml:"location,attr"`
|
||||
SourceAccount string `xml:"sourceAccount,attr,omitempty"`
|
||||
IsPresetable string `xml:"isPresetable,attr"`
|
||||
ItemName string `xml:"itemName"`
|
||||
ContentItemType string `xml:"contentItemType"`
|
||||
ContainerArt string `xml:"containerArt"`
|
||||
} `xml:"ContentItem"`
|
||||
}
|
||||
|
||||
@@ -349,6 +549,7 @@ func (ds *DataStore) SavePresets(account, device string, presets []models.Servic
|
||||
pxml.ContentItem.SourceAccount = p.SourceAccount
|
||||
pxml.ContentItem.IsPresetable = "true"
|
||||
pxml.ContentItem.ItemName = p.Name
|
||||
pxml.ContentItem.ContentItemType = p.ContentItemType
|
||||
pxml.ContentItem.ContainerArt = p.ContainerArt
|
||||
px.Presets = append(px.Presets, pxml)
|
||||
}
|
||||
@@ -365,6 +566,9 @@ func (ds *DataStore) SavePresets(account, device string, presets []models.Servic
|
||||
|
||||
// GetRecents retrieves all recent items for the specified account and device.
|
||||
func (ds *DataStore) GetRecents(account, device string) ([]models.ServiceRecent, error) {
|
||||
ds.fileMutex.RLock()
|
||||
defer ds.fileMutex.RUnlock()
|
||||
|
||||
path := filepath.Join(ds.AccountDeviceDir(account, device), constants.RecentsFile)
|
||||
|
||||
data, err := os.ReadFile(path)
|
||||
@@ -372,45 +576,39 @@ func (ds *DataStore) GetRecents(account, device string) ([]models.ServiceRecent,
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var recentsWrap struct {
|
||||
Recents []struct {
|
||||
ID string `xml:"id,attr"`
|
||||
DeviceID string `xml:"deviceID,attr"`
|
||||
UtcTime string `xml:"utcTime,attr"`
|
||||
ContentItem struct {
|
||||
Source string `xml:"source,attr"`
|
||||
Type string `xml:"type,attr"`
|
||||
Location string `xml:"location,attr"`
|
||||
SourceAccount string `xml:"sourceAccount,attr"`
|
||||
IsPresetable string `xml:"isPresetable,attr"`
|
||||
ItemName string `xml:"itemName"`
|
||||
ContainerArt string `xml:"containerArt"`
|
||||
} `xml:"contentItem"`
|
||||
} `xml:"recent"`
|
||||
type RecentsXML struct {
|
||||
XMLName xml.Name `xml:"recents"`
|
||||
Recents []models.ServiceRecent `xml:"recent"`
|
||||
}
|
||||
|
||||
var recentsWrap RecentsXML
|
||||
|
||||
if err := xml.Unmarshal(data, &recentsWrap); err != nil {
|
||||
return nil, fmt.Errorf("malformed recents XML at %s: %w", path, err)
|
||||
}
|
||||
|
||||
recents := []models.ServiceRecent{}
|
||||
recents := recentsWrap.Recents
|
||||
maxID := 0
|
||||
|
||||
for i := range recentsWrap.Recents {
|
||||
r := &recentsWrap.Recents[i]
|
||||
recents = append(recents, models.ServiceRecent{
|
||||
ServiceContentItem: models.ServiceContentItem{
|
||||
ID: r.ID,
|
||||
Name: r.ContentItem.ItemName,
|
||||
Source: r.ContentItem.Source,
|
||||
Type: r.ContentItem.Type,
|
||||
Location: r.ContentItem.Location,
|
||||
SourceAccount: r.ContentItem.SourceAccount,
|
||||
IsPresetable: r.ContentItem.IsPresetable,
|
||||
},
|
||||
DeviceID: r.DeviceID,
|
||||
UtcTime: r.UtcTime,
|
||||
ContainerArt: r.ContentItem.ContainerArt,
|
||||
})
|
||||
for i := range recents {
|
||||
r := &recents[i]
|
||||
if id, err := strconv.Atoi(r.ID); err == nil {
|
||||
if id > maxID {
|
||||
maxID = id
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
for i := range recents {
|
||||
r := &recents[i]
|
||||
if r.ContentItemType == "" {
|
||||
r.ContentItemType = r.Type
|
||||
}
|
||||
|
||||
if _, err := strconv.Atoi(recents[i].ID); err != nil || recents[i].ID == "" {
|
||||
maxID++
|
||||
recents[i].ID = strconv.Itoa(maxID)
|
||||
}
|
||||
}
|
||||
|
||||
return recents, nil
|
||||
@@ -418,54 +616,21 @@ func (ds *DataStore) GetRecents(account, device string) ([]models.ServiceRecent,
|
||||
|
||||
// SaveRecents saves the recent items list for the specified account and device.
|
||||
func (ds *DataStore) SaveRecents(account, device string, recents []models.ServiceRecent) error {
|
||||
ds.fileMutex.Lock()
|
||||
defer ds.fileMutex.Unlock()
|
||||
|
||||
path := filepath.Join(ds.AccountDeviceDir(account, device), constants.RecentsFile)
|
||||
|
||||
type RecentXML struct {
|
||||
ID string `xml:"id,attr"`
|
||||
DeviceID string `xml:"deviceID,attr"`
|
||||
UtcTime string `xml:"utcTime,attr"`
|
||||
ContentItem struct {
|
||||
Source string `xml:"source,attr,omitempty"`
|
||||
Type string `xml:"type,attr"`
|
||||
Location string `xml:"location,attr"`
|
||||
SourceAccount string `xml:"sourceAccount,attr,omitempty"`
|
||||
IsPresetable string `xml:"isPresetable,attr"`
|
||||
ItemName string `xml:"itemName"`
|
||||
ContainerArt string `xml:"containerArt"`
|
||||
} `xml:"contentItem"`
|
||||
}
|
||||
|
||||
type RecentsXML struct {
|
||||
XMLName xml.Name `xml:"recents"`
|
||||
Recents []RecentXML `xml:"recent"`
|
||||
XMLName xml.Name `xml:"recents"`
|
||||
Recents []models.ServiceRecent `xml:"recent"`
|
||||
}
|
||||
|
||||
var rx RecentsXML
|
||||
|
||||
for i := range recents {
|
||||
r := &recents[i]
|
||||
|
||||
var rxml RecentXML
|
||||
|
||||
rxml.ID = r.ID
|
||||
rxml.DeviceID = r.DeviceID
|
||||
rxml.UtcTime = r.UtcTime
|
||||
rxml.ContentItem.Source = r.Source
|
||||
rxml.ContentItem.Type = r.Type
|
||||
rxml.ContentItem.Location = r.Location
|
||||
rxml.ContentItem.SourceAccount = r.SourceAccount
|
||||
|
||||
rxml.ContentItem.IsPresetable = r.IsPresetable
|
||||
if rxml.ContentItem.IsPresetable == "" {
|
||||
rxml.ContentItem.IsPresetable = "true"
|
||||
}
|
||||
|
||||
rxml.ContentItem.ItemName = r.Name
|
||||
rxml.ContentItem.ContainerArt = r.ContainerArt
|
||||
rx.Recents = append(rx.Recents, rxml)
|
||||
wrap := RecentsXML{
|
||||
Recents: recents,
|
||||
}
|
||||
|
||||
data, err := xml.MarshalIndent(rx, "", " ")
|
||||
data, err := xml.MarshalIndent(wrap, "", " ")
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
@@ -477,10 +642,49 @@ func (ds *DataStore) SaveRecents(account, device string, recents []models.Servic
|
||||
|
||||
// SaveDeviceInfo saves device information for the specified account and device.
|
||||
func (ds *DataStore) SaveDeviceInfo(account, device string, info *models.ServiceDeviceInfo) error {
|
||||
ds.fileMutex.Lock()
|
||||
defer ds.fileMutex.Unlock()
|
||||
|
||||
if device == "" {
|
||||
return fmt.Errorf("device ID/name cannot be empty")
|
||||
}
|
||||
|
||||
// Try to load existing device info to avoid overwriting existing details with empty values.
|
||||
existing, _ := ds.getDeviceInfoNoLock(account, device)
|
||||
if existing != nil {
|
||||
if info.Name == "" {
|
||||
info.Name = existing.Name
|
||||
}
|
||||
|
||||
if info.ProductCode == "" {
|
||||
info.ProductCode = existing.ProductCode
|
||||
}
|
||||
|
||||
if info.DeviceSerialNumber == "" {
|
||||
info.DeviceSerialNumber = existing.DeviceSerialNumber
|
||||
}
|
||||
|
||||
if info.ProductSerialNumber == "" {
|
||||
info.ProductSerialNumber = existing.ProductSerialNumber
|
||||
}
|
||||
|
||||
if info.FirmwareVersion == "" {
|
||||
info.FirmwareVersion = existing.FirmwareVersion
|
||||
}
|
||||
|
||||
if info.IPAddress == "" {
|
||||
info.IPAddress = existing.IPAddress
|
||||
}
|
||||
|
||||
if info.MacAddress == "" {
|
||||
info.MacAddress = existing.MacAddress
|
||||
}
|
||||
|
||||
if info.DiscoveryMethod == "" {
|
||||
info.DiscoveryMethod = existing.DiscoveryMethod
|
||||
}
|
||||
}
|
||||
|
||||
dir := ds.AccountDeviceDir(account, device)
|
||||
if err := os.MkdirAll(dir, 0755); err != nil {
|
||||
return err
|
||||
@@ -495,8 +699,9 @@ func (ds *DataStore) SaveDeviceInfo(account, device string, info *models.Service
|
||||
}
|
||||
|
||||
type NetworkInfoXML struct {
|
||||
Type string `xml:"type,attr"`
|
||||
IPAddress string `xml:"ipAddress"`
|
||||
Type string `xml:"type,attr"`
|
||||
IPAddress string `xml:"ipAddress"`
|
||||
MacAddress string `xml:"macAddress"`
|
||||
}
|
||||
|
||||
type InfoXML struct {
|
||||
@@ -542,8 +747,9 @@ func (ds *DataStore) SaveDeviceInfo(account, device string, info *models.Service
|
||||
},
|
||||
NetworkInfo: []NetworkInfoXML{
|
||||
{
|
||||
Type: "SCM",
|
||||
IPAddress: info.IPAddress,
|
||||
Type: "SCM",
|
||||
IPAddress: info.IPAddress,
|
||||
MacAddress: info.MacAddress,
|
||||
},
|
||||
},
|
||||
DiscoveryMethod: info.DiscoveryMethod,
|
||||
@@ -561,12 +767,24 @@ func (ds *DataStore) SaveDeviceInfo(account, device string, info *models.Service
|
||||
|
||||
// RemoveDevice removes a device and all its data from the specified account.
|
||||
func (ds *DataStore) RemoveDevice(account, device string) error {
|
||||
ds.fileMutex.Lock()
|
||||
defer ds.fileMutex.Unlock()
|
||||
|
||||
dir := ds.AccountDeviceDir(account, device)
|
||||
|
||||
return os.RemoveAll(dir)
|
||||
}
|
||||
|
||||
// RemoveDeviceDir is an alias for RemoveDevice for backwards compatibility.
|
||||
func (ds *DataStore) RemoveDeviceDir(account, device string) error {
|
||||
return ds.RemoveDevice(account, device)
|
||||
}
|
||||
|
||||
// GetConfiguredSources retrieves all configured sources for the specified account and device.
|
||||
func (ds *DataStore) GetConfiguredSources(account, device string) ([]models.ConfiguredSource, error) {
|
||||
ds.fileMutex.RLock()
|
||||
defer ds.fileMutex.RUnlock()
|
||||
|
||||
path := filepath.Join(ds.AccountDeviceDir(account, device), constants.SourcesFile)
|
||||
|
||||
data, err := os.ReadFile(path)
|
||||
@@ -582,11 +800,24 @@ func (ds *DataStore) GetConfiguredSources(account, device string) ([]models.Conf
|
||||
return nil, fmt.Errorf("malformed sources XML at %s: %w", path, err)
|
||||
}
|
||||
|
||||
// Helper struct for unmarshaling with displayName
|
||||
var sourcesWithDisplayName struct {
|
||||
Sources []struct {
|
||||
DisplayName string `xml:"displayName,attr"`
|
||||
} `xml:"source"`
|
||||
}
|
||||
|
||||
_ = xml.Unmarshal(data, &sourcesWithDisplayName)
|
||||
|
||||
for i := range sourcesWrap.Sources {
|
||||
s := &sourcesWrap.Sources[i]
|
||||
if s.ID == "" {
|
||||
s.ID = strconv.Itoa(100001 + i)
|
||||
}
|
||||
|
||||
if s.DisplayName == "" && i < len(sourcesWithDisplayName.Sources) {
|
||||
s.DisplayName = sourcesWithDisplayName.Sources[i].DisplayName
|
||||
}
|
||||
// Sync legacy fields
|
||||
s.SourceKeyType = s.SourceKey.Type
|
||||
s.SourceKeyAccount = s.SourceKey.Account
|
||||
@@ -597,6 +828,9 @@ func (ds *DataStore) GetConfiguredSources(account, device string) ([]models.Conf
|
||||
|
||||
// SaveConfiguredSources saves the configured sources list for the specified account and device.
|
||||
func (ds *DataStore) SaveConfiguredSources(account, device string, sources []models.ConfiguredSource) error {
|
||||
ds.fileMutex.Lock()
|
||||
defer ds.fileMutex.Unlock()
|
||||
|
||||
path := filepath.Join(ds.AccountDeviceDir(account, device), constants.SourcesFile)
|
||||
if err := os.MkdirAll(filepath.Dir(path), 0755); err != nil {
|
||||
return err
|
||||
@@ -633,14 +867,102 @@ func (ds *DataStore) SaveConfiguredSources(account, device string, sources []mod
|
||||
return os.WriteFile(path, append(header, data...), 0644)
|
||||
}
|
||||
|
||||
// Initialize creates the necessary directory structure for the datastore.
|
||||
// updateDeviceMappings creates bidirectional mappings for device resolution
|
||||
func (ds *DataStore) updateDeviceMappings(info models.ServiceDeviceInfo) {
|
||||
ds.idMutex.Lock()
|
||||
defer ds.idMutex.Unlock()
|
||||
|
||||
deviceID := info.DeviceID
|
||||
macAddress := info.MacAddress
|
||||
deviceSerial := info.DeviceSerialNumber
|
||||
|
||||
// If device is stored with MAC as deviceID and has a serial, create backward mapping
|
||||
if isMACAddressFormat(deviceID) && deviceSerial != "" && deviceSerial != deviceID {
|
||||
ds.deviceMappings[deviceSerial] = deviceID
|
||||
}
|
||||
|
||||
// If device is stored with serial as deviceID and has a MAC, create forward mapping
|
||||
if !isMACAddressFormat(deviceID) && macAddress != "" {
|
||||
ds.deviceMappings[macAddress] = deviceID
|
||||
// Also store normalized MAC version
|
||||
normalizedMAC := normalizeMAC(macAddress)
|
||||
if normalizedMAC != macAddress {
|
||||
ds.deviceMappings[normalizedMAC] = deviceID
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// UpdateMapping maintains backward compatibility for external callers
|
||||
func (ds *DataStore) UpdateMapping(mac, serial string) {
|
||||
if mac == "" || serial == "" {
|
||||
return
|
||||
}
|
||||
|
||||
ds.idMutex.Lock()
|
||||
defer ds.idMutex.Unlock()
|
||||
|
||||
// In the new system, MAC addresses are preferred as deviceIDs
|
||||
// So map the serial TO the MAC (reverse of old system)
|
||||
ds.deviceMappings[serial] = mac
|
||||
|
||||
// Also map MAC to serial for any remaining legacy code
|
||||
ds.deviceMappings[mac] = serial
|
||||
|
||||
normalizedMAC := normalizeMAC(mac)
|
||||
if normalizedMAC != mac {
|
||||
ds.deviceMappings[normalizedMAC] = serial
|
||||
}
|
||||
}
|
||||
|
||||
// isMACAddressFormat checks if a string looks like a MAC address
|
||||
func isMACAddressFormat(s string) bool {
|
||||
// AABBCCDDEEFF format
|
||||
if len(s) == 12 {
|
||||
return isHexOnly(s)
|
||||
}
|
||||
|
||||
// AA:BB:CC:DD:EE:FF or AA-BB-CC-DD-EE-FF format
|
||||
if len(s) == 17 && (strings.Contains(s, ":") || strings.Contains(s, "-")) {
|
||||
s = strings.ReplaceAll(s, "-", ":")
|
||||
|
||||
parts := strings.Split(s, ":")
|
||||
if len(parts) != 6 {
|
||||
return false
|
||||
}
|
||||
|
||||
for _, part := range parts {
|
||||
if len(part) != 2 || !isHexOnly(part) {
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
func isHexOnly(s string) bool {
|
||||
for _, r := range s {
|
||||
if (r < '0' || r > '9') && (r < 'A' || r > 'F') && (r < 'a' || r > 'f') {
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
// Initialize creates the necessary directory structure for the datastore and populates ID mappings.
|
||||
func (ds *DataStore) Initialize() error {
|
||||
// Ensure base data directory exists
|
||||
if err := os.MkdirAll(ds.DataDir, 0755); err != nil {
|
||||
return fmt.Errorf("failed to create data directory: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
// Scan for devices to populate MAC to Serial mapping
|
||||
_, err := ds.ListAllDevices()
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
// GetETagForPresets returns the ETag (modification time) for the presets file for a specific device.
|
||||
@@ -699,19 +1021,21 @@ func (ds *DataStore) GetETagForAccount(account, device string) int64 {
|
||||
|
||||
// Settings represents the global service settings.
|
||||
type Settings struct {
|
||||
ServerURL string `json:"server_url"`
|
||||
SoundcorkURL string `json:"soundcork_url"`
|
||||
HTTPServerURL string `json:"https_server_url,omitempty"`
|
||||
RedactLogs bool `json:"redact_logs"`
|
||||
LogBodies bool `json:"log_bodies"`
|
||||
RecordInteractions bool `json:"record_interactions"`
|
||||
DiscoveryInterval string `json:"discovery_interval,omitempty"`
|
||||
DiscoveryEnabled bool `json:"discovery_enabled"`
|
||||
EnableSoundcorkProxy bool `json:"enable_soundcork_proxy"`
|
||||
DNSEnabled bool `json:"dns_enabled"`
|
||||
DNSUpstream string `json:"dns_upstream,omitempty"`
|
||||
DNSBindAddr string `json:"dns_bind_addr,omitempty"`
|
||||
Shortcuts map[string]int `json:"shortcuts,omitempty"`
|
||||
ServerURL string `json:"server_url"`
|
||||
HTTPServerURL string `json:"https_server_url,omitempty"`
|
||||
RedactLogs bool `json:"redact_logs"`
|
||||
LogBodies bool `json:"log_bodies"`
|
||||
RecordInteractions bool `json:"record_interactions"`
|
||||
DiscoveryInterval string `json:"discovery_interval,omitempty"`
|
||||
DiscoveryEnabled bool `json:"discovery_enabled"`
|
||||
DNSEnabled bool `json:"dns_enabled"`
|
||||
DNSUpstream []string `json:"dns_upstream,omitempty"`
|
||||
DNSBindAddr string `json:"dns_bind_addr,omitempty"`
|
||||
MirrorEnabled bool `json:"mirror_enabled"`
|
||||
MirrorEndpoints []string `json:"mirror_endpoints,omitempty"`
|
||||
PreferredSource string `json:"preferred_source,omitempty"`
|
||||
InternalPaths []string `json:"internal_paths,omitempty"`
|
||||
Shortcuts map[string]int `json:"shortcuts,omitempty"`
|
||||
}
|
||||
|
||||
// GetSettings retrieves the global service settings.
|
||||
|
||||
@@ -148,7 +148,7 @@ func TestListAllDevices(t *testing.T) {
|
||||
info := &models.ServiceDeviceInfo{
|
||||
DeviceID: deviceID,
|
||||
Name: "Test Speaker",
|
||||
IPAddress: "192.168.178.28",
|
||||
IPAddress: "192.168.1.100",
|
||||
DeviceSerialNumber: deviceID,
|
||||
ProductCode: "SoundTouch 10",
|
||||
FirmwareVersion: "1.2.3",
|
||||
@@ -382,7 +382,6 @@ func TestSettingsPersistence(t *testing.T) {
|
||||
|
||||
settings := Settings{
|
||||
ServerURL: "http://myserver:8000",
|
||||
SoundcorkURL: "http://myproxy:8001",
|
||||
LogBodies: true,
|
||||
DiscoveryInterval: "10m",
|
||||
DiscoveryEnabled: true,
|
||||
|
||||
@@ -0,0 +1,64 @@
|
||||
package datastore
|
||||
|
||||
import (
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/models"
|
||||
)
|
||||
|
||||
func TestSaveDeviceInfo_MergesName(t *testing.T) {
|
||||
tempDir, err := os.MkdirTemp("", "datastore-test")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create temp dir: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tempDir)
|
||||
|
||||
ds := NewDataStore(tempDir)
|
||||
account := "3230304"
|
||||
device := "A81B6A536A98"
|
||||
|
||||
// 1. Initial save with name
|
||||
info1 := &models.ServiceDeviceInfo{
|
||||
DeviceID: device,
|
||||
AccountID: account,
|
||||
Name: "Living Room",
|
||||
ProductCode: "SoundTouch 20",
|
||||
}
|
||||
if err := ds.SaveDeviceInfo(account, device, info1); err != nil {
|
||||
t.Fatalf("First SaveDeviceInfo failed: %v", err)
|
||||
}
|
||||
|
||||
// 2. Verify name is saved
|
||||
saved1, err := ds.GetDeviceInfo(account, device)
|
||||
if err != nil {
|
||||
t.Fatalf("First GetDeviceInfo failed: %v", err)
|
||||
}
|
||||
if saved1.Name != "Living Room" {
|
||||
t.Errorf("Expected name 'Living Room', got '%s'", saved1.Name)
|
||||
}
|
||||
|
||||
// 3. Save with empty name (simulating power_on)
|
||||
info2 := &models.ServiceDeviceInfo{
|
||||
DeviceID: device,
|
||||
AccountID: account,
|
||||
Name: "",
|
||||
ProductCode: "SoundTouch 20",
|
||||
IPAddress: "192.168.1.100",
|
||||
}
|
||||
if err := ds.SaveDeviceInfo(account, device, info2); err != nil {
|
||||
t.Fatalf("Second SaveDeviceInfo failed: %v", err)
|
||||
}
|
||||
|
||||
// 4. Verify name is preserved
|
||||
saved2, err := ds.GetDeviceInfo(account, device)
|
||||
if err != nil {
|
||||
t.Fatalf("Second GetDeviceInfo failed: %v", err)
|
||||
}
|
||||
if saved2.Name != "Living Room" {
|
||||
t.Errorf("Expected name 'Living Room' to be preserved, but got '%s'", saved2.Name)
|
||||
}
|
||||
if saved2.IPAddress != "192.168.1.100" {
|
||||
t.Errorf("Expected IPAddress '192.168.1.100', got '%s'", saved2.IPAddress)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,235 @@
|
||||
package datastore
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/models"
|
||||
)
|
||||
|
||||
func TestMacAddressSerialization(t *testing.T) {
|
||||
tempDir, err := os.MkdirTemp("", "mac-serialization-test-*")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.RemoveAll(tempDir)
|
||||
|
||||
ds := NewDataStore(tempDir)
|
||||
account := "3230304"
|
||||
device := "I6332527703739342000020"
|
||||
macAddress := "A81B6A536A98"
|
||||
|
||||
// Create device info with MAC address
|
||||
info := &models.ServiceDeviceInfo{
|
||||
DeviceID: device,
|
||||
Name: "Test SoundTouch",
|
||||
ProductCode: "SoundTouch 10",
|
||||
IPAddress: "192.168.1.100",
|
||||
MacAddress: macAddress,
|
||||
DeviceSerialNumber: device,
|
||||
ProductSerialNumber: "PROD123456",
|
||||
FirmwareVersion: "4.8.1.23456",
|
||||
DiscoveryMethod: "UPnP",
|
||||
}
|
||||
|
||||
// Save device info
|
||||
err = ds.SaveDeviceInfo(account, device, info)
|
||||
if err != nil {
|
||||
t.Fatalf("SaveDeviceInfo failed: %v", err)
|
||||
}
|
||||
|
||||
// Verify the XML file was created
|
||||
deviceInfoPath := filepath.Join(ds.AccountDeviceDir(account, device), "DeviceInfo.xml")
|
||||
if _, err := os.Stat(deviceInfoPath); err != nil {
|
||||
t.Fatalf("DeviceInfo.xml not created: %v", err)
|
||||
}
|
||||
|
||||
// Read back the device info
|
||||
loadedInfo, err := ds.GetDeviceInfo(account, device)
|
||||
if err != nil {
|
||||
t.Fatalf("GetDeviceInfo failed: %v", err)
|
||||
}
|
||||
|
||||
// Verify MAC address is preserved
|
||||
if loadedInfo.MacAddress != macAddress {
|
||||
t.Errorf("MAC address not preserved. Expected: '%s', Got: '%s'", macAddress, loadedInfo.MacAddress)
|
||||
}
|
||||
|
||||
// Verify other fields are also correct
|
||||
if loadedInfo.DeviceID != device {
|
||||
t.Errorf("DeviceID mismatch. Expected: %s, Got: %s", device, loadedInfo.DeviceID)
|
||||
}
|
||||
|
||||
if loadedInfo.IPAddress != "192.168.1.100" {
|
||||
t.Errorf("IPAddress mismatch. Expected: 192.168.1.100, Got: %s", loadedInfo.IPAddress)
|
||||
}
|
||||
|
||||
// Initialize datastore to populate MAC mappings
|
||||
err = ds.Initialize()
|
||||
if err != nil {
|
||||
t.Fatalf("Initialize failed: %v", err)
|
||||
}
|
||||
|
||||
// Test that MAC address mapping works
|
||||
resolvedPath := ds.AccountDeviceDir(account, macAddress)
|
||||
expectedPath := ds.AccountDeviceDir(account, device)
|
||||
|
||||
if resolvedPath != expectedPath {
|
||||
t.Errorf("MAC address mapping failed. MAC '%s' resolved to '%s', expected '%s'",
|
||||
macAddress, resolvedPath, expectedPath)
|
||||
}
|
||||
|
||||
// Test that Sources.xml path resolves correctly via MAC address
|
||||
// (We don't need to actually read the file, just verify the path resolution works)
|
||||
macPath := ds.AccountDeviceDir(account, macAddress)
|
||||
devicePath := ds.AccountDeviceDir(account, device)
|
||||
|
||||
if macPath != devicePath {
|
||||
t.Errorf("MAC address path resolution failed. MAC path: %s, Device path: %s", macPath, devicePath)
|
||||
}
|
||||
|
||||
t.Logf("✅ MAC address serialization working correctly")
|
||||
t.Logf(" - MAC address '%s' saved to DeviceInfo.xml", macAddress)
|
||||
t.Logf(" - MAC address '%s' loaded from DeviceInfo.xml", loadedInfo.MacAddress)
|
||||
t.Logf(" - MAC mapping: '%s' -> '%s'", macAddress, device)
|
||||
t.Logf(" - Sources.xml accessible via MAC address")
|
||||
}
|
||||
|
||||
func TestMacAddressSerializationEdgeCases(t *testing.T) {
|
||||
tempDir, err := os.MkdirTemp("", "mac-edge-cases-test-*")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.RemoveAll(tempDir)
|
||||
|
||||
ds := NewDataStore(tempDir)
|
||||
account := "testaccount"
|
||||
device := "testdevice"
|
||||
|
||||
testCases := []struct {
|
||||
name string
|
||||
macAddress string
|
||||
expected string
|
||||
}{
|
||||
{"uppercase", "A81B6A536A98", "A81B6A536A98"},
|
||||
{"lowercase", "a81b6a536a98", "a81b6a536a98"},
|
||||
{"with_colons", "A8:1B:6A:53:6A:98", "A8:1B:6A:53:6A:98"},
|
||||
{"with_dashes", "A8-1B-6A-53-6A-98", "A8-1B-6A-53-6A-98"},
|
||||
{"empty", "", ""},
|
||||
}
|
||||
|
||||
for _, tc := range testCases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
deviceID := device + "_" + tc.name
|
||||
|
||||
info := &models.ServiceDeviceInfo{
|
||||
DeviceID: deviceID,
|
||||
Name: "Test Device " + tc.name,
|
||||
ProductCode: "SoundTouch 10",
|
||||
IPAddress: "192.168.1.100",
|
||||
MacAddress: tc.macAddress,
|
||||
DeviceSerialNumber: deviceID,
|
||||
}
|
||||
|
||||
// Save and load
|
||||
err := ds.SaveDeviceInfo(account, deviceID, info)
|
||||
if err != nil {
|
||||
t.Fatalf("SaveDeviceInfo failed for %s: %v", tc.name, err)
|
||||
}
|
||||
|
||||
loadedInfo, err := ds.GetDeviceInfo(account, deviceID)
|
||||
if err != nil {
|
||||
t.Fatalf("GetDeviceInfo failed for %s: %v", tc.name, err)
|
||||
}
|
||||
|
||||
if loadedInfo.MacAddress != tc.expected {
|
||||
t.Errorf("MAC address mismatch for %s. Expected: '%s', Got: '%s'",
|
||||
tc.name, tc.expected, loadedInfo.MacAddress)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestExistingDeviceInfoUpdate(t *testing.T) {
|
||||
tempDir, err := os.MkdirTemp("", "device-update-test-*")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.RemoveAll(tempDir)
|
||||
|
||||
ds := NewDataStore(tempDir)
|
||||
account := "3230304"
|
||||
device := "I6332527703739342000020"
|
||||
|
||||
// First save without MAC address (simulating old DeviceInfo.xml)
|
||||
infoWithoutMAC := &models.ServiceDeviceInfo{
|
||||
DeviceID: device,
|
||||
Name: "Test SoundTouch",
|
||||
ProductCode: "SoundTouch 10",
|
||||
IPAddress: "192.168.1.100",
|
||||
MacAddress: "", // No MAC address initially
|
||||
DeviceSerialNumber: device,
|
||||
}
|
||||
|
||||
err = ds.SaveDeviceInfo(account, device, infoWithoutMAC)
|
||||
if err != nil {
|
||||
t.Fatalf("Initial SaveDeviceInfo failed: %v", err)
|
||||
}
|
||||
|
||||
// Verify no MAC address initially
|
||||
loadedInfo1, err := ds.GetDeviceInfo(account, device)
|
||||
if err != nil {
|
||||
t.Fatalf("Initial GetDeviceInfo failed: %v", err)
|
||||
}
|
||||
|
||||
if loadedInfo1.MacAddress != "" {
|
||||
t.Errorf("Expected empty MAC address, got '%s'", loadedInfo1.MacAddress)
|
||||
}
|
||||
|
||||
// Now update with MAC address (simulating discovery update)
|
||||
macAddress := "A81B6A536A98"
|
||||
infoWithMAC := &models.ServiceDeviceInfo{
|
||||
DeviceID: device,
|
||||
Name: "Test SoundTouch",
|
||||
ProductCode: "SoundTouch 10",
|
||||
IPAddress: "192.168.1.100",
|
||||
MacAddress: macAddress,
|
||||
DeviceSerialNumber: device,
|
||||
}
|
||||
|
||||
err = ds.SaveDeviceInfo(account, device, infoWithMAC)
|
||||
if err != nil {
|
||||
t.Fatalf("Update SaveDeviceInfo failed: %v", err)
|
||||
}
|
||||
|
||||
// Verify MAC address is now present
|
||||
loadedInfo2, err := ds.GetDeviceInfo(account, device)
|
||||
if err != nil {
|
||||
t.Fatalf("Updated GetDeviceInfo failed: %v", err)
|
||||
}
|
||||
|
||||
if loadedInfo2.MacAddress != macAddress {
|
||||
t.Errorf("MAC address not updated. Expected: '%s', Got: '%s'", macAddress, loadedInfo2.MacAddress)
|
||||
}
|
||||
|
||||
// Initialize to test mapping
|
||||
err = ds.Initialize()
|
||||
if err != nil {
|
||||
t.Fatalf("Initialize failed: %v", err)
|
||||
}
|
||||
|
||||
// Test that MAC mapping now works
|
||||
resolvedPath := ds.AccountDeviceDir(account, macAddress)
|
||||
expectedPath := ds.AccountDeviceDir(account, device)
|
||||
|
||||
if resolvedPath != expectedPath {
|
||||
t.Errorf("MAC mapping failed after update. MAC '%s' resolved to '%s', expected '%s'",
|
||||
macAddress, resolvedPath, expectedPath)
|
||||
}
|
||||
|
||||
t.Logf("✅ DeviceInfo.xml update with MAC address working correctly")
|
||||
t.Logf(" - Initial: no MAC address")
|
||||
t.Logf(" - Updated: MAC address '%s' added", macAddress)
|
||||
t.Logf(" - Mapping: '%s' -> '%s'", macAddress, device)
|
||||
}
|
||||
@@ -0,0 +1,368 @@
|
||||
package datastore
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/models"
|
||||
)
|
||||
|
||||
func TestAccountDeviceDir_MACFirstResolution(t *testing.T) {
|
||||
tempDir, err := os.MkdirTemp("", "mac-first-test-*")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.RemoveAll(tempDir)
|
||||
|
||||
ds := NewDataStore(tempDir)
|
||||
accountID := "testaccount"
|
||||
macAddress := "A81B6A536A98"
|
||||
serialNumber := "I6332527703739342000020"
|
||||
|
||||
t.Run("NewMACBasedDevice", func(t *testing.T) {
|
||||
// Create a new device with MAC as deviceID
|
||||
deviceInfo := &models.ServiceDeviceInfo{
|
||||
DeviceID: macAddress,
|
||||
AccountID: accountID,
|
||||
Name: "New MAC Device",
|
||||
IPAddress: "192.168.1.100",
|
||||
MacAddress: macAddress,
|
||||
DeviceSerialNumber: serialNumber,
|
||||
ProductCode: "SoundTouch 10 sm2",
|
||||
}
|
||||
|
||||
// Save the device
|
||||
if err := ds.SaveDeviceInfo(accountID, macAddress, deviceInfo); err != nil {
|
||||
t.Fatalf("Failed to save MAC-based device: %v", err)
|
||||
}
|
||||
|
||||
// Test AccountDeviceDir resolution
|
||||
resolvedDir := ds.AccountDeviceDir(accountID, macAddress)
|
||||
expectedDir := filepath.Join(tempDir, "accounts", accountID, "devices", macAddress)
|
||||
|
||||
if resolvedDir != expectedDir {
|
||||
t.Errorf("Expected MAC-based device dir '%s', got '%s'", expectedDir, resolvedDir)
|
||||
}
|
||||
|
||||
// Verify the directory actually exists
|
||||
if _, err := os.Stat(resolvedDir); os.IsNotExist(err) {
|
||||
t.Errorf("MAC-based device directory should exist: %s", resolvedDir)
|
||||
}
|
||||
|
||||
t.Logf("✅ MAC-based device correctly resolved to: %s", resolvedDir)
|
||||
})
|
||||
|
||||
t.Run("LegacySerialBasedDevice", func(t *testing.T) {
|
||||
// Create a legacy device with serial as deviceID (simulating old storage)
|
||||
legacyInfo := &models.ServiceDeviceInfo{
|
||||
DeviceID: serialNumber,
|
||||
AccountID: accountID,
|
||||
Name: "Legacy Serial Device",
|
||||
IPAddress: "192.168.1.101",
|
||||
MacAddress: macAddress,
|
||||
DeviceSerialNumber: serialNumber,
|
||||
ProductCode: "SoundTouch 10",
|
||||
}
|
||||
|
||||
// Save the legacy device
|
||||
if err := ds.SaveDeviceInfo(accountID, serialNumber, legacyInfo); err != nil {
|
||||
t.Fatalf("Failed to save legacy device: %v", err)
|
||||
}
|
||||
|
||||
// Initialize to populate mappings
|
||||
if err := ds.Initialize(); err != nil {
|
||||
t.Fatalf("Failed to initialize datastore: %v", err)
|
||||
}
|
||||
|
||||
// Test resolution by MAC address (should find the legacy device via mapping)
|
||||
resolvedDir := ds.AccountDeviceDir(accountID, macAddress)
|
||||
expectedLegacyDir := filepath.Join(tempDir, "accounts", accountID, "devices", serialNumber)
|
||||
|
||||
// Since both MAC and serial devices exist, MAC device should take priority
|
||||
expectedMACDir := filepath.Join(tempDir, "accounts", accountID, "devices", macAddress)
|
||||
if resolvedDir != expectedMACDir {
|
||||
t.Errorf("Expected MAC device to take priority. Got '%s', expected '%s'", resolvedDir, expectedMACDir)
|
||||
}
|
||||
|
||||
t.Logf("✅ MAC address resolution correctly prioritized MAC-based device")
|
||||
|
||||
// Test resolution by serial number (should find the legacy device directly)
|
||||
serialResolvedDir := ds.AccountDeviceDir(accountID, serialNumber)
|
||||
if serialResolvedDir != expectedLegacyDir {
|
||||
t.Errorf("Expected serial-based device dir '%s', got '%s'", expectedLegacyDir, serialResolvedDir)
|
||||
}
|
||||
|
||||
t.Logf("✅ Serial number correctly resolved to legacy device: %s", serialResolvedDir)
|
||||
})
|
||||
|
||||
t.Run("MACResolutionWithOnlyLegacyDevice", func(t *testing.T) {
|
||||
// Create a fresh datastore
|
||||
tempDir2, err := os.MkdirTemp("", "mac-legacy-only-*")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.RemoveAll(tempDir2)
|
||||
|
||||
ds2 := NewDataStore(tempDir2)
|
||||
testAccount := "legacyaccount"
|
||||
testSerial := "LEGACY123456789"
|
||||
testMAC := "BB:CC:DD:EE:FF:00"
|
||||
|
||||
// Create ONLY a legacy device (no MAC-based device)
|
||||
legacyInfo := &models.ServiceDeviceInfo{
|
||||
DeviceID: testSerial,
|
||||
AccountID: testAccount,
|
||||
Name: "Only Legacy Device",
|
||||
MacAddress: testMAC,
|
||||
DeviceSerialNumber: testSerial,
|
||||
}
|
||||
|
||||
if err := ds2.SaveDeviceInfo(testAccount, testSerial, legacyInfo); err != nil {
|
||||
t.Fatalf("Failed to save legacy-only device: %v", err)
|
||||
}
|
||||
|
||||
// Initialize to populate mappings
|
||||
if err := ds2.Initialize(); err != nil {
|
||||
t.Fatalf("Failed to initialize datastore: %v", err)
|
||||
}
|
||||
|
||||
// Test MAC resolution (should find the legacy device via mapping)
|
||||
resolvedDir := ds2.AccountDeviceDir(testAccount, testMAC)
|
||||
expectedDir := filepath.Join(tempDir2, "accounts", testAccount, "devices", testSerial)
|
||||
|
||||
if resolvedDir != expectedDir {
|
||||
t.Errorf("MAC '%s' should resolve to legacy device '%s', got '%s'", testMAC, expectedDir, resolvedDir)
|
||||
}
|
||||
|
||||
t.Logf("✅ MAC address correctly resolved to legacy device when no MAC-based device exists")
|
||||
})
|
||||
|
||||
t.Run("NonExistentDevice", func(t *testing.T) {
|
||||
unknownMAC := "FF:FF:FF:FF:FF:FF"
|
||||
resolvedDir := ds.AccountDeviceDir(accountID, unknownMAC)
|
||||
expectedDir := filepath.Join(tempDir, "accounts", accountID, "devices", unknownMAC)
|
||||
|
||||
if resolvedDir != expectedDir {
|
||||
t.Errorf("Non-existent device should resolve to direct path '%s', got '%s'", expectedDir, resolvedDir)
|
||||
}
|
||||
|
||||
t.Logf("✅ Non-existent device correctly resolved to direct MAC path")
|
||||
})
|
||||
|
||||
t.Run("MACNormalization", func(t *testing.T) {
|
||||
// Test different MAC address formats
|
||||
macFormats := []string{
|
||||
"A81B6A536A98", // No separators
|
||||
"A8:1B:6A:53:6A:98", // Colons
|
||||
"A8-1B-6A-53-6A-98", // Dashes
|
||||
"a81b6a536a98", // Lowercase
|
||||
"a8:1b:6a:53:6a:98", // Lowercase with colons
|
||||
}
|
||||
|
||||
for _, macFormat := range macFormats {
|
||||
resolvedDir := ds.AccountDeviceDir(accountID, macFormat)
|
||||
// Should resolve to the MAC-based device we created earlier
|
||||
expectedDir := filepath.Join(tempDir, "accounts", accountID, "devices", macAddress)
|
||||
|
||||
if resolvedDir != expectedDir {
|
||||
t.Logf("MAC format '%s' resolved to '%s', expected '%s'", macFormat, resolvedDir, expectedDir)
|
||||
// For now, we'll log this - full normalization might require additional work
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("BackwardCompatibilityMapping", func(t *testing.T) {
|
||||
// Test that the legacy UpdateMapping method still works
|
||||
testMAC := "CC:DD:EE:FF:00:11"
|
||||
testSerial := "COMPAT789"
|
||||
|
||||
ds.UpdateMapping(testMAC, testSerial)
|
||||
|
||||
// After calling UpdateMapping, the MAC should resolve via the mapping
|
||||
resolvedDir := ds.AccountDeviceDir(accountID, testMAC)
|
||||
directPath := filepath.Join(tempDir, "accounts", accountID, "devices", testMAC)
|
||||
|
||||
// Since no actual device exists, it should return the direct path
|
||||
if resolvedDir != directPath {
|
||||
t.Errorf("UpdateMapping backward compatibility test failed. Got '%s', expected '%s'", resolvedDir, directPath)
|
||||
}
|
||||
|
||||
t.Logf("✅ UpdateMapping backward compatibility maintained")
|
||||
})
|
||||
}
|
||||
|
||||
func TestDeviceMappings_Bidirectional(t *testing.T) {
|
||||
tempDir, err := os.MkdirTemp("", "bidirectional-test-*")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.RemoveAll(tempDir)
|
||||
|
||||
ds := NewDataStore(tempDir)
|
||||
accountID := "testaccount"
|
||||
|
||||
t.Run("MACBasedDeviceCreatesSerialMapping", func(t *testing.T) {
|
||||
macAddress := "11:22:33:44:55:66"
|
||||
serialNumber := "NEWDEVICE123"
|
||||
|
||||
// Create MAC-based device
|
||||
deviceInfo := &models.ServiceDeviceInfo{
|
||||
DeviceID: macAddress,
|
||||
AccountID: accountID,
|
||||
Name: "MAC First Device",
|
||||
MacAddress: macAddress,
|
||||
DeviceSerialNumber: serialNumber,
|
||||
}
|
||||
|
||||
if err := ds.SaveDeviceInfo(accountID, macAddress, deviceInfo); err != nil {
|
||||
t.Fatalf("Failed to save MAC-based device: %v", err)
|
||||
}
|
||||
|
||||
// Initialize to populate mappings
|
||||
if err := ds.Initialize(); err != nil {
|
||||
t.Fatalf("Failed to initialize: %v", err)
|
||||
}
|
||||
|
||||
// Serial should resolve to the MAC-based device
|
||||
resolvedDir := ds.AccountDeviceDir(accountID, serialNumber)
|
||||
expectedDir := filepath.Join(tempDir, "accounts", accountID, "devices", macAddress)
|
||||
|
||||
if resolvedDir != expectedDir {
|
||||
t.Errorf("Serial '%s' should resolve to MAC device '%s', got '%s'", serialNumber, expectedDir, resolvedDir)
|
||||
}
|
||||
|
||||
t.Logf("✅ MAC-based device creates correct serial→MAC mapping")
|
||||
})
|
||||
|
||||
t.Run("SerialBasedDeviceCreatesMACMapping", func(t *testing.T) {
|
||||
macAddress := "77:88:99:AA:BB:CC"
|
||||
serialNumber := "SERIALDEVICE456"
|
||||
|
||||
// Create serial-based device (legacy)
|
||||
deviceInfo := &models.ServiceDeviceInfo{
|
||||
DeviceID: serialNumber,
|
||||
AccountID: accountID,
|
||||
Name: "Serial First Device",
|
||||
MacAddress: macAddress,
|
||||
DeviceSerialNumber: serialNumber,
|
||||
}
|
||||
|
||||
if err := ds.SaveDeviceInfo(accountID, serialNumber, deviceInfo); err != nil {
|
||||
t.Fatalf("Failed to save serial-based device: %v", err)
|
||||
}
|
||||
|
||||
// Initialize to populate mappings
|
||||
if err := ds.Initialize(); err != nil {
|
||||
t.Fatalf("Failed to initialize: %v", err)
|
||||
}
|
||||
|
||||
// MAC should resolve to the serial-based device
|
||||
resolvedDir := ds.AccountDeviceDir(accountID, macAddress)
|
||||
expectedDir := filepath.Join(tempDir, "accounts", accountID, "devices", serialNumber)
|
||||
|
||||
if resolvedDir != expectedDir {
|
||||
t.Errorf("MAC '%s' should resolve to serial device '%s', got '%s'", macAddress, expectedDir, resolvedDir)
|
||||
}
|
||||
|
||||
t.Logf("✅ Serial-based device creates correct MAC→serial mapping")
|
||||
})
|
||||
}
|
||||
|
||||
func TestMACAddressFormatDetection(t *testing.T) {
|
||||
testCases := []struct {
|
||||
input string
|
||||
expected bool
|
||||
name string
|
||||
}{
|
||||
{"A81B6A536A98", true, "12-char hex"},
|
||||
{"a81b6a536a98", true, "12-char hex lowercase"},
|
||||
{"A8:1B:6A:53:6A:98", true, "colon-separated"},
|
||||
{"A8-1B-6A-53-6A-98", true, "dash-separated"},
|
||||
{"a8:1b:6a:53:6a:98", true, "colon-separated lowercase"},
|
||||
{"a8-1b-6a-53-6a-98", true, "dash-separated lowercase"},
|
||||
{"I6332527703739342000020", false, "device serial"},
|
||||
{"192.168.1.100", false, "IP address"},
|
||||
{"ABCDEFGHIJKL", false, "12-char non-hex"},
|
||||
{"A8:1B:6A:53:6A", false, "incomplete MAC"},
|
||||
{"A8:1B:6A:53:6A:98:01", false, "too long MAC"},
|
||||
{"", false, "empty string"},
|
||||
}
|
||||
|
||||
for _, tc := range testCases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
result := isMACAddressFormat(tc.input)
|
||||
if result != tc.expected {
|
||||
t.Errorf("isMACAddressFormat('%s') = %v, expected %v", tc.input, result, tc.expected)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestAccountDeviceDir_PriorityOrder(t *testing.T) {
|
||||
tempDir, err := os.MkdirTemp("", "priority-test-*")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.RemoveAll(tempDir)
|
||||
|
||||
ds := NewDataStore(tempDir)
|
||||
accountID := "prioritytest"
|
||||
macAddress := "A8:1B:6A:53:6A:98"
|
||||
serialNumber := "PRIORITY123456789"
|
||||
|
||||
// Create both MAC-based and serial-based devices for the same physical device
|
||||
macDevice := &models.ServiceDeviceInfo{
|
||||
DeviceID: macAddress,
|
||||
AccountID: accountID,
|
||||
Name: "MAC Version",
|
||||
MacAddress: macAddress,
|
||||
DeviceSerialNumber: serialNumber,
|
||||
}
|
||||
|
||||
serialDevice := &models.ServiceDeviceInfo{
|
||||
DeviceID: serialNumber,
|
||||
AccountID: accountID,
|
||||
Name: "Serial Version",
|
||||
MacAddress: macAddress,
|
||||
DeviceSerialNumber: serialNumber,
|
||||
}
|
||||
|
||||
// Save both devices
|
||||
if err := ds.SaveDeviceInfo(accountID, macAddress, macDevice); err != nil {
|
||||
t.Fatalf("Failed to save MAC device: %v", err)
|
||||
}
|
||||
|
||||
if err := ds.SaveDeviceInfo(accountID, serialNumber, serialDevice); err != nil {
|
||||
t.Fatalf("Failed to save serial device: %v", err)
|
||||
}
|
||||
|
||||
// Initialize mappings
|
||||
if err := ds.Initialize(); err != nil {
|
||||
t.Fatalf("Failed to initialize: %v", err)
|
||||
}
|
||||
|
||||
// Test priority: MAC address should resolve to MAC-based device (not serial-based)
|
||||
resolvedDir := ds.AccountDeviceDir(accountID, macAddress)
|
||||
expectedMACDir := filepath.Join(tempDir, "accounts", accountID, "devices", macAddress)
|
||||
|
||||
if resolvedDir != expectedMACDir {
|
||||
t.Errorf("MAC address should resolve to MAC-based device directory")
|
||||
t.Errorf("Expected: %s", expectedMACDir)
|
||||
t.Errorf("Got: %s", resolvedDir)
|
||||
}
|
||||
|
||||
// Test that serial still resolves to its own device
|
||||
serialResolvedDir := ds.AccountDeviceDir(accountID, serialNumber)
|
||||
expectedSerialDir := filepath.Join(tempDir, "accounts", accountID, "devices", serialNumber)
|
||||
|
||||
if serialResolvedDir != expectedSerialDir {
|
||||
t.Errorf("Serial should resolve to serial-based device directory")
|
||||
t.Errorf("Expected: %s", expectedSerialDir)
|
||||
t.Errorf("Got: %s", serialResolvedDir)
|
||||
}
|
||||
|
||||
t.Logf("✅ Priority test passed:")
|
||||
t.Logf(" MAC '%s' → %s", macAddress, resolvedDir)
|
||||
t.Logf(" Serial '%s' → %s", serialNumber, serialResolvedDir)
|
||||
}
|
||||
@@ -0,0 +1,259 @@
|
||||
package datastore
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/service/constants"
|
||||
)
|
||||
|
||||
func TestMacMappingDiagnostic(t *testing.T) {
|
||||
// Test the exact scenario described in the issue
|
||||
tmpDir, err := os.MkdirTemp("", "mac-mapping-diagnostic")
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create temp dir: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tmpDir)
|
||||
|
||||
accountID := "3230304"
|
||||
serialNumber := "I6332527703739342000020"
|
||||
macAddress := "A81B6A536A98"
|
||||
|
||||
// Create the directory structure as it exists in production
|
||||
deviceDir := filepath.Join(tmpDir, "accounts", accountID, "devices", serialNumber)
|
||||
if err := os.MkdirAll(deviceDir, 0755); err != nil {
|
||||
t.Fatalf("failed to create device dir: %v", err)
|
||||
}
|
||||
|
||||
// Create DeviceInfo.xml with the MAC address
|
||||
deviceInfoXML := `<?xml version="1.0" encoding="UTF-8"?>
|
||||
<info deviceID="` + serialNumber + `">
|
||||
<name>SoundTouch Device</name>
|
||||
<components>
|
||||
<component>
|
||||
<componentCategory>SCM</componentCategory>
|
||||
<softwareVersion>4.8.1</softwareVersion>
|
||||
<serialNumber>` + serialNumber + `</serialNumber>
|
||||
</component>
|
||||
</components>
|
||||
<networkInfo type="SCM">
|
||||
<macAddress>` + macAddress + `</macAddress>
|
||||
<ipAddress>192.168.1.100</ipAddress>
|
||||
</networkInfo>
|
||||
</info>`
|
||||
if err := os.WriteFile(filepath.Join(deviceDir, constants.DeviceInfoFile), []byte(deviceInfoXML), 0644); err != nil {
|
||||
t.Fatalf("failed to write DeviceInfo.xml: %v", err)
|
||||
}
|
||||
|
||||
// Create Presets.xml to simulate the file that should be found
|
||||
presetsXML := `<?xml version="1.0" encoding="UTF-8"?>
|
||||
<presets>
|
||||
<preset id="1">
|
||||
<ContentItem source="SPOTIFY" type="station" location="/station/abc123" sourceAccount="spotify_user">
|
||||
<itemName>My Preset</itemName>
|
||||
</ContentItem>
|
||||
</preset>
|
||||
</presets>`
|
||||
if err := os.WriteFile(filepath.Join(deviceDir, constants.PresetsFile), []byte(presetsXML), 0644); err != nil {
|
||||
t.Fatalf("failed to write Presets.xml: %v", err)
|
||||
}
|
||||
|
||||
// Initialize the datastore
|
||||
ds := NewDataStore(tmpDir)
|
||||
if err := ds.Initialize(); err != nil {
|
||||
t.Fatalf("failed to initialize datastore: %v", err)
|
||||
}
|
||||
|
||||
// Test 1: Check if the mapping was populated
|
||||
t.Run("CheckMappingPopulation", func(t *testing.T) {
|
||||
ds.idMutex.RLock()
|
||||
serial, ok := ds.deviceMappings[macAddress]
|
||||
ds.idMutex.RUnlock()
|
||||
|
||||
if !ok {
|
||||
t.Errorf("MAC address %s not found in mapping", macAddress)
|
||||
} else if serial != serialNumber {
|
||||
t.Errorf("MAC address %s mapped to %s, expected %s", macAddress, serial, serialNumber)
|
||||
} else {
|
||||
t.Logf("✓ MAC address %s correctly mapped to %s", macAddress, serial)
|
||||
}
|
||||
})
|
||||
|
||||
// Test 2: Check AccountDeviceDir resolution
|
||||
t.Run("CheckAccountDeviceDir", func(t *testing.T) {
|
||||
// Test with MAC address (should resolve to serial)
|
||||
resolvedDir := ds.AccountDeviceDir(accountID, macAddress)
|
||||
expectedDir := filepath.Join(tmpDir, "accounts", accountID, "devices", serialNumber)
|
||||
|
||||
if resolvedDir != expectedDir {
|
||||
t.Errorf("AccountDeviceDir with MAC %s resolved to %s, expected %s", macAddress, resolvedDir, expectedDir)
|
||||
} else {
|
||||
t.Logf("✓ AccountDeviceDir correctly resolved MAC %s to path %s", macAddress, resolvedDir)
|
||||
}
|
||||
|
||||
// Test with serial number (should work as-is)
|
||||
resolvedDirSerial := ds.AccountDeviceDir(accountID, serialNumber)
|
||||
if resolvedDirSerial != expectedDir {
|
||||
t.Errorf("AccountDeviceDir with serial %s resolved to %s, expected %s", serialNumber, resolvedDirSerial, expectedDir)
|
||||
} else {
|
||||
t.Logf("✓ AccountDeviceDir works correctly with serial number %s", serialNumber)
|
||||
}
|
||||
})
|
||||
|
||||
// Test 3: Check GetPresets functionality with MAC address
|
||||
t.Run("CheckGetPresetsWithMAC", func(t *testing.T) {
|
||||
presets, err := ds.GetPresets(accountID, macAddress)
|
||||
if err != nil {
|
||||
t.Errorf("GetPresets failed with MAC address %s: %v", macAddress, err)
|
||||
} else if len(presets) == 0 {
|
||||
t.Error("GetPresets returned no presets")
|
||||
} else {
|
||||
t.Logf("✓ GetPresets successfully returned %d presets using MAC address %s", len(presets), macAddress)
|
||||
}
|
||||
})
|
||||
|
||||
// Test 4: Check GetPresets functionality with serial number
|
||||
t.Run("CheckGetPresetsWithSerial", func(t *testing.T) {
|
||||
presets, err := ds.GetPresets(accountID, serialNumber)
|
||||
if err != nil {
|
||||
t.Errorf("GetPresets failed with serial number %s: %v", serialNumber, err)
|
||||
} else if len(presets) == 0 {
|
||||
t.Error("GetPresets returned no presets")
|
||||
} else {
|
||||
t.Logf("✓ GetPresets successfully returned %d presets using serial number %s", len(presets), serialNumber)
|
||||
}
|
||||
})
|
||||
|
||||
// Test 5: Check case sensitivity
|
||||
t.Run("CheckCaseSensitivity", func(t *testing.T) {
|
||||
lowercaseMAC := "a81b6a536a98"
|
||||
uppercaseMAC := "A81B6A536A98"
|
||||
|
||||
ds.idMutex.RLock()
|
||||
_, lowercaseOk := ds.deviceMappings[lowercaseMAC]
|
||||
_, uppercaseOk := ds.deviceMappings[uppercaseMAC]
|
||||
ds.idMutex.RUnlock()
|
||||
|
||||
t.Logf("Lowercase MAC '%s' in mapping: %v", lowercaseMAC, lowercaseOk)
|
||||
t.Logf("Uppercase MAC '%s' in mapping: %v", uppercaseMAC, uppercaseOk)
|
||||
|
||||
// Test GetPresets with different cases
|
||||
_, errLower := ds.GetPresets(accountID, lowercaseMAC)
|
||||
_, errUpper := ds.GetPresets(accountID, uppercaseMAC)
|
||||
|
||||
t.Logf("GetPresets with lowercase MAC error: %v", errLower)
|
||||
t.Logf("GetPresets with uppercase MAC error: %v", errUpper)
|
||||
})
|
||||
|
||||
// Test 6: Dump all mappings for debugging
|
||||
t.Run("DumpMappings", func(t *testing.T) {
|
||||
ds.idMutex.RLock()
|
||||
defer ds.idMutex.RUnlock()
|
||||
|
||||
t.Logf("Total mappings found: %d", len(ds.deviceMappings))
|
||||
for mac, serial := range ds.deviceMappings {
|
||||
t.Logf(" MAC '%s' -> Serial '%s'", mac, serial)
|
||||
}
|
||||
})
|
||||
|
||||
// Test 7: Check actual file paths
|
||||
t.Run("CheckFilePaths", func(t *testing.T) {
|
||||
// Path that should work (with serial number)
|
||||
correctPath := filepath.Join(tmpDir, "accounts", accountID, "devices", serialNumber, constants.PresetsFile)
|
||||
if _, err := os.Stat(correctPath); err != nil {
|
||||
t.Errorf("File not found at correct path %s: %v", correctPath, err)
|
||||
} else {
|
||||
t.Logf("✓ File found at correct path: %s", correctPath)
|
||||
}
|
||||
|
||||
// Path that would be wrong (with MAC address)
|
||||
wrongPath := filepath.Join(tmpDir, "accounts", accountID, "devices", macAddress, constants.PresetsFile)
|
||||
if _, err := os.Stat(wrongPath); err == nil {
|
||||
t.Logf("⚠️ File also found at MAC path (unexpected): %s", wrongPath)
|
||||
} else {
|
||||
t.Logf("✓ File correctly not found at MAC path: %s", wrongPath)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// TestMacMappingWithDifferentFormats tests various MAC address formats
|
||||
func TestMacMappingWithDifferentFormats(t *testing.T) {
|
||||
tmpDir, err := os.MkdirTemp("", "mac-format-test")
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create temp dir: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tmpDir)
|
||||
|
||||
testCases := []struct {
|
||||
name string
|
||||
macInXML string
|
||||
macInRequest string
|
||||
shouldWork bool
|
||||
}{
|
||||
{"ExactMatch", "A81B6A536A98", "A81B6A536A98", true},
|
||||
{"LowerCase", "A81B6A536A98", "a81b6a536a98", true}, // Should work with normalization
|
||||
{"UpperCase", "a81b6a536a98", "A81B6A536A98", true}, // Should work with normalization
|
||||
{"WithColons", "A8:1B:6A:53:6A:98", "A81B6A536A98", true}, // Should work with normalization
|
||||
{"WithDashes", "A8-1B-6A-53-6A-98", "A81B6A536A98", true}, // Should work with normalization
|
||||
}
|
||||
|
||||
for _, tc := range testCases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
// Create separate directory for each test case
|
||||
testDir := filepath.Join(tmpDir, tc.name)
|
||||
accountID := "12345"
|
||||
serialNumber := "TEST123456789"
|
||||
|
||||
deviceDir := filepath.Join(testDir, "accounts", accountID, "devices", serialNumber)
|
||||
if err := os.MkdirAll(deviceDir, 0755); err != nil {
|
||||
t.Fatalf("failed to create device dir: %v", err)
|
||||
}
|
||||
|
||||
// Create DeviceInfo.xml with the specific MAC format
|
||||
deviceInfoXML := `<?xml version="1.0" encoding="UTF-8"?>
|
||||
<info deviceID="` + serialNumber + `">
|
||||
<name>Test Device</name>
|
||||
<components>
|
||||
<component>
|
||||
<componentCategory>SCM</componentCategory>
|
||||
<softwareVersion>4.8.1</softwareVersion>
|
||||
<serialNumber>` + serialNumber + `</serialNumber>
|
||||
</component>
|
||||
</components>
|
||||
<networkInfo type="SCM">
|
||||
<macAddress>` + tc.macInXML + `</macAddress>
|
||||
<ipAddress>192.168.1.100</ipAddress>
|
||||
</networkInfo>
|
||||
</info>`
|
||||
if err := os.WriteFile(filepath.Join(deviceDir, constants.DeviceInfoFile), []byte(deviceInfoXML), 0644); err != nil {
|
||||
t.Fatalf("failed to write DeviceInfo.xml: %v", err)
|
||||
}
|
||||
|
||||
// Create Presets.xml
|
||||
presetsXML := `<presets><preset id="1">test</preset></presets>`
|
||||
if err := os.WriteFile(filepath.Join(deviceDir, constants.PresetsFile), []byte(presetsXML), 0644); err != nil {
|
||||
t.Fatalf("failed to write Presets.xml: %v", err)
|
||||
}
|
||||
|
||||
// Initialize datastore
|
||||
ds := NewDataStore(testDir)
|
||||
if err := ds.Initialize(); err != nil {
|
||||
t.Fatalf("failed to initialize datastore: %v", err)
|
||||
}
|
||||
|
||||
// Try to get presets using the request MAC format
|
||||
_, err := ds.GetPresets(accountID, tc.macInRequest)
|
||||
|
||||
if tc.shouldWork && err != nil {
|
||||
t.Errorf("Expected success but got error: %v", err)
|
||||
} else if !tc.shouldWork && err == nil {
|
||||
t.Errorf("Expected failure but got success")
|
||||
} else if tc.shouldWork {
|
||||
t.Logf("✓ Successfully resolved MAC '%s' to serial '%s' (normalization worked)", tc.macInRequest, serialNumber)
|
||||
} else {
|
||||
t.Logf("✓ Correctly failed to resolve MAC '%s' (XML had '%s')", tc.macInRequest, tc.macInXML)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,79 @@
|
||||
package datastore
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/service/constants"
|
||||
)
|
||||
|
||||
func TestDataStore_MacAddressMapping(t *testing.T) {
|
||||
if err := os.MkdirAll("testdata/mapping", 0755); err != nil {
|
||||
t.Fatalf("failed to create temp dir: %v", err)
|
||||
}
|
||||
defer os.RemoveAll("testdata/mapping")
|
||||
|
||||
accountID := "12345"
|
||||
serialNumber := "SERIAL123"
|
||||
macAddress := "AABBCCDDEEFF"
|
||||
|
||||
// Create directory structure
|
||||
deviceDir := filepath.Join("testdata/mapping", "accounts", accountID, "devices", serialNumber)
|
||||
if err := os.MkdirAll(deviceDir, 0755); err != nil {
|
||||
t.Fatalf("failed to create device dir: %v", err)
|
||||
}
|
||||
|
||||
// Create DeviceInfo.xml with MAC address
|
||||
deviceInfoXML := `<?xml version="1.0" encoding="UTF-8"?>
|
||||
<info deviceID="` + serialNumber + `">
|
||||
<name>Test Device</name>
|
||||
<components>
|
||||
<component>
|
||||
<componentCategory>SCM</componentCategory>
|
||||
<softwareVersion>1.0</softwareVersion>
|
||||
<serialNumber>` + serialNumber + `</serialNumber>
|
||||
</component>
|
||||
</components>
|
||||
<networkInfo type="SCM">
|
||||
<macAddress>` + macAddress + `</macAddress>
|
||||
<ipAddress>192.168.1.10</ipAddress>
|
||||
</networkInfo>
|
||||
</info>`
|
||||
if err := os.WriteFile(filepath.Join(deviceDir, constants.DeviceInfoFile), []byte(deviceInfoXML), 0644); err != nil {
|
||||
t.Fatalf("failed to write DeviceInfo.xml: %v", err)
|
||||
}
|
||||
|
||||
// Create Presets.xml so we can verify access
|
||||
presetsXML := `<presets><preset id="1">test</preset></presets>`
|
||||
if err := os.WriteFile(filepath.Join(deviceDir, constants.PresetsFile), []byte(presetsXML), 0644); err != nil {
|
||||
t.Fatalf("failed to write Presets.xml: %v", err)
|
||||
}
|
||||
|
||||
ds := NewDataStore("testdata/mapping")
|
||||
if err := ds.Initialize(); err != nil {
|
||||
t.Fatalf("failed to initialize datastore: %v", err)
|
||||
}
|
||||
|
||||
// Test mapping resolution in AccountDeviceDir
|
||||
resolvedDir := ds.AccountDeviceDir(accountID, macAddress)
|
||||
expectedDir, _ := filepath.Abs(filepath.Join("testdata/mapping", "accounts", accountID, "devices", serialNumber))
|
||||
if resolvedDir != expectedDir {
|
||||
t.Errorf("expected dir %s, got %s", expectedDir, resolvedDir)
|
||||
}
|
||||
|
||||
// Test that we can still use the serial number directly
|
||||
resolvedDirSerial := ds.AccountDeviceDir(accountID, serialNumber)
|
||||
if resolvedDirSerial != expectedDir {
|
||||
t.Errorf("expected dir %s when using serial, got %s", expectedDir, resolvedDirSerial)
|
||||
}
|
||||
|
||||
// Test GetPresets using MAC address
|
||||
presets, err := ds.GetPresets(accountID, macAddress)
|
||||
if err != nil {
|
||||
t.Errorf("GetPresets failed with MAC address: %v", err)
|
||||
}
|
||||
if len(presets) == 0 {
|
||||
t.Error("expected presets to be loaded")
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,386 @@
|
||||
package datastore
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/discovery"
|
||||
"github.com/gesellix/bose-soundtouch/pkg/models"
|
||||
"github.com/gesellix/bose-soundtouch/pkg/service/constants"
|
||||
)
|
||||
|
||||
func TestUPnPDiscoveryToDatastoreMapping_FullFlow(t *testing.T) {
|
||||
// This test demonstrates the complete flow:
|
||||
// 1. UPnP discovery finds device with MAC in serialNumber
|
||||
// 2. Device is stored in datastore with serial number directory
|
||||
// 3. MAC address mapping is established
|
||||
// 4. HTTP requests using MAC address are resolved to correct directory
|
||||
|
||||
tmpDir, err := os.MkdirTemp("", "upnp-datastore-integration")
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create temp dir: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tmpDir)
|
||||
|
||||
// Test data matching the user's scenario
|
||||
accountID := "3230304"
|
||||
deviceSerial := "I6332527703739342000020"
|
||||
deviceMAC := "A81B6A536A98"
|
||||
deviceName := "Sound Machinechen"
|
||||
|
||||
t.Logf("Test scenario:")
|
||||
t.Logf(" Account: %s", accountID)
|
||||
t.Logf(" Device Serial: %s", deviceSerial)
|
||||
t.Logf(" Device MAC: %s", deviceMAC)
|
||||
t.Logf(" Expected directory: accounts/%s/devices/%s/", accountID, deviceSerial)
|
||||
t.Logf(" Expected request: GET /streaming/account/%s/device/%s/presets", accountID, deviceMAC)
|
||||
t.Logf("")
|
||||
|
||||
// Step 1: Create the device directory structure using serial number
|
||||
deviceDir := filepath.Join(tmpDir, "accounts", accountID, "devices", deviceSerial)
|
||||
if err := os.MkdirAll(deviceDir, 0755); err != nil {
|
||||
t.Fatalf("failed to create device dir: %v", err)
|
||||
}
|
||||
|
||||
// Create DeviceInfo.xml with MAC address
|
||||
deviceInfoXML := `<?xml version="1.0" encoding="UTF-8"?>
|
||||
<info deviceID="` + deviceSerial + `">
|
||||
<name>` + deviceName + `</name>
|
||||
<components>
|
||||
<component>
|
||||
<componentCategory>SCM</componentCategory>
|
||||
<softwareVersion>4.8.1</softwareVersion>
|
||||
<serialNumber>` + deviceSerial + `</serialNumber>
|
||||
</component>
|
||||
</components>
|
||||
<networkInfo type="SCM">
|
||||
<macAddress>` + deviceMAC + `</macAddress>
|
||||
<ipAddress>192.168.1.100</ipAddress>
|
||||
</networkInfo>
|
||||
</info>`
|
||||
if err := os.WriteFile(filepath.Join(deviceDir, constants.DeviceInfoFile), []byte(deviceInfoXML), 0644); err != nil {
|
||||
t.Fatalf("failed to write DeviceInfo.xml: %v", err)
|
||||
}
|
||||
|
||||
// Create Presets.xml (the target file we want to access)
|
||||
presetsXML := `<?xml version="1.0" encoding="UTF-8"?>
|
||||
<presets>
|
||||
<preset id="1">
|
||||
<ContentItem source="SPOTIFY" type="station" location="/station/test123" sourceAccount="spotify">
|
||||
<itemName>My Spotify Station</itemName>
|
||||
</ContentItem>
|
||||
</preset>
|
||||
<preset id="2">
|
||||
<ContentItem source="TUNEIN" type="station" location="/station/s12345" sourceAccount="">
|
||||
<itemName>NPR News</itemName>
|
||||
</ContentItem>
|
||||
</preset>
|
||||
</presets>`
|
||||
if err := os.WriteFile(filepath.Join(deviceDir, constants.PresetsFile), []byte(presetsXML), 0644); err != nil {
|
||||
t.Fatalf("failed to write Presets.xml: %v", err)
|
||||
}
|
||||
|
||||
// Step 2: Simulate UPnP discovery with real device XML
|
||||
t.Run("Step2_UPnPDiscovery", func(t *testing.T) {
|
||||
// UPnP XML exactly as provided by the user
|
||||
upnpXML := `<?xml version="1.0" encoding="utf-8"?>
|
||||
<root xmlns="urn:schemas-upnp-org:device-1-0">
|
||||
<specVersion>
|
||||
<major>1</major>
|
||||
<minor>0</minor>
|
||||
</specVersion>
|
||||
<device>
|
||||
<deviceType>urn:schemas-upnp-org:device:MediaRenderer:1</deviceType>
|
||||
<friendlyName>` + deviceName + `</friendlyName>
|
||||
<qq:X_QPlay_SoftwareCapability xmlns:qq="http://www.tencent.com">QPlay:2</qq:X_QPlay_SoftwareCapability>
|
||||
<manufacturer>Bose Corporation</manufacturer>
|
||||
<manufacturerURL>http://www.bose.com</manufacturerURL>
|
||||
<modelName>SoundTouch 10</modelName>
|
||||
<modelNumber></modelNumber>
|
||||
<modelDescription>Bose SoundTouch Wireless Streaming Audio Device</modelDescription>
|
||||
<modelURL>http://www.bose.com</modelURL>
|
||||
<serialNumber>` + deviceMAC + `</serialNumber>
|
||||
<UDN>uuid:BO5EBO5E-F00D-F00D-FEED-` + deviceMAC + `</UDN>
|
||||
<serviceList>
|
||||
<service>
|
||||
<serviceType>urn:schemas-upnp-org:service:AVTransport:1</serviceType>
|
||||
<serviceId>urn:upnp-org:serviceId:AVTransport</serviceId>
|
||||
<SCPDURL>/Xml/AVTransport3.xml</SCPDURL>
|
||||
<controlURL>/AVTransport/Control</controlURL>
|
||||
<eventSubURL>/AVTransport/Event</eventSubURL>
|
||||
</service>
|
||||
</serviceList>
|
||||
</device>
|
||||
</root>`
|
||||
|
||||
// Create UPnP server
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/xml; charset=utf-8")
|
||||
fmt.Fprint(w, upnpXML)
|
||||
}))
|
||||
defer server.Close()
|
||||
|
||||
// Simulate UPnP discovery
|
||||
discoveryService := discovery.NewService(5 * time.Second)
|
||||
device := &models.DiscoveredDevice{
|
||||
Host: "192.168.1.100",
|
||||
Port: 8091,
|
||||
Name: "Initial Name",
|
||||
}
|
||||
|
||||
err := discoveryService.EnrichDeviceInfo(device, server.URL+"/XD/BO5EBO5E-F00D-F00D-FEED-"+deviceMAC+".xml")
|
||||
if err != nil {
|
||||
t.Errorf("UPnP enrichment failed: %v", err)
|
||||
} else {
|
||||
t.Logf("✓ UPnP discovery extracted MAC: '%s' from serialNumber", device.UPnPSerial)
|
||||
}
|
||||
|
||||
// Verify UPnP extraction
|
||||
if device.UPnPSerial != deviceMAC {
|
||||
t.Errorf("Expected UPnPSerial '%s', got '%s'", deviceMAC, device.UPnPSerial)
|
||||
}
|
||||
})
|
||||
|
||||
// Step 3: Initialize datastore and verify mapping
|
||||
t.Run("Step3_DatastoreMapping", func(t *testing.T) {
|
||||
ds := NewDataStore(tmpDir)
|
||||
err := ds.Initialize()
|
||||
if err != nil {
|
||||
t.Fatalf("failed to initialize datastore: %v", err)
|
||||
}
|
||||
|
||||
// Verify mapping was created during initialization
|
||||
ds.idMutex.RLock()
|
||||
mappedSerial, hasMappingExact := ds.deviceMappings[deviceMAC]
|
||||
normalizedMAC := normalizeMAC(deviceMAC)
|
||||
mappedSerialNormalized, hasMappingNormalized := ds.deviceMappings[normalizedMAC]
|
||||
ds.idMutex.RUnlock()
|
||||
|
||||
t.Logf("Mapping check:")
|
||||
t.Logf(" Original MAC '%s' -> mapped: %v", deviceMAC, hasMappingExact)
|
||||
if hasMappingExact {
|
||||
t.Logf(" Original MAC maps to: '%s'", mappedSerial)
|
||||
}
|
||||
t.Logf(" Normalized MAC '%s' -> mapped: %v", normalizedMAC, hasMappingNormalized)
|
||||
if hasMappingNormalized {
|
||||
t.Logf(" Normalized MAC maps to: '%s'", mappedSerialNormalized)
|
||||
}
|
||||
|
||||
if !hasMappingExact && !hasMappingNormalized {
|
||||
t.Error("No mapping found for MAC address")
|
||||
} else {
|
||||
t.Logf("✓ MAC address mapping established successfully")
|
||||
}
|
||||
})
|
||||
|
||||
// Step 4: Test HTTP request resolution
|
||||
t.Run("Step4_HTTPRequestResolution", func(t *testing.T) {
|
||||
ds := NewDataStore(tmpDir)
|
||||
err := ds.Initialize()
|
||||
if err != nil {
|
||||
t.Fatalf("failed to initialize datastore: %v", err)
|
||||
}
|
||||
|
||||
// Test various MAC address formats in HTTP requests
|
||||
testCases := []struct {
|
||||
name string
|
||||
requestMAC string
|
||||
shouldWork bool
|
||||
description string
|
||||
}{
|
||||
{
|
||||
name: "ExactMatch",
|
||||
requestMAC: "A81B6A536A98",
|
||||
shouldWork: true,
|
||||
description: "Exact MAC match",
|
||||
},
|
||||
{
|
||||
name: "LowercaseMAC",
|
||||
requestMAC: "a81b6a536a98",
|
||||
shouldWork: true,
|
||||
description: "Lowercase MAC (should work with normalization)",
|
||||
},
|
||||
{
|
||||
name: "MACWithColons",
|
||||
requestMAC: "A8:1B:6A:53:6A:98",
|
||||
shouldWork: true,
|
||||
description: "MAC with colons (should work with normalization)",
|
||||
},
|
||||
{
|
||||
name: "MACWithDashes",
|
||||
requestMAC: "A8-1B-6A-53-6A-98",
|
||||
shouldWork: true,
|
||||
description: "MAC with dashes (should work with normalization)",
|
||||
},
|
||||
{
|
||||
name: "InvalidMAC",
|
||||
requestMAC: "INVALID123456",
|
||||
shouldWork: false,
|
||||
description: "Invalid MAC (should fail)",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range testCases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
// Simulate HTTP request: GET /streaming/account/{account}/device/{device}/presets
|
||||
presets, err := ds.GetPresets(accountID, tc.requestMAC)
|
||||
|
||||
if tc.shouldWork {
|
||||
if err != nil {
|
||||
t.Errorf("%s failed: %v", tc.description, err)
|
||||
} else if len(presets) == 0 {
|
||||
t.Errorf("%s: no presets returned", tc.description)
|
||||
} else {
|
||||
t.Logf("✓ %s: Successfully retrieved %d presets", tc.description, len(presets))
|
||||
|
||||
// Verify preset content
|
||||
if presets[0].ID == "1" && presets[1].ID == "2" {
|
||||
t.Logf(" ✓ Preset content verified (IDs: %s, %s)", presets[0].ID, presets[1].ID)
|
||||
}
|
||||
}
|
||||
} else {
|
||||
if err == nil {
|
||||
t.Errorf("%s: expected failure but got success", tc.description)
|
||||
} else {
|
||||
t.Logf("✓ %s: Correctly failed with error: %v", tc.description, err)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
})
|
||||
|
||||
// Step 5: Test directory resolution
|
||||
t.Run("Step5_DirectoryResolution", func(t *testing.T) {
|
||||
ds := NewDataStore(tmpDir)
|
||||
err := ds.Initialize()
|
||||
if err != nil {
|
||||
t.Fatalf("failed to initialize datastore: %v", err)
|
||||
}
|
||||
|
||||
// Test AccountDeviceDir resolution
|
||||
resolvedDirMAC := ds.AccountDeviceDir(accountID, deviceMAC)
|
||||
resolvedDirSerial := ds.AccountDeviceDir(accountID, deviceSerial)
|
||||
expectedDir := filepath.Join(tmpDir, "accounts", accountID, "devices", deviceSerial)
|
||||
|
||||
t.Logf("Directory resolution:")
|
||||
t.Logf(" Request with MAC '%s' -> '%s'", deviceMAC, resolvedDirMAC)
|
||||
t.Logf(" Request with serial '%s' -> '%s'", deviceSerial, resolvedDirSerial)
|
||||
t.Logf(" Expected directory: '%s'", expectedDir)
|
||||
|
||||
if resolvedDirMAC != expectedDir {
|
||||
t.Errorf("MAC resolution failed: expected '%s', got '%s'", expectedDir, resolvedDirMAC)
|
||||
} else {
|
||||
t.Logf("✓ MAC address correctly resolved to serial number directory")
|
||||
}
|
||||
|
||||
if resolvedDirSerial != expectedDir {
|
||||
t.Errorf("Serial resolution failed: expected '%s', got '%s'", expectedDir, resolvedDirSerial)
|
||||
} else {
|
||||
t.Logf("✓ Serial number resolution works correctly")
|
||||
}
|
||||
})
|
||||
|
||||
// Step 6: Integration summary
|
||||
t.Run("Step6_IntegrationSummary", func(t *testing.T) {
|
||||
t.Log("")
|
||||
t.Log("=== INTEGRATION SUMMARY ===")
|
||||
t.Log("✅ UPnP Discovery: MAC address extracted from serialNumber field")
|
||||
t.Log("✅ Datastore Initialization: MAC-to-serial mapping created from DeviceInfo.xml")
|
||||
t.Log("✅ MAC Normalization: Case and format variations handled correctly")
|
||||
t.Log("✅ HTTP Request Resolution: MAC addresses resolve to correct device directories")
|
||||
t.Log("✅ File Access: Presets.xml found using MAC address in request URL")
|
||||
t.Log("")
|
||||
t.Log("The original issue has been resolved:")
|
||||
t.Logf(" Request: GET /streaming/account/%s/device/%s/presets", accountID, deviceMAC)
|
||||
t.Logf(" Resolves to: %s/accounts/%s/devices/%s/Presets.xml", tmpDir, accountID, deviceSerial)
|
||||
t.Log("")
|
||||
})
|
||||
}
|
||||
|
||||
func TestNormalizationEdgeCases(t *testing.T) {
|
||||
testCases := []struct {
|
||||
input string
|
||||
expected string
|
||||
desc string
|
||||
}{
|
||||
{"", "", "empty string"},
|
||||
{"a", "A", "single character"},
|
||||
{"ab", "AB", "two characters"},
|
||||
{"A81B6A536A98", "A81B6A536A98", "standard MAC"},
|
||||
{"a81b6a536a98", "A81B6A536A98", "lowercase MAC"},
|
||||
{"A8:1B:6A:53:6A:98", "A81B6A536A98", "MAC with colons"},
|
||||
{"A8-1B-6A-53-6A-98", "A81B6A536A98", "MAC with dashes"},
|
||||
{"a8:1b:6a:53:6a:98", "A81B6A536A98", "lowercase MAC with colons"},
|
||||
{"a8-1b-6a-53-6a-98", "A81B6A536A98", "lowercase MAC with dashes"},
|
||||
{"A8::1B::6A", "A81B6A", "multiple consecutive colons"},
|
||||
{"A8--1B--6A", "A81B6A", "multiple consecutive dashes"},
|
||||
{"A8:-1B-:6A", "A81B6A", "mixed separators"},
|
||||
{" A81B6A536A98 ", "A81B6A536A98", "MAC with spaces (handled by normalization)"},
|
||||
}
|
||||
|
||||
for _, tc := range testCases {
|
||||
t.Run(tc.desc, func(t *testing.T) {
|
||||
result := normalizeMAC(tc.input)
|
||||
if result != tc.expected {
|
||||
t.Errorf("normalizeMAC(%q) = %q, expected %q", tc.input, result, tc.expected)
|
||||
} else {
|
||||
t.Logf("✓ %s: %q -> %q", tc.desc, tc.input, result)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestMACMappingPerformance(t *testing.T) {
|
||||
// Test performance with many mappings
|
||||
tmpDir, err := os.MkdirTemp("", "mac-performance-test")
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create temp dir: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tmpDir)
|
||||
|
||||
ds := NewDataStore(tmpDir)
|
||||
|
||||
// Add many mappings
|
||||
numMappings := 1000
|
||||
t.Logf("Testing performance with %d MAC mappings...", numMappings)
|
||||
|
||||
start := time.Now()
|
||||
for i := 0; i < numMappings; i++ {
|
||||
mac := fmt.Sprintf("AA:BB:CC:DD:EE:%02X", i%256)
|
||||
serial := fmt.Sprintf("SERIAL%06d", i)
|
||||
ds.UpdateMapping(mac, serial)
|
||||
}
|
||||
updateDuration := time.Since(start)
|
||||
|
||||
// Test lookup performance
|
||||
start = time.Now()
|
||||
for i := 0; i < numMappings; i++ {
|
||||
mac := fmt.Sprintf("AA:BB:CC:DD:EE:%02X", i%256)
|
||||
accountID := "test"
|
||||
_ = ds.AccountDeviceDir(accountID, mac)
|
||||
}
|
||||
lookupDuration := time.Since(start)
|
||||
|
||||
t.Logf("✓ Performance test completed:")
|
||||
t.Logf(" Update %d mappings: %v (%.2f μs per mapping)", numMappings, updateDuration, float64(updateDuration.Nanoseconds())/float64(numMappings)/1000.0)
|
||||
t.Logf(" Lookup %d mappings: %v (%.2f μs per lookup)", numMappings, lookupDuration, float64(lookupDuration.Nanoseconds())/float64(numMappings)/1000.0)
|
||||
|
||||
// Verify total mappings (should be more than numMappings due to normalization)
|
||||
ds.idMutex.RLock()
|
||||
totalMappings := len(ds.deviceMappings)
|
||||
ds.idMutex.RUnlock()
|
||||
|
||||
t.Logf(" Total mappings stored: %d (includes normalized versions)", totalMappings)
|
||||
|
||||
if updateDuration > time.Millisecond*100 {
|
||||
t.Errorf("Update performance too slow: %v", updateDuration)
|
||||
}
|
||||
if lookupDuration > time.Millisecond*70 {
|
||||
t.Errorf("Lookup performance too slow: %v", lookupDuration)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,107 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/service/datastore"
|
||||
)
|
||||
|
||||
func TestHandleBMXRegistry_DNSDependent(t *testing.T) {
|
||||
tempDir, err := os.MkdirTemp("", "bmx-registry-test")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create temp dir: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tempDir)
|
||||
|
||||
ds := datastore.NewDataStore(tempDir)
|
||||
_ = ds.Initialize()
|
||||
|
||||
localURL := "https://soundtouch.local"
|
||||
server := NewServer(ds, nil, localURL, false, false, false)
|
||||
|
||||
t.Run("DNSEnabled_UsesBoseURL", func(t *testing.T) {
|
||||
server.SetDNSSettings(true, "8.8.8.8", ":5353")
|
||||
|
||||
req := httptest.NewRequest("GET", "/bmx/v1/services", nil)
|
||||
w := httptest.NewRecorder()
|
||||
|
||||
server.HandleBMXRegistry(w, req)
|
||||
|
||||
if w.Code != http.StatusOK {
|
||||
t.Errorf("Expected status 200, got %d", w.Code)
|
||||
}
|
||||
|
||||
var resp map[string]interface{}
|
||||
if err := json.Unmarshal(w.Body.Bytes(), &resp); err != nil {
|
||||
t.Fatalf("Failed to unmarshal response: %v", err)
|
||||
}
|
||||
|
||||
services := resp["bmx_services"].([]interface{})
|
||||
foundTuneIn := false
|
||||
for _, s := range services {
|
||||
service := s.(map[string]interface{})
|
||||
if service["id"].(map[string]interface{})["name"] == "TUNEIN" {
|
||||
foundTuneIn = true
|
||||
baseURL := service["baseUrl"].(string)
|
||||
if baseURL != "https://content.api.bose.io/bmx/tunein" {
|
||||
t.Errorf("Expected baseUrl https://content.api.bose.io/bmx/tunein, got %s", baseURL)
|
||||
}
|
||||
|
||||
// Check assets (MEDIA_SERVER) - should still be local
|
||||
assets := service["assets"].(map[string]interface{})
|
||||
icons := assets["icons"].(map[string]interface{})
|
||||
for k, v := range icons {
|
||||
iconURL := v.(string)
|
||||
if strings.HasPrefix(iconURL, "{") {
|
||||
t.Errorf("Icon %s still has placeholder: %s", k, iconURL)
|
||||
}
|
||||
if !strings.HasPrefix(iconURL, localURL+"/media/bmx-icons/tunein") {
|
||||
t.Errorf("Icon %s should point to local media server bmx-icons subdirectory, got %s", k, iconURL)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
if !foundTuneIn {
|
||||
t.Error("TuneIn service not found in registry")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("DNSDisabled_UsesLocalURL", func(t *testing.T) {
|
||||
server.SetDNSSettings(false, "", "")
|
||||
|
||||
req := httptest.NewRequest("GET", "/bmx/v1/services", nil)
|
||||
w := httptest.NewRecorder()
|
||||
|
||||
server.HandleBMXRegistry(w, req)
|
||||
|
||||
if w.Code != http.StatusOK {
|
||||
t.Errorf("Expected status 200, got %d", w.Code)
|
||||
}
|
||||
|
||||
var resp map[string]interface{}
|
||||
if err := json.Unmarshal(w.Body.Bytes(), &resp); err != nil {
|
||||
t.Fatalf("Failed to unmarshal response: %v", err)
|
||||
}
|
||||
|
||||
services := resp["bmx_services"].([]interface{})
|
||||
foundTuneIn := false
|
||||
for _, s := range services {
|
||||
service := s.(map[string]interface{})
|
||||
if service["id"].(map[string]interface{})["name"] == "TUNEIN" {
|
||||
foundTuneIn = true
|
||||
baseURL := service["baseUrl"].(string)
|
||||
if baseURL != localURL+"/bmx/tunein" {
|
||||
t.Errorf("Expected baseUrl %s/bmx/tunein, got %s", localURL, baseURL)
|
||||
}
|
||||
}
|
||||
}
|
||||
if !foundTuneIn {
|
||||
t.Error("TuneIn service not found in registry")
|
||||
}
|
||||
})
|
||||
}
|
||||
@@ -23,7 +23,7 @@ func TestDNSSettingsValidation(t *testing.T) {
|
||||
|
||||
r, server := setupRouter("http://localhost:8001", ds)
|
||||
|
||||
// Test Case 1: Enable DNS with empty upstream
|
||||
// Test Case 1: Enable DNS with empty upstream (should fallback to system DNS)
|
||||
update := map[string]interface{}{
|
||||
"dns_enabled": true,
|
||||
"dns_upstream": "",
|
||||
@@ -38,14 +38,18 @@ func TestDNSSettingsValidation(t *testing.T) {
|
||||
w := httptest.NewRecorder()
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
if w.Code != http.StatusBadRequest {
|
||||
t.Errorf("Expected status 400 when enabling DNS without upstream, got %d", w.Code)
|
||||
if w.Code != http.StatusOK {
|
||||
t.Errorf("Expected status 200 when enabling DNS without upstream (fallback to system), got %d. Body: %s", w.Code, w.Body.String())
|
||||
}
|
||||
|
||||
// Verify DNS server is NOT running
|
||||
running, _ := server.GetDNSRunning()
|
||||
if running {
|
||||
t.Error("DNS server should not be running after invalid config attempt")
|
||||
// Verify DNS state in server
|
||||
if !server.dnsEnabled {
|
||||
t.Error("DNS should be enabled in server state")
|
||||
}
|
||||
|
||||
// Verify it TRIED to start (either it is running, or it failed due to port conflict but state is enabled)
|
||||
if !server.dnsEnabled {
|
||||
t.Error("DNS state should be enabled")
|
||||
}
|
||||
|
||||
// Test Case 2: Enable DNS with valid upstream
|
||||
|
||||
@@ -2,9 +2,10 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"encoding/base64"
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"os"
|
||||
"net/url"
|
||||
"strings"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/service/bmx"
|
||||
@@ -13,13 +14,19 @@ import (
|
||||
|
||||
// HandleBMXRegistry returns the BMX service registry.
|
||||
func (s *Server) HandleBMXRegistry(w http.ResponseWriter, _ *http.Request) {
|
||||
baseURL := os.Getenv("BASE_URL")
|
||||
if baseURL == "" {
|
||||
baseURL = "http://localhost:8000"
|
||||
baseURL := s.serverURL
|
||||
|
||||
s.mu.RLock()
|
||||
dnsEnabled := s.dnsEnabled
|
||||
s.mu.RUnlock()
|
||||
|
||||
bmxServer := baseURL
|
||||
if dnsEnabled {
|
||||
bmxServer = "https://content.api.bose.io"
|
||||
}
|
||||
|
||||
content := string(bmxServicesJSON)
|
||||
content = strings.ReplaceAll(content, "{BMX_SERVER}", baseURL)
|
||||
content = strings.ReplaceAll(content, "{BMX_SERVER}", bmxServer)
|
||||
content = strings.ReplaceAll(content, "{MEDIA_SERVER}", baseURL+"/media")
|
||||
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
@@ -98,3 +105,41 @@ func (s *Server) HandleOrionPlayback(w http.ResponseWriter, r *http.Request) {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// HandleCustomPlayback returns custom playback information for a given stream URL.
|
||||
func (s *Server) HandleCustomPlayback(w http.ResponseWriter, r *http.Request) {
|
||||
encodedURL := chi.URLParam(r, "encodedURL")
|
||||
imageUrl := r.URL.Query().Get("imageUrl")
|
||||
name := r.URL.Query().Get("name")
|
||||
|
||||
// Decode URL if it's base64 encoded
|
||||
var streamUrl string
|
||||
|
||||
decoded, err := base64.URLEncoding.DecodeString(encodedURL)
|
||||
if err != nil {
|
||||
decoded, err = base64.StdEncoding.DecodeString(encodedURL)
|
||||
}
|
||||
|
||||
if err == nil {
|
||||
streamUrl = string(decoded)
|
||||
} else {
|
||||
// Try unescaping if it's not base64
|
||||
streamUrl, err = url.PathUnescape(encodedURL)
|
||||
if err != nil {
|
||||
streamUrl = encodedURL
|
||||
}
|
||||
}
|
||||
|
||||
resp, err := bmx.BuildCustomStreamResponse(streamUrl, imageUrl, name)
|
||||
if err != nil {
|
||||
http.Error(w, err.Error(), http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
|
||||
if err := json.NewEncoder(w).Encode(resp); err != nil {
|
||||
http.Error(w, "Failed to encode response", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
@@ -5,6 +5,7 @@ import (
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"net/url"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
@@ -39,6 +40,10 @@ func TestBMXServices(t *testing.T) {
|
||||
|
||||
// Verify placeholder replacement
|
||||
bodyStr := string(body)
|
||||
if !strings.Contains(bodyStr, "http://localhost:8001") {
|
||||
t.Errorf("Response does not contain expected baseURL http://localhost:8001, got: %s", bodyStr)
|
||||
}
|
||||
|
||||
if strings.Contains(bodyStr, "{BMX_SERVER}") {
|
||||
t.Error("Response still contains {BMX_SERVER} placeholder")
|
||||
}
|
||||
@@ -48,6 +53,31 @@ func TestBMXServices(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestBMXServices_EmptyBaseURL(t *testing.T) {
|
||||
r, _ := setupRouter("", nil)
|
||||
|
||||
ts := httptest.NewServer(r)
|
||||
defer ts.Close()
|
||||
|
||||
res, err := http.Get(ts.URL + "/bmx/registry/v1/services")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer func() { _ = res.Body.Close() }()
|
||||
|
||||
body, _ := io.ReadAll(res.Body)
|
||||
bodyStr := string(body)
|
||||
|
||||
// Since we removed the fallback, it should use the empty baseURL
|
||||
if strings.Contains(bodyStr, "http://localhost:8000") {
|
||||
t.Error("Response contains fallback URL http://localhost:8000, which should be removed")
|
||||
}
|
||||
|
||||
if strings.Contains(bodyStr, "{BMX_SERVER}") {
|
||||
t.Error("Response still contains {BMX_SERVER} placeholder")
|
||||
}
|
||||
}
|
||||
|
||||
func TestOrionPlayback(t *testing.T) {
|
||||
r, _ := setupRouter("http://localhost:8001", nil)
|
||||
|
||||
@@ -78,3 +108,44 @@ func TestOrionPlayback(t *testing.T) {
|
||||
t.Errorf("Expected name Test Orion, got %v", resp["name"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestCustomPlayback(t *testing.T) {
|
||||
r, _ := setupRouter("http://localhost:8001", nil)
|
||||
|
||||
ts := httptest.NewServer(r)
|
||||
defer ts.Close()
|
||||
|
||||
// Base64 encoded: http://example.com/stream
|
||||
encodedURL := "aHR0cDovL2V4YW1wbGUuY29tL3N0cmVhbQ=="
|
||||
imageUrl := "http://example.com/img.jpg"
|
||||
name := "Test Custom"
|
||||
|
||||
res, err := http.Get(ts.URL + "/custom/v1/playback/" + encodedURL + "?imageUrl=" + url.QueryEscape(imageUrl) + "&name=" + url.QueryEscape(name))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
defer func() { _ = res.Body.Close() }()
|
||||
|
||||
if res.StatusCode != http.StatusOK {
|
||||
t.Errorf("Expected status OK, got %v", res.Status)
|
||||
}
|
||||
|
||||
body, _ := io.ReadAll(res.Body)
|
||||
|
||||
var resp map[string]interface{}
|
||||
_ = json.Unmarshal(body, &resp)
|
||||
|
||||
if resp["name"] != "Test Custom" {
|
||||
t.Errorf("Expected name Test Custom, got %v", resp["name"])
|
||||
}
|
||||
|
||||
audio := resp["audio"].(map[string]interface{})
|
||||
if audio["streamUrl"] != "http://example.com/stream" {
|
||||
t.Errorf("Expected streamUrl http://example.com/stream, got %v", audio["streamUrl"])
|
||||
}
|
||||
|
||||
if resp["imageUrl"] != imageUrl {
|
||||
t.Errorf("Expected imageUrl %s, got %v", imageUrl, resp["imageUrl"])
|
||||
}
|
||||
}
|
||||
|
||||
@@ -59,7 +59,7 @@ func (s *Server) HandleDocs(w http.ResponseWriter, r *http.Request) {
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>%s - Bose SoundTouch Toolkit Docs</title>
|
||||
<link rel="icon" href="/media/favicon-braille.svg" type="image/svg+xml">
|
||||
<link rel="icon" href="/web/img/favicon-braille.svg" type="image/svg+xml">
|
||||
<link rel="stylesheet" href="/web/css/style.css">
|
||||
<style>
|
||||
body { margin: 0; padding: 0; display: flex; font-family: sans-serif; height: 100vh; overflow: hidden; }
|
||||
|
||||
@@ -14,7 +14,7 @@ import (
|
||||
|
||||
func TestEventLog(t *testing.T) {
|
||||
ds := datastore.NewDataStore(t.TempDir())
|
||||
s := &Server{ds: ds}
|
||||
s := NewServer(ds, nil, "http://localhost", false, false, false)
|
||||
|
||||
r := chi.NewRouter()
|
||||
r.Post("/streaming/stats/usage", s.HandleUsageStats)
|
||||
|
||||
@@ -20,7 +20,7 @@ type healthResp struct {
|
||||
|
||||
func TestHealthEndpoint(t *testing.T) {
|
||||
r := chi.NewRouter()
|
||||
srv := &Server{}
|
||||
srv := NewServer(nil, nil, "http://localhost", false, false, false)
|
||||
r.Get("/health", srv.HandleHealth)
|
||||
|
||||
ts := httptest.NewServer(r)
|
||||
|
||||
@@ -4,11 +4,13 @@ import (
|
||||
"encoding/xml"
|
||||
"io"
|
||||
"log"
|
||||
"net"
|
||||
"net/http"
|
||||
"strconv"
|
||||
"time"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/models"
|
||||
"github.com/gesellix/bose-soundtouch/pkg/service/constants"
|
||||
"github.com/gesellix/bose-soundtouch/pkg/service/marge"
|
||||
"github.com/go-chi/chi/v5"
|
||||
)
|
||||
@@ -27,7 +29,7 @@ func (s *Server) HandleMargeSourceProviders(w http.ResponseWriter, r *http.Reque
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "application/xml")
|
||||
w.Header().Set("Content-Type", "application/vnd.bose.streaming-v1.2+xml")
|
||||
w.Header()["ETag"] = []string{etag}
|
||||
_, _ = w.Write(data)
|
||||
}
|
||||
@@ -50,13 +52,80 @@ func (s *Server) HandleMargeAccountFull(w http.ResponseWriter, r *http.Request)
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "application/xml")
|
||||
w.Header().Set("Content-Type", "application/vnd.bose.streaming-v1.2+xml")
|
||||
w.Header()["ETag"] = []string{etag}
|
||||
_, _ = w.Write(data)
|
||||
}
|
||||
|
||||
// HandleMargePowerOn handles the Marge power on request.
|
||||
func (s *Server) HandleMargePowerOn(w http.ResponseWriter, _ *http.Request) {
|
||||
func (s *Server) HandleMargePowerOn(w http.ResponseWriter, r *http.Request) {
|
||||
body, err := io.ReadAll(r.Body)
|
||||
if err != nil {
|
||||
log.Printf("[Marge] Failed to read power_on body: %v", err)
|
||||
w.WriteHeader(http.StatusOK)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
var req models.CustomerSupportRequest
|
||||
if err := xml.Unmarshal(body, &req); err != nil {
|
||||
log.Printf("[Marge] Failed to parse power_on body: %v", err)
|
||||
|
||||
// Fallback to remote address if body parsing fails
|
||||
if host, _, err := net.SplitHostPort(r.RemoteAddr); err == nil {
|
||||
go s.PrimeDeviceWithSpotify(host)
|
||||
}
|
||||
|
||||
w.WriteHeader(http.StatusOK)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
deviceID := req.Device.ID
|
||||
deviceIP := req.DiagnosticData.DeviceLandscape.IPAddress
|
||||
|
||||
log.Printf("[Marge] Device %s powered on (IP: %s)", deviceID, deviceIP)
|
||||
|
||||
// Persist device details provided in the power_on request
|
||||
if deviceID != "" && s.ds != nil {
|
||||
// Use "default" account if not found or if the device is not yet mapped to an account.
|
||||
// In a real scenario, this might be resolved differently if we already have the account info.
|
||||
accountID := "default"
|
||||
if existing := s.findExistingDeviceInfoByDeviceID(deviceID); existing != nil && existing.AccountID != "" {
|
||||
accountID = existing.AccountID
|
||||
}
|
||||
|
||||
macAddress := ""
|
||||
if len(req.DiagnosticData.DeviceLandscape.MacAddresses) > 0 {
|
||||
macAddress = req.DiagnosticData.DeviceLandscape.MacAddresses[0]
|
||||
}
|
||||
|
||||
info := &models.ServiceDeviceInfo{
|
||||
DeviceID: deviceID,
|
||||
AccountID: accountID,
|
||||
ProductCode: req.Device.Product.ProductCode,
|
||||
DeviceSerialNumber: req.Device.SerialNumber,
|
||||
ProductSerialNumber: req.Device.Product.SerialNumber,
|
||||
FirmwareVersion: req.Device.FirmwareVersion,
|
||||
IPAddress: deviceIP,
|
||||
MacAddress: macAddress,
|
||||
DiscoveryMethod: "power_on",
|
||||
}
|
||||
|
||||
if err := s.ds.SaveDeviceInfo(accountID, deviceID, info); err != nil {
|
||||
log.Printf("[Marge] Failed to save device info for %s: %v", deviceID, err)
|
||||
}
|
||||
}
|
||||
|
||||
if deviceIP != "" {
|
||||
go s.PrimeDeviceWithSpotify(deviceIP)
|
||||
} else {
|
||||
// Fallback to remote address if IP is missing from XML
|
||||
if host, _, err := net.SplitHostPort(r.RemoteAddr); err == nil {
|
||||
go s.PrimeDeviceWithSpotify(host)
|
||||
}
|
||||
}
|
||||
|
||||
w.WriteHeader(http.StatusOK)
|
||||
}
|
||||
|
||||
@@ -109,7 +178,7 @@ func (s *Server) HandleMargeGetEmailAddress(w http.ResponseWriter, _ *http.Reque
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "application/xml")
|
||||
w.Header().Set("Content-Type", "application/vnd.bose.streaming-v1.2+xml")
|
||||
_, _ = w.Write([]byte(xml.Header))
|
||||
_, _ = w.Write(data)
|
||||
}
|
||||
@@ -128,7 +197,7 @@ func (s *Server) HandleMargeGetDeviceSettings(w http.ResponseWriter, _ *http.Req
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "application/xml")
|
||||
w.Header().Set("Content-Type", "application/vnd.bose.streaming-v1.2+xml")
|
||||
_, _ = w.Write([]byte(xml.Header))
|
||||
_, _ = w.Write(data)
|
||||
}
|
||||
@@ -147,13 +216,28 @@ func (s *Server) HandleMargeSoftwareUpdate(w http.ResponseWriter, r *http.Reques
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "application/xml")
|
||||
w.Header().Set("Content-Type", "application/vnd.bose.streaming-v1.2+xml")
|
||||
w.Header()["ETag"] = []string{etag}
|
||||
|
||||
// For the account-specific firmware route, always return the software_update tag.
|
||||
// This route is specifically used by firmware like Bose_Lisa/27.0.6.
|
||||
if chi.URLParam(r, "account") != "" {
|
||||
w.Header().Set("Content-Type", "application/vnd.bose.streaming-v1.2+xml")
|
||||
|
||||
xmlData := marge.SoftwareUpdateToXML()
|
||||
w.Header().Set("Content-Length", strconv.Itoa(len(xmlData)))
|
||||
_, _ = w.Write([]byte(xmlData))
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
if len(swUpdateXML) > 0 {
|
||||
w.Header().Set("Content-Length", strconv.Itoa(len(swUpdateXML)))
|
||||
_, _ = w.Write(swUpdateXML)
|
||||
} else {
|
||||
_, _ = w.Write([]byte(marge.SoftwareUpdateToXML()))
|
||||
xmlData := marge.SoftwareUpdateToXML()
|
||||
w.Header().Set("Content-Length", strconv.Itoa(len(xmlData)))
|
||||
_, _ = w.Write([]byte(xmlData))
|
||||
}
|
||||
}
|
||||
|
||||
@@ -174,7 +258,7 @@ func (s *Server) HandleMargePresets(w http.ResponseWriter, r *http.Request) {
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "application/xml")
|
||||
w.Header().Set("Content-Type", "application/vnd.bose.streaming-v1.2+xml")
|
||||
w.Header()["ETag"] = []string{etag}
|
||||
_, _ = w.Write(data)
|
||||
}
|
||||
@@ -207,7 +291,29 @@ func (s *Server) HandleMargeUpdatePreset(w http.ResponseWriter, r *http.Request)
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "application/xml")
|
||||
w.Header().Set("Content-Type", "application/vnd.bose.streaming-v1.2+xml")
|
||||
_, _ = w.Write(data)
|
||||
}
|
||||
|
||||
// HandleMargeRecents returns the Marge recents for a device.
|
||||
func (s *Server) HandleMargeRecents(w http.ResponseWriter, r *http.Request) {
|
||||
account := chi.URLParam(r, "account")
|
||||
device := chi.URLParam(r, "device")
|
||||
|
||||
etag := strconv.FormatInt(s.ds.GetETagForRecents(account, device), 10)
|
||||
if r.Header.Get("If-None-Match") == etag {
|
||||
w.WriteHeader(http.StatusNotModified)
|
||||
return
|
||||
}
|
||||
|
||||
data, err := marge.RecentsToXML(s.ds, account, device)
|
||||
if err != nil {
|
||||
http.Error(w, err.Error(), http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "application/vnd.bose.streaming-v1.2+xml")
|
||||
w.Header()["ETag"] = []string{etag}
|
||||
_, _ = w.Write(data)
|
||||
}
|
||||
|
||||
@@ -231,7 +337,8 @@ func (s *Server) HandleMargeAddRecent(w http.ResponseWriter, r *http.Request) {
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "application/xml")
|
||||
w.Header().Set("Content-Type", "application/vnd.bose.streaming-v1.2+xml")
|
||||
w.WriteHeader(http.StatusCreated)
|
||||
_, _ = w.Write(data)
|
||||
}
|
||||
|
||||
@@ -251,7 +358,7 @@ func (s *Server) HandleMargeAddDevice(w http.ResponseWriter, r *http.Request) {
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "application/xml")
|
||||
w.Header().Set("Content-Type", "application/vnd.bose.streaming-v1.2+xml")
|
||||
_, _ = w.Write(data)
|
||||
}
|
||||
|
||||
@@ -273,7 +380,7 @@ func (s *Server) HandleMargeRemoveDevice(w http.ResponseWriter, r *http.Request)
|
||||
func (s *Server) HandleMargeProviderSettings(w http.ResponseWriter, r *http.Request) {
|
||||
account := chi.URLParam(r, "account")
|
||||
|
||||
w.Header().Set("Content-Type", "application/xml")
|
||||
w.Header().Set("Content-Type", "application/vnd.bose.streaming-v1.2+xml")
|
||||
_, _ = w.Write([]byte(marge.ProviderSettingsToXML(account)))
|
||||
}
|
||||
|
||||
@@ -295,10 +402,30 @@ func (s *Server) HandleMargeStreamingToken(w http.ResponseWriter, _ *http.Reques
|
||||
w.Header().Set("Content-Type", "application/vnd.bose.streaming-v1.2+xml")
|
||||
w.Header().Set("Authorization", bearerToken.GetAuthHeader())
|
||||
w.WriteHeader(http.StatusOK)
|
||||
_, _ = w.Write([]byte(xml.Header))
|
||||
_, _ = w.Write([]byte(constants.XMLHeader))
|
||||
_, _ = w.Write(data)
|
||||
}
|
||||
|
||||
// HandleMargeDeviceGroup returns grouping information for a device (empty group by default).
|
||||
func (s *Server) HandleMargeDeviceGroup(w http.ResponseWriter, _ *http.Request) {
|
||||
// Native firmware expects vnd.bose.streaming content type
|
||||
w.Header().Set("Content-Type", "application/vnd.bose.streaming-v1.2+xml")
|
||||
w.WriteHeader(http.StatusOK)
|
||||
_, _ = w.Write([]byte(constants.XMLHeader + `<group/>`))
|
||||
}
|
||||
|
||||
// HandleMargeDeviceGroupServer returns grouping server information (404 by default if not a server).
|
||||
func (s *Server) HandleMargeDeviceGroupServer(w http.ResponseWriter, r *http.Request) {
|
||||
// Not in a group as server
|
||||
http.NotFound(w, r)
|
||||
}
|
||||
|
||||
// HandleMargeDeviceGroupMember returns grouping member information (404 by default if not a member).
|
||||
func (s *Server) HandleMargeDeviceGroupMember(w http.ResponseWriter, r *http.Request) {
|
||||
// Not in a group as member
|
||||
http.NotFound(w, r)
|
||||
}
|
||||
|
||||
// HandleMargeCustomerSupport handles Marge customer support uploads.
|
||||
func (s *Server) HandleMargeCustomerSupport(w http.ResponseWriter, r *http.Request) {
|
||||
body, err := io.ReadAll(r.Body)
|
||||
@@ -326,7 +453,5 @@ func (s *Server) HandleMargeCustomerSupport(w http.ResponseWriter, r *http.Reque
|
||||
},
|
||||
}
|
||||
s.ds.AddDeviceEvent(req.Device.ID, event)
|
||||
|
||||
w.Header().Set("Content-Type", "application/vnd.bose.streaming-v1.2+xml")
|
||||
w.WriteHeader(http.StatusOK)
|
||||
}
|
||||
|
||||
@@ -2,6 +2,7 @@ package handlers
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
@@ -54,10 +55,13 @@ func TestMargeSoftwareUpdate(t *testing.T) {
|
||||
}
|
||||
|
||||
body, _ := io.ReadAll(res.Body)
|
||||
// Should contain software_update or INDEX (if swupdate.xml exists)
|
||||
if !strings.Contains(string(body), "software_update") && !strings.Contains(string(body), "INDEX") {
|
||||
// Should contain INDEX as we updated swupdate.xml
|
||||
if !strings.Contains(string(body), "INDEX") {
|
||||
t.Errorf("Unexpected response: %s", string(body))
|
||||
}
|
||||
if !strings.Contains(string(body), "0x0933") {
|
||||
t.Errorf("Response missing VideoWave (0x0933) info: %s", string(body))
|
||||
}
|
||||
}
|
||||
|
||||
func TestMargeAccountFull(t *testing.T) {
|
||||
@@ -264,7 +268,7 @@ func TestMargeUpdatePreset(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestMargeDeviceInfo(t *testing.T) {
|
||||
func TestMargeAddRecentRoute(t *testing.T) {
|
||||
tempDir, err := os.MkdirTemp("", "st-test-*")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create temp dir: %v", err)
|
||||
@@ -320,8 +324,8 @@ func TestMargeDeviceInfo(t *testing.T) {
|
||||
|
||||
defer func() { _ = res.Body.Close() }()
|
||||
|
||||
if res.StatusCode != http.StatusOK {
|
||||
t.Errorf("Expected status OK, got %v", res.Status)
|
||||
if res.StatusCode != http.StatusCreated {
|
||||
t.Errorf("Expected status Created, got %v", res.Status)
|
||||
}
|
||||
|
||||
// Verify file was saved
|
||||
@@ -331,6 +335,298 @@ func TestMargeDeviceInfo(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestMargeNativeStreamingRoutes(t *testing.T) {
|
||||
tempDir, err := os.MkdirTemp("", "st-test-native-*")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create temp dir: %v", err)
|
||||
}
|
||||
|
||||
defer func() { _ = os.RemoveAll(tempDir) }()
|
||||
|
||||
ds := datastore.NewDataStore(tempDir)
|
||||
|
||||
account := "12345"
|
||||
deviceID := "DEV1"
|
||||
|
||||
accountDir := filepath.Join(tempDir, "accounts", account)
|
||||
deviceDir := filepath.Join(accountDir, "devices", deviceID)
|
||||
err = os.MkdirAll(deviceDir, 0755)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create device dir: %v", err)
|
||||
}
|
||||
|
||||
// Mock Sources.xml for recent tests
|
||||
if err := os.WriteFile(filepath.Join(deviceDir, "Sources.xml"), []byte(`
|
||||
<sources>
|
||||
<source id="SRC1" displayName="TUNEIN" secret="" secretType="Audio">
|
||||
<sourceKey type="TUNEIN" account=""/>
|
||||
</source>
|
||||
</sources>
|
||||
`), 0644); err != nil {
|
||||
t.Fatalf("Failed to write Sources.xml: %v", err)
|
||||
}
|
||||
|
||||
if err := os.WriteFile(filepath.Join(deviceDir, "Recents.xml"), []byte(`<recents></recents>`), 0644); err != nil {
|
||||
t.Fatalf("Failed to write Recents.xml: %v", err)
|
||||
}
|
||||
|
||||
if err := os.WriteFile(filepath.Join(deviceDir, "Presets.xml"), []byte(`<presets></presets>`), 0644); err != nil {
|
||||
t.Fatalf("Failed to write Presets.xml: %v", err)
|
||||
}
|
||||
|
||||
r, _ := setupRouter("http://localhost:8001", ds)
|
||||
ts := httptest.NewServer(r)
|
||||
defer ts.Close()
|
||||
|
||||
t.Run("POST /streaming/account/{account}/device/{device}/recent", func(t *testing.T) {
|
||||
payload := `
|
||||
<recent>
|
||||
<name>New Route Recent</name>
|
||||
<sourceid>SRC1</sourceid>
|
||||
<location>/station/s999</location>
|
||||
<contentItemType>station</contentItemType>
|
||||
</recent>`
|
||||
|
||||
res, err := http.Post(ts.URL+"/streaming/account/"+account+"/device/"+deviceID+"/recent", "application/xml", strings.NewReader(payload))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
if res.StatusCode != http.StatusCreated {
|
||||
body, _ := io.ReadAll(res.Body)
|
||||
t.Errorf("Expected status Created, got %v: %s", res.Status, string(body))
|
||||
}
|
||||
|
||||
if ct := res.Header.Get("Content-Type"); ct != "application/vnd.bose.streaming-v1.2+xml" {
|
||||
t.Errorf("Expected Content-Type application/vnd.bose.streaming-v1.2+xml, got %v", ct)
|
||||
}
|
||||
|
||||
// Verify file was saved
|
||||
recentData, _ := os.ReadFile(filepath.Join(deviceDir, "Recents.xml"))
|
||||
if !strings.Contains(string(recentData), "New Route Recent") {
|
||||
t.Error("Recent from native route was not saved to datastore")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("GET /streaming/account/{account}/full", func(t *testing.T) {
|
||||
res, err := http.Get(ts.URL + "/streaming/account/" + account + "/full")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
if res.StatusCode != http.StatusOK {
|
||||
body, _ := io.ReadAll(res.Body)
|
||||
t.Errorf("Expected status OK, got %v: %s", res.Status, string(body))
|
||||
}
|
||||
|
||||
if ct := res.Header.Get("Content-Type"); ct != "application/vnd.bose.streaming-v1.2+xml" {
|
||||
t.Errorf("Expected Content-Type application/vnd.bose.streaming-v1.2+xml, got %v", ct)
|
||||
}
|
||||
|
||||
fullData, _ := io.ReadAll(res.Body)
|
||||
if !strings.Contains(string(fullData), account) {
|
||||
t.Error("Account full response does not contain account ID")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("GET /streaming/software/update/account/{account}", func(t *testing.T) {
|
||||
res, err := http.Get(ts.URL + "/streaming/software/update/account/" + account)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
if res.StatusCode != http.StatusOK {
|
||||
body, _ := io.ReadAll(res.Body)
|
||||
t.Errorf("Expected status OK, got %v: %s", res.Status, string(body))
|
||||
}
|
||||
|
||||
if ct := res.Header.Get("Content-Type"); ct != "application/vnd.bose.streaming-v1.2+xml" {
|
||||
t.Errorf("Expected Content-Type application/vnd.bose.streaming-v1.2+xml, got %v", ct)
|
||||
}
|
||||
|
||||
swData, _ := io.ReadAll(res.Body)
|
||||
if !strings.Contains(string(swData), "software_update") {
|
||||
t.Errorf("Response missing software_update tag: %s", string(swData))
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("GET /streaming/account/{account}/device/{device}/recent", func(t *testing.T) {
|
||||
res, err := http.Get(ts.URL + "/streaming/account/" + account + "/device/" + deviceID + "/recent")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
if res.StatusCode != http.StatusOK {
|
||||
body, _ := io.ReadAll(res.Body)
|
||||
t.Errorf("Expected status OK, got %v: %s", res.Status, string(body))
|
||||
}
|
||||
|
||||
if ct := res.Header.Get("Content-Type"); ct != "application/vnd.bose.streaming-v1.2+xml" {
|
||||
t.Errorf("Expected Content-Type application/vnd.bose.streaming-v1.2+xml, got %v", ct)
|
||||
}
|
||||
|
||||
etag := res.Header.Get("ETag")
|
||||
if etag == "" {
|
||||
t.Error("Expected ETag header")
|
||||
}
|
||||
|
||||
recentData, _ := io.ReadAll(res.Body)
|
||||
if !strings.Contains(string(recentData), "recents") {
|
||||
t.Errorf("Response missing recents tag: %s", string(recentData))
|
||||
}
|
||||
|
||||
// Test 304
|
||||
req, _ := http.NewRequest("GET", ts.URL+"/streaming/account/"+account+"/device/"+deviceID+"/recent", nil)
|
||||
req.Header.Set("If-None-Match", etag)
|
||||
res2, err := http.DefaultClient.Do(req)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer res2.Body.Close()
|
||||
if res2.StatusCode != http.StatusNotModified {
|
||||
t.Errorf("Expected 304 Not Modified, got %v", res2.Status)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("GET /streaming/account/{account}/device/{device}/presets", func(t *testing.T) {
|
||||
res, err := http.Get(ts.URL + "/streaming/account/" + account + "/device/" + deviceID + "/presets")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
if res.StatusCode != http.StatusOK {
|
||||
body, _ := io.ReadAll(res.Body)
|
||||
t.Errorf("Expected status OK, got %v: %s", res.Status, string(body))
|
||||
}
|
||||
|
||||
if ct := res.Header.Get("Content-Type"); ct != "application/vnd.bose.streaming-v1.2+xml" {
|
||||
t.Errorf("Expected Content-Type application/vnd.bose.streaming-v1.2+xml, got %v", ct)
|
||||
}
|
||||
|
||||
etag := res.Header.Get("ETag")
|
||||
if etag == "" {
|
||||
t.Error("Expected ETag header")
|
||||
}
|
||||
|
||||
presetData, _ := io.ReadAll(res.Body)
|
||||
if !strings.Contains(string(presetData), "presets") {
|
||||
t.Errorf("Response missing presets tag: %s", string(presetData))
|
||||
}
|
||||
|
||||
// Test 304
|
||||
req, _ := http.NewRequest("GET", ts.URL+"/streaming/account/"+account+"/device/"+deviceID+"/presets", nil)
|
||||
req.Header.Set("If-None-Match", etag)
|
||||
res2, err := http.DefaultClient.Do(req)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer res2.Body.Close()
|
||||
if res2.StatusCode != http.StatusNotModified {
|
||||
t.Errorf("Expected 304 Not Modified, got %v", res2.Status)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("POST /streaming/account/{account}/device/{device}/presets/{presetNumber}", func(t *testing.T) {
|
||||
payload := `
|
||||
<preset>
|
||||
<name>New Native Preset</name>
|
||||
<sourceid>SRC1</sourceid>
|
||||
<location>/station/s777</location>
|
||||
<contentItemType>station</contentItemType>
|
||||
</preset>`
|
||||
|
||||
res, err := http.Post(ts.URL+"/streaming/account/"+account+"/device/"+deviceID+"/presets/1", "application/xml", strings.NewReader(payload))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
if res.StatusCode != http.StatusOK {
|
||||
body, _ := io.ReadAll(res.Body)
|
||||
t.Errorf("Expected status OK, got %v: %s", res.Status, string(body))
|
||||
}
|
||||
|
||||
if ct := res.Header.Get("Content-Type"); ct != "application/vnd.bose.streaming-v1.2+xml" {
|
||||
t.Errorf("Expected Content-Type application/vnd.bose.streaming-v1.2+xml, got %v", ct)
|
||||
}
|
||||
|
||||
// Verify file was saved
|
||||
presetData, _ := os.ReadFile(filepath.Join(deviceDir, "Presets.xml"))
|
||||
if !strings.Contains(string(presetData), "New Native Preset") {
|
||||
t.Error("Preset from native route was not saved to datastore")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("GET /streaming/account/{account}/device/{device}/group/", func(t *testing.T) {
|
||||
res, err := http.Get(ts.URL + "/streaming/account/" + account + "/device/" + deviceID + "/group/")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
if res.StatusCode != http.StatusOK {
|
||||
body, _ := io.ReadAll(res.Body)
|
||||
t.Errorf("Expected status OK, got %v: %s", res.Status, string(body))
|
||||
}
|
||||
|
||||
groupData, _ := io.ReadAll(res.Body)
|
||||
if !strings.Contains(string(groupData), "<group") {
|
||||
t.Errorf("Response missing group tag: %s", string(groupData))
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("GET /streaming/account/{account}/device/{device}/group/server", func(t *testing.T) {
|
||||
res, err := http.Get(ts.URL + "/streaming/account/" + account + "/device/" + deviceID + "/group/server")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
if res.StatusCode != http.StatusNotFound {
|
||||
t.Errorf("Expected 404 Not Found, got %v", res.Status)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("GET /streaming/account/{account}/device/{device}/group/member", func(t *testing.T) {
|
||||
res, err := http.Get(ts.URL + "/streaming/account/" + account + "/device/" + deviceID + "/group/member")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
if res.StatusCode != http.StatusNotFound {
|
||||
t.Errorf("Expected 404 Not Found, got %v", res.Status)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("GET /marge/accounts/{account}/devices/{device}/group", func(t *testing.T) {
|
||||
res, err := http.Get(ts.URL + "/marge/accounts/" + account + "/devices/" + deviceID + "/group")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
if res.StatusCode != http.StatusOK {
|
||||
body, _ := io.ReadAll(res.Body)
|
||||
t.Errorf("Expected status OK, got %v: %s", res.Status, string(body))
|
||||
}
|
||||
|
||||
if ct := res.Header.Get("Content-Type"); ct != "application/vnd.bose.streaming-v1.2+xml" {
|
||||
t.Errorf("Expected Content-Type application/vnd.bose.streaming-v1.2+xml, got %v", ct)
|
||||
}
|
||||
|
||||
groupData, _ := io.ReadAll(res.Body)
|
||||
if !strings.Contains(string(groupData), "<group") {
|
||||
t.Errorf("Response missing group tag: %s", string(groupData))
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestMargeAddRemoveDevice(t *testing.T) {
|
||||
tempDir, err := os.MkdirTemp("", "st-test-*")
|
||||
if err != nil {
|
||||
@@ -414,16 +710,112 @@ func TestMargePowerOn(t *testing.T) {
|
||||
ts := httptest.NewServer(r)
|
||||
defer ts.Close()
|
||||
|
||||
res, err := http.Post(ts.URL+"/marge/streaming/support/power_on", "application/xml", bytes.NewReader([]byte("<powerOn/>")))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
t.Run("EmptyBody", func(t *testing.T) {
|
||||
res, err := http.Post(ts.URL+"/marge/streaming/support/power_on", "application/xml", bytes.NewReader([]byte("<powerOn/>")))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer func() { _ = res.Body.Close() }()
|
||||
if res.StatusCode != http.StatusOK {
|
||||
t.Errorf("Expected status OK, got %v", res.Status)
|
||||
}
|
||||
})
|
||||
|
||||
defer func() { _ = res.Body.Close() }()
|
||||
t.Run("FullBody", func(t *testing.T) {
|
||||
payload := `<?xml version="1.0" encoding="UTF-8" ?><device-data><device id="A81B6A536A98"><serialnumber>I6332527703739342000020</serialnumber><firmware-version>27.0.6.46330</firmware-version><product product_code="SoundTouch 10 sm2" type="5"><serialnumber>069231P63364828AE</serialnumber></product></device><diagnostic-data><device-landscape><rssi>Excellent</rssi><gateway-ip-address>192.168.1.1</gateway-ip-address><macaddresses><macaddress>A81B6A536A98</macaddress></macaddresses><ip-address>192.168.1.100</ip-address><network-connection-type>Wireless</network-connection-type></device-landscape></diagnostic-data></device-data>`
|
||||
res, err := http.Post(ts.URL+"/marge/streaming/support/power_on", "application/vnd.bose.streaming-v1.2+xml", strings.NewReader(payload))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer func() { _ = res.Body.Close() }()
|
||||
if res.StatusCode != http.StatusOK {
|
||||
t.Errorf("Expected status OK, got %v", res.Status)
|
||||
}
|
||||
})
|
||||
|
||||
if res.StatusCode != http.StatusOK {
|
||||
t.Errorf("Expected status OK, got %v", res.Status)
|
||||
}
|
||||
t.Run("Persistence", func(t *testing.T) {
|
||||
tempDir, err := os.MkdirTemp("", "st-test-*")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create temp dir: %v", err)
|
||||
}
|
||||
defer func() { _ = os.RemoveAll(tempDir) }()
|
||||
|
||||
ds := datastore.NewDataStore(tempDir)
|
||||
r, _ := setupRouter("http://localhost:8001", ds)
|
||||
ts2 := httptest.NewServer(r)
|
||||
defer ts2.Close()
|
||||
|
||||
deviceID := "A81B6A536A98"
|
||||
serialNumber := "I6332527703739342000020"
|
||||
firmware := "27.0.6.46330"
|
||||
productCode := "SoundTouch 10 sm2"
|
||||
productSerial := "069231P63364828AE"
|
||||
ipAddress := "192.168.1.100"
|
||||
macAddress := "A81B6A536A98"
|
||||
|
||||
payload := fmt.Sprintf(`<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<device-data>
|
||||
<device id="%s">
|
||||
<serialnumber>%s</serialnumber>
|
||||
<firmware-version>%s</firmware-version>
|
||||
<product product_code="%s" type="5">
|
||||
<serialnumber>%s</serialnumber>
|
||||
</product>
|
||||
</device>
|
||||
<diagnostic-data>
|
||||
<device-landscape>
|
||||
<rssi>Excellent</rssi>
|
||||
<gateway-ip-address>192.168.1.1</gateway-ip-address>
|
||||
<macaddresses>
|
||||
<macaddress>%s</macaddress>
|
||||
</macaddresses>
|
||||
<ip-address>%s</ip-address>
|
||||
<network-connection-type>Wireless</network-connection-type>
|
||||
</device-landscape>
|
||||
</diagnostic-data>
|
||||
</device-data>`, deviceID, serialNumber, firmware, productCode, productSerial, macAddress, ipAddress)
|
||||
|
||||
res, err := http.Post(ts2.URL+"/marge/streaming/support/power_on", "application/vnd.bose.streaming-v1.2+xml", strings.NewReader(payload))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer func() { _ = res.Body.Close() }()
|
||||
|
||||
if res.StatusCode != http.StatusOK {
|
||||
t.Errorf("Expected status OK, got %v", res.Status)
|
||||
}
|
||||
|
||||
// Verify data in datastore
|
||||
info, err := ds.GetDeviceInfo("default", deviceID)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get device info: %v", err)
|
||||
}
|
||||
|
||||
if info.DeviceID != deviceID {
|
||||
t.Errorf("Expected DeviceID %s, got %s", deviceID, info.DeviceID)
|
||||
}
|
||||
if info.DeviceSerialNumber != serialNumber {
|
||||
t.Errorf("Expected SerialNumber %s, got %s", serialNumber, info.DeviceSerialNumber)
|
||||
}
|
||||
if info.FirmwareVersion != firmware {
|
||||
t.Errorf("Expected Firmware %s, got %s", firmware, info.FirmwareVersion)
|
||||
}
|
||||
if info.ProductCode != productCode {
|
||||
t.Errorf("Expected ProductCode %s, got %s", productCode, info.ProductCode)
|
||||
}
|
||||
if info.ProductSerialNumber != productSerial {
|
||||
t.Errorf("Expected ProductSerialNumber %s, got %s", productSerial, info.ProductSerialNumber)
|
||||
}
|
||||
if info.IPAddress != ipAddress {
|
||||
t.Errorf("Expected IPAddress %s, got %s", ipAddress, info.IPAddress)
|
||||
}
|
||||
if info.MacAddress != macAddress {
|
||||
t.Errorf("Expected MacAddress %s, got %s", macAddress, info.MacAddress)
|
||||
}
|
||||
if info.DiscoveryMethod != "power_on" {
|
||||
t.Errorf("Expected DiscoveryMethod power_on, got %s", info.DiscoveryMethod)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestMargeAdvancedFeatures(t *testing.T) {
|
||||
@@ -457,6 +849,12 @@ func TestMargeAdvancedFeatures(t *testing.T) {
|
||||
if !strings.Contains(string(body), "<boseId>123</boseId>") {
|
||||
t.Errorf("Response body missing account ID: %s", body)
|
||||
}
|
||||
if !strings.Contains(string(body), "<keyName>ELIGIBLE_FOR_TRIAL</keyName>") {
|
||||
t.Errorf("Response body missing ELIGIBLE_FOR_TRIAL: %s", body)
|
||||
}
|
||||
if !strings.Contains(string(body), "<keyName>STREAMING_QUALITY</keyName>") {
|
||||
t.Errorf("Response body missing STREAMING_QUALITY: %s", body)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("StreamingToken", func(t *testing.T) {
|
||||
@@ -519,6 +917,10 @@ func TestMargeAdvancedFeatures(t *testing.T) {
|
||||
t.Errorf("Expected status OK, got %v", res.Status)
|
||||
}
|
||||
|
||||
if ct := res.Header.Get("Content-Type"); ct != "" {
|
||||
t.Errorf("Expected no Content-Type for customer support upload (empty body), got %v", ct)
|
||||
}
|
||||
|
||||
// Verify event was recorded
|
||||
events := ds.GetDeviceEvents("587A628A4042")
|
||||
found := false
|
||||
@@ -539,4 +941,40 @@ func TestMargeAdvancedFeatures(t *testing.T) {
|
||||
t.Error("Customer support event not found in event log")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("AddRecent_Reproduction", func(t *testing.T) {
|
||||
account := "3230304"
|
||||
device := "A81B6A536A98"
|
||||
|
||||
// Setup sources for this device
|
||||
deviceDir := ds.AccountDeviceDir(account, device)
|
||||
_ = os.MkdirAll(deviceDir, 0755)
|
||||
_ = os.WriteFile(filepath.Join(deviceDir, "Recents.xml"), []byte("<recents/>"), 0644)
|
||||
// No Sources.xml
|
||||
|
||||
path := "/marge/streaming/account/" + account + "/device/" + device + "/recent"
|
||||
payload := `<?xml version="1.0" encoding="UTF-8" ?><recent><lastplayedat>2026-02-25T23:03:14+00:00</lastplayedat><sourceid>10863533</sourceid><name>My top tracks playlist</name><location>/playback/container/c3BvdGlmeTpwbGF5bGlzdDo3YklIMERKRUdoVjFSZ2duandOYWxn</location><contentItemType>tracklisturl</contentItemType></recent>`
|
||||
|
||||
res, err := http.Post(ts.URL+path, "application/xml", strings.NewReader(payload))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
if res.StatusCode != http.StatusCreated {
|
||||
body, _ := io.ReadAll(res.Body)
|
||||
t.Errorf("Expected status Created (201), got %v: %s", res.Status, body)
|
||||
}
|
||||
|
||||
// Verify it was saved
|
||||
recents, err := ds.GetRecents(account, device)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get recents: %v", err)
|
||||
}
|
||||
if len(recents) == 0 {
|
||||
t.Error("Recents list is empty")
|
||||
} else if recents[0].Name != "My top tracks playlist" {
|
||||
t.Errorf("Expected name 'My top tracks playlist', got '%s'", recents[0].Name)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
@@ -11,7 +11,7 @@ import (
|
||||
//go:embed web/index.html
|
||||
var indexHTML []byte
|
||||
|
||||
//go:embed web/css/* web/js/*
|
||||
//go:embed web/css/* web/js/* web/img/favicon-braille* web/img/favicon*
|
||||
var webFS embed.FS
|
||||
|
||||
//go:embed static/media/*
|
||||
@@ -50,7 +50,6 @@ func (s *Server) HandleMedia() http.HandlerFunc {
|
||||
subFS, _ := fs.Sub(mediaFS, "static/media")
|
||||
|
||||
return func(w http.ResponseWriter, r *http.Request) {
|
||||
fs := http.StripPrefix("/media/", http.FileServer(http.FS(subFS)))
|
||||
fs.ServeHTTP(w, r)
|
||||
http.StripPrefix("/media", http.FileServer(http.FS(subFS))).ServeHTTP(w, r)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -79,8 +79,8 @@ func TestStaticMedia(t *testing.T) {
|
||||
ts := httptest.NewServer(r)
|
||||
defer ts.Close()
|
||||
|
||||
// Use a known file from static/media
|
||||
res, err := http.Get(ts.URL + "/media/SiriusXM_Logo_Color.svg")
|
||||
// Use a known file from static/media in a subdirectory
|
||||
res, err := http.Get(ts.URL + "/media/bmx-icons/siriusxm-everest/SiriusXM_Logo_Color.svg")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
@@ -131,4 +131,51 @@ func TestStaticWeb(t *testing.T) {
|
||||
!strings.Contains(res.Header.Get("Content-Type"), "text/javascript") {
|
||||
t.Errorf("JS: Expected javascript content type, got %s", res.Header.Get("Content-Type"))
|
||||
}
|
||||
|
||||
// 3. Test diff.min.js
|
||||
res, err = http.Get(ts.URL + "/web/js/diff.min.js")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
if res.StatusCode != http.StatusOK {
|
||||
t.Errorf("Diff JS: Expected status OK, got %v", res.Status)
|
||||
}
|
||||
|
||||
// 4. Test Favicon
|
||||
res, err = http.Get(ts.URL + "/web/img/favicon-braille.svg")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
if res.StatusCode != http.StatusOK {
|
||||
t.Errorf("Favicon: Expected status OK, got %v", res.Status)
|
||||
}
|
||||
if !strings.Contains(res.Header.Get("Content-Type"), "image/svg+xml") {
|
||||
t.Errorf("Favicon: Expected image/svg+xml content type, got %s", res.Header.Get("Content-Type"))
|
||||
}
|
||||
|
||||
// 5. Test old Favicon path (should be 404)
|
||||
res, err = http.Get(ts.URL + "/media/favicon-braille.svg")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
if res.StatusCode != http.StatusNotFound {
|
||||
t.Errorf("Old Favicon: Expected status NotFound, got %v", res.Status)
|
||||
}
|
||||
|
||||
// 6. Test old Favicon path in web/ (should be 404)
|
||||
res, err = http.Get(ts.URL + "/web/favicon-braille.svg")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
if res.StatusCode != http.StatusNotFound {
|
||||
t.Errorf("Web Root Favicon: Expected status NotFound, got %v", res.Status)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,313 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"log"
|
||||
"net/http"
|
||||
|
||||
"github.com/go-chi/chi/v5"
|
||||
"github.com/go-chi/chi/v5/middleware"
|
||||
)
|
||||
|
||||
// BasicAuthMgmt returns a Basic Auth middleware using the server's management credentials.
|
||||
func (s *Server) BasicAuthMgmt() func(http.Handler) http.Handler {
|
||||
s.mu.RLock()
|
||||
username := s.mgmtUsername
|
||||
password := s.mgmtPassword
|
||||
s.mu.RUnlock()
|
||||
|
||||
return middleware.BasicAuth("Management API", map[string]string{username: password})
|
||||
}
|
||||
|
||||
// HandleMgmtListSpeakers returns discovered speakers for the given account.
|
||||
func (s *Server) HandleMgmtListSpeakers(w http.ResponseWriter, r *http.Request) {
|
||||
_ = chi.URLParam(r, "accountId")
|
||||
|
||||
allDevices, err := s.ds.ListAllDevices()
|
||||
if err != nil {
|
||||
log.Printf("[Mgmt] Failed to list devices: %v", err)
|
||||
|
||||
allDevices = nil
|
||||
}
|
||||
|
||||
type speaker struct {
|
||||
IPAddress string `json:"ipAddress"`
|
||||
Name string `json:"name"`
|
||||
DeviceID string `json:"deviceId"`
|
||||
Type string `json:"type"`
|
||||
}
|
||||
|
||||
speakers := make([]speaker, 0, len(allDevices))
|
||||
for i := range allDevices {
|
||||
d := &allDevices[i]
|
||||
speakers = append(speakers, speaker{
|
||||
IPAddress: d.IPAddress,
|
||||
Name: d.Name,
|
||||
DeviceID: d.DeviceID,
|
||||
Type: d.ProductCode,
|
||||
})
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
|
||||
if err := json.NewEncoder(w).Encode(map[string]interface{}{
|
||||
"speakers": speakers,
|
||||
}); err != nil {
|
||||
log.Printf("[Mgmt] Failed to encode speakers: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// HandleMgmtDeviceEvents returns events for a device (currently a placeholder).
|
||||
func (s *Server) HandleMgmtDeviceEvents(w http.ResponseWriter, r *http.Request) {
|
||||
deviceID := chi.URLParam(r, "deviceId")
|
||||
|
||||
events := s.ds.GetDeviceEvents(deviceID)
|
||||
if events == nil {
|
||||
events = nil // will marshal as empty array via wrapper
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
// Return the events in the structure the Flutter app expects.
|
||||
// Use an explicit empty slice to ensure JSON "[]" instead of "null".
|
||||
type eventEntry struct {
|
||||
Type string `json:"type"`
|
||||
Time string `json:"time"`
|
||||
Data map[string]interface{} `json:"data"`
|
||||
}
|
||||
|
||||
result := make([]eventEntry, 0, len(events))
|
||||
for _, e := range events {
|
||||
result = append(result, eventEntry{
|
||||
Type: e.Type,
|
||||
Time: e.Time,
|
||||
Data: e.Data,
|
||||
})
|
||||
}
|
||||
|
||||
if err := json.NewEncoder(w).Encode(map[string]interface{}{
|
||||
"events": result,
|
||||
}); err != nil {
|
||||
log.Printf("[Mgmt] Failed to encode events: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// HandleMgmtSpotifyInit starts the Spotify OAuth flow by returning an authorization URL.
|
||||
func (s *Server) HandleMgmtSpotifyInit(w http.ResponseWriter, _ *http.Request) {
|
||||
s.mu.RLock()
|
||||
svc := s.spotifyService
|
||||
s.mu.RUnlock()
|
||||
|
||||
if svc == nil {
|
||||
http.Error(w, `{"error":"spotify not configured"}`, http.StatusServiceUnavailable)
|
||||
return
|
||||
}
|
||||
|
||||
redirectURL := svc.BuildAuthorizeURL()
|
||||
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
enc := json.NewEncoder(w)
|
||||
enc.SetEscapeHTML(false)
|
||||
|
||||
if err := enc.Encode(map[string]string{
|
||||
"redirectUrl": redirectURL,
|
||||
}); err != nil {
|
||||
log.Printf("[Mgmt] Failed to encode redirect URL: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// HandleMgmtSpotifyCallback is the browser OAuth callback from Spotify.
|
||||
// Not protected by Basic Auth — Spotify redirects the user's browser here directly.
|
||||
// Returns an HTML page the user can close.
|
||||
func (s *Server) HandleMgmtSpotifyCallback(w http.ResponseWriter, r *http.Request) {
|
||||
s.mu.RLock()
|
||||
svc := s.spotifyService
|
||||
s.mu.RUnlock()
|
||||
|
||||
if svc == nil {
|
||||
w.Header().Set("Content-Type", "text/html")
|
||||
w.WriteHeader(http.StatusServiceUnavailable)
|
||||
_, _ = w.Write([]byte(`<html><body><h1>Error</h1><p>Spotify integration not configured</p></body></html>`))
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
if errMsg := r.URL.Query().Get("error"); errMsg != "" {
|
||||
w.Header().Set("Content-Type", "text/html")
|
||||
w.WriteHeader(http.StatusBadRequest)
|
||||
_, _ = w.Write([]byte(`<html><body><h1>Spotify Authorization Failed</h1><p>Error: ` + errMsg + `</p></body></html>`))
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
code := r.URL.Query().Get("code")
|
||||
if code == "" {
|
||||
w.Header().Set("Content-Type", "text/html")
|
||||
w.WriteHeader(http.StatusBadRequest)
|
||||
_, _ = w.Write([]byte(`<html><body><h1>Missing authorization code</h1></body></html>`))
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
if err := svc.ExchangeCodeAndStore(code); err != nil {
|
||||
log.Printf("[Mgmt] Spotify callback failed: %v", err)
|
||||
w.Header().Set("Content-Type", "text/html")
|
||||
w.WriteHeader(http.StatusInternalServerError)
|
||||
_, _ = w.Write([]byte(`<html><body><h1>Error</h1><p>Token exchange failed</p></body></html>`))
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "text/html")
|
||||
_, _ = w.Write([]byte(`<html><body><h1>Spotify Connected</h1><p>You can close this window.</p></body></html>`))
|
||||
}
|
||||
|
||||
// HandleMgmtSpotifyConfirm exchanges an authorization code for tokens.
|
||||
// Used by the ueberboese mobile app after the deep link callback delivers the code.
|
||||
// Protected by Basic Auth.
|
||||
func (s *Server) HandleMgmtSpotifyConfirm(w http.ResponseWriter, r *http.Request) {
|
||||
s.mu.RLock()
|
||||
svc := s.spotifyService
|
||||
s.mu.RUnlock()
|
||||
|
||||
if svc == nil {
|
||||
http.Error(w, `{"error":"spotify not configured"}`, http.StatusServiceUnavailable)
|
||||
return
|
||||
}
|
||||
|
||||
code := r.URL.Query().Get("code")
|
||||
if code == "" {
|
||||
http.Error(w, `{"error":"missing code parameter"}`, http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
if err := svc.ExchangeCodeAndStore(code); err != nil {
|
||||
log.Printf("[Mgmt] Spotify confirm failed: %v", err)
|
||||
http.Error(w, `{"error":"token exchange failed"}`, http.StatusInternalServerError)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
w.WriteHeader(http.StatusOK)
|
||||
_, _ = w.Write([]byte(`{"ok":true}`))
|
||||
}
|
||||
|
||||
// HandleMgmtSpotifyAccounts returns linked Spotify accounts (tokens stripped).
|
||||
func (s *Server) HandleMgmtSpotifyAccounts(w http.ResponseWriter, _ *http.Request) {
|
||||
s.mu.RLock()
|
||||
svc := s.spotifyService
|
||||
s.mu.RUnlock()
|
||||
|
||||
if svc == nil {
|
||||
http.Error(w, `{"error":"spotify not configured"}`, http.StatusServiceUnavailable)
|
||||
return
|
||||
}
|
||||
|
||||
accounts := svc.GetAccounts()
|
||||
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
|
||||
if err := json.NewEncoder(w).Encode(map[string]interface{}{
|
||||
"accounts": accounts,
|
||||
}); err != nil {
|
||||
log.Printf("[Mgmt] Failed to encode accounts: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// HandleMgmtSpotifyToken returns a fresh Spotify access token for the linked account.
|
||||
func (s *Server) HandleMgmtSpotifyToken(w http.ResponseWriter, _ *http.Request) {
|
||||
s.mu.RLock()
|
||||
svc := s.spotifyService
|
||||
s.mu.RUnlock()
|
||||
|
||||
if svc == nil {
|
||||
http.Error(w, `{"error":"spotify not configured"}`, http.StatusServiceUnavailable)
|
||||
return
|
||||
}
|
||||
|
||||
accessToken, username, err := svc.GetFreshToken()
|
||||
if err != nil {
|
||||
log.Printf("[Mgmt] Spotify token error: %v", err)
|
||||
http.Error(w, `{"error":"no token available"}`, http.StatusInternalServerError)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
|
||||
if err := json.NewEncoder(w).Encode(map[string]string{
|
||||
"access_token": accessToken,
|
||||
"username": username,
|
||||
}); err != nil {
|
||||
log.Printf("[Mgmt] Failed to encode token: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// HandleMgmtSpotifyEntity resolves a Spotify URI to name and image URL.
|
||||
func (s *Server) HandleMgmtSpotifyEntity(w http.ResponseWriter, r *http.Request) {
|
||||
s.mu.RLock()
|
||||
svc := s.spotifyService
|
||||
s.mu.RUnlock()
|
||||
|
||||
if svc == nil {
|
||||
http.Error(w, `{"error":"spotify not configured"}`, http.StatusServiceUnavailable)
|
||||
return
|
||||
}
|
||||
|
||||
body, err := io.ReadAll(r.Body)
|
||||
if err != nil {
|
||||
http.Error(w, `{"error":"failed to read body"}`, http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
var request struct {
|
||||
URI string `json:"uri"`
|
||||
}
|
||||
if unmarshalErr := json.Unmarshal(body, &request); unmarshalErr != nil || request.URI == "" {
|
||||
http.Error(w, `{"error":"missing or invalid uri"}`, http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
name, imageURL, err := svc.ResolveEntity(request.URI)
|
||||
if err != nil {
|
||||
log.Printf("[Mgmt] Spotify entity resolve error: %v", err)
|
||||
http.Error(w, `{"error":"entity resolution failed"}`, http.StatusInternalServerError)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
|
||||
if err := json.NewEncoder(w).Encode(map[string]string{
|
||||
"name": name,
|
||||
"imageUrl": imageURL,
|
||||
}); err != nil {
|
||||
log.Printf("[Mgmt] Failed to encode entity: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// HandleMgmtPrimeDevice triggers a Spotify priming for a specific device.
|
||||
func (s *Server) HandleMgmtPrimeDevice(w http.ResponseWriter, r *http.Request) {
|
||||
deviceID := r.URL.Query().Get("deviceId")
|
||||
|
||||
if deviceID == "" {
|
||||
http.Error(w, `{"error":"missing deviceId"}`, http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
deviceIP, err := s.resolveDeviceIDToIP(deviceID)
|
||||
if err != nil {
|
||||
log.Printf("[Mgmt] Prime failed: %v", err)
|
||||
http.Error(w, fmt.Sprintf(`{"error":"%v"}`, err), http.StatusNotFound)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// Trigger priming
|
||||
go s.PrimeDeviceWithSpotify(deviceIP)
|
||||
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_, _ = w.Write([]byte(`{"status":"Priming triggered"}`))
|
||||
}
|
||||
@@ -0,0 +1,266 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/service/datastore"
|
||||
"github.com/gesellix/bose-soundtouch/pkg/service/spotify"
|
||||
"github.com/go-chi/chi/v5"
|
||||
)
|
||||
|
||||
func TestHandleMgmtSpotifyInit(t *testing.T) {
|
||||
s := NewServer(nil, nil, "http://localhost", false, false, false)
|
||||
// No spotify service configured
|
||||
req := httptest.NewRequest("POST", "/mgmt/spotify/init", nil)
|
||||
w := httptest.NewRecorder()
|
||||
s.HandleMgmtSpotifyInit(w, req)
|
||||
|
||||
if w.Code != http.StatusServiceUnavailable {
|
||||
t.Errorf("expected 503, got %d", w.Code)
|
||||
}
|
||||
|
||||
// With spotify service
|
||||
svc := spotify.NewSpotifyService("cid", "secret", "http://localhost/cb", t.TempDir())
|
||||
s.SetSpotifyService(svc)
|
||||
|
||||
w = httptest.NewRecorder()
|
||||
s.HandleMgmtSpotifyInit(w, req)
|
||||
|
||||
if w.Code != http.StatusOK {
|
||||
t.Errorf("expected 200, got %d", w.Code)
|
||||
}
|
||||
|
||||
var resp map[string]string
|
||||
if err := json.NewDecoder(w.Body).Decode(&resp); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if !strings.Contains(resp["redirectUrl"], "client_id=cid") {
|
||||
t.Errorf("expected redirectUrl to contain client_id=cid, got %s", resp["redirectUrl"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleMgmtSpotifyAccounts(t *testing.T) {
|
||||
s := NewServer(nil, nil, "http://localhost", false, false, false)
|
||||
svc := spotify.NewSpotifyService("cid", "secret", "http://localhost/cb", t.TempDir())
|
||||
s.SetSpotifyService(svc)
|
||||
|
||||
req := httptest.NewRequest("GET", "/mgmt/spotify/accounts", nil)
|
||||
w := httptest.NewRecorder()
|
||||
s.HandleMgmtSpotifyAccounts(w, req)
|
||||
|
||||
if w.Code != http.StatusOK {
|
||||
t.Errorf("expected 200, got %d", w.Code)
|
||||
}
|
||||
|
||||
var resp map[string][]spotify.Account
|
||||
if err := json.NewDecoder(w.Body).Decode(&resp); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if len(resp["accounts"]) != 0 {
|
||||
t.Errorf("expected 0 accounts, got %d", len(resp["accounts"]))
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleMgmtListSpeakers(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
ds := datastore.NewDataStore(tmpDir)
|
||||
_, s := setupRouter("http://localhost:8000", ds)
|
||||
|
||||
req := httptest.NewRequest("GET", "/mgmt/accounts/default/speakers", nil)
|
||||
w := httptest.NewRecorder()
|
||||
s.HandleMgmtListSpeakers(w, req)
|
||||
|
||||
if w.Code != http.StatusOK {
|
||||
t.Errorf("expected 200, got %d", w.Code)
|
||||
}
|
||||
|
||||
var resp map[string]interface{}
|
||||
if err := json.NewDecoder(w.Body).Decode(&resp); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if _, ok := resp["speakers"]; !ok {
|
||||
t.Error("expected 'speakers' in response")
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleMgmtSpotifyCallback(t *testing.T) {
|
||||
s := NewServer(nil, nil, "http://localhost", false, false, false)
|
||||
svc := spotify.NewSpotifyService("cid", "secret", "http://localhost/cb", t.TempDir())
|
||||
s.SetSpotifyService(svc)
|
||||
|
||||
// Mock Spotify token and profile endpoints
|
||||
tokenServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
json.NewEncoder(w).Encode(map[string]interface{}{
|
||||
"access_token": "at",
|
||||
"refresh_token": "rt",
|
||||
"expires_in": 3600,
|
||||
})
|
||||
}))
|
||||
defer tokenServer.Close()
|
||||
|
||||
profileServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
json.NewEncoder(w).Encode(map[string]interface{}{
|
||||
"id": "user123",
|
||||
"display_name": "Test User",
|
||||
})
|
||||
}))
|
||||
defer profileServer.Close()
|
||||
|
||||
// Use internal members to override URLs (available because we are in the same package)
|
||||
// Actually we need to reach through s.spotifyService which is private.
|
||||
// But s.spotifyService is *spotify.Service, which we have a handle to (svc).
|
||||
// We can't access private fields of spotify.Service from handlers package.
|
||||
// Wait, I can't override tokenURL from here if it's unexported in spotify package.
|
||||
// Let's check service.go again. Yes, tokenURL and apiBase are unexported.
|
||||
|
||||
// Since I can't easily mock the external Spotify API here without exported fields,
|
||||
// I will test the error paths.
|
||||
|
||||
t.Run("Missing code", func(t *testing.T) {
|
||||
req := httptest.NewRequest("GET", "/mgmt/spotify/callback", nil)
|
||||
w := httptest.NewRecorder()
|
||||
s.HandleMgmtSpotifyCallback(w, req)
|
||||
if w.Code != http.StatusBadRequest {
|
||||
t.Errorf("expected 400, got %d", w.Code)
|
||||
}
|
||||
if !strings.Contains(w.Body.String(), "Missing authorization code") {
|
||||
t.Errorf("expected missing code error message, got %s", w.Body.String())
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("Spotify error", func(t *testing.T) {
|
||||
req := httptest.NewRequest("GET", "/mgmt/spotify/callback?error=access_denied", nil)
|
||||
w := httptest.NewRecorder()
|
||||
s.HandleMgmtSpotifyCallback(w, req)
|
||||
if w.Code != http.StatusBadRequest {
|
||||
t.Errorf("expected 400, got %d", w.Code)
|
||||
}
|
||||
if !strings.Contains(w.Body.String(), "access_denied") {
|
||||
t.Errorf("expected access_denied error message, got %s", w.Body.String())
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestHandleMgmtSpotifyConfirm(t *testing.T) {
|
||||
s := NewServer(nil, nil, "http://localhost", false, false, false)
|
||||
svc := spotify.NewSpotifyService("cid", "secret", "http://localhost/cb", t.TempDir())
|
||||
s.SetSpotifyService(svc)
|
||||
|
||||
t.Run("Missing code", func(t *testing.T) {
|
||||
req := httptest.NewRequest("POST", "/mgmt/spotify/confirm", nil)
|
||||
w := httptest.NewRecorder()
|
||||
s.HandleMgmtSpotifyConfirm(w, req)
|
||||
if w.Code != http.StatusBadRequest {
|
||||
t.Errorf("expected 400, got %d", w.Code)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestHandleMgmtDeviceEvents(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
ds := datastore.NewDataStore(tmpDir)
|
||||
_, s := setupRouter("http://localhost:8000", ds)
|
||||
|
||||
r := chi.NewRouter()
|
||||
r.Get("/mgmt/devices/{deviceId}/events", s.HandleMgmtDeviceEvents)
|
||||
|
||||
req := httptest.NewRequest("GET", "/mgmt/devices/device123/events", nil)
|
||||
w := httptest.NewRecorder()
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
if w.Code != http.StatusOK {
|
||||
t.Errorf("expected 200, got %d", w.Code)
|
||||
}
|
||||
|
||||
var resp map[string]interface{}
|
||||
if err := json.NewDecoder(w.Body).Decode(&resp); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if _, ok := resp["events"]; !ok {
|
||||
t.Error("expected 'events' in response")
|
||||
}
|
||||
}
|
||||
|
||||
func TestBasicAuthMgmt(t *testing.T) {
|
||||
s := NewServer(nil, nil, "http://localhost", false, false, false)
|
||||
s.SetMgmtConfig("admin", "secret123")
|
||||
|
||||
handler := s.BasicAuthMgmt()(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
w.WriteHeader(http.StatusOK)
|
||||
_, _ = w.Write([]byte("OK"))
|
||||
}))
|
||||
|
||||
t.Run("Valid credentials", func(t *testing.T) {
|
||||
req := httptest.NewRequest(http.MethodGet, "/mgmt/test", nil)
|
||||
req.SetBasicAuth("admin", "secret123")
|
||||
rr := httptest.NewRecorder()
|
||||
|
||||
handler.ServeHTTP(rr, req)
|
||||
|
||||
if rr.Code != http.StatusOK {
|
||||
t.Errorf("expected status %d, got %d", http.StatusOK, rr.Code)
|
||||
}
|
||||
if rr.Body.String() != "OK" {
|
||||
t.Errorf("expected body 'OK', got %q", rr.Body.String())
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("Wrong username", func(t *testing.T) {
|
||||
req := httptest.NewRequest(http.MethodGet, "/mgmt/test", nil)
|
||||
req.SetBasicAuth("wrong", "secret123")
|
||||
rr := httptest.NewRecorder()
|
||||
|
||||
handler.ServeHTTP(rr, req)
|
||||
|
||||
if rr.Code != http.StatusUnauthorized {
|
||||
t.Errorf("expected status %d, got %d", http.StatusUnauthorized, rr.Code)
|
||||
}
|
||||
if rr.Header().Get("WWW-Authenticate") == "" {
|
||||
t.Error("expected WWW-Authenticate header to be set")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("Wrong password", func(t *testing.T) {
|
||||
req := httptest.NewRequest(http.MethodGet, "/mgmt/test", nil)
|
||||
req.SetBasicAuth("admin", "wrongpass")
|
||||
rr := httptest.NewRecorder()
|
||||
|
||||
handler.ServeHTTP(rr, req)
|
||||
|
||||
if rr.Code != http.StatusUnauthorized {
|
||||
t.Errorf("expected status %d, got %d", http.StatusUnauthorized, rr.Code)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("Missing auth header", func(t *testing.T) {
|
||||
req := httptest.NewRequest(http.MethodGet, "/mgmt/test", nil)
|
||||
rr := httptest.NewRecorder()
|
||||
|
||||
handler.ServeHTTP(rr, req)
|
||||
|
||||
if rr.Code != http.StatusUnauthorized {
|
||||
t.Errorf("expected status %d, got %d", http.StatusUnauthorized, rr.Code)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("Empty credentials", func(t *testing.T) {
|
||||
req := httptest.NewRequest(http.MethodGet, "/mgmt/test", nil)
|
||||
req.SetBasicAuth("", "")
|
||||
rr := httptest.NewRecorder()
|
||||
|
||||
handler.ServeHTTP(rr, req)
|
||||
|
||||
if rr.Code != http.StatusUnauthorized {
|
||||
t.Errorf("expected status %d, got %d", http.StatusUnauthorized, rr.Code)
|
||||
}
|
||||
})
|
||||
}
|
||||
@@ -0,0 +1,70 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"log"
|
||||
"net/http"
|
||||
|
||||
"github.com/go-chi/chi/v5"
|
||||
)
|
||||
|
||||
// HandleBoseSpotifyToken handles the Bose-specific Spotify token refresh request from the speaker.
|
||||
// POST /oauth/device/{deviceID}/music/musicprovider/15/token/cs3
|
||||
func (s *Server) HandleBoseSpotifyToken(w http.ResponseWriter, r *http.Request) {
|
||||
deviceID := chi.URLParam(r, "deviceID")
|
||||
log.Printf("[Spotify Proxy] Intercepted token request for device %s", deviceID)
|
||||
|
||||
s.mu.RLock()
|
||||
svc := s.spotifyService
|
||||
s.mu.RUnlock()
|
||||
|
||||
if svc == nil {
|
||||
log.Printf("[Spotify Proxy] Spotify service not configured, falling back to upstream")
|
||||
s.HandleBoseProxy(w, r)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
accounts := svc.GetAccounts()
|
||||
if len(accounts) == 0 {
|
||||
log.Printf("[Spotify Proxy] No Spotify accounts linked, falling back to upstream")
|
||||
s.HandleBoseProxy(w, r)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// We use the first linked account.
|
||||
accessToken, _, err := svc.GetFreshToken()
|
||||
if err != nil {
|
||||
log.Printf("[Spotify Proxy] Failed to get fresh token: %v. Falling back to upstream", err)
|
||||
s.HandleBoseProxy(w, r)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// Format response as expected by Bose firmware.
|
||||
// Based on observed interactions, it's a JSON object with access_token.
|
||||
// The "scope" and other fields might be needed by some firmware versions.
|
||||
response := map[string]interface{}{
|
||||
"access_token": accessToken,
|
||||
"token_type": "Bearer",
|
||||
"expires_in": 3600,
|
||||
// These scopes are typical for what Bose requests.
|
||||
"scope": "playlist-read-private playlist-read-collaborative streaming user-library-read user-library-modify playlist-modify-private playlist-modify-public user-read-email user-read-private user-top-read",
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
w.Header().Set("X-Proxy-Origin", "self")
|
||||
|
||||
if err := json.NewEncoder(w).Encode(response); err != nil {
|
||||
log.Printf("[Spotify Proxy] Failed to encode response: %v", err)
|
||||
http.Error(w, "Internal Server Error", http.StatusInternalServerError)
|
||||
}
|
||||
}
|
||||
|
||||
// HandleBoseSpotifyLegacyToken handles the Bose-specific Spotify token refresh request (legacy or variant).
|
||||
// POST /oauth/device/{deviceID}/music/musicprovider/15/token
|
||||
func (s *Server) HandleBoseSpotifyLegacyToken(w http.ResponseWriter, r *http.Request) {
|
||||
// Some firmware might use a slightly different path.
|
||||
s.HandleBoseSpotifyToken(w, r)
|
||||
}
|
||||
@@ -0,0 +1,134 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/service/datastore"
|
||||
"github.com/gesellix/bose-soundtouch/pkg/service/spotify"
|
||||
"github.com/go-chi/chi/v5"
|
||||
)
|
||||
|
||||
func TestHandleBoseSpotifyToken_LocalResponse(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
ds := datastore.NewDataStore(tmpDir)
|
||||
server := NewServer(ds, nil, "http://localhost", false, false, false)
|
||||
|
||||
// Wait, I can't easily inject an account into spotify.Service from here because fields are private.
|
||||
// Let's check if there's any other way.
|
||||
// I could mock the spotify.Service if it was an interface, but it's a struct.
|
||||
|
||||
// ss.load() expects accounts in tmpDir/spotify/accounts.json
|
||||
spotifyDir := filepath.Join(tmpDir, "spotify")
|
||||
_ = os.MkdirAll(spotifyDir, 0755)
|
||||
|
||||
account := map[string]interface{}{
|
||||
"user1": map[string]interface{}{
|
||||
"user_id": "user1",
|
||||
"display_name": "Test User",
|
||||
"access_token": "valid-token",
|
||||
"refresh_token": "refresh-token",
|
||||
"expires_at": time.Now().Add(1 * time.Hour).Unix(),
|
||||
},
|
||||
}
|
||||
data, err := json.Marshal(account)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to marshal account: %v", err)
|
||||
}
|
||||
_ = os.WriteFile(filepath.Join(spotifyDir, "accounts.json"), data, 0644)
|
||||
|
||||
// Initialize ss so it loads the data
|
||||
ss := spotify.NewSpotifyService("client-id", "client-secret", "http://localhost/callback", tmpDir)
|
||||
|
||||
server.SetSpotifyService(ss)
|
||||
|
||||
// chi.URLParam works when using chi router
|
||||
r := chi.NewRouter()
|
||||
r.Post("/oauth/device/{deviceID}/music/musicprovider/15/token/cs3", server.HandleBoseSpotifyToken)
|
||||
|
||||
req := httptest.NewRequest("POST", "/oauth/device/DEVICE123/music/musicprovider/15/token/cs3", nil)
|
||||
w := httptest.NewRecorder()
|
||||
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
if w.Code != http.StatusOK {
|
||||
t.Errorf("Expected status 200, got %d", w.Code)
|
||||
}
|
||||
|
||||
if w.Header().Get("X-Proxy-Origin") != "self" {
|
||||
t.Errorf("Expected X-Proxy-Origin: self, got %s", w.Header().Get("X-Proxy-Origin"))
|
||||
}
|
||||
|
||||
var resp map[string]interface{}
|
||||
if err := json.NewDecoder(w.Body).Decode(&resp); err != nil {
|
||||
t.Fatalf("Failed to decode response: %v", err)
|
||||
}
|
||||
|
||||
if resp["access_token"] != "valid-token" {
|
||||
t.Errorf("Expected access_token 'valid-token', got %v", resp["access_token"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleBoseSpotifyToken_FallbackToProxy(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
ds := datastore.NewDataStore(tmpDir)
|
||||
server := NewServer(ds, nil, "http://localhost", false, false, false)
|
||||
|
||||
// Mirroring must be enabled for HandleBoseProxy to work (based on previous changes)
|
||||
// Actually I reverted that, so it should work regardless of MirrorEnabled now.
|
||||
server.SetMirrorSettings(true, nil, "")
|
||||
|
||||
// chi.URLParam works when using chi router
|
||||
r := chi.NewRouter()
|
||||
r.Post("/oauth/device/{deviceID}/music/musicprovider/15/token/cs3", server.HandleBoseSpotifyToken)
|
||||
|
||||
// Since there's no Spotify service, it should fall back to HandleBoseProxy.
|
||||
// HandleBoseProxy will try to contact streaming.bose.com.
|
||||
// We can check if it returns a 502 or 404 (since we are not actually proxying to real Bose).
|
||||
|
||||
req := httptest.NewRequest("POST", "/oauth/device/DEVICE123/music/musicprovider/15/token/cs3", nil)
|
||||
req.Host = "localhost" // use localhost to avoid real network call
|
||||
w := httptest.NewRecorder()
|
||||
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
// If it fell back to proxy, it should NOT have X-Proxy-Origin: self
|
||||
if w.Header().Get("X-Proxy-Origin") == "self" {
|
||||
t.Errorf("Expected fallback to proxy, but got X-Proxy-Origin: self")
|
||||
}
|
||||
|
||||
// HandleBoseProxy sets X-Proxy-Origin: upstream
|
||||
if w.Header().Get("X-Proxy-Origin") != "upstream" {
|
||||
// It might fail before setting the header if the target host is invalid,
|
||||
// but our HandleBoseProxy sets it in ModifyResponse.
|
||||
// If it fails to connect, it might return 502 without the header.
|
||||
if w.Code != http.StatusBadGateway && w.Code != http.StatusNotFound {
|
||||
t.Errorf("Expected fallback to proxy (upstream), got status %d and origin %s", w.Code, w.Header().Get("X-Proxy-Origin"))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleBoseSpotifyLegacyToken(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
ds := datastore.NewDataStore(tmpDir)
|
||||
server := NewServer(ds, nil, "http://localhost", false, false, false)
|
||||
|
||||
r := chi.NewRouter()
|
||||
r.Post("/oauth/device/{deviceID}/music/musicprovider/15/token", server.HandleBoseSpotifyLegacyToken)
|
||||
|
||||
// Since we are not configuring Spotify, it should fall back to proxy
|
||||
req := httptest.NewRequest("POST", "/oauth/device/DEVICE123/music/musicprovider/15/token", nil)
|
||||
req.Host = "localhost"
|
||||
w := httptest.NewRecorder()
|
||||
|
||||
r.ServeHTTP(w, req)
|
||||
|
||||
if w.Header().Get("X-Proxy-Origin") == "self" {
|
||||
t.Errorf("Expected fallback to proxy")
|
||||
}
|
||||
}
|
||||
@@ -55,23 +55,21 @@ func (s *Server) ServeProxy(target *url.URL) http.HandlerFunc {
|
||||
r.Body = io.NopCloser(bytes.NewBuffer(reqBody))
|
||||
}
|
||||
|
||||
rp := httputil.NewSingleHostReverseProxy(target)
|
||||
rp.Transport = &http.Transport{
|
||||
TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
|
||||
}
|
||||
rp := &httputil.ReverseProxy{
|
||||
Rewrite: func(pr *httputil.ProxyRequest) {
|
||||
pr.SetURL(target)
|
||||
pr.Out.Host = target.Host
|
||||
// If target has a path, we should probably append or replace.
|
||||
// For Bose upstream, it's usually just the domain.
|
||||
if target.Path != "" && target.Path != "/" {
|
||||
pr.Out.URL.Path = target.Path
|
||||
}
|
||||
|
||||
// Update director to set the correct host and path
|
||||
originalDirector := rp.Director
|
||||
rp.Director = func(req *http.Request) {
|
||||
originalDirector(req)
|
||||
req.Host = target.Host
|
||||
// If target has a path, we should probably append or replace.
|
||||
// For Bose upstream, it's usually just the domain.
|
||||
if target.Path != "" && target.Path != "/" {
|
||||
req.URL.Path = target.Path
|
||||
}
|
||||
|
||||
lp.LogRequest(req)
|
||||
lp.LogRequest(pr.Out)
|
||||
},
|
||||
Transport: &http.Transport{
|
||||
TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
|
||||
},
|
||||
}
|
||||
|
||||
rp.ModifyResponse = func(res *http.Response) error {
|
||||
@@ -98,84 +96,9 @@ func (s *Server) ServeProxy(target *url.URL) http.HandlerFunc {
|
||||
|
||||
// HandleNotFound handles requests that don't match any route.
|
||||
func (s *Server) HandleNotFound(w http.ResponseWriter, r *http.Request) {
|
||||
if s.enableSoundcorkProxy {
|
||||
s.HandleSoundcorkWithFallback(w, r)
|
||||
return
|
||||
}
|
||||
|
||||
s.HandleBoseProxy(w, r)
|
||||
}
|
||||
|
||||
// HandleSoundcorkWithFallback tries Soundcork first, then Bose if Soundcork returns 404 or fails.
|
||||
func (s *Server) HandleSoundcorkWithFallback(w http.ResponseWriter, r *http.Request) {
|
||||
target, _ := url.Parse(s.soundcorkURL)
|
||||
|
||||
// Buffer request body if any, to allow multiple proxy attempts
|
||||
var bodyBytes []byte
|
||||
if r.Body != nil {
|
||||
bodyBytes, _ = io.ReadAll(r.Body)
|
||||
_ = r.Body.Close()
|
||||
}
|
||||
|
||||
// We use a custom response writer to catch 404s
|
||||
rw := &fallbackResponseWriter{
|
||||
ResponseWriter: w,
|
||||
statusCode: http.StatusOK,
|
||||
buffer: &bytes.Buffer{},
|
||||
}
|
||||
|
||||
// Create a shallow copy of the request to avoid side effects between attempts
|
||||
r2 := r.Clone(r.Context())
|
||||
if bodyBytes != nil {
|
||||
r2.Body = io.NopCloser(bytes.NewBuffer(bodyBytes))
|
||||
} else {
|
||||
r2.Body = nil
|
||||
}
|
||||
|
||||
// Remove RequestURI as it's not allowed in client requests
|
||||
r2.RequestURI = ""
|
||||
|
||||
s.ServeProxy(target)(rw, r2)
|
||||
|
||||
if rw.statusCode == http.StatusNotFound || rw.statusCode == http.StatusBadGateway || rw.statusCode == http.StatusServiceUnavailable {
|
||||
log.Printf("[PROXY] Soundcork returned %d for %s, falling back to Bose", rw.statusCode, r.URL.Path)
|
||||
|
||||
if !rw.wroteHeader {
|
||||
// Restore original body if any
|
||||
if bodyBytes != nil {
|
||||
r.Body = io.NopCloser(bytes.NewBuffer(bodyBytes))
|
||||
}
|
||||
|
||||
s.HandleBoseProxy(w, r)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
type fallbackResponseWriter struct {
|
||||
http.ResponseWriter
|
||||
statusCode int
|
||||
wroteHeader bool
|
||||
buffer *bytes.Buffer
|
||||
}
|
||||
|
||||
func (rw *fallbackResponseWriter) WriteHeader(code int) {
|
||||
rw.statusCode = code
|
||||
if code != http.StatusNotFound && code != http.StatusBadGateway && code != http.StatusServiceUnavailable {
|
||||
rw.wroteHeader = true
|
||||
rw.ResponseWriter.WriteHeader(code)
|
||||
}
|
||||
}
|
||||
|
||||
func (rw *fallbackResponseWriter) Write(b []byte) (int, error) {
|
||||
if rw.statusCode == http.StatusNotFound || rw.statusCode == http.StatusBadGateway || rw.statusCode == http.StatusServiceUnavailable {
|
||||
return len(b), nil // Drop the body
|
||||
}
|
||||
|
||||
rw.wroteHeader = true
|
||||
|
||||
return rw.ResponseWriter.Write(b)
|
||||
}
|
||||
|
||||
// HandleBoseProxy proxies the request to the Bose upstream.
|
||||
func (s *Server) HandleBoseProxy(w http.ResponseWriter, r *http.Request) {
|
||||
host := r.Host
|
||||
|
||||
@@ -33,7 +33,7 @@ func TestHandleProxyRequest_RequestBodyRecording(t *testing.T) {
|
||||
defer backend.Close()
|
||||
|
||||
ds := datastore.NewDataStore(filepath.Join(tmpDir, "test.db"))
|
||||
server := NewServer(ds, nil, "http://localhost:8000", false, false, false, false)
|
||||
server := NewServer(ds, nil, "http://localhost", false, false, false)
|
||||
server.recordEnabled = true
|
||||
server.proxyLogBody = true
|
||||
recorder := proxy.NewRecorder(tmpDir)
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user