Compare commits

...
30 Commits
Author SHA1 Message Date
Tobias GesellchenandClaude Opus 4.7 c668c732df fix(#308): handle placeholder presets without panicking
The ST10's /presets response after a factory reset emits self-closing
<preset/> entries with no ContentItem child. cmd/soundtouch-cli's
getPresets() handled the missing ContentItem in GetDisplayName() but
then dereferenced preset.ContentItem.Source on the next line, panicking
with "invalid memory address or nil pointer dereference" the moment the
loop reached the first empty entry.

A second placeholder shape was observed on healthy devices that were
never reset: <preset id="0"><ContentItem source="INVALID_SOURCE"
isPresetable="true"/></preset>. ContentItem is non-nil here, so the
previous "ContentItem != nil" guard at other call sites still let
these placeholders through into listings and into the AfterTouch
datastore.

Fix shape:

  pkg/models/presets.go - extend Preset.IsEmpty() to recognise both
  shapes (ContentItem == nil, OR Source == "" / "INVALID_SOURCE").
  HasPresets, GetEmptyPresetSlots and GetUsedPresetSlots become honest
  about which slots actually carry playable content.

  cmd/soundtouch-cli/cmd_info.go (the crash site) - filter the slice
  via IsEmpty before the print loop, and switch the still-printed
  fields to the existing nil-safe Get* helpers.

  pkg/service/setup/setup.go - upgrade syncPresets's "ContentItem ==
  nil" continue-guard to IsEmpty so Shape B placeholders don't get
  persisted in the AfterTouch datastore and then surface as junk
  rows in the admin web UI.

  cmd/soundtouch-cli/cmd_events.go, cmd/websocket-demo/main.go - same
  nil-guard upgrade. These already nil-checked so were crash-safe;
  the change is for consistency and to stop printing
  "Preset 0:  (INVALID_SOURCE)" demo lines.

  examples/preset-management/main.go - had the same latent crash as
  cmd_info.go; same fix shape.

Regression tests in pkg/models/presets_test.go cover both shapes using
the exact XML observed in the wild: the reporter's three <preset/>
placeholders plus the three INVALID_SOURCE entries from a live device.
The reporter XML test walks every preset through the same accessor
path the CLI used and asserts no panic.

The soundtouch-web Go code does not deref preset.ContentItem.X
anywhere - presets flow through as JSON - so no separate crash trap
exists there. The web frontend will pick up the cleaner data once
syncPresets stops persisting placeholders.

Closes #308

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-17 11:36:55 +02:00
Tobias GesellchenandClaude Opus 4.7 4e7a20f7ec refactor(soundtouch-web): make DeviceConnection.Status atomically swappable
Status was a value-typed DeviceStatus field on DeviceConnection,
written from the periodic poller (UpdateDeviceStatus) and from four
WebSocket event handlers (OnNowPlaying, OnVolumeUpdated,
OnConnectionState, OnPresetUpdated) while being read from every HTTP
handler and the WebSocket broadcaster. The struct was 8+ words wide
with time.Time and string members, so concurrent readers could
observe torn fields or mixed-update snapshots. The map-level race was
fixed in the previous commit; this one closes the per-connection
struct race.

Hide the field behind atomic.Pointer[DeviceStatus]:

  Status()                                 // returns current snapshot
  SetStatus(*DeviceStatus)                 // wholesale replace
  UpdateStatus(func(*DeviceStatus))        // CAS retry loop

NewDeviceConnection constructs a connection with the atomic pointer
pre-initialised, so Status() never returns nil for callers that go
through the constructor (the old struct-literal pattern is no longer
possible because the status field is now private).

UpdateDeviceStatus runs network fetches into local vars first, then
batches them into a single UpdateStatus call so the CAS loop only
retries the merge — not the slow IO. WebSocket event handlers and
the connect/disconnect transitions each use UpdateStatus, so any
ordering of poller + event delivery converges to a consistent
status.

The UpdateStatus docstring is explicit about the shallow-copy
contract: nested pointer fields (NowPlaying, Volume, Bass, Presets,
Sources) MUST be replaced, not mutated through, because the copy
mut receives shares those pointers with the prior snapshot. All
production callers already follow this pattern (every value comes
fresh from the device API).

Tests:
  - types_test.go: migrated literal struct to NewDeviceConnection +
    SetStatus, switched reads to Status().
  - status_test.go (new): six tests covering constructor init,
    SetStatus replacement semantics, UpdateStatus mutator
    application, field preservation across UpdateStatus, snapshot
    isolation (old snapshot stable under later writes), and a
    concurrent stress test (16 writers + 32 readers x 200 ops) that
    runs under -race.
  - handlers_test.go, registry_test.go, spa_test.go: migrated to
    constructor.

Not addressed by this commit:
  - DeviceConnection.WebSocket (set once in ConnectDeviceWebSocket,
    read elsewhere). Word-sized pointer, atomic at the hardware
    level on amd64/arm64; race detector may still flag.
  - DeviceConnection.LastSeen (written under devicesMu by the
    registry, read outside that lock via DeviceSnapshot consumers).
    time.Time is non-atomic but the read is cosmetic.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-17 11:14:17 +02:00
Tobias GesellchenandClaude Opus 4.7 e7d1b44587 refactor(soundtouch-web): encapsulate WebApp device registry behind methods
The Devices map on WebApp was written from the startup goroutine, the
/api/discover POST handler, and addDevice, while being read from every
HTTP handler and the WebSocket periodic-update loop — all without any
mutex. The Go runtime panics with "fatal error: concurrent map writes"
or "concurrent map read and map write" on any actual collision, so this
was a latent crash, not a tearing issue.

Hide the map behind a sync.RWMutex and a small API:

  GetDevice(id) (*DeviceConnection, bool)
  DeviceSnapshot() []DeviceEntry
  DeviceCount() int
  AddDevice(id, conn) bool        // atomic insert-or-touch
  TouchDevice(id) bool            // fast-path LastSeen bump

Update every caller — handlers, websocket, main, tests — to go through
the API. addDevice's existing-host fast path uses TouchDevice; the
final insert uses AddDevice so a race with another writer is rejected
cleanly instead of silently overwriting.

Add a TestRegistryConcurrent stress test that runs 64 goroutines doing
12,800 operations across writers, touchers, and two reader patterns.
It exists to give `-race` (already on in CI) a concrete shape to catch
if the encapsulation ever leaks back out.

Struct-field races on conn.Status.* are not addressed by this change;
they need their own follow-up.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-17 11:14:17 +02:00
Tobias GesellchenandClaude Opus 4.7 2c50ce3ee8 refactor(soundtouch-web): unify manual and discovered device registration
`addManualDevice` and the per-device branch of `discoverDevices` were
~40 lines of near-identical client setup, info fetch, connection
build, and map write — differing only in log wording. Extract a
shared `addDevice(app, host, port, source)` helper used by both
paths.

Side effects of consolidating:

- Duplicate-host guard (LastSeen bump) now applies to both paths, so
  passing `--devices 1.2.3.4` twice is idempotent and matches how
  discovery treats repeat sightings.
- Map write happens before the UpdateDeviceStatus goroutine launch,
  so a concurrent GET /api/devices sees the device with
  `IsConnected: false` instead of racing the status update.
- Log wording is consistent: "Failed to fetch device info from <host>
  (<source>): <err>" and "Added <source> device <name> (<type>) at
  <host>:<port>".

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-17 11:14:17 +02:00
Tobias Gesellchen 1269481411 lint 2026-05-17 10:30:25 +02:00
chrizg 712801259e feat(soundtouch-web): rename --host to --devices, support multiple devices via StringSliceFlag 2026-05-17 10:30:25 +02:00
chrizg 46546f5494 feat(soundtouch-web): add --host flag for manual device IP 2026-05-17 10:30:25 +02:00
chris 6d462191d9 docs: add SoundTouch 30 factory reset sequence (#305)
## Description

Add missing factory reset sequence for SoundTouch 30 (non-Series III).
The current table only lists SoundTouch 30 Series III. The SoundTouch 30
uses a different sequence: power on, then hold Preset 1 + Volume − for
10 s. The display counts down from 10 to 1 and shows "Hold to restore
factory settings" before restarting.

## Type of Change

Please check the type of change your PR introduces:

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [x] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring (no functional changes)
- [ ] Test improvements
- [ ] Build/CI improvements

## Related Issues

## Changes Made

### API Changes
- [ ] Added new endpoints
- [ ] Modified existing endpoints
- [ ] Added new CLI commands
- [ ] Modified existing CLI commands
- [ ] Added new configuration options

### Implementation Details
- Added missing table row for SoundTouch 30 (non-Series III) in the
factory reset sequences table. No new dependencies.

## Testing

### Automated Tests
- [ ] Unit tests added/updated
- [ ] Integration tests added/updated
- [ ] All existing tests pass
- [ ] Test coverage maintained or improved

### Manual Testing
- [x] Tested with real SoundTouch device(s)
- [ ] Tested CLI changes manually
- [ ] Tested in different network environments

**Device(s) tested with:**
- Device model: SoundTouch 30
- Firmware: 27.0.6.46330
- Test results: Factory reset sequence verified on real device

### Test Commands

## Documentation

- [ ] Updated relevant documentation
- [ ] Added code comments for complex logic
- [ ] Updated CLI help text
- [ ] Added usage examples
- [ ] Updated API documentation

**Documentation files updated:**
- [ ] README.md
- [ ] docs/API-Endpoints-Overview.md
- [ ] docs/CLI-REFERENCE.md
- [ ] Code documentation (godoc)

docs/DEVICE-INITIAL-SETUP.md

## Backward Compatibility

- [x] This change is backward compatible
- [ ] This change includes breaking changes (requires major version
bump)
- [ ] This change requires configuration migration

**Breaking changes (if any):**

## Security Considerations

- [x] No security implications
- [ ] Security review required
- [ ] Added input validation
- [ ] Updated authentication/authorization

## Performance Impact

- [x] No performance impact
- [ ] Performance improvement
- [ ] Potential performance regression (justify why)

**Performance notes:**

## Code Quality

- [ ] Code follows project style guidelines
- [ ] No linting errors
- [ ] No security warnings
- [ ] Memory leaks checked (if applicable)

### Pre-submission Checklist

- [ ] `make check` passes (format, lint, vet)
- [ ] `make test` passes
- [ ] No TODO comments left in production code
- [ ] Error handling is comprehensive
- [ ] Logging is appropriate (not too verbose, not too quiet)

## Deployment Notes

## Screenshots (if applicable)

## Additional Notes

## Review Requests
2026-05-17 10:15:10 +02:00
Tobias GesellchenandClaude Opus 4.7 f3c974cbbd docs(troubleshooting): capture three recurring symptoms from issues #224 #235 #253
Add three new entries to docs/guides/TROUBLESHOOTING.md so the next
reporter who hits these symptoms finds the answer without needing the
issue thread.

- "Every cloud source shows status=UNAVAILABLE / can't stream anything"
  (Connection Issues). Three-step diagnostic checklist: :443
  reachability preflight, margeAccountUUID check, filtered
  `logread -f`. Distilled from the diagnostic ping on #224 plus
  Thatboioofy's resolution (missing margeAccountUUID was the cause).
  Sidebar clarifies that the firmware-internal placeholder sources
  (SpotifyConnectUserName, SpotifyAlexaUserName, UPnPUserName,
  StoredMusicUserName, QPlay{1,2}UserName, AirPlay2DefaultUserName)
  are speaker-synthesized and their UNAVAILABLE status is never an
  AfterTouch problem on its own.

- New section "Music Service & Preset Issues" with "Spotify preset
  fails with 'Current content cannot be saved as preset'". Explains
  the firmware-side isPresetable="false" gate on Connect-pushed
  playback (foob61451's NowPlaying capture in #235), why an
  OAuth-linked account flips it to true, and cross-links to
  MUSIC-SERVICES.md and the new spotify-overview.md.

- "TuneIn (or Internet Radio) missing from /sources after a factory
  reset". TuneIn is not a default source; the speaker only registers
  it after first play. Captured from the #253 side-thread with both
  app and `soundtouch-cli source content` recipes plus the
  no-SSH caveat for newer hardware (SA-5).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-17 00:12:28 +02:00
Tobias GesellchenandClaude Opus 4.7 862c1caca2 docs: render mermaid diagrams on the GitHub Pages site
spotify-oauth.md (and any future docs) embed mermaid sequence/flow
diagrams as fenced code blocks. Kramdown emits those as
<pre><code class="language-mermaid">, which is not what Mermaid's
auto-renderer looks for, so on the rendered site they show up as raw
code instead of diagrams.

Add docs/_includes/head-custom.html (a hook the pages-themes/minimal
remote theme already exposes) to load Mermaid 11 as an ES module from
jsDelivr, rewrite pre/code.language-mermaid nodes into div.mermaid, and
call mermaid.run() once.

No Jekyll plugin or _config.yml change needed — the include slot is
honoured by the remote theme as-is.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-16 23:54:39 +02:00
Tobias GesellchenandClaude Opus 4.7 b0d7e8aae2 feat(spotify): wire preset storage end-to-end via server-centric priming (#302)
storePreset on the speaker was failing with "AddPreset - failed due to
invalid SourceID" because the watchdog priming path only pushed ZeroConf
credentials and never registered a SPOTIFY ConfiguredSource in marge.

PrimeDeviceWithSpotify now:
- resolves the device's paired account via live :8090/info
(margeAccountUUID), falling back to ServiceDeviceInfo.AccountID — same
order as setup.populateDeviceInfo;
- writes a SPOTIFY ConfiguredSource under that account (providerID=15,
BoseSecret as credential), mirroring bridgeSpotifyToMarge;
- POSTs `<updates><sourcesUpdated/></updates>` so the speaker re-fetches
its on-device Sources.xml from marge.

Also introduce zeroconf.ErrAddUserNoOp for the narrow firmware quirk
(404 + empty body on ?action=addUser when activeUser already matches).
Recognised only on that exact pattern; real 4xx/5xx still surface loudly
with full response details. Same treatment applied to Amazon priming.

Docs:
- new docs/concepts/spotify-overview.md anchors the topic (mental model,
streamingoauth.bose.com DNS gotcha, token lifecycle, clientId notes,
troubleshooting table);
- spotify-oauth.md drops the removed install-primer endpoint and the
on-device boot-primer install sections, adds /mgmt/spotify/prime;
- spotify-priming-strategy.md and MUSIC-SERVICES.md link to the
overview.

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-16 22:47:57 +02:00
Tobias GesellchenandClaude Opus 4.7 e64481f008 docs(setup): record ST10 ≡ ST20 bundle equivalence + curl reproducer
Two doc-only additions to TestValidateRealSpeakerBundle's header
comment:

  - Cross-model note: ST10 and ST20 ship the byte-identical CA
    bundle on firmware 27.0.6.46330.5043500 (md5
    2d150987b312e4280fc576b508e62b43, 165 certs, ~251 KB).
    Verified against firmware/_backup_ST10/_/etc/pki/tls/certs/
    ca-bundle.crt 2026-05-16. The existing
    testdata/ca_bundle_st20_pristine.crt fixture therefore stands
    in for both models on that firmware build, so any expired-root
    hypothesis evaluated against it covers both.
  - Curl reproducer: three one-liners that point curl at the fixture
    and probe the actual TuneIn stream chain a SoundTouch speaker
    would walk (using K-LOVE / s33828 as the canonical example —
    matches the case from #292). Control with the system trust
    store shown alongside. Both bundles handle the chain (Amazon
    Root CA 1 + DigiCert Global Root, valid through 2026+) so the
    expired-root hypothesis is ruled out for firmware 27 — recorded
    in the comment so future-me / reviewers can replay the same
    probe without re-deriving it from chat context.

No code change; test still passes.

Related to https://github.com/gesellix/Bose-SoundTouch/issues/292.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-16 16:23:23 +02:00
Tobias GesellchenandClaude Opus 4.7 04b3a445ca feat(bmx): make TuneIn formats= configurable via Settings.TuneInStreamFormats
PR #249 added "hls" unconditionally to TuneIn's Tune.ashx formats=
query. That regressed playback on the SoundTouch line: TuneIn returns
an .m3u8 HLS playlist for stations like K-LOVE (s33828), the speaker
can't parse it, blinks amber and falls silent. Verified that
firmware 27 on ST10 and ST20 ships the byte-identical Mozilla CCADB
bundle and validates the actual stream chain cleanly, so it isn't a
cert-expiry issue (#292's hypothesis) — the speaker simply has no
HLS support.

Changes:

  - TuneInStream is now a builder, not a const: takes the station ID
    plus a formats string (empty falls back to the new exported
    DefaultTuneInStreamFormats = "mp3,aac,ogg" — matches the pre-#249
    request shape).
  - TuneInPlayback and TuneInPlaybackPodcast take the formats string.
  - New Settings.TuneInStreamFormats string. Empty by default.
    Operators with HLS-capable speakers can set it to
    "mp3,aac,ogg,hls" — or any other comma-separated list — via
    settings.json. The value is passed through verbatim; AfterTouch
    does not validate the individual format tokens, so this is also
    the right knob for trialling additional formats without code
    changes.
  - Two regression tests pin both the empty-uses-default contract
    and the override-passes-through contract (with the whitespace-
    trim sub-case) so PR #249-style regressions surface at
    compile/test time.

The setting is settings.json-only (matches the existing pattern for
AllowInsecureUpstreamTLS / TrustForwardedHeaders / TrustedProxyCIDRs
which are also edit-the-file settings). UI surface can be a small
follow-up if reporters ask for it.

Example settings.json snippet to re-enable HLS (only if your
speaker can actually play it):

    {
      "server_url": "http://aftertouch.local:8000",
      "tunein_stream_formats": "mp3,aac,ogg,hls"
    }

Restart soundtouch-service after editing.

Related to https://github.com/gesellix/Bose-SoundTouch/issues/292.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-16 16:14:28 +02:00
Tobias GesellchenandClaude Opus 4.7 06916226df feat(setup): tag service-side IP resolve with a sentinel + observe SSH cost
The migration-summary preflight always emitted a "resolved from service,
not from device"  row whenever the target was a hostname — even when
SSH was available and could have answered authoritatively. Two
problems compounded: the summary builder passed `nil` for the SSH
client (skipping the device-side ping), and resolveIP's service-side
fallback returned a bare fmt.Errorf the caller couldn't distinguish
from a real failure.

Changes:

  - ErrResolvedFromServiceOnly sentinel; service-side fallback wraps
    it with fmt.Errorf("%w: ...") so callers can errors.Is()-check.
    Apply-path callers that pass a real SSH client keep getting the
    same error shape they always did.
  - populatePlannedNetworkConfig now takes an SSHClient. GetMigrationSummary
    opens one when probe.SSHOK is true and passes it through, so the
    summary's resolve call uses the same device-side authority the
    apply paths use. Skipping the dial when SSH is known dead keeps
    a stale handshake-timeout from burning the preflight budget.
  - MigrationSummary gains ResolveIPSource ("device" / "service") and
    ResolveIPDurationMS so we can observe the SSH-ping cost in the
    wild. The historical comment claimed 2-5 s on firmware-27 devices —
    we now have data instead of a guess.
  - CLI renderer prints the new source + timing line, and only renders
    the  ResolveIPError row for hard failures (both SSH ping AND
    service DNS failed).
  - Two regression tests cover the sentinel-tagging contract and the
    device-success-returns-nil-error path.

Related to https://github.com/gesellix/Bose-SoundTouch/issues/282.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-16 15:16:53 +02:00
Tobias GesellchenandClaude Opus 4.7 695dd954e7 test(setup): regression for telnet-only migration detection
Pins the ordering invariant fixed in the preceding commit. Builds a
fake-speaker scenario where:

  - SSH is unavailable (every SSH-driven axis stays false)
  - telnet getpdo reports the AfterTouch hostname

Pre-fix, checkIsMigratedFromProbe ran before the telnet channel was
drained, so summary.TelnetVerifiedConfig was empty when
isTelnetMigrated read it — the telnet axis came back false and
summary.IsMigrated followed. The CLI's `setup verify` exited
non-zero, the web UI rendered "Not Migrated". Reproduced by
foob61451 on #293.

The test asserts:

  - summary.TelnetVerifiedConfig is populated (sanity guard — the
    downstream assertions are meaningless if the probe didn't run)
  - summary.TelnetMigrated == true
  - summary.IsMigrated == true

Verified locally: the test PASSES with the ordering fix applied and
FAILS without it. Failure messages name PR #294 by number so a
future regression points at the same code path.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-16 14:46:04 +02:00
Marcin Mennemann 3bd82f3bf9 adj: comment numbers 2026-05-16 14:46:04 +02:00
Marcin Mennemann 5d2f5d12ec fix: detect telnet-only migrations in summary by waiting for probe result 2026-05-16 14:46:04 +02:00
Tobias GesellchenandClaude Opus 4.7 675288a329 docs(migration): add CLI-driven factory-reset alternative
The web-UI wizard is in-place migration: it preserves the speaker's
existing pairing and synced data. The CLI sequence is a different
shape — full factory-reset → wifi-push → pair against AfterTouch
from scratch — and it's the right tool when you want a clean,
scriptable, reproducible setup (automation, batched onboarding, or
just starting from a reset speaker).

Documents the full 6-step CLI flow (plan / factory-reset / wait-ap
/ wifi-push / wait-online / setup pair --mode=full), the verification
checks, and a side-by-side comparison so users can pick the right
path. Placed after "Repeat for each speaker" so the wizard remains
the recommended default for one-off migrations.

The flow assumes #195 and #269 are fixed in v0.80.2 — without the
AUX/sources filter, the CLI factory-reset path produces a speaker
where AUX won't dispatch.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-16 12:14:18 +02:00
Tobias GesellchenandClaude Opus 4.7 355328da57 fix(cli): retry wifi-push once when the speaker's first ACK times out
The previous 10s→30s timeout bump didn't help — the first POST to
/addWirelessProfile on the speaker's AP-mode endpoint frequently
hangs until the deadline elapses, then a second POST a few seconds
later succeeds immediately. Empirically the workaround was "just
run wifi-push twice"; this commit folds that into the function.

PushWiFiCredentials now:
  - caps each attempt at 12 s (well above the sub-second healthy
    response time) so a stuck first attempt doesn't burn the whole
    budget
  - waits 2 s between attempts so the speaker's setup endpoint can
    finish whatever the first POST kicked off
  - falls through cleanly if the first attempt succeeds (the second
    never fires)
  - returns the second attempt's error if both fail, with context
    cancellation surfaced explicitly

Total budget is well under the CLI's 30 s --request-timeout, so
the flag still acts as a hard ceiling.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-16 12:14:18 +02:00
Tobias GesellchenandClaude Opus 4.7 30456d7ff8 test(integration): update http-client assertions for cloud-side AUX exclusion
Two HTTP client tests asserted AUX (id=10001 / sourceproviderid=9) was
present in /streaming/account/{a}/full and /streaming/account/{a}/sources.
After 2b40481 drops AUX from those cloud responses (matching real Bose
behaviour; see pkg/service/marge/marge.go getAccountSources), both
tests fail. Updates them to:

  - Expect 5 sources in /full (down from 6) — INTERNET_RADIO,
    LOCAL_INTERNET_RADIO, TUNEIN, RADIO_BROWSER, Spotify.
  - Expect ids 10002/10003/10004 (not 10001/...) in /sources.
  - Add explicit negative assertions that sourceproviderid=9 / id=10001
    is *not* present, so a regression that re-introduces AUX in cloud
    responses fails loud.

Verified via `make test-http-client`: 49 requests, 0 failures.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-16 12:14:18 +02:00
Tobias GesellchenandClaude Opus 4.7 74007c7cb2 feat(setup): align <PairDeviceWithAccount> with the official Bose app shape
The Stockholm app (stockholm/setup/js/workflow_add_devices.js:23,77)
and Zimbo88's OpenCloudTouch USB-less script
(https://github.com/scheilch/opencloudtouch/discussions/201) both send
<boseServer>, <updateServer>, and <accountEmail> alongside the
<accountId>/<userAuthToken> pair. AfterTouch's setMargeAccount
historically sent only the latter two.

Adds:

  - MargePairingExtras struct on SessionConfig, opt-in via
    BoseServer (UpdateServer + AccountEmail default-derived when
    empty).
  - DefaultMargeAuthToken constant ("Bearer AfterTouch") and
    DefaultMargePairingEmail constant ("local@aftertouch.invalid",
    RFC 2606 reserved .invalid TLD).
  - buildPairDeviceWithAccountXML helper extracted so tests can
    pin both the minimal-payload and extended-payload shapes
    without driving a full WebSocket session.
  - --token flag on `soundtouch-cli setup pair` so we can override
    the placeholder for token-shape experiments.
  - runPairBare threads --service-url through to PairingExtras so
    `--mode=bare --service-url=...` ships the extended payload too;
    runPairFull already used it via applyInitPlanDefaults.

The speaker accepts any non-empty Bearer string (verified during
#195 investigation: "Bearer AfterTouch" passes and the speaker
re-derives its post-pair state from the marge endpoints regardless
of token content). The Stockholm-app payload shape is purely
documentation alignment; it did NOT fix the post-pair AUX/preset
breakage that turned out to be the cloud /full source list (see the
preceding marge commit). Keeping the wiring so the switches are
ready when we want to experiment further.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-16 12:14:18 +02:00
Tobias GesellchenandClaude Opus 4.7 332c7b87d0 fix(marge): drop AUX from cloud /full and /sources to unblock dispatch
Closes #195 and #269. Both issues reported the same symptom on
freshly-paired speakers: AUX selection and preset playback failed
post-pair, while /sources at :8090 still reported the sources as
READY. The bug was upstream in AfterTouch's cloud-side responses.

Real Bose's /streaming/account/{a}/full never emitted AUX as a
cloud <source>. Verified across 61 captured upstream /full bodies
covering 4669 source elements: zero match sourceproviderid=9 (AUX),
zero match the literal string "AUX". Captures sample at
scripts/android/captures/var/lib/soundtouch-service/parity_mismatches/.
The captured speakers are SoundTouch 20s which do have physical AUX
inputs — Bose deliberately kept AUX out of /full and let the speaker
enumerate it locally via isLocal=true.

AfterTouch's getAccountSources unconditionally included AUX
(id=10001) with the wrong shape: a displayName="AUX IN" attribute
(real Bose: never), <name>AUX</name> (real Bose: empty), an empty
<credential> (real Bose: empty for INTERNET_RADIO providerid=2 only,
never present for AUX since AUX wasn't there). The speaker's source-
reconciliation logic treated AfterTouch's malformed AUX entry as a
cloud-side inconsistency and refused dispatch to AUX — even though
the local availability check kept reporting it READY.

This was the actual cause behind a long red-herring trail (TPDA
:30034 storm, IoT.xml/AVS bootstrap, userAuthToken shape, SETUP
state machine bracket). All of those are universal across the
firmware family; spotty has the same TPDA storm in logread and AUX
still works there. Only the cloud-source-list shape diverged
between working and broken speakers.

The filter applies in getAccountSources because both AccountFullToXML
and AccountSourcesToXML go through it. AUX stays in
GetDefaultSources for non-cloud consumers (web UI source picker,
default-sources init). Three handler tests updated to assert AUX is
intentionally excluded from cloud responses.

Verified by gesellix on rhino 2026-05-16 via full factory-reset →
wifi-push → setup pair → AUX press → audio plays.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-16 12:14:18 +02:00
Tobias GesellchenandClaude Opus 4.7 824ed920ff fix(cli): give wifi-push the time the speaker needs to ACK
The speaker confirms AddWirelessProfile then tears down its AP within
~30 s. The default 10 s --request-timeout races that ACK whenever the
speaker is busy reconciling state — and a hard-coded 10 s on the
internal http.Client capped the user-passed timeout silently, so a
longer --request-timeout had no effect.

The CLI default is now 30 s and the inner http.Client lets the
context govern alone.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-16 12:14:18 +02:00
Tobias Gesellchen c5938b8e05 gitignore stale testdata 2026-05-15 19:36:57 +02:00
Tobias GesellchenandClaude Opus 4.7 74420a4d02 docs(web): add stereo-pair rendering to soundtouch-web roadmap
Section 4 captures the presentation-only follow-up to #252: collapse
the two halves of a stereo pair into a single device-list entry using
each speaker's GET /getGroup metadata. Pair lifecycle (add/rename/remove)
already works end-to-end via pkg/client + soundtouch-cli, so this is
purely a soundtouch-web UI concern.

Drafted after BirdyBA's stereo-pair confirmation on the closed #252:
https://github.com/gesellix/Bose-SoundTouch/issues/252#issuecomment-4458140305

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-15 19:36:43 +02:00
Tobias Gesellchen 9dcde21f39 Bump release version to v0.80.1 in installer scripts 2026-05-15 19:25:01 +02:00
Tobias GesellchenandClaude Opus 4.7 979374b501 test(integration): pin #285 rename PUT behaviour at the HTTP layer
Adds rename_device.http between get_group.http and unregister_device.http
in the make test-http-client sequence. The new test fires the PUT
the speaker emits after a rename and asserts:

  - 200 OK, content type vnd.bose.streaming-v1.2+xml
  - the response carries the renamed value
  - createdOn matches the value captured during register_device.http
    (cross-request global), locking in the "first-paired" semantics
  - ipaddress is preserved from the prior power_on, not reset by the
    rename body's empty IP field
  - a mismatched body deviceid is rejected with 400

register_device.http captures the initial createdOn into a global so
the rename test can assert equality rather than a flakier
updatedOn != createdOn heuristic. The variant POST's stale
updatedOn === createdOn assertion is replaced with an upsert-aware
equality against the same captured global.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-15 19:04:41 +02:00
Tobias GesellchenandClaude Opus 4.7 6bc4ee1e73 fix(marge): reject rename PUT mismatch before persisting
HandleMargeUpdateDevice used to call AddDeviceToAccount (an upsert)
and only check body-vs-URL deviceID after the row was already
written. A speaker sending a malformed PUT with the wrong deviceid
attribute would still leave a spurious record before getting 400.

Now we parse just the deviceid attribute, compare against the URL
segment, and only call into the upsert when they match. The
existing regression test gains two GetDeviceInfo assertions to lock
the no-spurious-row guarantee in.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-15 19:04:41 +02:00
Tobias GesellchenandClaude Opus 4.7 49904635f2 fix(marge): preserve CreatedOn + IPAddress across the device rename PUT
The PUT handler shipped in 5f31616 + the routing fix in 66b83b6 made
the rename PUT reach AfterTouch and return 200. But the response and
the on-disk record both drifted away from real Bose's parity on every
rename: CreatedOn was rewritten to now() (so the "first paired in
2017" semantics evaporated on the second rename) and IPAddress
landed empty (because the speaker's PUT body doesn't carry it and
the marge handler had no preservation path).

Pre-shutdown capture at
data/parity_mismatches/1771797308__streaming_account_3230304_device_A81B6A536A98.json
shows real Bose's 200 OK shape: createdOn pinned to the original
pairing timestamp (2017-02-07), ipaddress populated, only updatedOn
and name change across renames. Aligning with that.

Three small persistence additions:

  - models.ServiceDeviceInfo grows CreatedOn + UpdatedOn (ISO8601
    strings, omitempty so existing JSON consumers don't break).
  - datastore.SaveDeviceInfo persists them inside the DeviceInfo.xml
    payload as <createdOn> / <updatedOn> alongside the other fields.
  - mergeWithExistingDeviceInfo preserves CreatedOn unconditionally
    (it's the "first-paired" timestamp and never re-derived from
    inbound data) and preserves UpdatedOn only if the caller didn't
    set a fresh one.

marge.AddDeviceToAccount becomes precedence-aware:

  - Reads the existing record once at the top.
  - CreatedOn: preserved from existing if present, else now() for
    first registration.
  - IPAddress: preserves what's in the existing record; falls back
    to r.RemoteAddr's host portion only when no prior IP exists.
    Lets first-time PUTs seed an IP from the inbound connection
    without later renames clobbering a known-good value.
  - UpdatedOn: always now().
  - Response XML now re-reads the persisted record so the
    response body matches what's on disk — no parallel hand-built
    XML drifting from the merge result.

Function signature gained a remoteAddr parameter. Both callers
(HandleMargeAddDevice and HandleMargeUpdateDevice) pass r.RemoteAddr.

Test coverage:

  - TestIssue285_RenamePutAcceptedAndPersisted seeds the datastore
    with a 2017 CreatedOn and a known IP, then PUTs the rename;
    asserts both survive on disk AND in the response body, and
    that UpdatedOn refreshes. The same pre-shutdown capture cited
    above is the parity reference.

  - TestIssue285_NewDeviceGetsRemoteAddrAndFreshTimestamps (new)
    covers the no-prior-record path: first-time PUT against an
    unknown device produces CreatedOn = now() and IPAddress
    pulled from the inbound TCP connection. Pins the fallback
    behaviour so it can't quietly stop seeding new devices.

Authorization is still not enforced — the speaker has no Bose token
to send post-shutdown, and we don't (yet) have a token-authority
story of our own. Adding a warn-only auth check is a deferred
follow-up (see NEXT.md). Real Bose returned 401 for this PUT in the
2026-05-15 capture; we knowingly accept anything.

Refs #285.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-15 19:04:41 +02:00
Tobias GesellchenandClaude Opus 4.7 ff96430f53 fix(router): consolidate /device subrouter so PUT and DELETE actually resolve
Issue #285's first fix (5f31616) registered the rename PUT inside a
chi subrouter at `/streaming/account/{account}/device`, alongside the
existing POST handlers. A *second* subrouter was already declared at
`/streaming/account/{account}/device/{device}` for the per-device
sub-resources (presets, recent, group, …). chi's radix tree treats
those two registrations as overlapping prefixes and at request time
prefers the more-specific `/device/{device}` subrouter — which had
no root-level method handlers. A PUT to /device/X fell through to
the [UNHANDLED] catch-all, got proxied to streaming.bose.com, came
back as 401 from CloudFront. Speakers retried in a loop.

The handlers-package regression test passed because the test router
in `pkg/service/handlers/main_test.go` is flatter (one subrouter for
device, no `/device/{device}` nested block). The route snapshot
test passed because `chi.Walk` enumerates each subrouter's
registrations independently — it doesn't simulate how the radix tree
will resolve a runtime request when subrouters overlap.

Reproduced against the actual production setupRouter in
TestPUTRenameRoutesToLocalHandler (new in router_test.go). Before
this commit: 404 / [UNHANDLED] / 401 proxy. After: 200 from
HandleMargeUpdateDevice.

Fix: collapse the two subrouters into one. All `/device` routes —
the POST/PUT/DELETE on the device resource itself plus the GET/POST
sub-resources — share a single `r.Route("/device", ...)` block with
explicit `/{device}/...` paths inside. No radix-tree ambiguity.

Knock-on: the `r.Delete("/device/{device}", server.HandleMargeRemoveDevice)`
that lived at the outer `/account/{account}` level moves into the
unified `/device` subrouter for symmetry. Its prior placement was
also being shadowed by the radix overlap, which is why the route
snapshot's first regeneration after this fix grew by exactly one
DELETE line — that route was never resolvable at runtime under the
old structure either.

Refs #285.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-15 18:08:52 +02:00
61 changed files with 3312 additions and 363 deletions
+1
View File
@@ -171,6 +171,7 @@ test-http-client:
/workdir/get_full_account.http \
/workdir/create_group.http \
/workdir/get_group.http \
/workdir/rename_device.http \
/workdir/unregister_device.http \
--report; \
EXIT_CODE=$$?; \
+5 -3
View File
@@ -413,9 +413,11 @@ func handlePresetEvent(event *models.PresetUpdatedEvent, verbose bool) {
for _, preset := range presets.Preset {
fmt.Printf(" 📻 Preset %d:", preset.ID)
if preset.ContentItem != nil {
fmt.Printf(" %s", preset.ContentItem.ItemName)
fmt.Printf(" (%s)", preset.ContentItem.Source)
// IsEmpty catches both <preset/> and INVALID_SOURCE
// placeholders; using the nil-safe helpers below means the
// inner Printf never dereferences a nil ContentItem.
if !preset.IsEmpty() {
fmt.Printf(" %s (%s)", preset.GetDisplayName(), preset.GetSource())
}
fmt.Println()
+20 -7
View File
@@ -177,23 +177,36 @@ func getPresets(c *cli.Context) error {
fmt.Printf("Device Presets:\n")
if len(presets.Preset) == 0 {
// Filter out placeholder presets the firmware emits for unconfigured
// slots (issue #308): self-closing <preset/> after factory reset,
// or <ContentItem source="INVALID_SOURCE"/> on healthy devices.
// IsEmpty covers both shapes; accessing fields like ContentItem.Source
// directly on the first shape panics.
configured := make([]models.Preset, 0, len(presets.Preset))
for _, p := range presets.Preset {
if !p.IsEmpty() {
configured = append(configured, p)
}
}
if len(configured) == 0 {
fmt.Printf(" No presets configured\n")
return nil
}
fmt.Printf(" Configured Presets:\n")
for _, preset := range presets.Preset {
for _, preset := range configured {
fmt.Printf(" %d. %s\n", preset.ID, preset.GetDisplayName())
fmt.Printf(" Source: %s\n", preset.ContentItem.Source)
fmt.Printf(" Source: %s\n", preset.GetSource())
if preset.ContentItem.SourceAccount != "" && preset.ContentItem.SourceAccount != preset.ContentItem.Source {
fmt.Printf(" Account: %s\n", preset.ContentItem.SourceAccount)
if account := preset.GetSourceAccount(); account != "" && account != preset.GetSource() {
fmt.Printf(" Account: %s\n", account)
}
if preset.ContentItem.Location != "" {
fmt.Printf(" Location: %s\n", preset.ContentItem.Location)
if location := preset.GetLocation(); location != "" {
fmt.Printf(" Location: %s\n", location)
}
// Show preset creation time if available
+33 -5
View File
@@ -404,7 +404,7 @@ func setupWiFiPushCmd() *cli.Command {
&cli.StringFlag{Name: "pass", Required: true, Usage: "Home Wi-Fi password"},
&cli.StringFlag{Name: "security", Value: setup.DefaultWiFiSecurity, Usage: "Security type (wpa_or_wpa2, wep, open)"},
&cli.StringFlag{Name: "ap-host", Value: setup.SpeakerSetupAP, Usage: "Speaker's setup-mode IP"},
&cli.DurationFlag{Name: "request-timeout", Value: 10 * time.Second},
&cli.DurationFlag{Name: "request-timeout", Value: 30 * time.Second, Usage: "Per-request timeout (the speaker can be slow to ACK before tearing down AP mode; 10 s often races)"},
},
Action: func(c *cli.Context) error {
params := setup.PushWiFiCredentialsParams{
@@ -949,6 +949,17 @@ func renderMigrationSummary(deviceIP, serviceURL string, s *setup.MigrationSumma
if s.ResolveIPError != "" {
PrintError("Resolve IP error: " + s.ResolveIPError)
}
// Observability for the IP-resolve path. Source tells the user whether
// the speaker itself was consulted (authoritative) or only the service
// (best-effort). DurationMS lets us watch the SSH-ping cost trend in
// the wild — historical comment claimed 2-5 s on firmware 27, worth
// re-evaluating as data accumulates.
if s.ResolveIPSource != "" {
fmt.Printf("Resolve IP source : %s (%d ms)\n", s.ResolveIPSource, s.ResolveIPDurationMS)
} else if s.ResolveIPDurationMS > 0 {
fmt.Printf("Resolve IP : %d ms\n", s.ResolveIPDurationMS)
}
}
func setupRebootCmd() *cli.Command {
@@ -1353,10 +1364,11 @@ func setupPairCmd() *cli.Command {
Flags: []cli.Flag{
&cli.StringFlag{Name: "account", Usage: "7-digit account ID (empty = generate)"},
&cli.StringFlag{Name: "mode", Value: "full", Usage: "full (state machine) or bare (setMargeAccount only — experimental)"},
&cli.StringFlag{Name: "service-url", Value: "http://aftertouch.local:8000", Usage: "AfterTouch base URL (used by mode=full for defaults)"},
&cli.StringFlag{Name: "service-url", Value: "http://aftertouch.local:8000", Usage: "AfterTouch base URL (also populates <boseServer>/<updateServer> in setMargeAccount)"},
&cli.StringFlag{Name: "name", Usage: "Speaker name to set during pairing (empty = keep current)"},
&cli.IntFlag{Name: "language", Value: setup.LanguageEnglish, Usage: "sysLanguage code (2 = English)"},
&cli.DurationFlag{Name: "step-timeout", Value: 8 * time.Second},
&cli.StringFlag{Name: "token", Usage: "userAuthToken value (empty = use built-in placeholder matching the Bose app token shape)"},
},
Action: func(c *cli.Context) error {
cfg := GetClientConfig(c)
@@ -1401,8 +1413,20 @@ func runPairBare(c *cli.Context, deviceIP, accountID string) error {
fmt.Printf("pre /info deviceID=%s margeAccountUUID=%q margeURL=%q\n",
info.DeviceID, info.MargeAccountUUID, info.MargeURL)
// Service URL drives the extended <PairDeviceWithAccount> payload
// (boseServer/updateServer/accountEmail). When empty, the session
// falls back to the minimal historical shape (accountId +
// userAuthToken only).
serviceURL := c.String("service-url")
var extras setup.MargePairingExtras
if serviceURL != "" {
extras = setup.MargePairingExtras{BoseServer: serviceURL}
}
session, err := setup.DialSession(deviceIP, info.DeviceID, setup.SessionConfig{
StepTimeout: c.Duration("step-timeout"),
StepTimeout: c.Duration("step-timeout"),
PairingExtras: extras,
})
if err != nil {
return fmt.Errorf("dial WS: %w", err)
@@ -1413,9 +1437,13 @@ func runPairBare(c *cli.Context, deviceIP, accountID string) error {
ctx, cancel := context.WithTimeout(c.Context, c.Duration("step-timeout")+2*time.Second)
defer cancel()
fmt.Printf("→ setMargeAccount accountID=%s (no SETUP bracket)\n", accountID)
if serviceURL != "" {
fmt.Printf("→ setMargeAccount accountID=%s (extended: boseServer=%s)\n", accountID, serviceURL)
} else {
fmt.Printf("→ setMargeAccount accountID=%s (minimal payload, no SETUP bracket)\n", accountID)
}
if pairErr := session.SetMargeAccount(ctx, accountID, ""); pairErr != nil {
if pairErr := session.SetMargeAccount(ctx, accountID, c.String("token")); pairErr != nil {
PrintError(fmt.Sprintf("setMargeAccount: %v", pairErr))
return pairErr
}
+22 -15
View File
@@ -936,6 +936,16 @@ func setupRouter(server *handlers.Server) *chi.Mux {
r.Get("/presets/all", server.HandleMargeAccountPresets)
r.Get("/provider_settings", server.HandleMargeProviderSettings)
// All `/device` routes share one chi subrouter. Two
// overlapping subrouters (`/device` + `/device/{device}`)
// caused chi's radix-tree resolver to bind a runtime
// request to the more-specific prefix even when only the
// less-specific subrouter had a matching method handler,
// producing the [UNHANDLED] → upstream-proxy fall-through
// behind issue #285's first-attempted fix. One subrouter
// keeps every device-scoped path resolvable; see
// TestPUTRenameRoutesToLocalHandler for the regression
// against the production router.
r.Route("/device", func(r chi.Router) {
r.Post("/", server.HandleMargeAddDevice)
r.Post("/{device}", server.HandleMargeAddDevice)
@@ -944,21 +954,20 @@ func setupRouter(server *handlers.Server) *chi.Mux {
// when the user renames via Bose App or
// `soundtouch-cli name set`. Issue #285.
r.Put("/{device}", server.HandleMargeUpdateDevice)
})
r.Delete("/{device}", server.HandleMargeRemoveDevice)
r.Route("/device/{device}", func(r chi.Router) {
r.Get("/presets", server.HandleMargePresets)
r.Post("/presets/{presetNumber}", server.HandleMargeUpdatePreset)
r.Put("/preset/{presetNumber}", server.HandleMargeUpdatePreset)
r.Delete("/preset/{presetNumber}", server.HandleMargeRemovePreset)
r.Get("/recent", server.HandleMargeRecents)
r.Get("/recents", server.HandleMargeRecents)
r.Post("/recent", server.HandleMargeAddRecent)
r.Get("/{device}/presets", server.HandleMargePresets)
r.Post("/{device}/presets/{presetNumber}", server.HandleMargeUpdatePreset)
r.Put("/{device}/preset/{presetNumber}", server.HandleMargeUpdatePreset)
r.Delete("/{device}/preset/{presetNumber}", server.HandleMargeRemovePreset)
r.Get("/{device}/recent", server.HandleMargeRecents)
r.Get("/{device}/recents", server.HandleMargeRecents)
r.Post("/{device}/recent", server.HandleMargeAddRecent)
r.Get("/group", server.HandleMargeDeviceGroup)
r.Get("/group/", server.HandleMargeDeviceGroup)
r.Get("/group/server", server.HandleMargeDeviceGroupServer)
r.Get("/group/member", server.HandleMargeDeviceGroupMember)
r.Get("/{device}/group", server.HandleMargeDeviceGroup)
r.Get("/{device}/group/", server.HandleMargeDeviceGroup)
r.Get("/{device}/group/server", server.HandleMargeDeviceGroupServer)
r.Get("/{device}/group/member", server.HandleMargeDeviceGroupMember)
})
// Speakers POST to /group/ (with trailing slash) when forwarding
@@ -968,8 +977,6 @@ func setupRouter(server *handlers.Server) *chi.Mux {
r.Post("/group/", server.HandleMargeAddGroup)
r.Post("/group/{groupId}", server.HandleMargeModifyGroup)
r.Delete("/group/{groupId}", server.HandleMargeDeleteGroup)
r.Delete("/device/{device}", server.HandleMargeRemoveDevice)
})
r.Get("/device/{device}/streaming_token", server.HandleMargeStreamingToken)
+55
View File
@@ -3,6 +3,7 @@ package main
import (
"fmt"
"net/http"
"net/http/httptest"
"os"
"reflect"
"runtime"
@@ -10,6 +11,7 @@ import (
"strings"
"testing"
"github.com/gesellix/bose-soundtouch/pkg/service/datastore"
"github.com/gesellix/bose-soundtouch/pkg/service/handlers"
"github.com/go-chi/chi/v5"
)
@@ -102,3 +104,56 @@ func TestPrintRoutes(t *testing.T) {
t.Errorf("Router routes changed! Diff the snapshot at %s with %s", snapshotPath, actualPath)
}
}
// TestPUTRenameRoutesToLocalHandler reproduces the runtime routing
// behaviour the user saw on their deployed v0.80.0: a PUT to
// /streaming/account/{a}/device/{d} should land on
// HandleMargeUpdateDevice, not fall through to the [UNHANDLED]
// proxy. The handlers-package test (TestIssue285_*) uses a simplified
// router that doesn't have the overlapping `/device` and
// `/device/{device}` route groups, so it can't catch a chi radix-
// tree resolution that prefers the more-specific subrouter.
//
// This test exercises the actual production setupRouter so a
// regression in the route topology is caught against the same chi
// behaviour speakers will see.
func TestPUTRenameRoutesToLocalHandler(t *testing.T) {
tempDir, err := os.MkdirTemp("", "router-rename-")
if err != nil {
t.Fatalf("mkdir temp: %v", err)
}
defer os.RemoveAll(tempDir)
ds := datastore.NewDataStore(tempDir)
_ = ds.Initialize()
server := handlers.NewServer(ds, nil, "http://localhost:8000", false, false, false)
r := setupRouter(server)
ts := httptest.NewServer(r)
defer ts.Close()
body := `<?xml version="1.0" encoding="UTF-8" ?><device deviceid="A81B6A536A98"><name>Sound Machinechen</name><macaddress>A81B6A536A98</macaddress></device>`
req, err := http.NewRequest(http.MethodPut,
ts.URL+"/streaming/account/1111111/device/A81B6A536A98",
strings.NewReader(body))
if err != nil {
t.Fatalf("build request: %v", err)
}
req.Header.Set("Content-Type", "application/xml")
resp, err := http.DefaultClient.Do(req)
if err != nil {
t.Fatalf("PUT: %v", err)
}
defer func() { _ = resp.Body.Close() }()
// 200 means our local HandleMargeUpdateDevice handled it.
// 401 / 502 / anything else means the request fell through to
// the [UNHANDLED] proxy and got the upstream response — which
// is exactly the failure mode #285 was supposed to fix.
if resp.StatusCode != http.StatusOK {
t.Fatalf("PUT status = %d, want 200 (local handler). Anything else means the request fell through to [UNHANDLED] proxy — chi is routing to a different subrouter than the PUT registration intended.", resp.StatusCode)
}
}
+1
View File
@@ -8,6 +8,7 @@ DELETE /setup/dns-discoveries handlers.(
DELETE /setup/interactions/sessions handlers.(*Server).HandleCleanupSessions-fm
DELETE /setup/interactions/sessions/{session} handlers.(*Server).HandleDeleteSession-fm
DELETE /setup/parity-mismatches handlers.(*Server).HandleClearParityMismatches-fm
DELETE /streaming/account/{account}/device/{device} handlers.(*Server).HandleMargeRemoveDevice-fm
DELETE /streaming/account/{account}/device/{device}/preset/{presetNumber} handlers.(*Server).HandleMargeRemovePreset-fm
DELETE /streaming/account/{account}/group/{groupId} handlers.(*Server).HandleMargeDeleteGroup-fm
GET / handlers.(*Server).HandleRoot-fm
+114 -23
View File
@@ -9,6 +9,7 @@ import (
"strconv"
"strings"
"sync"
"time"
"github.com/gesellix/bose-soundtouch/cmd/soundtouch-web/webtypes"
"github.com/gesellix/bose-soundtouch/pkg/models"
@@ -17,18 +18,34 @@ import (
"github.com/gorilla/websocket"
)
// WebApp holds the application state and dependencies
// WebApp holds the application state and dependencies.
//
// The device registry (devices map + devicesMu) is encapsulated:
// callers go through GetDevice / DeviceSnapshot / AddDevice /
// TouchDevice / DeviceCount instead of touching the map directly.
// This prevents the concurrent-map-read/write panic that would
// otherwise be reachable any time an HTTP handler runs while
// discovery or the /api/discover endpoint is registering devices.
type WebApp struct {
Devices map[string]*webtypes.DeviceConnection
devicesMu sync.RWMutex
devices map[string]*webtypes.DeviceConnection
Upgrader websocket.Upgrader
WSClients map[*websocket.Conn]bool
WSMutex sync.RWMutex
}
// DeviceEntry pairs a device id with its connection. Used by
// DeviceSnapshot so callers can iterate without holding the lock.
type DeviceEntry struct {
ID string
Device *webtypes.DeviceConnection
}
// NewWebApp creates a new WebApp instance for SPA mode
func NewWebApp() *WebApp {
return &WebApp{
Devices: make(map[string]*webtypes.DeviceConnection),
devices: make(map[string]*webtypes.DeviceConnection),
WSClients: make(map[*websocket.Conn]bool),
Upgrader: websocket.Upgrader{
CheckOrigin: func(_ *http.Request) bool { return true },
@@ -36,17 +53,89 @@ func NewWebApp() *WebApp {
}
}
// GetDevice returns the device for id and whether it exists.
func (app *WebApp) GetDevice(id string) (*webtypes.DeviceConnection, bool) {
app.devicesMu.RLock()
defer app.devicesMu.RUnlock()
device, ok := app.devices[id]
return device, ok
}
// DeviceSnapshot returns a list of (id, *DeviceConnection) pairs taken
// under a single read lock. Callers can iterate the result without
// holding any registry lock. Devices added or removed after the call
// are not reflected; the pointers themselves remain valid because
// nothing deletes from the underlying map today.
func (app *WebApp) DeviceSnapshot() []DeviceEntry {
app.devicesMu.RLock()
defer app.devicesMu.RUnlock()
out := make([]DeviceEntry, 0, len(app.devices))
for id, device := range app.devices {
out = append(out, DeviceEntry{ID: id, Device: device})
}
return out
}
// DeviceCount returns the number of registered devices at call time.
func (app *WebApp) DeviceCount() int {
app.devicesMu.RLock()
defer app.devicesMu.RUnlock()
return len(app.devices)
}
// AddDevice atomically registers conn under id when id is not already
// known. If id existed, its LastSeen is bumped and AddDevice returns
// false (the caller should discard conn). Returns true if conn was
// inserted.
func (app *WebApp) AddDevice(id string, conn *webtypes.DeviceConnection) bool {
app.devicesMu.Lock()
defer app.devicesMu.Unlock()
if existing, ok := app.devices[id]; ok {
existing.LastSeen = time.Now()
return false
}
app.devices[id] = conn
return true
}
// TouchDevice bumps LastSeen for id if it exists; returns true if
// found. Use this as a fast-path check before doing the network work
// needed to construct a new DeviceConnection.
func (app *WebApp) TouchDevice(id string) bool {
app.devicesMu.Lock()
defer app.devicesMu.Unlock()
existing, ok := app.devices[id]
if !ok {
return false
}
existing.LastSeen = time.Now()
return true
}
// HandleAPIDevices returns all devices as JSON
func (app *WebApp) HandleAPIDevices(w http.ResponseWriter, _ *http.Request) {
w.Header().Set("Content-Type", "application/json")
// Return all devices as JSON
devices := make(map[string]interface{})
for id, device := range app.Devices {
devices[id] = map[string]interface{}{
"info": device.DeviceInfo,
"status": device.Status,
"lastSeen": device.LastSeen,
snapshot := app.DeviceSnapshot()
devices := make(map[string]interface{}, len(snapshot))
for _, entry := range snapshot {
devices[entry.ID] = map[string]interface{}{
"info": entry.Device.DeviceInfo,
"status": entry.Device.Status(),
"lastSeen": entry.Device.LastSeen,
}
}
@@ -68,7 +157,7 @@ func (app *WebApp) HandleAPIDevice(w http.ResponseWriter, r *http.Request) {
return
}
device, exists := app.Devices[deviceID]
device, exists := app.GetDevice(deviceID)
if !exists {
app.sendError(w, "Device not found", http.StatusNotFound)
return
@@ -88,7 +177,7 @@ func (app *WebApp) HandleAPIDevice(w http.ResponseWriter, r *http.Request) {
Success: true,
Data: map[string]interface{}{
"info": device.DeviceInfo,
"status": device.Status,
"status": device.Status(),
},
}
@@ -107,7 +196,7 @@ func (app *WebApp) HandleAPIControl(w http.ResponseWriter, r *http.Request) {
return
}
device, exists := app.Devices[deviceID]
device, exists := app.GetDevice(deviceID)
if !exists {
app.sendError(w, "Device not found", http.StatusNotFound)
return
@@ -318,7 +407,7 @@ func (app *WebApp) HandleDeviceKey(w http.ResponseWriter, r *http.Request) {
deviceID := chi.URLParam(r, "id")
key := chi.URLParam(r, "key")
device, exists := app.Devices[deviceID]
device, exists := app.GetDevice(deviceID)
if !exists {
app.sendError(w, "Device not found", http.StatusNotFound)
return
@@ -350,7 +439,7 @@ func (app *WebApp) HandleDirectVolumeControl(w http.ResponseWriter, r *http.Requ
return
}
device, exists := app.Devices[deviceID]
device, exists := app.GetDevice(deviceID)
if !exists {
app.sendError(w, "Device not found", http.StatusNotFound)
return
@@ -376,7 +465,7 @@ func (app *WebApp) HandleDirectVolumeControl(w http.ResponseWriter, r *http.Requ
func (app *WebApp) HandleDevicePower(w http.ResponseWriter, r *http.Request) {
deviceID := chi.URLParam(r, "id")
device, exists := app.Devices[deviceID]
device, exists := app.GetDevice(deviceID)
if !exists {
app.sendError(w, "Device not found", http.StatusNotFound)
return
@@ -403,7 +492,7 @@ func (app *WebApp) HandleDevicePower(w http.ResponseWriter, r *http.Request) {
func (app *WebApp) HandleDevicePowerStatus(w http.ResponseWriter, r *http.Request) {
deviceID := chi.URLParam(r, "id")
device, exists := app.Devices[deviceID]
device, exists := app.GetDevice(deviceID)
if !exists {
app.sendError(w, "Device not found", http.StatusNotFound)
return
@@ -444,12 +533,14 @@ func (app *WebApp) BroadcastDeviceList() {
app.WSMutex.RLock()
defer app.WSMutex.RUnlock()
devices := make(map[string]interface{})
for id, device := range app.Devices {
devices[id] = map[string]interface{}{
"info": device.DeviceInfo,
"status": device.Status,
"lastSeen": device.LastSeen,
snapshot := app.DeviceSnapshot()
devices := make(map[string]interface{}, len(snapshot))
for _, entry := range snapshot {
devices[entry.ID] = map[string]interface{}{
"info": entry.Device.DeviceInfo,
"status": entry.Device.Status(),
"lastSeen": entry.Device.LastSeen,
}
}
@@ -598,7 +689,7 @@ func (app *WebApp) HandlePlayTuneIn(w http.ResponseWriter, r *http.Request) {
return
}
device, exists := app.Devices[deviceID]
device, exists := app.GetDevice(deviceID)
if !exists {
app.sendError(w, fmt.Sprintf("Device '%s' not found", deviceID), http.StatusNotFound)
return
+13 -23
View File
@@ -28,19 +28,15 @@ func createTestApp() *WebApp {
},
}
device := &webtypes.DeviceConnection{
Client: nil, // No real client for unit tests
DeviceInfo: deviceInfo,
LastSeen: time.Now(),
Status: webtypes.DeviceStatus{
Volume: &models.Volume{ActualVolume: 50, MuteEnabled: false},
Bass: &models.Bass{ActualBass: 0},
IsConnected: true,
LastActivity: time.Now(),
},
}
device := webtypes.NewDeviceConnection(nil, deviceInfo)
device.SetStatus(&webtypes.DeviceStatus{
Volume: &models.Volume{ActualVolume: 50, MuteEnabled: false},
Bass: &models.Bass{ActualBass: 0},
IsConnected: true,
LastActivity: time.Now(),
})
app.Devices["test-device"] = device
app.AddDevice("test-device", device)
return app
}
@@ -59,13 +55,9 @@ func TestNewWebApp(t *testing.T) {
if app == nil {
t.Fatal("NewWebApp returned nil")
}
if app.Devices == nil {
t.Fatal("Devices map not initialized")
}
// At this point we know app and app.Devices are not nil
if len(app.Devices) != 0 {
t.Errorf("Expected empty devices map, got %d devices", len(app.Devices))
if count := app.DeviceCount(); count != 0 {
t.Errorf("Expected empty device registry, got %d devices", count)
}
}
@@ -549,11 +541,9 @@ func BenchmarkHandleAPIDevices(b *testing.B) {
// Add more devices for realistic benchmarking
for i := 0; i < 10; i++ {
deviceID := "device-" + string(rune('0'+i))
app.Devices[deviceID] = &webtypes.DeviceConnection{
Client: &client.Client{},
DeviceInfo: &models.DeviceInfo{Name: "Test Device " + deviceID},
Status: webtypes.DeviceStatus{IsConnected: true},
}
conn := webtypes.NewDeviceConnection(&client.Client{}, &models.DeviceInfo{Name: "Test Device " + deviceID})
conn.SetStatus(&webtypes.DeviceStatus{IsConnected: true})
app.AddDevice(deviceID, conn)
}
req := httptest.NewRequest("GET", "/api/devices", nil)
@@ -0,0 +1,194 @@
// Package handlers contains tests for the device registry API on
// WebApp (GetDevice, AddDevice, TouchDevice, DeviceSnapshot,
// DeviceCount).
package handlers
import (
"fmt"
"sync"
"testing"
"github.com/gesellix/bose-soundtouch/cmd/soundtouch-web/webtypes"
"github.com/gesellix/bose-soundtouch/pkg/models"
)
func newRegistryDevice(name string) *webtypes.DeviceConnection {
conn := webtypes.NewDeviceConnection(nil, &models.DeviceInfo{Name: name})
conn.SetStatus(&webtypes.DeviceStatus{IsConnected: true})
return conn
}
func TestAddDevice_Inserts(t *testing.T) {
app := NewWebApp()
conn := newRegistryDevice("first")
if !app.AddDevice("host-1", conn) {
t.Fatal("AddDevice returned false on first insert")
}
got, ok := app.GetDevice("host-1")
if !ok {
t.Fatal("GetDevice did not find the device after AddDevice")
}
if got != conn {
t.Errorf("GetDevice returned a different pointer than inserted")
}
}
func TestAddDevice_RejectsDuplicateAndBumpsLastSeen(t *testing.T) {
app := NewWebApp()
original := newRegistryDevice("first")
app.AddDevice("host-1", original)
originalSeen := original.LastSeen
replacement := newRegistryDevice("second")
if app.AddDevice("host-1", replacement) {
t.Fatal("AddDevice returned true on duplicate; expected false")
}
got, _ := app.GetDevice("host-1")
if got != original {
t.Error("Duplicate AddDevice replaced the existing device pointer")
}
if !got.LastSeen.After(originalSeen) {
t.Error("Duplicate AddDevice did not bump LastSeen on existing device")
}
}
func TestTouchDevice(t *testing.T) {
app := NewWebApp()
if app.TouchDevice("missing") {
t.Error("TouchDevice returned true for unknown id")
}
conn := newRegistryDevice("first")
app.AddDevice("host-1", conn)
seenBefore := conn.LastSeen
if !app.TouchDevice("host-1") {
t.Fatal("TouchDevice returned false for known id")
}
if !conn.LastSeen.After(seenBefore) {
t.Error("TouchDevice did not bump LastSeen")
}
}
func TestDeviceSnapshotAndCount(t *testing.T) {
app := NewWebApp()
if got := app.DeviceCount(); got != 0 {
t.Errorf("DeviceCount on empty app = %d; want 0", got)
}
if snap := app.DeviceSnapshot(); len(snap) != 0 {
t.Errorf("DeviceSnapshot on empty app = %v; want []", snap)
}
for i := 0; i < 5; i++ {
app.AddDevice(fmt.Sprintf("host-%d", i), newRegistryDevice(fmt.Sprintf("n%d", i)))
}
if got := app.DeviceCount(); got != 5 {
t.Errorf("DeviceCount after 5 adds = %d; want 5", got)
}
snap := app.DeviceSnapshot()
if len(snap) != 5 {
t.Errorf("DeviceSnapshot len = %d; want 5", len(snap))
}
// Spot-check that the snapshot ids match what we inserted.
seen := map[string]bool{}
for _, entry := range snap {
seen[entry.ID] = true
}
for i := 0; i < 5; i++ {
id := fmt.Sprintf("host-%d", i)
if !seen[id] {
t.Errorf("DeviceSnapshot missing %s", id)
}
}
}
// TestRegistryConcurrent exercises the registry from many goroutines
// at once. Before the introduction of devicesMu this would either
// panic with "fatal error: concurrent map read and map write" or be
// flagged by the race detector. The test runs under `go test -race`
// in CI so a future regression that re-exposes the underlying map
// without locking would be caught here.
func TestRegistryConcurrent(t *testing.T) {
app := NewWebApp()
const workers = 16
const opsPerWorker = 200
var wg sync.WaitGroup
wg.Add(workers * 4)
// Writers: insert distinct ids across workers.
for w := 0; w < workers; w++ {
go func(worker int) {
defer wg.Done()
for i := 0; i < opsPerWorker; i++ {
id := fmt.Sprintf("w%d-%d", worker, i)
app.AddDevice(id, newRegistryDevice(id))
}
}(w)
}
// Touchers: bump LastSeen on a shared id (which may or may not
// exist yet — both branches are exercised).
for w := 0; w < workers; w++ {
go func() {
defer wg.Done()
for i := 0; i < opsPerWorker; i++ {
app.TouchDevice("shared")
}
}()
}
// Readers via snapshot.
for w := 0; w < workers; w++ {
go func() {
defer wg.Done()
for i := 0; i < opsPerWorker; i++ {
_ = app.DeviceSnapshot()
}
}()
}
// Readers via direct lookup.
for w := 0; w < workers; w++ {
go func() {
defer wg.Done()
for i := 0; i < opsPerWorker; i++ {
_, _ = app.GetDevice("shared")
_ = app.DeviceCount()
}
}()
}
wg.Wait()
// Sanity check: every writer inserted opsPerWorker devices, plus
// the "shared" entry was never AddDevice'd so should be absent.
if got, want := app.DeviceCount(), workers*opsPerWorker; got != want {
t.Errorf("DeviceCount after concurrent inserts = %d; want %d", got, want)
}
if _, ok := app.GetDevice("shared"); ok {
t.Error("shared device should not exist (only TouchDevice was called for it)")
}
}
+92 -61
View File
@@ -35,12 +35,14 @@ func (app *WebApp) HandleWebSocket(w http.ResponseWriter, r *http.Request) {
app.WSMutex.Unlock()
// Send initial device list
devices := make(map[string]interface{})
for id, device := range app.Devices {
devices[id] = map[string]interface{}{
"info": device.DeviceInfo,
"status": device.Status,
"lastSeen": device.LastSeen,
snapshot := app.DeviceSnapshot()
devices := make(map[string]interface{}, len(snapshot))
for _, entry := range snapshot {
devices[entry.ID] = map[string]interface{}{
"info": entry.Device.DeviceInfo,
"status": entry.Device.Status(),
"lastSeen": entry.Device.LastSeen,
}
}
@@ -88,12 +90,13 @@ func (app *WebApp) HandleWebSocket(w http.ResponseWriter, r *http.Request) {
}
// Send periodic status updates
for id, device := range app.Devices {
if device.Status.IsConnected {
for _, entry := range app.DeviceSnapshot() {
status := entry.Device.Status()
if status.IsConnected {
statusMessage := webtypes.WebSocketMessage{
Type: "status_update",
DeviceID: id,
Data: device.Status,
DeviceID: entry.ID,
Data: status,
}
if err := conn.WriteJSON(statusMessage); err != nil {
@@ -134,25 +137,35 @@ func (app *WebApp) ConnectDeviceWebSocket(deviceID string, conn *webtypes.Device
wsClient := conn.Client.NewWebSocketClient(nil)
// Setup event handlers
// Setup event handlers. Each handler funnels its change through
// UpdateStatus so concurrent events and the periodic poller
// (UpdateDeviceStatus) cannot lose each other's writes.
wsClient.OnNowPlaying(func(event *models.NowPlayingUpdatedEvent) {
conn.Status.NowPlaying = &event.NowPlaying
conn.Status.LastActivity = time.Now()
conn.UpdateStatus(func(s *webtypes.DeviceStatus) {
s.NowPlaying = &event.NowPlaying
s.LastActivity = time.Now()
})
})
wsClient.OnVolumeUpdated(func(event *models.VolumeUpdatedEvent) {
conn.Status.Volume = &event.Volume
conn.Status.LastActivity = time.Now()
conn.UpdateStatus(func(s *webtypes.DeviceStatus) {
s.Volume = &event.Volume
s.LastActivity = time.Now()
})
})
wsClient.OnConnectionState(func(event *models.ConnectionStateUpdatedEvent) {
conn.Status.IsConnected = event.ConnectionState.IsConnected()
conn.Status.LastActivity = time.Now()
conn.UpdateStatus(func(s *webtypes.DeviceStatus) {
s.IsConnected = event.ConnectionState.IsConnected()
s.LastActivity = time.Now()
})
})
wsClient.OnPresetUpdated(func(event *models.PresetUpdatedEvent) {
conn.Status.Presets = &event.Presets
conn.Status.LastActivity = time.Now()
conn.UpdateStatus(func(s *webtypes.DeviceStatus) {
s.Presets = &event.Presets
s.LastActivity = time.Now()
})
})
// Connect WebSocket
@@ -162,64 +175,81 @@ func (app *WebApp) ConnectDeviceWebSocket(deviceID string, conn *webtypes.Device
}
conn.WebSocket = wsClient
conn.Status.IsConnected = true
conn.UpdateStatus(func(s *webtypes.DeviceStatus) {
s.IsConnected = true
})
log.Printf("WebSocket connected for device %s", deviceID)
// Wait for disconnection
wsClient.Wait()
conn.Status.IsConnected = false
conn.UpdateStatus(func(s *webtypes.DeviceStatus) {
s.IsConnected = false
})
log.Printf("WebSocket disconnected for device %s", deviceID)
}
// UpdateDeviceStatus fetches current status from device
// UpdateDeviceStatus fetches current status from the device.
//
// Network calls run outside the atomic merge so the CAS loop in
// UpdateStatus stays fast and doesn't retry slow IO. WebSocket event
// handlers running concurrently are not lost: their UpdateStatus
// runs against whichever snapshot they observe, and the merge below
// sees their changes when it CAS-loops onto the latest status.
func (app *WebApp) UpdateDeviceStatus(_ string, conn *webtypes.DeviceConnection) {
// Skip status update if client is not available (e.g., in tests)
if conn.Client == nil {
return
}
statusUpdated := false
// Phase 1: slow network fetches. Local vars only, no shared state
// is touched yet. Errors are recorded so the merge below can tell
// "field N stayed unchanged" apart from "field N got refreshed".
nowPlaying, nowPlayingErr := conn.Client.GetNowPlaying()
volume, volumeErr := conn.Client.GetVolume()
presets, presetsErr := conn.Client.GetPresets()
sources, sourcesErr := conn.Client.GetSources()
bass, bassErr := conn.Client.GetBass()
// Get current now playing
if nowPlaying, err := conn.Client.GetNowPlaying(); err == nil {
conn.Status.NowPlaying = nowPlaying
statusUpdated = true
}
// Phase 2: fast merge. Only fields we successfully fetched
// overwrite; everything else keeps the value other goroutines may
// have just written.
conn.UpdateStatus(func(s *webtypes.DeviceStatus) {
statusUpdated := false
// Get current volume
if volume, err := conn.Client.GetVolume(); err == nil {
conn.Status.Volume = volume
statusUpdated = true
}
if nowPlayingErr == nil {
s.NowPlaying = nowPlaying
statusUpdated = true
}
// Get presets
if presets, err := conn.Client.GetPresets(); err == nil {
conn.Status.Presets = presets
statusUpdated = true
}
if volumeErr == nil {
s.Volume = volume
statusUpdated = true
}
// Update last activity if any status was updated
if statusUpdated {
conn.Status.LastActivity = time.Now()
}
// Get sources
if sources, err := conn.Client.GetSources(); err == nil {
conn.Status.Sources = sources
statusUpdated = true
}
if presetsErr == nil {
s.Presets = presets
statusUpdated = true
}
// Get bass (if available)
if bass, err := conn.Client.GetBass(); err == nil {
conn.Status.Bass = bass
statusUpdated = true
}
if sourcesErr == nil {
s.Sources = sources
statusUpdated = true
}
// Mark as connected if we successfully got at least one status
conn.Status.IsConnected = statusUpdated
conn.Status.LastActivity = time.Now()
if bassErr == nil {
s.Bass = bass
statusUpdated = true
}
// Mark as connected if we successfully got at least one
// status from this round. Mirrors prior behaviour.
s.IsConnected = statusUpdated
s.LastActivity = time.Now()
})
}
// HandleDeviceWebSocket handles individual device WebSocket connections for real-time device-specific updates
@@ -230,7 +260,7 @@ func (app *WebApp) HandleDeviceWebSocket(w http.ResponseWriter, r *http.Request)
return
}
device, exists := app.Devices[deviceID]
device, exists := app.GetDevice(deviceID)
if !exists {
http.Error(w, "Device not found", http.StatusNotFound)
return
@@ -251,7 +281,7 @@ func (app *WebApp) HandleDeviceWebSocket(w http.ResponseWriter, r *http.Request)
DeviceID: deviceID,
Data: map[string]interface{}{
"info": device.DeviceInfo,
"status": device.Status,
"status": device.Status(),
},
}
@@ -293,12 +323,13 @@ func (app *WebApp) HandleDeviceWebSocket(w http.ResponseWriter, r *http.Request)
}
// Send device status update
status := device.Status()
statusMessage := webtypes.WebSocketMessage{
Type: "device_status",
DeviceID: deviceID,
Data: map[string]interface{}{
"info": device.DeviceInfo,
"status": device.Status,
"status": status,
},
}
@@ -309,13 +340,13 @@ func (app *WebApp) HandleDeviceWebSocket(w http.ResponseWriter, r *http.Request)
// If device has active WebSocket connection to SoundTouch device,
// also send any real-time updates from that connection
if device.WebSocket != nil && device.Status.IsConnected {
if device.WebSocket != nil && status.IsConnected {
realtimeMessage := webtypes.WebSocketMessage{
Type: "device_realtime",
DeviceID: deviceID,
Data: map[string]interface{}{
"nowPlaying": device.Status.NowPlaying,
"volume": device.Status.Volume,
"nowPlaying": status.NowPlaying,
"volume": status.Volume,
"timestamp": time.Now(),
},
}
+53 -46
View File
@@ -46,6 +46,11 @@ func main() {
Usage: "Network interface name (e.g. eth0) for mDNS and UPnP device discovery. Defaults to the --bind interface name when one was given; leave empty otherwise to auto-pick",
EnvVars: []string{"DISCOVERY_INTERFACE"},
},
&cli.StringSliceFlag{
Name: "devices",
Usage: "SoundTouch device IP address(es) to add manually (can be specified multiple times)",
EnvVars: []string{"SOUNDTOUCH_DEVICES"},
},
},
Action: func(c *cli.Context) error {
port := c.String("port")
@@ -61,6 +66,7 @@ func main() {
}
rawIface := c.String("interface")
manualHosts := c.StringSlice("devices")
ifaceName := defaultDiscoveryInterface(rawIface, rawBind, bindAddr)
if rawIface == "" && ifaceName != "" {
@@ -97,11 +103,15 @@ func main() {
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
webApp.BroadcastDiscoveryStatus("starting", len(webApp.Devices))
webApp.BroadcastDiscoveryStatus("starting", webApp.DeviceCount())
for _, host := range manualHosts {
addDevice(webApp, host, 8090, "manual")
}
discoverDevices(ctx, webApp, discoveryService)
webApp.BroadcastDiscoveryStatus("completed", len(webApp.Devices))
webApp.BroadcastDiscoveryStatus("completed", webApp.DeviceCount())
webApp.BroadcastDeviceList()
}()
@@ -200,6 +210,43 @@ func resolveBindAddr(bindAddr string) (string, error) {
}
}
// addDevice registers a SoundTouch device with the WebApp by fetching
// its /info and creating a DeviceConnection. The source label
// ("manual" or "discovered") appears in log lines so the operator can
// tell apart entries that came from --devices from those found via
// mDNS/UPnP. If the host is already known, the existing entry's
// LastSeen is bumped and the function returns without re-fetching.
func addDevice(app *handlers.WebApp, host string, port int, source string) {
// Fast path: skip the network call if we already know this host.
if app.TouchDevice(host) {
return
}
c := client.NewClient(&client.Config{
Host: host,
Port: port,
Timeout: 10 * time.Second,
})
info, err := c.GetDeviceInfo()
if err != nil {
log.Printf("Failed to fetch device info from %s (%s): %v", host, source, err)
return
}
conn := webtypes.NewDeviceConnection(c, info)
if !app.AddDevice(host, conn) {
// Lost a race — another goroutine inserted the same host
// between TouchDevice and AddDevice. AddDevice bumped LastSeen
// on the existing entry; discard our conn.
return
}
go app.UpdateDeviceStatus(host, conn)
log.Printf("Added %s device %s (%s) at %s:%d", source, info.Name, info.Type, host, port)
}
func setupRoutes(app *handlers.WebApp, discoveryService *discovery.UnifiedDiscoveryService) *chi.Mux {
r := chi.NewRouter()
@@ -230,12 +277,12 @@ func setupRoutes(app *handlers.WebApp, discoveryService *discovery.UnifiedDiscov
defer cancel()
// Broadcast discovery start
app.BroadcastDiscoveryStatus("starting", len(app.Devices))
app.BroadcastDiscoveryStatus("starting", app.DeviceCount())
discoverDevices(ctx, app, discoveryService)
// Broadcast discovery completion and updated device list
app.BroadcastDiscoveryStatus("completed", len(app.Devices))
app.BroadcastDiscoveryStatus("completed", app.DeviceCount())
app.BroadcastDeviceList()
}()
})
@@ -271,7 +318,7 @@ func discoverDevices(ctx context.Context, app *handlers.WebApp, discoveryService
devices, err := discoveryService.DiscoverDevices(ctx)
if err != nil {
log.Printf("Discovery failed: %v", err)
app.BroadcastDiscoveryStatus("failed", len(app.Devices))
app.BroadcastDiscoveryStatus("failed", app.DeviceCount())
return
}
@@ -279,46 +326,6 @@ func discoverDevices(ctx context.Context, app *handlers.WebApp, discoveryService
log.Printf("Found %d devices", len(devices))
for _, device := range devices {
deviceID := device.Host // Use host as unique ID for now
// Skip if we already have this device
if _, exists := app.Devices[deviceID]; exists {
app.Devices[deviceID].LastSeen = time.Now()
continue
}
// Create new device connection
clientConfig := &client.Config{
Host: device.Host,
Port: device.Port,
Timeout: 10 * time.Second,
}
soundTouchClient := client.NewClient(clientConfig)
// Get device info
deviceInfo, err := soundTouchClient.GetDeviceInfo()
if err != nil {
log.Printf("Failed to get device info for %s: %v", device.Host, err)
continue
}
// Create device connection
conn := &webtypes.DeviceConnection{
Client: soundTouchClient,
DeviceInfo: deviceInfo,
LastSeen: time.Now(),
Status: webtypes.DeviceStatus{
IsConnected: false,
LastActivity: time.Now(),
},
}
// Initial status fetch asynchronously to avoid blocking discovery
go app.UpdateDeviceStatus(deviceID, conn)
app.Devices[deviceID] = conn
log.Printf("Added device: %s (%s) at %s", deviceInfo.Name, deviceInfo.Type, device.Host)
addDevice(app, device.Host, device.Port, "discovered")
}
}
+3 -8
View File
@@ -7,7 +7,6 @@ import (
"net/http/httptest"
"strings"
"testing"
"time"
"github.com/gesellix/bose-soundtouch/cmd/soundtouch-web/handlers"
"github.com/gesellix/bose-soundtouch/cmd/soundtouch-web/webtypes"
@@ -250,13 +249,9 @@ func TestControlAPIValidation(t *testing.T) {
}
// Add a mock device for testing unknown action validation
mockDevice := &webtypes.DeviceConnection{
Client: nil,
DeviceInfo: &models.DeviceInfo{Name: "Test Device"},
LastSeen: time.Now(),
Status: webtypes.DeviceStatus{IsConnected: true},
}
app.Devices["testdevice"] = mockDevice
mockDevice := webtypes.NewDeviceConnection(nil, &models.DeviceInfo{Name: "Test Device"})
mockDevice.SetStatus(&webtypes.DeviceStatus{IsConnected: true})
app.AddDevice("testdevice", mockDevice)
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
+197
View File
@@ -0,0 +1,197 @@
// Package webtypes tests for the atomic Status API on DeviceConnection
// (Status, SetStatus, UpdateStatus, NewDeviceConnection).
package webtypes
import (
"fmt"
"sync"
"testing"
"github.com/gesellix/bose-soundtouch/pkg/models"
)
func TestNewDeviceConnection_InitialStatus(t *testing.T) {
conn := NewDeviceConnection(nil, &models.DeviceInfo{Name: "test"})
status := conn.Status()
if status == nil {
t.Fatal("Status() returned nil from a NewDeviceConnection")
}
if status.IsConnected {
t.Error("IsConnected should default to false")
}
if status.LastActivity.IsZero() {
t.Error("LastActivity should be initialised, got zero time")
}
}
func TestSetStatus_ReplacesEntireStatus(t *testing.T) {
conn := NewDeviceConnection(nil, &models.DeviceInfo{Name: "test"})
conn.SetStatus(&DeviceStatus{
Volume: &models.Volume{ActualVolume: 42},
IsConnected: true,
})
got := conn.Status()
if got.Volume == nil || got.Volume.ActualVolume != 42 {
t.Errorf("Volume not stored: got %+v", got.Volume)
}
// Setting a sparser status should wipe previously-set fields.
conn.SetStatus(&DeviceStatus{IsConnected: false})
got = conn.Status()
if got.Volume != nil {
t.Error("SetStatus did not wipe previously-set Volume")
}
if got.IsConnected {
t.Error("SetStatus did not wipe IsConnected")
}
}
func TestUpdateStatus_AppliesMutator(t *testing.T) {
conn := NewDeviceConnection(nil, &models.DeviceInfo{Name: "test"})
conn.UpdateStatus(func(s *DeviceStatus) {
s.IsConnected = true
s.Volume = &models.Volume{ActualVolume: 30}
})
got := conn.Status()
if !got.IsConnected {
t.Error("UpdateStatus did not set IsConnected")
}
if got.Volume == nil || got.Volume.ActualVolume != 30 {
t.Errorf("UpdateStatus did not set Volume: %+v", got.Volume)
}
}
func TestUpdateStatus_PreservesUnchangedFields(t *testing.T) {
conn := NewDeviceConnection(nil, &models.DeviceInfo{Name: "test"})
conn.SetStatus(&DeviceStatus{
Volume: &models.Volume{ActualVolume: 10},
Bass: &models.Bass{ActualBass: 3},
IsConnected: true,
})
// Only touch Volume; Bass and IsConnected must survive.
conn.UpdateStatus(func(s *DeviceStatus) {
s.Volume = &models.Volume{ActualVolume: 99}
})
got := conn.Status()
if got.Volume.ActualVolume != 99 {
t.Errorf("Volume = %d, want 99", got.Volume.ActualVolume)
}
if got.Bass == nil || got.Bass.ActualBass != 3 {
t.Errorf("Bass not preserved: %+v", got.Bass)
}
if !got.IsConnected {
t.Error("IsConnected not preserved")
}
}
func TestStatusSnapshotIsolation(t *testing.T) {
// A snapshot returned by Status() must NOT change when a later
// UpdateStatus replaces a pointer field. This proves the atomic
// store gives readers a stable view (so long as the writer
// follows the docstring contract of replacing nested pointers).
conn := NewDeviceConnection(nil, &models.DeviceInfo{Name: "test"})
conn.SetStatus(&DeviceStatus{Volume: &models.Volume{ActualVolume: 1}})
first := conn.Status()
conn.UpdateStatus(func(s *DeviceStatus) {
s.Volume = &models.Volume{ActualVolume: 2}
})
if first.Volume.ActualVolume != 1 {
t.Errorf("Snapshot mutated after later UpdateStatus: got %d, want 1",
first.Volume.ActualVolume)
}
if conn.Status().Volume.ActualVolume != 2 {
t.Errorf("Current status not updated: got %d, want 2",
conn.Status().Volume.ActualVolume)
}
}
// TestStatusConcurrent runs many UpdateStatus writers alongside many
// Status() readers. Before atomic.Pointer[DeviceStatus] this pattern
// would be flagged by the race detector (writers mutate
// conn.Status.X while readers copy conn.Status). With the atomic
// pointer it must run clean under `go test -race`.
func TestStatusConcurrent(t *testing.T) {
conn := NewDeviceConnection(nil, &models.DeviceInfo{Name: "concurrent"})
const writers = 16
const readersPerKind = 16
const opsPerGoroutine = 200
var wg sync.WaitGroup
wg.Add(writers + 2*readersPerKind)
// Writers: each goroutine replaces NowPlaying with a fresh struct
// carrying its worker id. Replacement (not in-place mutation)
// is what the UpdateStatus contract requires for nested
// pointers.
for w := 0; w < writers; w++ {
go func(worker int) {
defer wg.Done()
for i := 0; i < opsPerGoroutine; i++ {
conn.UpdateStatus(func(s *DeviceStatus) {
s.NowPlaying = &models.NowPlaying{
Track: fmt.Sprintf("w%d-%d", worker, i),
}
s.IsConnected = true
})
}
}(w)
}
// Readers via Status() — full snapshot.
for r := 0; r < readersPerKind; r++ {
go func() {
defer wg.Done()
for i := 0; i < opsPerGoroutine; i++ {
_ = conn.Status()
}
}()
}
// Readers that deref a single field. Tests the common
// "device.Status().IsConnected" pattern.
for r := 0; r < readersPerKind; r++ {
go func() {
defer wg.Done()
for i := 0; i < opsPerGoroutine; i++ {
_ = conn.Status().IsConnected
}
}()
}
wg.Wait()
// After all writers finish, IsConnected should be true (every
// writer sets it). The exact NowPlaying value is whichever
// writer landed last, but it must be a valid non-nil pointer.
final := conn.Status()
if !final.IsConnected {
t.Error("IsConnected should be true after writers ran")
}
if final.NowPlaying == nil {
t.Error("NowPlaying should be non-nil after writers ran")
}
}
+69 -2
View File
@@ -2,6 +2,7 @@
package webtypes
import (
"sync/atomic"
"time"
"github.com/gesellix/bose-soundtouch/pkg/client"
@@ -29,13 +30,21 @@ type SoundTouchClient interface {
NewWebSocketClient(config interface{}) *client.WebSocketClient
}
// DeviceConnection wraps a SoundTouch client with WebSocket connection
// DeviceConnection wraps a SoundTouch client with WebSocket connection.
//
// The Status field is stored behind atomic.Pointer so concurrent
// readers (HTTP handlers, WebSocket broadcasters) never observe a
// torn struct while a writer (UpdateDeviceStatus, WebSocket event
// handlers) is mid-update. Access status through Status / SetStatus
// / UpdateStatus rather than the private field; construct connections
// via NewDeviceConnection to guarantee the status is initialised.
type DeviceConnection struct {
Client *client.Client
WebSocket *client.WebSocketClient
DeviceInfo *models.DeviceInfo
LastSeen time.Time
Status DeviceStatus
status atomic.Pointer[DeviceStatus]
}
// DeviceStatus represents the current device state
@@ -49,6 +58,64 @@ type DeviceStatus struct {
LastActivity time.Time `json:"lastActivity"`
}
// NewDeviceConnection creates a fully-initialised connection. The
// status starts with IsConnected=false and LastActivity set to now;
// real values arrive via UpdateStatus once the device responds.
func NewDeviceConnection(c *client.Client, info *models.DeviceInfo) *DeviceConnection {
conn := &DeviceConnection{
Client: c,
DeviceInfo: info,
LastSeen: time.Now(),
}
conn.status.Store(&DeviceStatus{
IsConnected: false,
LastActivity: time.Now(),
})
return conn
}
// Status returns a snapshot of the current device status. The returned
// pointer is read-only from the caller's perspective; mutating the
// pointed-to struct has no effect on the stored status. Use
// UpdateStatus or SetStatus to apply changes. Never returns nil for
// connections built via NewDeviceConnection.
func (c *DeviceConnection) Status() *DeviceStatus {
return c.status.Load()
}
// SetStatus atomically replaces the entire status. Use sparingly —
// UpdateStatus is the preferred entry point because it preserves
// concurrent changes from other goroutines.
func (c *DeviceConnection) SetStatus(s *DeviceStatus) {
c.status.Store(s)
}
// UpdateStatus atomically applies mut to a copy of the current status
// and stores the result. If another goroutine updates the status while
// mut runs, UpdateStatus retries with the newer status — so concurrent
// writers cannot silently lose each other's changes.
//
// The copy mut receives is a shallow value copy of the previous status.
// Nested pointer fields (NowPlaying, Volume, Presets, Sources, Bass)
// share their backing struct with the previous version: callers MUST
// REPLACE these pointers (s.Volume = &models.Volume{...}) rather than
// mutate through them (s.Volume.ActualVolume++ would race with any
// reader still holding the previous snapshot). Production callers
// receive these values fresh from the device API, so this is the
// natural shape.
func (c *DeviceConnection) UpdateStatus(mut func(*DeviceStatus)) {
for {
old := c.status.Load()
next := *old
mut(&next)
if c.status.CompareAndSwap(old, &next) {
return
}
}
}
// APIResponse is a standard JSON response wrapper
type APIResponse struct {
Success bool `json:"success"`
+14 -15
View File
@@ -145,31 +145,30 @@ func TestDeviceConnection(t *testing.T) {
MuteEnabled: false,
}
conn := &DeviceConnection{
DeviceInfo: deviceInfo,
LastSeen: time.Now(),
Status: DeviceStatus{
NowPlaying: nowPlaying,
Volume: volume,
IsConnected: true,
LastActivity: time.Now(),
},
}
conn := NewDeviceConnection(nil, deviceInfo)
conn.SetStatus(&DeviceStatus{
NowPlaying: nowPlaying,
Volume: volume,
IsConnected: true,
LastActivity: time.Now(),
})
t.Run("device connection fields", func(t *testing.T) {
if conn.DeviceInfo.Name != "Test Speaker" {
t.Errorf("Expected device name 'Test Speaker', got '%s'", conn.DeviceInfo.Name)
}
if conn.Status.NowPlaying.Track != "Test Track" {
t.Errorf("Expected track 'Test Track', got '%s'", conn.Status.NowPlaying.Track)
status := conn.Status()
if status.NowPlaying.Track != "Test Track" {
t.Errorf("Expected track 'Test Track', got '%s'", status.NowPlaying.Track)
}
if conn.Status.Volume.ActualVolume != 50 {
t.Errorf("Expected volume 50, got %d", conn.Status.Volume.ActualVolume)
if status.Volume.ActualVolume != 50 {
t.Errorf("Expected volume 50, got %d", status.Volume.ActualVolume)
}
if !conn.Status.IsConnected {
if !status.IsConnected {
t.Error("Expected device to be connected")
}
})
+5 -3
View File
@@ -355,9 +355,11 @@ func handlePreset(event *models.PresetUpdatedEvent, verbose bool) {
for _, preset := range presets.Preset {
fmt.Printf(" 📻 Preset %d:", preset.ID)
if preset.ContentItem != nil {
fmt.Printf(" %s", preset.ContentItem.ItemName)
fmt.Printf(" (%s)", preset.ContentItem.Source)
// IsEmpty catches both <preset/> and INVALID_SOURCE
// placeholders; using the nil-safe helpers below means the
// inner Printf never dereferences a nil ContentItem.
if !preset.IsEmpty() {
fmt.Printf(" %s (%s)", preset.GetDisplayName(), preset.GetSource())
}
fmt.Println()
+24
View File
@@ -0,0 +1,24 @@
{%- comment -%}
Render Mermaid diagrams in docs pages.
Markdown ```mermaid fenced blocks are emitted by Kramdown as
<pre><code class="language-mermaid"></code></pre>, but Mermaid only
auto-renders elements with class="mermaid". This snippet rewrites the
pre/code nodes into div.mermaid before initialising the library.
Loaded as an ES module from the jsDelivr CDN so we don't have to vendor
the library into the repo. Pinned to a major version for cache stability.
{%- endcomment -%}
<script type="module">
import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
document.querySelectorAll('pre > code.language-mermaid').forEach((code) => {
const div = document.createElement('div');
div.className = 'mermaid';
div.textContent = code.textContent;
code.parentElement.replaceWith(div);
});
mermaid.initialize({ startOnLoad: false, securityLevel: 'strict' });
mermaid.run();
</script>
+11 -26
View File
@@ -1,5 +1,10 @@
# Spotify OAuth Integration
> **New here?** Start with [spotify-overview.md](spotify-overview.md) for the
> mental model (Spotify Connect vs OAuth-intercept, DNS rewrite gotcha,
> end-to-end token lifecycle). This document zooms in on the OAuth flows and
> management endpoints.
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
@@ -91,43 +96,23 @@ sequenceDiagram
Note over Speaker: Speaker now has Spotify access
```
## Boot Primer Script
## Priming Speakers
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.
> **Note:** The on-device boot-primer flow (installing `spotify-boot-primer.sh` onto the speaker's `/mnt/nv` and hooking it from `rc.local`) is **deprecated**. AfterTouch now uses a server-centric model: the service registers a `SPOTIFY` source in marge for the device's paired account and pushes credentials via ZeroConf from the server side, triggered on `power_on` and a manual "Prime" action. See [spotify-priming-strategy.md](spotify-priming-strategy.md) for the current model and rationale.
>
> The artifacts under `scripts/spotify/` are kept as historical reference for users who still rely on the on-device approach. There is no longer a `/mgmt/devices/{deviceId}/spotify/install-primer` endpoint.
## 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 |
| GET | `/mgmt/spotify/callback` | None | Browser OAuth callback (redirect from Spotify, returns HTML) |
| 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 |
| POST | `/mgmt/spotify/prime` | Basic | Manually trigger server-side priming of a discovered speaker |
## Security
+183
View File
@@ -0,0 +1,183 @@
# Spotify on SoundTouch — Overview
This is the entry point for understanding how Spotify works on a SoundTouch
speaker behind AfterTouch. Read this first; the deeper docs assume you already
have the mental model below.
> **Premium likely required.** As far as we know, Spotify Connect on
> SoundTouch only works with a Spotify Premium account — this matches our
> testing and matches what other SoundTouch-replacement projects report, but
> we have not exhaustively verified every account tier or region. None of the
> workarounds in this document change Spotify's account-tier requirements.
## Two completely separate Spotify paths
These are routinely confused. They share a speaker and a Spotify account, but
they ride on different infrastructure and fail for different reasons.
### 1. Spotify Connect (speaker-native, independent of AfterTouch)
- The speaker advertises itself on the LAN as a Spotify Connect endpoint
(mDNS service `_spotify-connect._tcp`).
- You open the Spotify app on your phone or desktop, tap the Connect device
picker, and select the SoundTouch.
- Audio streams directly from Spotify's CDN to the speaker. Token handling,
session setup, and playback all happen between Spotify and the speaker.
- **AfterTouch is not involved.** It still works even if AfterTouch is
offline.
This is the simplest path. If you only want to push playback from your phone,
you do not need to link Spotify to AfterTouch at all — see [Manual kick-start
alternative](#manual-kick-start-alternative) below.
### 2. OAuth-intercept path (managed by AfterTouch)
This is what enables features that originate **from the speaker**:
- Spotify presets on the speaker's buttons.
- Spotify playback from the Bose app's source picker.
- "Resume Spotify" after a power cycle without touching the Spotify app.
After Bose's cloud shutdown (May 2026), the speaker can no longer reach
Bose's OAuth server for Spotify token refresh. AfterTouch intercepts those
calls via DNS, brokers tokens with Spotify using your linked account, and
hands them back to the speaker.
The rest of this document describes that path.
## Setup at a glance
Full step-by-step is in
[docs/guides/MUSIC-SERVICES.md](../guides/MUSIC-SERVICES.md). Summary:
1. **Register a Spotify developer app** (one-time, by the AfterTouch operator).
2. **Configure AfterTouch** with the Client ID, Client Secret, and Redirect
URI in the Settings tab.
3. **Authorize your Spotify account** via the Local Account tab — completes
the OAuth flow and persists a long-lived refresh token to AfterTouch's
datastore.
4. **Prime each speaker** so its source list and ZeroConf state know about
Spotify.
After step 4, presets and Bose-app-initiated Spotify playback work.
## The DNS rewrite — easy to miss, breaks everything
Bose firmware does **not** read a separate OAuth server hostname from
configuration. It derives the OAuth host from the marge host by inserting
`oauth` into the first label:
| Purpose | Hostname |
|-----------------|---------------------------|
| Marge / sources | `streaming.bose.com` |
| OAuth refresh | `streamingoauth.bose.com` |
**Both hostnames must resolve to AfterTouch.** AfterTouch's DNS server hijacks
both, but if you bypass that DNS server (e.g. by hard-coding only the marge
hostname in `/etc/hosts`, or by routing only one through a custom resolver),
token refresh will silently die while the speaker still pulls sources.
Symptom: the speaker briefly streams Spotify after priming, then stops at the
first token refresh ~1 hour later.
If you self-host AfterTouch at e.g. `aftertouch.local`, you would equivalently
need `aftertouchoauth.local` for the OAuth interception path.
## End-to-end token lifecycle
What actually happens, from priming to steady-state playback:
1. **Operator links Spotify account.** OAuth flow stores
`{user_id, refresh_token, bose_secret}` in `spotify/accounts.json`. The
`bose_secret` is an opaque surrogate (e.g. `bs-deadbeef…`) that AfterTouch
issues; the speaker only ever sees this surrogate, never the real Spotify
refresh token.
2. **Priming runs.** Either on speaker `power_on`, on discovery, or on a
manual `POST /mgmt/spotify/prime`. AfterTouch:
- Resolves the speaker's currently-paired account via live `:8090/info`
(`margeAccountUUID`).
- Writes a `SPOTIFY` `ConfiguredSource` into marge under that account with
`secret = bose_secret`, `secretType = token_version_3`.
- POSTs `<updates><sourcesUpdated/></updates>` to the speaker's
`:8090/notification`, causing the speaker to re-fetch
`/streaming/account/{account}/full` and pick up the new source.
- Optionally pushes a fresh access token to the speaker's ZeroConf
endpoint (`:8200/zc?action=addUser`). This is best-effort — see
[ZeroConf clientId and benign 404s](#zeroconf-clientid-and-benign-404s).
3. **Speaker pulls sources.** It now has a SPOTIFY entry with the surrogate
as its credential. The speaker stores this; from its perspective the
surrogate is the refresh token.
4. **Speaker uses Spotify.** When it needs a fresh access token (every ~1 h
on Spotify's clock), it POSTs to
`streamingoauth.bose.com/oauth/device/{deviceID}/music/musicprovider/15/token/cs3`
with the surrogate.
5. **AfterTouch translates.** DNS hijack routes the request to AfterTouch,
which looks up the surrogate, performs the real refresh against Spotify
using the stored refresh token, and returns the resulting access token to
the speaker.
6. **Speaker uses the access token** for Spotify Web API metadata calls
(artwork, track lookups, playback container resolution).
Forensic details of the request shapes are in
[docs/reference/spotify-account-addition.md](../reference/spotify-account-addition.md).
The cryptographic specifics of the ZeroConf `addUser` blob are in
[spotify-priming-strategy.md](spotify-priming-strategy.md).
## ZeroConf clientId and benign 404s
`GET http://<speaker>:8200/zc?action=getInfo` returns, among other fields:
```json
"clientID": "79ebcb219e8e4e9a892e796607931810"
"tokenType": "accesstoken"
"activeUser": "<spotify-user-id-or-empty>"
```
That `clientID` is **Bose's official Spotify Connect partner client_id**,
baked into firmware. It is **not** the client_id of the developer app you
registered for AfterTouch — those are two unrelated OAuth apps, by design.
The Bose-baked one is what Spotify Connect uses when a Spotify mobile app
discovers the speaker on the LAN. The AfterTouch-registered one is what
brokers refresh tokens for the OAuth-intercept path. They never converge.
**Implication:** an access token AfterTouch obtained under its own client_id
is not directly usable as a Spotify Connect session token. Pushing it via
ZeroConf `addUser` is best-effort, and the speaker may respond with a `404`
and an empty body when its `activeUser` already matches the username being
pushed — that is the firmware's idiomatic "no transition required" signal,
not a failure. AfterTouch recognises this case (`zeroconf.ErrAddUserNoOp`)
and logs it as an expected no-op rather than an error.
A 404 **with a body**, or any other non-2xx, is treated as a real failure
and logged loudly with the response headers and body so it can be
diagnosed.
## Manual kick-start alternative
You can skip the OAuth setup entirely if you only want playback pushed from
the Spotify app:
1. Open the Spotify mobile/desktop app.
2. Start any track.
3. Open the Connect device picker, select the SoundTouch.
The speaker now holds an in-memory Spotify Connect session and can play
until next reboot. Presets and Bose-app-initiated Spotify playback will
still not work — those require the OAuth-intercept path — but Spotify-app-
initiated playback does.
## Troubleshooting quick reference
| Symptom | Most likely cause |
|----------------------------------------------------|------------------------------------------------------------------------------------------------|
| Preset stores then fails: "invalid SourceID" | No `SPOTIFY` source in marge for the speaker's paired account. Re-run priming. |
| Preset stores fine; playback dies after ~1 hour | `streamingoauth.bose.com` not pointed at AfterTouch (DNS rewrite gap). |
| Speaker has source but `Sources.xml` looks stale | `<sourcesUpdated/>` notification did not reach the speaker. Re-run priming or POST it by hand. |
| ZeroConf `addUser` returns 404, empty body | Benign no-op; speaker already has `activeUser` set. Marge path is authoritative. |
| Spotify Connect device picker doesn't show speaker | Unrelated to AfterTouch; check the speaker's mDNS visibility on the LAN. |
## Where to go next
- **Setup walkthrough:** [docs/guides/MUSIC-SERVICES.md](../guides/MUSIC-SERVICES.md)
- **OAuth flow details (browser + mobile + endpoint table):** [spotify-oauth.md](spotify-oauth.md)
- **Priming strategy, ZeroConf DH protocol, deployment topologies:** [spotify-priming-strategy.md](spotify-priming-strategy.md)
- **Forensic request/response analysis from the Stockholm app:** [docs/reference/spotify-account-addition.md](../reference/spotify-account-addition.md)
@@ -1,5 +1,9 @@
# Spotify Priming Strategy
> **New here?** Start with [spotify-overview.md](spotify-overview.md) for the
> mental model. This document goes deep on the priming protocol, ZeroConf DH
> exchange, and deployment topologies.
This document outlines the strategy for ensuring Bose SoundTouch devices are correctly "primed" for Spotify Connect integration within the AfterTouch ecosystem.
## Overview
+1
View File
@@ -86,6 +86,7 @@ A factory reset wipes Wi-Fi credentials, account pairing, and all presets, retur
| SoundTouch 10 | Power on; hold **Preset 1** + **Volume ** for 10 s | Wi-Fi indicator glows solid amber |
| SoundTouch 20 | Power on; hold **Preset 1** + **Volume ** for 10 s | Lights blink L→R, then solid amber |
| SoundTouch 20 Series III | Hold **Preset 1** + **Preset 6** simultaneously for ~10 s | White LED sweep |
| SoundTouch 30 | Power on; hold **Preset 1** + **Volume ** for 10 s (display counts down 101) | Display shows "Hold to restore factory settings", then restarts |
| SoundTouch 30 Series III | Hold **Preset 1** + **Preset 6** simultaneously for ~10 s | White LED sweep |
| SoundTouch 300 | Hold **Volume ** until light bar blinks rapidly (~15 s) | Rapid blink → off → on |
| SoundTouch 10 (alt) | Press and hold the back recessed **Reset** pinhole for 10 s | Status LED restarts |
+76
View File
@@ -206,6 +206,82 @@ Each speaker is migrated independently. You can run multiple migrations in paral
---
## Alternative: CLI-driven factory-reset workflow
If you prefer scripting the migration, or the wizard isn't an option (headless server, automation, batch onboarding of many speakers), `soundtouch-cli` exposes the same building blocks. The flow below is **not** an in-place migration — it factory-resets the speaker and brings it up fresh against AfterTouch, so any data Bose preserved on the device is wiped. Use this when:
- You're starting from a factory-reset speaker anyway.
- The wizard's in-place migration didn't take and you want a clean slate.
- You're scripting setup for many speakers and want a reproducible recipe.
### Prerequisites
- AfterTouch service running and reachable at a stable URL (e.g., `https://soundtouch.local` from your `.env`).
- The speaker reachable on its current IP (passed as `--host`).
- For the AP-mode handover step, your laptop must be able to join the speaker's `Bose SoundTouch` Wi-Fi (you'll switch between home Wi-Fi and the speaker's AP).
### The full sequence
```bash
# 1. Plan what the reset+pair pipeline will write (dry run, no changes yet).
soundtouch-cli --host 192.168.1.50 setup plan \
--reset=true --include-pair=false \
--service-url='https://soundtouch.local'
# 2. Trigger the factory reset. The speaker reboots into AP mode.
soundtouch-cli --host 192.168.1.50 setup factory-reset
# --- Manual step: join the speaker's Wi-Fi AP (SSID "Bose SoundTouch ...") ---
# 3. Wait for the AP-mode endpoint to answer.
soundtouch-cli setup wait-ap
# 4. Push your home Wi-Fi credentials to the speaker.
# Run twice if the first attempt's ACK races the AP teardown — the second
# one is a no-op if the first succeeded.
soundtouch-cli setup wifi-push --ssid="YourHomeSSID" --pass='your-wifi-password'
# --- Manual step: switch your laptop back to the home Wi-Fi network ---
# 5. Wait for the speaker to come back online on the home network.
# --match takes the last 4-6 hex chars of the speaker's MAC (visible on
# the bottom of the device).
soundtouch-cli setup wait-online --match=42CAFE
# 6. Pair the speaker with an AfterTouch account.
# --mode=full runs the canonical WebSocket SETUP sequence (matches the
# Bose app's flow); --account is the 7-digit account ID AfterTouch
# should attach the speaker to.
soundtouch-cli --host 192.168.1.50 setup pair \
--mode=full --account=1111111 \
--service-url='https://soundtouch.local'
```
### Verifying the result
After pairing completes:
- The speaker should appear on the **Devices** tab in the web UI.
- AUX should switch and play audio when selected.
- Pressing presets should fetch their content from AfterTouch (the `[LOG]` rows on the service confirm).
- TuneIn search and playback should work end-to-end.
If any of these fail post-pair, see [Troubleshooting](TROUBLESHOOTING.md) — most commonly the speaker just needs a power cycle to pick up everything cleanly.
### Differences vs the wizard
| Aspect | Wizard (in-place migration) | CLI factory-reset workflow |
|-------------------------------------|---------------------------------------------------------|---------------------------------------------------------|
| Preserves speaker's existing state | yes (Presets, recents, attached account) | **no** — wipes everything |
| Requires Wi-Fi-network switching | no | yes (laptop joins speaker AP, then home network) |
| Scriptable / reproducible | clickable, not scriptable | full bash recipe |
| Cloud-side data (Bose Marge backup) | preserved if Sync ran while cloud was alive | not relevant — fresh account on AfterTouch |
| Best for | "I want this speaker to keep working with what's on it" | "I want a clean, reproducible setup against AfterTouch" |
The wizard is still the recommended path for a one-off migration of an existing setup. The CLI workflow is the right choice when you're scripting, batching, or already starting from a reset.
---
## Rollback
If you need to undo a migration:
+6
View File
@@ -2,6 +2,12 @@
This guide explains how to link your Spotify or Amazon Music account to AfterTouch so your speakers can stream music from those services.
> For Spotify, a higher-level mental model of how the integration works —
> Spotify Connect vs. AfterTouch's OAuth-intercept path, the
> `streamingoauth.bose.com` DNS gotcha, and the token lifecycle — is in
> [docs/concepts/spotify-overview.md](../concepts/spotify-overview.md).
> Read that if priming or playback isn't behaving as you'd expect.
---
## How it works
+129
View File
@@ -105,6 +105,54 @@ iperf3 -c 192.168.1.1 # If iperf server available
## 🌐 **Connection Issues**
### ❌ Every cloud source shows `status="UNAVAILABLE"` / can't stream anything
**Symptoms:**
- The speaker's `/sources` (or the soundtouch-cli `source availability` output) lists every cloud-backed source — Spotify, TuneIn, Internet Radio, AirPlay, Amazon, Alexa — as `status="UNAVAILABLE"`.
- Often only AUX shows `status="READY"`.
- The speaker can be reached on the LAN (`:8090/info` works) but no Internet streaming source can be selected.
This is a different failure mode from the [`Curl 7` case below](#-speaker-logs-curl-7-http-0-and-aftertouch-sees-no-http-requests): the speaker can reach AfterTouch but doesn't have the account state to authenticate any cloud surface, so every cloud handler 401s itself out.
**Three-step diagnostic checklist** (in order — the cause is almost always one of these):
#### 1. Is `:443` reachable on AfterTouch?
The AfterTouch Settings tab now ships a preflight that flips ✅ / ❌ for whether the speaker can open a TLS handshake to AfterTouch's HTTPS listener. If `:443` is ❌, follow the steps in [HTTPS-SETUP.md → Binding to port 443](HTTPS-SETUP.md#binding-to-port-443).
A failing preflight at this layer typically presents as `Curl 7, http 0` in the speaker's syslog (see the [`Curl 7` entry below](#-speaker-logs-curl-7-http-0-and-aftertouch-sees-no-http-requests) for the focused walkthrough).
#### 2. Does the speaker have a `margeAccountUUID`?
```bash
curl -s http://<speaker-ip>:8090/info | xmllint --xpath '/info/margeAccountUUID/text()' -
```
If the element is empty (or you get no output), the speaker has no account token — every cloud surface that requires authentication will 401 itself out. The Migration tab in AfterTouch detects this and renders:
> **Current: ❌ Not paired (factory-reset or never paired) — set an ID to pair as part of Apply**
The Devices list also shows a `⚠ Not paired — re-pair` badge. To resolve, **open the Migration tab**, pick a previous account ID from the dropdown (or click **Generate**), and click **Apply** — same flow as the [factory-reset recovery](#-presets-flash-then-revert-to-select-a-preset-after-a-factory-reset) section below.
#### 3. What does `logread` say while you trigger a failing source?
SSH into the speaker (see [DEVICE-LOGGING.md](../DEVICE-LOGGING.md#1-accessing-system-logs-requires-root)) and capture:
```bash
logread -f | grep -v '127.0.0.1:'
```
…while you select a failing source in the SoundTouch app or via `soundtouch-cli`. The lines around the failed attempt usually name the failing host + protocol — TLS handshake error, token fetch 401, missing route, etc. — and that's enough to file an actionable issue.
**Common outcomes:**
- ❌ `:443` → fix HTTPS routing, sources transition to READY on the next refresh.
- ❌ `margeAccountUUID` empty → run Migration → Apply, sources reappear after `<sourcesUpdated/>` triggers a `/sources` re-sync.
- Everything looks right but sources still UNAVAILABLE → the `logread` snippet is the next signal; open an issue with it attached.
> **Note on the firmware-internal placeholder sources.** The `<sourceItem source="SPOTIFY" sourceAccount="SpotifyConnectUserName" ...>`, `SpotifyAlexaUserName`, `UPNP/UPnPUserName`, `STORED_MUSIC_MEDIA_RENDERER/StoredMusicUserName`, and `QPLAY/QPlay{1,2}UserName` entries that appear in `/sources` even on a broken or unpaired speaker are *firmware-synthesized*. They show up regardless of AfterTouch's source list — their `status="UNAVAILABLE"` does not indicate an AfterTouch problem. Use the three checks above to diagnose the actual cause.
### ❌ Speaker logs `Curl 7, http 0` and AfterTouch sees no HTTP requests
**Symptoms:**
@@ -335,6 +383,87 @@ client.SelectAux()
---
## 🎶 **Music Service & Preset Issues**
### ❌ Spotify preset fails with "Current content cannot be saved as preset"
**Symptoms:**
You push playback to the speaker via Spotify Connect from the Spotify mobile/desktop app. Audio plays fine. You try to store it as a preset and the CLI reports:
```
$ soundtouch-cli preset store-current --slot 2
Storing current content as preset 2 from 192.168.x.y:8090...
✗ Current content cannot be saved as preset
Content: <track name>
Source: SPOTIFY
2026/05/16 09:13:10 current content cannot be preset
```
…and `soundtouch-cli play now` shows `Source Account: SpotifyConnectUserName`.
**Cause:**
The speaker firmware marks Spotify-Connect-pushed content as **non-presetable** at the NowPlaying layer:
```xml
<ContentItem source="SPOTIFY" type="DO_NOT_RESUME" ...
sourceAccount="SpotifyConnectUserName" isPresetable="false">
```
That `isPresetable="false"` means the firmware can't independently re-fetch the stream later — it only knows about the session token your phone pushed via the Spotify Connect protocol, which is ephemeral. The speaker refuses the preset *locally*, before any storePreset request reaches AfterTouch's marge.
**Why an OAuth-linked Spotify account changes the answer:**
When AfterTouch has a Spotify OAuth account linked (see [MUSIC-SERVICES.md](MUSIC-SERVICES.md)), the speaker has a *persistent* Spotify source it can use to resolve the content URI later — typically an album/playlist container. With that source available, the firmware rewrites the content item from `DO_NOT_RESUME` to `tracklisturl` at save time, flips `isPresetable` to `true`, and the preset goes through. The recall path then routes through AfterTouch's `/oauth/.../cs3` token broker, which returns a Spotify access token for your linked account.
**Fix:**
1. Set up Spotify OAuth in AfterTouch following [MUSIC-SERVICES.md](MUSIC-SERVICES.md). The high-level model (Spotify Connect vs the OAuth-intercept path, the `streamingoauth.bose.com` DNS rewrite, the token lifecycle) is in [spotify-overview.md](../concepts/spotify-overview.md).
2. Make sure you're on **v0.84.0 or later** — earlier versions had a custom-OAuth-client bug that caused playback to hang at "Buffering".
3. Re-prime the speaker (Migration tab → **Prime Spotify**, or wait for the watchdog), then retry the preset save with Connect-pushed playback.
**What this won't fix:**
A Connect-only setup with no OAuth account linked in AfterTouch — that's a firmware-level constraint we can't route around from the server side. The speaker simply doesn't have credentials it can use to replay the content later, so it refuses to preset.
### ❌ TuneIn (or Internet Radio) missing from `/sources` after a factory reset
**Symptoms:**
- The speaker is happily migrated and reachable; most cloud sources work.
- `curl http://<speaker-ip>:8090/sources` lists AUX, Bluetooth, Spotify Connect placeholders, etc. — but **no `TUNEIN` entry**.
- `soundtouch-cli source content --source TUNEIN --type stationurl --location /v1/playback/station/<id> --name '<name>'` fails with `1005` (or playing a TuneIn preset silently does nothing).
- Other devices on the same setup have `TUNEIN` in `/sources` and work fine.
**Cause:**
TuneIn is **not a default source** on a freshly factory-reset SoundTouch. The speaker only adds `TUNEIN` to its `Sources.xml` after the source has been played at least once. Until then, source-selection requests for `TUNEIN` are rejected as invalid.
This is firmware behaviour — independent of AfterTouch — and is why one device can have `TUNEIN` and a sibling device (just reset) can be missing it. The same applies to `LOCAL_INTERNET_RADIO` if the speaker was reset before any LIR content was played.
**Fix:**
Play any TuneIn station once to register the source. Two equivalent paths:
1. **Via the SoundTouch app** — open the app, pick TuneIn, play any station. The source appears in `/sources` after a few seconds.
2. **Via `soundtouch-cli`** on a device that *does* still have TuneIn registered, or by first registering it with a known-working station:
```bash
soundtouch-cli --host <speaker-ip> source content \
--source TUNEIN --type stationurl \
--location /v1/playback/station/s166521 \
--name 'SMOOTH JAZZ'
```
(Station `s166521` is one that works for AfterTouch testing; any valid TuneIn station ID works.)
Once the source plays once, it gets persisted to `/mnt/nv/BoseApp-Persistence/1/Sources.xml` and subsequent TuneIn requests succeed without needing the app.
**For speakers without SSH:**
If `soundtouch-cli source content --source TUNEIN ...` returns `1005` on a reset device that has never had TuneIn, the speaker is refusing because the source isn't registered yet — chicken-and-egg. The SoundTouch app is then the only practical path to register it; we can't write `Sources.xml` directly over telnet on most models.
## 🔊 **Volume & Audio Issues**
### ❌ "Volume control not working"
+43 -1
View File
@@ -1,6 +1,6 @@
# soundtouch-web: remaining features
Three features complete the parity gap between soundtouch-web and the Stockholm
Four features complete the parity gap between soundtouch-web and the Stockholm
app's local-control functionality. Everything else in Stockholm (OAuth flows,
setup wizard, service account linking, onboarding, analytics) is cloud
infrastructure that is either shut down or already handled by soundtouch-service.
@@ -86,6 +86,48 @@ rename and network/firmware info.
---
## 4. Render stereo pairs as a single device
Today soundtouch-web shows the two halves of a stereo pair (formed via
`/addGroup` — see issue #252) as independent entries in the device list. The
Bose app collapsed a paired ST10 set into one "L+R" entry; restoring that
presentation closes the perception gap BirdyBA flagged at
<https://github.com/gesellix/Bose-SoundTouch/issues/252#issuecomment-4458140305>.
**Device API:**
- `GET /getGroup` on each speaker — returns the current `<group>` with
`<masterDeviceId>` + `<roles>` (each `<groupRole>` carries the speaker's
deviceId, role `LEFT|RIGHT`, and ipAddress)
- Empty `<group/>` means the speaker is standalone
- Querying the master and slave returns the same `<group>` payload, so either
side is sufficient to detect the pair
**Backend:**
- During device-list assembly, call `GET /getGroup` for each discovered device
in parallel (matches the propagation pattern already used by
`soundtouch-cli group create` in `cmd/soundtouch-cli/cmd_group.go`)
- Bucket devices by `<masterDeviceId>` — each bucket emits one entry in the
list response. Standalone devices stay as their own bucket-of-one
- Expose pair metadata on the list entry so the UI can render role chips
(`L`/`R`) and resolve role → physical device for actions
**Frontend:**
- Device list collapses paired devices into one card titled with both names
(e.g. `"Wohnzimmer L+R"`) and role chips
- Clicking the card opens a device-detail page that exposes both per-role
status and a "Dissolve pair" action (DELETE flow, already wired in
`soundtouch-cli group remove` and in fakespeaker's `/removeGroup` GET)
- Standalone speakers continue to render as today
**Note:** Pair lifecycle (create / rename / remove) already works
end-to-end — `pkg/client` group endpoints + `cmd/soundtouch-cli/cmd_group.go`,
covered by tests in `cmd/soundtouch-cli/cmd_group_test.go` and exercisable
against the fake speaker's group routes
(`pkg/service/testing/fakespeaker/fakespeaker.go`). This task is purely about
presentation in soundtouch-web's device list — no protocol work required.
---
## Decide later
| Feature | Reason |
+22 -6
View File
@@ -96,22 +96,38 @@ func showCurrentPresets(c *client.Client) error {
return err
}
if len(presets.Preset) == 0 {
// Filter out placeholder presets (issue #308): self-closing
// <preset/> entries from a factory-reset device and
// INVALID_SOURCE placeholders from healthy devices both panic if
// their fields are dereferenced directly.
configured := make([]models.Preset, 0, len(presets.Preset))
for _, p := range presets.Preset {
if !p.IsEmpty() {
configured = append(configured, p)
}
}
if len(configured) == 0 {
fmt.Println(" 📭 No presets configured")
return nil
}
fmt.Printf(" 📻 Found %d configured presets:\n", len(presets.Preset))
for _, preset := range presets.Preset {
fmt.Printf(" 📻 Found %d configured presets:\n", len(configured))
for _, preset := range configured {
fmt.Printf(" %d. %s\n", preset.ID, preset.GetDisplayName())
fmt.Printf(" Source: %s\n", preset.ContentItem.Source)
if preset.ContentItem.Location != "" {
fmt.Printf(" Location: %s\n", preset.ContentItem.Location)
fmt.Printf(" Source: %s\n", preset.GetSource())
if location := preset.GetLocation(); location != "" {
fmt.Printf(" Location: %s\n", location)
}
if preset.CreatedOn != nil && *preset.CreatedOn != 0 {
createdTime := time.Unix(*preset.CreatedOn, 0)
fmt.Printf(" Created: %s\n", createdTime.Format("2006-01-02 15:04:05"))
}
fmt.Println()
}
+10
View File
@@ -597,6 +597,16 @@ type ServiceDeviceInfo struct {
DiscoveryMethod string `json:"discovery_method,omitempty"`
AccountID string `json:"account_id,omitempty"`
Components []ServiceComponent `json:"components,omitempty" xml:"-"`
// CreatedOn is the ISO8601 timestamp the device was first
// registered against the account. Preserved across renames so
// AfterTouch's PUT response matches real Bose's "first paired
// in 2017" semantics rather than rewriting `now()` on every
// update. Empty for never-persisted records.
CreatedOn string `json:"created_on,omitempty" xml:"-"`
// UpdatedOn is the ISO8601 timestamp of the most recent change
// to the device record (rename, IP refresh, …). Refreshed by
// every SaveDeviceInfo write that mutates a known device.
UpdatedOn string `json:"updated_on,omitempty" xml:"-"`
}
// ServiceComponent represents a hardware or software component of a device.
+18 -2
View File
@@ -71,9 +71,25 @@ func (p *Preset) IsSpotifyPreset() bool {
return p.ContentItem != nil && p.ContentItem.Source == "SPOTIFY"
}
// IsEmpty returns true if the preset has no content
// IsEmpty returns true if the preset has no playable content. Two
// placeholder shapes are observed in the wild and both count as empty:
//
// - <preset/> (or <preset id="0"/>) — no ContentItem child at all.
// Emitted by some firmware after a factory reset (issue #308).
// - <preset id="0"><ContentItem source="INVALID_SOURCE" isPresetable="true"/></preset>
// — a placeholder ContentItem the firmware uses for unconfigured
// slots, observed on FW 27.0.6 even on devices that were never
// reset.
//
// Treating both as empty keeps GetEmptyPresetSlots, GetUsedPresetSlots
// and HasPresets honest, and lets callers safely skip placeholders
// before formatting a preset for display.
func (p *Preset) IsEmpty() bool {
return p.ContentItem == nil
if p.ContentItem == nil {
return true
}
return p.ContentItem.Source == "" || p.ContentItem.Source == "INVALID_SOURCE"
}
// GetSource returns the source of the preset content
+188
View File
@@ -0,0 +1,188 @@
package models
import (
"encoding/xml"
"testing"
)
// reporterXML is the /presets response captured from the speaker that
// crashed the CLI in issue #308 (ST10 post factory reset, FW 27.0.6).
// Two configured presets followed by three self-closing <preset/>
// placeholders. The original crash happened on the first <preset/>:
// GetDisplayName() handled the nil ContentItem, but the very next
// line dereferenced ContentItem.Source unconditionally.
const reporterXML = `<presets>
<preset id="1" createdOn="1348058580" updatedOn="1348058580">
<ContentItem source="TUNEIN" type="stationurl" location="/v1/playback/station/s6634" sourceAccount="" isPresetable="true">
<itemName>MDR JUMP</itemName>
<containerArt/>
</ContentItem>
</preset>
<preset id="2" createdOn="1348058580" updatedOn="1348058580">
<ContentItem source="TUNEIN" type="stationurl" location="/v1/playback/station/s10637" sourceAccount="" isPresetable="true">
<itemName>SUNSHINE LIVE</itemName>
<containerArt>
http://cdn-profiles.tunein.com/s10637/images/logog.png?t=637791086340000000
</containerArt>
</ContentItem>
</preset>
<preset/>
<preset/>
<preset/>
</presets>`
// invalidSourceXML is the second placeholder shape observed in the
// wild (gesellix's ST10/ST20 on FW 27.0.6, never factory-reset). The
// firmware here populates ContentItem with source="INVALID_SOURCE"
// for unconfigured slots — non-nil but useless, so the old IsEmpty
// (== nil only) returned false and the placeholders polluted listings.
const invalidSourceXML = `<?xml version="1.0" encoding="UTF-8" ?><presets>` +
`<preset id="0"><ContentItem source="INVALID_SOURCE" isPresetable="true" /></preset>` +
`<preset id="0"><ContentItem source="INVALID_SOURCE" isPresetable="true" /></preset>` +
`<preset id="0"><ContentItem source="INVALID_SOURCE" isPresetable="true" /></preset>` +
`<preset id="1"><ContentItem source="SPOTIFY" type="tracklisturl" location="/playback/container/abc" sourceAccount="user" isPresetable="true"><itemName>Sand Castle Tapes</itemName><containerArt></containerArt></ContentItem></preset>` +
`<preset id="2" createdOn="1778965482" updatedOn="1778965482"><ContentItem source="SPOTIFY" type="tracklisturl" location="/playback/container/def" sourceAccount="user" isPresetable="true"><itemName>Unplugged</itemName><containerArt>https://example.com/art.jpg</containerArt></ContentItem></preset>` +
`<preset id="6"><ContentItem source="TUNEIN" type="stationurl" location="/v1/playback/station/s166521" sourceAccount="" isPresetable="true"><itemName>SMOOTH JAZZ</itemName><containerArt>https://example.com/logo.png</containerArt></ContentItem></preset>` +
`</presets>`
func TestIsEmpty_NoContentItem(t *testing.T) {
// Shape A: <preset/> — ContentItem == nil. This is the shape
// behind the issue #308 crash.
p := Preset{}
if !p.IsEmpty() {
t.Error("IsEmpty() should be true when ContentItem is nil")
}
}
func TestIsEmpty_InvalidSourcePlaceholder(t *testing.T) {
// Shape B: ContentItem present but Source == "INVALID_SOURCE".
// Observed on devices that never had a factory reset.
p := Preset{
ContentItem: &ContentItem{Source: "INVALID_SOURCE", IsPresetable: true},
}
if !p.IsEmpty() {
t.Error("IsEmpty() should be true when ContentItem has INVALID_SOURCE")
}
}
func TestIsEmpty_EmptySource(t *testing.T) {
// A ContentItem with no Source can't drive playback. Treat it
// as empty too — defensive, not tied to a single observed shape.
p := Preset{ContentItem: &ContentItem{}}
if !p.IsEmpty() {
t.Error("IsEmpty() should be true when ContentItem.Source is empty")
}
}
func TestIsEmpty_RealPreset(t *testing.T) {
p := Preset{
ContentItem: &ContentItem{
Source: "TUNEIN",
ItemName: "MDR JUMP",
},
}
if p.IsEmpty() {
t.Error("IsEmpty() should be false for a configured preset")
}
}
func TestReporterXML_DoesNotPanicAndFiltersEmpty(t *testing.T) {
// Reproducer for issue #308: simulate the loop that crashed the
// CLI. The fix is two-fold: IsEmpty now recognises <preset/>,
// and callers use the nil-safe Get* accessors. Walking every
// preset through the same paths the CLI uses must not panic on
// any entry.
var presets Presets
if err := xml.Unmarshal([]byte(reporterXML), &presets); err != nil {
t.Fatalf("Failed to unmarshal reporter XML: %v", err)
}
if got := len(presets.Preset); got != 5 {
t.Fatalf("Expected 5 preset entries (2 configured + 3 empty), got %d", got)
}
emptyCount := 0
configuredCount := 0
for _, p := range presets.Preset {
// The CLI now skips empty presets before dereferencing
// anything on ContentItem. The IsEmpty call must catch all
// three <preset/> entries.
if p.IsEmpty() {
emptyCount++
continue
}
configuredCount++
// These calls would have panicked pre-fix on the empty
// entries; here they exercise the still-printed paths for
// the real ones.
_ = p.GetDisplayName()
_ = p.GetSource()
_ = p.GetSourceAccount()
_ = p.GetLocation()
}
if emptyCount != 3 {
t.Errorf("Expected 3 empty presets, got %d", emptyCount)
}
if configuredCount != 2 {
t.Errorf("Expected 2 configured presets, got %d", configuredCount)
}
// HasPresets should reflect "there are real presets" — not
// confused by the placeholders.
if !presets.HasPresets() {
t.Error("HasPresets() should be true (2 real presets present)")
}
if got := presets.GetUsedPresetSlots(); len(got) != 2 {
t.Errorf("GetUsedPresetSlots() = %v; want 2 entries", got)
}
}
func TestInvalidSourceXML_PlaceholdersFilteredOut(t *testing.T) {
// Second-shape reproducer: three INVALID_SOURCE placeholders
// preceding three real presets. Before the IsEmpty extension,
// listings printed "0. Preset 0 / Source: INVALID_SOURCE" three
// times before the real entries — annoying, not crashing.
var presets Presets
if err := xml.Unmarshal([]byte(invalidSourceXML), &presets); err != nil {
t.Fatalf("Failed to unmarshal invalid-source XML: %v", err)
}
if got := len(presets.Preset); got != 6 {
t.Fatalf("Expected 6 preset entries, got %d", got)
}
configured := 0
for _, p := range presets.Preset {
if !p.IsEmpty() {
configured++
}
}
if configured != 3 {
t.Errorf("Expected 3 configured presets (after filtering INVALID_SOURCE placeholders), got %d",
configured)
}
// The three placeholders all carry id="0", so used-slot
// reporting should ignore them and show only the real ids.
used := presets.GetUsedPresetSlots()
if len(used) != 3 {
t.Fatalf("GetUsedPresetSlots() = %v; want 3 entries", used)
}
wantIDs := map[int]bool{1: true, 2: true, 6: true}
for _, id := range used {
if !wantIDs[id] {
t.Errorf("Unexpected used slot id %d; want one of %v", id, []int{1, 2, 6})
}
}
}
+4
View File
@@ -2,6 +2,10 @@ package amazon
import "github.com/gesellix/bose-soundtouch/pkg/service/zeroconf"
// ErrAddUserNoOp re-exports zeroconf.ErrAddUserNoOp for callers that don't
// want a direct dependency on the zeroconf package.
var ErrAddUserNoOp = zeroconf.ErrAddUserNoOp
// PushAmazonCredentials pushes Amazon Music credentials to a speaker using the
// ZeroConf DH key exchange protocol. Falls back to simplified token push if
// the speaker does not support DH (older firmware).
+34 -7
View File
@@ -20,11 +20,35 @@ import (
// TuneIn endpoint templates used to resolve station and stream URLs.
const (
TuneInDescribe = "https://opml.radiotime.com/describe.ashx?id=%s"
TuneInStream = "http://opml.radiotime.com/Tune.ashx?id=%s&formats=mp3,aac,ogg,hls"
TuneInNavigateAshx = "http://opml.radiotime.com/?render=json"
TuneInSearchAPI = "https://api.radiotime.com/profiles?fulltextsearch=true&version=1.3&query="
// DefaultTuneInStreamFormats is the comma-separated format list
// AfterTouch sends to TuneIn's Tune.ashx by default. Matches the
// pre-2026-05-10 behaviour from before PR #249 added "hls"
// unconditionally — HLS playback is broken on SoundTouch 10/
// firmware 27 (and probably the rest of the line; see #292).
// Speakers receive an .m3u8 playlist URL they can't parse, blink
// amber, fall silent. Operators with HLS-compatible speakers can
// override via Settings.TuneInStreamFormats.
DefaultTuneInStreamFormats = "mp3,aac,ogg"
)
// TuneInStream returns the formatted Tune.ashx URL for a station or
// podcast. The formats argument controls the formats= query parameter;
// empty falls back to DefaultTuneInStreamFormats. Operators can set
// arbitrary lists (e.g. "mp3,aac,ogg,hls" to re-enable HLS, or
// "aac" to force a single format) via Settings.TuneInStreamFormats.
// The value is passed through verbatim — no token-level validation.
func TuneInStream(stationID, formats string) string {
formats = strings.TrimSpace(formats)
if formats == "" {
formats = DefaultTuneInStreamFormats
}
return fmt.Sprintf("http://opml.radiotime.com/Tune.ashx?id=%s&formats=%s", stationID, formats)
}
var tuneInClient = &http.Client{Timeout: 10 * time.Second}
// allowedTuneInHosts restricts outbound fetches to known TuneIn domains.
@@ -555,8 +579,10 @@ func TuneInNavigateProfile(encodedURI string) (*models.BmxNavResponse, error) {
}
// TuneInPlayback resolves a live radio station and returns a Bose-compatible
// playback response with primary stream and variants.
func TuneInPlayback(stationID string) (*models.BmxPlaybackResponse, error) {
// playback response with primary stream and variants. formats is the
// comma-separated list passed to Tune.ashx?formats=… ; empty falls back to
// DefaultTuneInStreamFormats (the SoundTouch-line-compatible shape).
func TuneInPlayback(stationID, formats string) (*models.BmxPlaybackResponse, error) {
describeURL := fmt.Sprintf(TuneInDescribe, stationID)
resp, err := http.Get(describeURL)
@@ -588,7 +614,7 @@ func TuneInPlayback(stationID string) (*models.BmxPlaybackResponse, error) {
station := opml.Body.Outline.Station
streamReq := fmt.Sprintf(TuneInStream, stationID)
streamReq := TuneInStream(stationID, formats)
streamResp, err := http.Get(streamReq)
if err != nil {
@@ -697,8 +723,9 @@ func TuneInPodcastInfo(podcastID, encodedName string) (*models.BmxPodcastInfoRes
}
// TuneInPlaybackPodcast resolves an on-demand podcast episode and returns
// a playback response suitable for SoundTouch devices.
func TuneInPlaybackPodcast(podcastID string) (*models.BmxPlaybackResponse, error) {
// a playback response suitable for SoundTouch devices. formats has the
// same semantics as in TuneInPlayback.
func TuneInPlaybackPodcast(podcastID, formats string) (*models.BmxPlaybackResponse, error) {
describeURL := fmt.Sprintf(TuneInDescribe, podcastID)
resp, err := http.Get(describeURL)
@@ -733,7 +760,7 @@ func TuneInPlaybackPodcast(podcastID string) (*models.BmxPlaybackResponse, error
topic := opml.Body.Outline.Topic
streamReq := fmt.Sprintf(TuneInStream, podcastID)
streamReq := TuneInStream(podcastID, formats)
streamResp, err := http.Get(streamReq)
if err != nil {
+49
View File
@@ -221,3 +221,52 @@ func TestTuneInPodcastInfo_Base64(t *testing.T) {
t.Errorf("Expected name %s, got %s", name, resp.Name)
}
}
// TestTuneInStream_EmptyFormatsUsesDefault pins the post-#292 contract:
// AfterTouch must NOT request HLS streams from TuneIn unless the
// operator has explicitly opted in. The default request shape is
// "mp3,aac,ogg" — matches pre-2026-05-10 behaviour and works on
// every SoundTouch model verified. PR #249 had added "hls"
// unconditionally; that regressed playback on ST10/firmware 27 (the
// speaker can't parse the .m3u8 playlist TuneIn returns when HLS is
// in the format list).
func TestTuneInStream_EmptyFormatsUsesDefault(t *testing.T) {
got := TuneInStream("s33828", "")
if strings.Contains(got, "hls") {
t.Errorf("default TuneInStream URL must NOT request HLS; got %s", got)
}
want := "formats=" + DefaultTuneInStreamFormats
if !strings.Contains(got, want) {
t.Errorf("default TuneInStream URL must request %q; got %s", want, got)
}
if !strings.Contains(got, "id=s33828") {
t.Errorf("TuneInStream URL must carry the station ID; got %s", got)
}
}
// TestTuneInStream_OverrideHonoured verifies the opt-in path: when an
// operator sets Settings.TuneInStreamFormats to a custom list,
// TuneInStream passes it through verbatim. Two sub-cases catch the
// common opt-in (re-add hls) and a more drastic override (single
// format) so a future regression in the trim/fallback logic surfaces
// at compile/test time.
func TestTuneInStream_OverrideHonoured(t *testing.T) {
cases := []struct {
formats string
want string
}{
{"mp3,aac,ogg,hls", "formats=mp3,aac,ogg,hls"}, // opt-in: re-add HLS
{"aac", "formats=aac"}, // single format
{" mp3 ", "formats=mp3"}, // whitespace stripped
}
for _, tc := range cases {
got := TuneInStream("s33828", tc.formats)
if !strings.Contains(got, tc.want) {
t.Errorf("TuneInStream(%q) URL must contain %q; got %s", tc.formats, tc.want, got)
}
}
}
+38
View File
@@ -565,6 +565,8 @@ func (ds *DataStore) getDeviceInfoNoLock(account, device string) (*models.Servic
MacAddress string `xml:"macAddress"`
} `xml:"networkInfo"`
DiscoveryMethod string `xml:"discoveryMethod"`
CreatedOn string `xml:"createdOn,omitempty"`
UpdatedOn string `xml:"updatedOn,omitempty"`
}
if err := xml.Unmarshal(data, &info); err != nil {
@@ -577,6 +579,8 @@ func (ds *DataStore) getDeviceInfoNoLock(account, device string) (*models.Servic
ProductCode: fmt.Sprintf("%s %s", info.Type, info.ModuleType),
Name: info.Name,
DiscoveryMethod: info.DiscoveryMethod,
CreatedOn: info.CreatedOn,
UpdatedOn: info.UpdatedOn,
}
for _, comp := range info.Components {
@@ -789,6 +793,8 @@ func (ds *DataStore) parseDeviceInfoFile(path string) (*models.ServiceDeviceInfo
MacAddress string `xml:"macAddress"`
} `xml:"networkInfo"`
DiscoveryMethod string `xml:"discoveryMethod"`
CreatedOn string `xml:"createdOn,omitempty"`
UpdatedOn string `xml:"updatedOn,omitempty"`
}
if err := xml.Unmarshal(data, &info); err != nil {
@@ -1192,6 +1198,8 @@ func (ds *DataStore) SaveDeviceInfo(account, device string, info *models.Service
Components []componentXML `xml:"components>component"`
NetworkInfo []NetworkInfoXML `xml:"networkInfo"`
DiscoveryMethod string `xml:"discoveryMethod,omitempty"`
CreatedOn string `xml:"createdOn,omitempty"`
UpdatedOn string `xml:"updatedOn,omitempty"`
}
// Parsing product code back to type and moduleType (best effort)
@@ -1203,6 +1211,8 @@ func (ds *DataStore) SaveDeviceInfo(account, device string, info *models.Service
Type: devType,
ModuleType: moduleType,
DiscoveryMethod: info.DiscoveryMethod,
CreatedOn: info.CreatedOn,
UpdatedOn: info.UpdatedOn,
}
if ix.DiscoveryMethod == "" {
@@ -1266,6 +1276,21 @@ func (ds *DataStore) mergeWithExistingDeviceInfo(account, device string, info *m
if info.DiscoveryMethod == "" {
info.DiscoveryMethod = existing.DiscoveryMethod
}
// CreatedOn is set once at first persistence and never re-derived
// from inbound data — preserve unconditionally so the
// "first-paired" timestamp survives renames, IP refreshes, etc.
// UpdatedOn is the opposite: every write that reaches here is by
// definition an update, so callers that want it refreshed must
// set it explicitly. If they didn't, fall back to the existing
// value (better than a regression to empty).
if existing.CreatedOn != "" {
info.CreatedOn = existing.CreatedOn
}
if info.UpdatedOn == "" {
info.UpdatedOn = existing.UpdatedOn
}
}
func (ds *DataStore) parseProductCode(productCode string) (string, string) {
@@ -2102,6 +2127,19 @@ type Settings struct {
// reverse proxy on the same host. Override only if the proxy lives on a
// different host within a known-good private subnet.
TrustedProxyCIDRs []string `json:"trusted_proxy_cidrs,omitempty"`
// TuneInStreamFormats overrides the comma-separated format list
// AfterTouch sends to TuneIn's Tune.ashx (formats=…). Empty value
// uses bmx.DefaultTuneInStreamFormats ("mp3,aac,ogg"), which
// matches AfterTouch's pre-2026-05-10 behaviour and plays on
// every SoundTouch model verified so far. PR #249 had added
// "hls" unconditionally; that regressed playback on the
// SoundTouch line (#292 — speaker can't parse the .m3u8 playlist
// and blinks amber). Operators with HLS-compatible speakers can
// set this to e.g. "mp3,aac,ogg,hls" via settings.json. The value
// is passed through verbatim; AfterTouch does not validate the
// individual format tokens.
TuneInStreamFormats string `json:"tunein_stream_formats,omitempty"`
}
// GetSettings retrieves the global service settings.
+22 -2
View File
@@ -15,6 +15,26 @@ import (
"github.com/go-chi/chi/v5"
)
// tuneInStreamFormats returns the formats= list AfterTouch should send
// to TuneIn's Tune.ashx, honouring Settings.TuneInStreamFormats when
// set. Empty (the default) lets bmx.TuneInStream fall back to
// bmx.DefaultTuneInStreamFormats — the SoundTouch-line-compatible
// "mp3,aac,ogg" shape. Operators with HLS-capable speakers can set
// the field to "mp3,aac,ogg,hls" (or any other comma-separated list)
// in settings.json.
func (s *Server) tuneInStreamFormats() string {
if s == nil || s.ds == nil {
return ""
}
settings, err := s.ds.GetSettings()
if err != nil {
return ""
}
return settings.TuneInStreamFormats
}
// HandleBMXRegistry returns the BMX service registry.
func (s *Server) HandleBMXRegistry(w http.ResponseWriter, _ *http.Request) {
baseURL := s.serverURL
@@ -62,7 +82,7 @@ func (s *Server) HandleTuneInPlayback(w http.ResponseWriter, r *http.Request) {
stationID := chi.URLParam(r, "stationID")
resp, err := bmx.TuneInPlayback(stationID)
resp, err := bmx.TuneInPlayback(stationID, s.tuneInStreamFormats())
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
@@ -109,7 +129,7 @@ func (s *Server) HandleTuneInPlaybackPodcast(w http.ResponseWriter, r *http.Requ
podcastID := chi.URLParam(r, "podcastID")
resp, err := bmx.TuneInPlaybackPodcast(podcastID)
resp, err := bmx.TuneInPlaybackPodcast(podcastID, s.tuneInStreamFormats())
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
+18 -6
View File
@@ -588,7 +588,7 @@ func (s *Server) HandleMargeAddDevice(w http.ResponseWriter, r *http.Request) {
return
}
deviceID, data, err := marge.AddDeviceToAccount(s.ds, account, body)
deviceID, data, err := marge.AddDeviceToAccount(s.ds, account, body, r.RemoteAddr)
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
@@ -637,20 +637,32 @@ func (s *Server) HandleMargeUpdateDevice(w http.ResponseWriter, r *http.Request)
return
}
bodyDeviceID, data, err := marge.AddDeviceToAccount(s.ds, account, body)
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
// Validate body deviceID against the URL segment *before* the
// upsert in AddDeviceToAccount runs — otherwise a mismatched PUT
// would still persist a row for the body's deviceID before the
// 400 response, leaving spurious state in the datastore.
var probe struct {
DeviceID string `xml:"deviceid,attr"`
}
if xmlErr := xml.Unmarshal(body, &probe); xmlErr != nil {
http.Error(w, xmlErr.Error(), http.StatusBadRequest)
return
}
if bodyDeviceID != device {
if probe.DeviceID != device {
http.Error(w,
fmt.Sprintf("device ID in body (%q) does not match URL (%q)", bodyDeviceID, device),
fmt.Sprintf("device ID in body (%q) does not match URL (%q)", probe.DeviceID, device),
http.StatusBadRequest)
return
}
_, data, err := marge.AddDeviceToAccount(s.ds, account, body, r.RemoteAddr)
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
w.Header().Set("Content-Type", "application/vnd.bose.streaming-v1.2+xml")
w.WriteHeader(http.StatusOK)
_, _ = w.Write(data)
+28 -10
View File
@@ -64,12 +64,16 @@ func TestMargeCreateAccount(t *testing.T) {
t.Errorf("Expected 7-digit ID, got %v", resp.ID)
}
// Verify it has default sources
if len(resp.Sources) != 5 {
t.Errorf("Expected 5 default sources, got %d", len(resp.Sources))
// Verify default sources. AUX (id=10001, sourceproviderid=9) is
// intentionally excluded from cloud responses — real Bose never
// emitted AUX in /full; the speaker enumerates AUX from its own
// hardware via isLocal=true in :8090/sources. See
// pkg/service/marge/marge.go getAccountSources.
if len(resp.Sources) != 4 {
t.Errorf("Expected 4 cloud default sources (AUX excluded), got %d", len(resp.Sources))
} else {
if resp.Sources[0].ID != "10001" {
t.Errorf("Expected first source ID 10001, got %s", resp.Sources[0].ID)
if resp.Sources[0].ID != "10002" {
t.Errorf("Expected first cloud source ID 10002 (INTERNET_RADIO), got %s", resp.Sources[0].ID)
}
}
@@ -380,10 +384,12 @@ func TestMargeAccountFullExcludesEmptyAmazonSource(t *testing.T) {
t.Errorf("/full response must not include an empty-credential Amazon source; body:\n%s", bodyStr)
}
// The 6 sources from lastDeviceID's stored Sources.xml must all be present.
// Checked by sourceproviderid since <name> may hold a display name rather than the type string.
// The cloud-visible sources from lastDeviceID's stored Sources.xml
// must all be present. AUX (sourceproviderid=9) is intentionally
// excluded — real Bose never emitted AUX in /full; the speaker
// enumerates AUX from its own hardware via isLocal=true. See
// pkg/service/marge/marge.go getAccountSources.
for _, wantProviderID := range []string{
"<sourceproviderid>9</sourceproviderid>", // AUX
"<sourceproviderid>2</sourceproviderid>", // INTERNET_RADIO
"<sourceproviderid>11</sourceproviderid>", // LOCAL_INTERNET_RADIO
"<sourceproviderid>25</sourceproviderid>", // TUNEIN
@@ -394,6 +400,11 @@ func TestMargeAccountFullExcludesEmptyAmazonSource(t *testing.T) {
t.Errorf("/full response is missing source with %s; body:\n%s", wantProviderID, bodyStr)
}
}
// And explicitly assert AUX is NOT present.
if strings.Contains(bodyStr, "<sourceproviderid>9</sourceproviderid>") {
t.Errorf("/full response must not include AUX (sourceproviderid=9); body:\n%s", bodyStr)
}
}
func TestMargeAccountSources(t *testing.T) {
@@ -627,13 +638,16 @@ func TestMargeAccountSourcesNoDevices(t *testing.T) {
body, _ := io.ReadAll(res.Body)
bodyStr := string(body)
// Verify that we get the default sources with correct IDs and empty display names
// Verify that we get the default cloud sources with correct IDs. AUX
// (id=10001) is intentionally excluded — real Bose never emitted AUX
// in cloud responses; the speaker enumerates AUX from its own
// hardware (isLocal=true on :8090/sources). See
// pkg/service/marge/marge.go getAccountSources.
expectedSnippets := []string{
"<sources>",
"<source id=\"10004\" type=\"Audio\"",
"<source id=\"10003\" type=\"Audio\"",
"<source id=\"10002\" type=\"Audio\"",
"<source id=\"10001\" type=\"Audio\"",
}
for _, snippet := range expectedSnippets {
@@ -642,6 +656,10 @@ func TestMargeAccountSourcesNoDevices(t *testing.T) {
}
}
if strings.Contains(bodyStr, "<source id=\"10001\"") {
t.Errorf("Response must not include AUX (id=10001); body:\n%s", bodyStr)
}
// Verify that no sources have empty display names
if strings.Count(bodyStr, "displayName=\"\"") != 0 {
t.Errorf("Expected no sources with empty displayName, got %d: %s", strings.Count(bodyStr, "displayName=\"\""), bodyStr)
+156 -11
View File
@@ -65,20 +65,26 @@ func TestIssue285_RenamePutAcceptedAndPersisted(t *testing.T) {
_ = ds.Initialize()
const (
accountID = "3981561"
deviceID = "884AEAEEBD27"
oldName = "Wohnzimmer"
newName = "Wohnzimmer SB"
accountID = "3981561"
deviceID = "884AEAEEBD27"
oldName = "Wohnzimmer"
newName = "Wohnzimmer SB"
preExistingIP = "192.168.0.109"
preExistingPaired = "2017-02-07T11:13:03.000+00:00"
)
// 1. Seed datastore with the device under its original name
// modelling a pre-existing paired device the user is now
// renaming.
// 1. Seed datastore with the device under its original name and
// a known pre-existing first-paired timestamp. The pre-existing
// data models a long-paired device the user is now renaming
// CreatedOn must survive the PUT (real Bose preserves it
// across renames; see parity capture at
// data/parity_mismatches/1771797308__streaming_account_3230304_device_A81B6A536A98.json).
if err := ds.SaveDeviceInfo(accountID, deviceID, &models.ServiceDeviceInfo{
DeviceID: deviceID,
AccountID: accountID,
Name: oldName,
IPAddress: "192.168.0.109",
IPAddress: preExistingIP,
CreatedOn: preExistingPaired,
}); err != nil {
t.Fatalf("seed datastore: %v", err)
}
@@ -146,10 +152,35 @@ func TestIssue285_RenamePutAcceptedAndPersisted(t *testing.T) {
t.Errorf("response still carries old name %q; body:\n%s", oldName, respBody)
}
// Parity assertion: the pre-existing first-paired CreatedOn
// must survive the rename. This is the load-bearing fix versus
// the prior behaviour that rewrote `now()` on every PUT, and
// matches what real Bose's pre-shutdown 200 OK responses
// carried (see the parity capture referenced above).
if !bytes.Contains(respBody, []byte(`<createdOn>`+preExistingPaired+`</createdOn>`)) {
t.Errorf("response did not preserve pre-existing CreatedOn %q; body:\n%s", preExistingPaired, respBody)
}
// Parity assertion: the pre-existing IP address must survive
// the rename. The request body doesn't carry an `<ipaddress>`,
// so the datastore merge has to inject what was already on
// disk rather than writing back empty.
if !bytes.Contains(respBody, []byte(`<ipaddress>`+preExistingIP+`</ipaddress>`)) {
t.Errorf("response did not preserve pre-existing IPAddress %q; body:\n%s", preExistingIP, respBody)
}
// Parity assertion: UpdatedOn refreshes. Don't pin the exact
// value — it's "now()" — but assert it's present and
// non-empty.
if !bytes.Contains(respBody, []byte(`<updatedOn>`)) ||
bytes.Contains(respBody, []byte(`<updatedOn></updatedOn>`)) {
t.Errorf("response missing or empty <updatedOn>; body:\n%s", respBody)
}
// 4. Persistence assertion: the datastore now reflects the new
// name. This is what the Bose App reads back on its next
// /streaming/account/.../full poll, which is what closes the
// visible rename loop.
// name AND keeps the original CreatedOn. This is what the
// Bose App reads back on its next /streaming/account/.../full
// poll, which is what closes the visible rename loop.
persisted, err := ds.GetDeviceInfo(accountID, deviceID)
if err != nil {
t.Fatalf("read persisted device info: %v", err)
@@ -158,6 +189,109 @@ func TestIssue285_RenamePutAcceptedAndPersisted(t *testing.T) {
if persisted.Name != newName {
t.Errorf("persisted Name = %q, want %q", persisted.Name, newName)
}
if persisted.CreatedOn != preExistingPaired {
t.Errorf("persisted CreatedOn = %q, want %q (preserved across rename)", persisted.CreatedOn, preExistingPaired)
}
if persisted.IPAddress != preExistingIP {
t.Errorf("persisted IPAddress = %q, want %q (preserved across rename)", persisted.IPAddress, preExistingIP)
}
if persisted.UpdatedOn == "" {
t.Errorf("persisted UpdatedOn is empty; want a fresh timestamp from the rename")
}
}
// TestIssue285_NewDeviceGetsRemoteAddrAndFreshTimestamps covers the
// "first-time registration" path on a PUT (which can happen if the
// speaker emits a rename before AfterTouch has ever heard of it).
// With no pre-existing datastore record:
//
// - CreatedOn must be a fresh timestamp (no record to preserve).
// - IPAddress must come from r.RemoteAddr (the inbound connection)
// since the request body doesn't carry one.
// - UpdatedOn must be the same fresh timestamp.
//
// Pairs with the parity-preservation assertions in the main test:
// existing records win, but new records seed sensibly instead of
// landing with empty CreatedOn / IPAddress.
func TestIssue285_NewDeviceGetsRemoteAddrAndFreshTimestamps(t *testing.T) {
tempDir, err := os.MkdirTemp("", "issue285-new-")
if err != nil {
t.Fatalf("mkdir temp: %v", err)
}
defer os.RemoveAll(tempDir)
ds := datastore.NewDataStore(tempDir)
_ = ds.Initialize()
const (
accountID = "1111111"
deviceID = "A81B6A536A98"
newName = "Sound Machinechen"
)
r, _ := setupRouter("http://localhost:8001", ds)
ts := httptest.NewServer(r)
t.Cleanup(ts.Close)
body := []byte(`<?xml version="1.0" encoding="UTF-8" ?>` +
`<device deviceid="` + deviceID + `"><name>` + newName + `</name><macaddress>` + deviceID + `</macaddress></device>`)
req, err := http.NewRequest(http.MethodPut,
ts.URL+"/streaming/account/"+accountID+"/device/"+deviceID,
bytes.NewReader(body))
if err != nil {
t.Fatalf("build request: %v", err)
}
req.Header.Set("Content-Type", "application/xml")
resp, err := http.DefaultClient.Do(req)
if err != nil {
t.Fatalf("PUT: %v", err)
}
defer func() { _ = resp.Body.Close() }()
if resp.StatusCode != http.StatusOK {
respBody, _ := io.ReadAll(resp.Body)
t.Fatalf("PUT status = %d, want 200; body:\n%s", resp.StatusCode, respBody)
}
respBody, err := io.ReadAll(resp.Body)
if err != nil {
t.Fatalf("read response: %v", err)
}
// CreatedOn present and non-empty (will be "now()" since no
// prior record existed).
if !bytes.Contains(respBody, []byte(`<createdOn>`)) ||
bytes.Contains(respBody, []byte(`<createdOn></createdOn>`)) {
t.Errorf("first-registration response missing CreatedOn; body:\n%s", respBody)
}
// IPAddress should be the httptest connection's remote host
// (127.0.0.1) since the body didn't carry one and there was
// no existing record to preserve from.
if !bytes.Contains(respBody, []byte(`<ipaddress>127.0.0.1</ipaddress>`)) {
t.Errorf("first-registration response missing IPAddress from RemoteAddr; body:\n%s", respBody)
}
// Persistence: CreatedOn and IPAddress on disk too.
persisted, err := ds.GetDeviceInfo(accountID, deviceID)
if err != nil {
t.Fatalf("read persisted device info: %v", err)
}
if persisted.CreatedOn == "" {
t.Errorf("persisted CreatedOn is empty for new device; want a fresh timestamp")
}
if persisted.IPAddress != "127.0.0.1" {
t.Errorf("persisted IPAddress = %q, want %q (from RemoteAddr)", persisted.IPAddress, "127.0.0.1")
}
}
// TestIssue285_RenamePutRejectsMismatchedDeviceID pins the safety
@@ -205,4 +339,15 @@ func TestIssue285_RenamePutRejectsMismatchedDeviceID(t *testing.T) {
respBody, _ := io.ReadAll(resp.Body)
t.Fatalf("PUT status = %d, want 400; body:\n%s", resp.StatusCode, respBody)
}
// Mismatched body must be rejected *before* the upsert runs —
// otherwise the datastore ends up with a row keyed on the body's
// deviceID even though we return 400. Verify by reading both keys.
if got, _ := ds.GetDeviceInfo("3981561", "DEADBEEFCAFE"); got != nil {
t.Fatalf("body deviceID DEADBEEFCAFE was persisted despite 400 response: %+v", got)
}
if got, _ := ds.GetDeviceInfo("3981561", urlDeviceID); got != nil {
t.Fatalf("URL deviceID %s was persisted despite 400 response: %+v", urlDeviceID, got)
}
}
+366
View File
@@ -0,0 +1,366 @@
package handlers
import (
"encoding/json"
"io"
"net"
"net/http"
"net/http/httptest"
"net/url"
"os"
"path/filepath"
"strings"
"sync/atomic"
"testing"
"time"
"github.com/gesellix/bose-soundtouch/pkg/models"
"github.com/gesellix/bose-soundtouch/pkg/service/constants"
"github.com/gesellix/bose-soundtouch/pkg/service/datastore"
"github.com/gesellix/bose-soundtouch/pkg/service/setup"
"github.com/gesellix/bose-soundtouch/pkg/service/spotify"
)
// TestPrimeDeviceWithSpotify_RegistersMargeSource is a regression test for the
// "AddPreset - failed due to invalid SourceID" failure observed when storing a
// Spotify preset on a primed device. The watchdog priming path used to push
// ZeroConf credentials without writing a SPOTIFY ConfiguredSource into the
// marge datastore — so marge.UpdatePreset later had nothing to match
// SourceID="SPOTIFY" against and rejected the storePreset request.
//
// This test verifies that PrimeDeviceWithSpotify now also calls marge.AddSource
// for the device's account, producing a ConfiguredSource with
// SourceProviderID="15" (constants.SpotifyProviderID).
func TestPrimeDeviceWithSpotify_RegistersMargeSource(t *testing.T) {
tmpDir := t.TempDir()
ds := datastore.NewDataStore(tmpDir)
server := NewServer(ds, nil, "http://localhost", false, false, false)
// Fake speaker that accepts the ZeroConf push via the simplified
// (non-DH) fallback AND records whether /notification (sourcesUpdated)
// was hit.
var notified atomic.Bool
speakerTS := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path == "/notification" {
notified.Store(true)
w.Header().Set("Content-Type", "application/xml")
_, _ = io.WriteString(w, `<?xml version="1.0" encoding="UTF-8" ?><status>/notification</status>`)
return
}
switch r.URL.Query().Get("action") {
case "getInfo":
http.Error(w, "not supported", http.StatusNotFound)
case "addUser":
w.WriteHeader(http.StatusOK)
default:
http.NotFound(w, r)
}
}))
defer speakerTS.Close()
speakerHostPort := strings.TrimPrefix(speakerTS.URL, "http://")
speakerHost, _, err := net.SplitHostPort(speakerHostPort)
if err != nil {
t.Fatalf("split speaker URL: %v", err)
}
// Register the device under a real account so the IP→account lookup succeeds.
const accountID = "acc-prime"
const deviceID = "DEVPRIME"
devInfo := &models.ServiceDeviceInfo{
DeviceID: deviceID,
AccountID: accountID,
Name: "Test Speaker",
IPAddress: speakerHost,
}
if err := ds.SaveDeviceInfo(accountID, deviceID, devInfo); err != nil {
t.Fatalf("SaveDeviceInfo: %v", err)
}
// marge.AddSource walks the account/devices dir — make sure the per-device
// subdir exists so the source actually gets persisted.
if err := os.MkdirAll(filepath.Join(ds.AccountDevicesDir(accountID), deviceID), 0o755); err != nil {
t.Fatalf("MkdirAll device dir: %v", err)
}
// Pre-seed a linked Spotify account so PrimeDeviceWithSpotify has something
// to push. The token is valid for an hour so GetFreshToken won't try to
// refresh against a live endpoint. We point the token endpoint at a noop
// URL just in case, so a stray refresh would fail loudly rather than fan
// out to the internet.
spotifyDir := filepath.Join(tmpDir, "spotify")
if err := os.MkdirAll(spotifyDir, 0o755); err != nil {
t.Fatalf("MkdirAll spotify dir: %v", err)
}
accountsPayload := map[string]map[string]any{
"spotify-user": {
"user_id": "spotify-user",
"display_name": "Spotify User",
"email": "user@example.com",
"access_token": "fresh-access-token",
"refresh_token": "refresh-token",
"expires_at": time.Now().Add(time.Hour).Unix(),
"bose_secret": "bs-deadbeef",
},
}
accountsJSON, err := json.Marshal(accountsPayload)
if err != nil {
t.Fatalf("marshal accounts: %v", err)
}
if err := os.WriteFile(filepath.Join(spotifyDir, "accounts.json"), accountsJSON, 0o600); err != nil {
t.Fatalf("write accounts.json: %v", err)
}
ss := spotify.NewSpotifyService("client-id", "client-secret", "http://localhost/callback", tmpDir)
// Unused fallback token endpoint — defensive in case the test ever drifts
// to an expired token.
ss.SetEndpoints("http://127.0.0.1:1/token", "http://127.0.0.1:1")
if err := ss.Load(); err != nil {
t.Fatalf("Load spotify accounts: %v", err)
}
if len(ss.GetAccounts()) != 1 {
t.Fatalf("expected 1 spotify account after Load, got %d", len(ss.GetAccounts()))
}
server.SetSpotifyService(ss)
// Sanity: no SPOTIFY source registered yet.
sources, _ := ds.GetConfiguredSources(accountID, deviceID)
if hasSpotifySource(sources) {
t.Fatalf("precondition failed: SPOTIFY source already present before priming")
}
// Pass host:port so the ZeroConf push hits our test server instead of the
// hard-coded :8200 fallback. The IP→account lookup strips the port before
// matching against devInfo.IPAddress.
server.PrimeDeviceWithSpotify(speakerHostPort)
sources, err = ds.GetConfiguredSources(accountID, deviceID)
if err != nil {
t.Fatalf("GetConfiguredSources after priming: %v", err)
}
if !hasSpotifySource(sources) {
for _, src := range sources {
t.Logf("source after priming: ID=%s providerID=%s keyType=%s account=%s", src.ID, src.SourceProviderID, src.SourceKey.Type, src.SourceKey.Account)
}
t.Fatalf("expected a SPOTIFY ConfiguredSource (providerID=%d) after priming", constants.SpotifyProviderID)
}
// The speaker's on-device Sources.xml only refreshes when we tell it to —
// without this notification storePreset keeps failing even though marge
// already has the SPOTIFY source.
deadline := time.Now().Add(1 * time.Second)
for time.Now().Before(deadline) && !notified.Load() {
time.Sleep(20 * time.Millisecond)
}
if !notified.Load() {
t.Errorf("speaker did not receive a sourcesUpdated /notification after priming")
}
}
// TestPrimeDeviceWithSpotify_SkipsWhenDeviceUnmapped ensures that priming a
// device whose IP is not associated with any account does NOT fabricate a
// source under the "default" account — the previous behavior would silently
// pollute marge with sources for devices that never asked.
func TestPrimeDeviceWithSpotify_SkipsWhenDeviceUnmapped(t *testing.T) {
tmpDir := t.TempDir()
ds := datastore.NewDataStore(tmpDir)
server := NewServer(ds, nil, "http://localhost", false, false, false)
speakerTS := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
switch r.URL.Query().Get("action") {
case "getInfo":
http.Error(w, "not supported", http.StatusNotFound)
case "addUser":
w.WriteHeader(http.StatusOK)
default:
http.NotFound(w, r)
}
}))
defer speakerTS.Close()
speakerURL, _ := url.Parse(speakerTS.URL)
speakerHostPort := speakerURL.Host
// Pre-seed a Spotify account but do NOT register any device.
spotifyDir := filepath.Join(tmpDir, "spotify")
_ = os.MkdirAll(spotifyDir, 0o755)
accountsPayload := map[string]map[string]any{
"spotify-user": {
"user_id": "spotify-user",
"display_name": "Spotify User",
"access_token": "fresh-access-token",
"expires_at": time.Now().Add(time.Hour).Unix(),
"bose_secret": "bs-deadbeef",
},
}
accountsJSON, err := json.Marshal(accountsPayload)
if err != nil {
t.Fatalf("marshal accounts: %v", err)
}
_ = os.WriteFile(filepath.Join(spotifyDir, "accounts.json"), accountsJSON, 0o600)
ss := spotify.NewSpotifyService("client-id", "client-secret", "http://localhost/callback", tmpDir)
ss.SetEndpoints("http://127.0.0.1:1/token", "http://127.0.0.1:1")
if err := ss.Load(); err != nil {
t.Fatalf("Load spotify accounts: %v", err)
}
server.SetSpotifyService(ss)
server.PrimeDeviceWithSpotify(speakerHostPort)
// "default" account should have no SPOTIFY source added by us.
sources, _ := ds.GetConfiguredSources("default", "")
if hasSpotifySource(sources) {
t.Errorf("priming an unmapped device wrote a SPOTIFY source under 'default' — should have been skipped")
}
}
// TestPrimeDeviceWithSpotify_LiveMargeAccountUUIDWins covers the production
// scenario the previous test didn't catch: a device whose datastore
// ServiceDeviceInfo.AccountID is "default" (or stale) but whose live
// :8090/info reports a real paired margeAccountUUID. The SPOTIFY source must
// land under the paired account — that's the account marge.UpdatePreset
// receives storePreset under, so writing anywhere else means the preset still
// fails with "AddPreset - failed due to invalid SourceID".
//
// Mirrors setup.populateDeviceInfo's resolution order (datastore ← live /info)
// rather than guessing.
func TestPrimeDeviceWithSpotify_LiveMargeAccountUUIDWins(t *testing.T) {
tmpDir := t.TempDir()
ds := datastore.NewDataStore(tmpDir)
server := NewServer(ds, nil, "http://localhost", false, false, false)
const (
datastoreAccount = "default" // stale / fallback
pairedAccount = "1111111" // live margeAccountUUID from /info
deviceID = "DEVPAIR"
)
// Fake speaker that serves both /info and the ZeroConf /zc.
var speakerHost string
speakerTS := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
switch {
case strings.HasSuffix(r.URL.Path, "/info"):
w.Header().Set("Content-Type", "application/xml")
_, _ = io.WriteString(w, `<?xml version="1.0" encoding="UTF-8" ?>`+
`<info deviceID="`+deviceID+`">`+
`<name>Paired Speaker</name><type>SoundTouch 20</type>`+
`<margeAccountUUID>`+pairedAccount+`</margeAccountUUID>`+
`</info>`)
case r.URL.Path == "/notification":
w.Header().Set("Content-Type", "application/xml")
_, _ = io.WriteString(w, `<?xml version="1.0" encoding="UTF-8" ?><status>/notification</status>`)
default:
switch r.URL.Query().Get("action") {
case "getInfo":
http.Error(w, "not supported", http.StatusNotFound)
case "addUser":
w.WriteHeader(http.StatusOK)
default:
http.NotFound(w, r)
}
}
}))
defer speakerTS.Close()
speakerHostPort := strings.TrimPrefix(speakerTS.URL, "http://")
speakerHost, _, _ = net.SplitHostPort(speakerHostPort)
// Register the device under the STALE account so the datastore lookup
// would yield the wrong answer if used in isolation.
devInfo := &models.ServiceDeviceInfo{
DeviceID: deviceID,
AccountID: datastoreAccount,
Name: "Paired Speaker",
IPAddress: speakerHost,
}
if err := ds.SaveDeviceInfo(datastoreAccount, deviceID, devInfo); err != nil {
t.Fatalf("SaveDeviceInfo: %v", err)
}
// And make sure the paired account's device dir exists so
// marge.AddSource can persist the source (it walks accounts/devices/...).
if err := os.MkdirAll(filepath.Join(ds.AccountDevicesDir(pairedAccount), deviceID), 0o755); err != nil {
t.Fatalf("MkdirAll paired dir: %v", err)
}
// Pre-seed a Spotify account so priming has something to push.
spotifyDir := filepath.Join(tmpDir, "spotify")
_ = os.MkdirAll(spotifyDir, 0o755)
accountsPayload := map[string]map[string]any{
"spotify-user": {
"user_id": "spotify-user",
"display_name": "Spotify User",
"access_token": "fresh-access-token",
"expires_at": time.Now().Add(time.Hour).Unix(),
"bose_secret": "bs-deadbeef",
},
}
accountsJSON, err := json.Marshal(accountsPayload)
if err != nil {
t.Fatalf("marshal accounts: %v", err)
}
_ = os.WriteFile(filepath.Join(spotifyDir, "accounts.json"), accountsJSON, 0o600)
ss := spotify.NewSpotifyService("client-id", "client-secret", "http://localhost/callback", tmpDir)
ss.SetEndpoints("http://127.0.0.1:1/token", "http://127.0.0.1:1")
if err := ss.Load(); err != nil {
t.Fatalf("Load spotify accounts: %v", err)
}
server.SetSpotifyService(ss)
// Wire a real setup.Manager so resolvePairedAccount reaches /info.
// HTTPGet uses the default net/http client, which hits the httptest
// server directly via deviceIP=host:port.
server.sm = setup.NewManager("http://localhost", ds, nil)
server.PrimeDeviceWithSpotify(speakerHostPort)
// SPOTIFY source must be under the PAIRED account, not the datastore one.
pairedSources, err := ds.GetConfiguredSources(pairedAccount, deviceID)
if err != nil {
t.Fatalf("GetConfiguredSources(paired): %v", err)
}
if !hasSpotifySource(pairedSources) {
t.Errorf("expected SPOTIFY source under paired account %s, got %d sources", pairedAccount, len(pairedSources))
}
// And it must NOT have been written under the stale datastore account.
staleSources, _ := ds.GetConfiguredSources(datastoreAccount, deviceID)
if hasSpotifySource(staleSources) {
t.Errorf("SPOTIFY source unexpectedly written under stale datastore account %s — should follow live margeAccountUUID", datastoreAccount)
}
}
func hasSpotifySource(sources []models.ConfiguredSource) bool {
for _, src := range sources {
if src.SourceProviderID == "15" || src.SourceKey.Type == constants.ProviderSpotify {
return true
}
}
return false
}
+121 -2
View File
@@ -3,19 +3,24 @@ package handlers
import (
"bytes"
"context"
"errors"
"fmt"
"log"
"net"
"net/http"
"net/url"
"strconv"
"strings"
"sync"
"time"
"github.com/gesellix/bose-soundtouch/pkg/client"
"github.com/gesellix/bose-soundtouch/pkg/discovery"
"github.com/gesellix/bose-soundtouch/pkg/models"
"github.com/gesellix/bose-soundtouch/pkg/service/amazon"
"github.com/gesellix/bose-soundtouch/pkg/service/constants"
"github.com/gesellix/bose-soundtouch/pkg/service/datastore"
"github.com/gesellix/bose-soundtouch/pkg/service/marge"
"github.com/gesellix/bose-soundtouch/pkg/service/proxy"
"github.com/gesellix/bose-soundtouch/pkg/service/setup"
"github.com/gesellix/bose-soundtouch/pkg/service/spotify"
@@ -659,13 +664,123 @@ func (s *Server) PrimeDeviceWithSpotify(deviceIP string) {
log.Printf("[Spotify Watchdog] Proactively priming %s with Spotify user %s", deviceIP, username)
// Register the SPOTIFY source in our marge datastore before pushing credentials.
// Without this, storePreset later fails with "AddPreset - failed due to invalid SourceID"
// because marge.UpdatePreset can't match SourceID="SPOTIFY" against any ConfiguredSource.
s.registerSpotifySourceForDevice(deviceIP, accounts)
if err := s.pushSpotifyTokenToDevice(deviceIP, username, accessToken); err != nil {
log.Printf("[Spotify Watchdog] Failed to prime %s: %v", deviceIP, err)
// addUser may return a benign 404+empty-body no-op when the speaker
// already has the activeUser set. The zeroconf-level log already
// recorded the specifics; here we just upgrade the watchdog's view to
// "primed" since marge holds the authoritative SPOTIFY source.
if errors.Is(err, spotify.ErrAddUserNoOp) {
log.Printf("[Spotify Watchdog] Successfully primed %s (ZeroConf addUser was an expected no-op)", deviceIP)
} else {
log.Printf("[Spotify Watchdog] Failed to prime %s: %v", deviceIP, err)
}
} else {
log.Printf("[Spotify Watchdog] Successfully primed %s", deviceIP)
}
}
// registerSpotifySourceForDevice writes a SPOTIFY ConfiguredSource into the marge
// datastore under the device's currently-paired account. No-op (with a log
// message) if the device can't be resolved to an account — falling back to
// "default" here would risk polluting an unrelated account's source list, and
// any storePreset the device sends will be under its real paired account anyway.
func (s *Server) registerSpotifySourceForDevice(deviceIP string, accounts []spotify.Account) {
host := deviceIP
if h, _, err := net.SplitHostPort(deviceIP); err == nil {
host = h
}
accountID, deviceID := s.resolvePairedAccount(deviceIP, host)
if accountID == "" {
log.Printf("[Spotify Watchdog] No paired account for %s yet — skipping marge source registration", deviceIP)
return
}
registered := false
for _, acc := range accounts {
credential := acc.BoseSecret
if credential == "" {
credential = acc.AccessToken
}
if _, err := marge.AddSource(s.ds, accountID, acc.UserID, strconv.Itoa(constants.SpotifyProviderID), credential, "token_version_3", acc.DisplayName); err != nil {
log.Printf("[Spotify Watchdog] Failed to register Spotify source for account %s: %v", accountID, err)
continue
}
log.Printf("[Spotify Watchdog] Registered Spotify source %s for account %s (device %s)", acc.UserID, accountID, deviceID)
registered = true
}
// Tell the speaker its sources list changed so it re-fetches from marge.
// Without this its on-device Sources.xml stays stale until something else
// triggers a sync — which leaves storePreset failing with
// "AddPreset - failed due to invalid SourceID" even though our marge
// datastore already has the SPOTIFY entry.
if registered && deviceID != "" {
c := client.NewClientFromHost(deviceIP)
if err := c.NotifySourcesUpdated(deviceID); err != nil {
log.Printf("[Spotify Watchdog] sourcesUpdated notification for %s failed: %v", deviceIP, err)
} else {
log.Printf("[Spotify Watchdog] Notified %s to re-sync sources (deviceID=%s)", deviceIP, deviceID)
}
}
}
// resolvePairedAccount returns the device's currently-paired account ID and its
// canonical deviceID. It prefers the live :8090/info margeAccountUUID (matches
// what the device will actually send on storePreset) and falls back to the
// datastore record. Mirrors setup.populateDeviceInfo's resolution order so
// priming and migration agree on which account a device belongs to.
//
// deviceIP is the original input (may carry a :port for tests); host is the
// bare host for datastore IPAddress matching.
func (s *Server) resolvePairedAccount(deviceIP, host string) (accountID, deviceID string) {
if devInfo := s.findExistingDeviceInfoByIP(host); devInfo != nil {
accountID = devInfo.AccountID
deviceID = devInfo.DeviceID
}
if s.sm != nil {
if info, err := s.sm.GetLiveDeviceInfo(deviceIP); err == nil {
if info.MargeAccountUUID != "" {
accountID = info.MargeAccountUUID
}
if info.DeviceID != "" {
deviceID = info.DeviceID
}
} else {
log.Printf("[Spotify Watchdog] live /info lookup for %s failed: %v (falling back to datastore account=%q)", deviceIP, err, accountID)
}
}
return accountID, deviceID
}
// findExistingDeviceInfoByIP looks up a device record by IP address across all accounts.
func (s *Server) findExistingDeviceInfoByIP(ip string) *models.ServiceDeviceInfo {
allDevices, err := s.ds.ListAllDevices()
if err != nil {
return nil
}
for i := range allDevices {
if allDevices[i].IPAddress == ip {
return &allDevices[i]
}
}
return nil
}
func (s *Server) pushSpotifyTokenToDevice(deviceIP, username, accessToken string) error {
var zcURL string
if _, _, err := net.SplitHostPort(deviceIP); err == nil {
@@ -701,7 +816,11 @@ func (s *Server) PrimeDeviceWithAmazon(deviceIP string) {
log.Printf("[Amazon Watchdog] Proactively priming %s with Amazon user %s", deviceIP, username)
if err := s.pushAmazonTokenToDevice(deviceIP, username, accessToken); err != nil {
log.Printf("[Amazon Watchdog] Failed to prime %s: %v", deviceIP, err)
if errors.Is(err, amazon.ErrAddUserNoOp) {
log.Printf("[Amazon Watchdog] Successfully primed %s (ZeroConf addUser was an expected no-op)", deviceIP)
} else {
log.Printf("[Amazon Watchdog] Failed to prime %s: %v", deviceIP, err)
}
} else {
log.Printf("[Amazon Watchdog] Successfully primed %s", deviceIP)
}
+88 -10
View File
@@ -7,6 +7,7 @@ import (
"encoding/xml"
"fmt"
"log"
"net"
"os"
"sort"
"strconv"
@@ -1035,6 +1036,25 @@ func getAccountSources(ds *datastore.DataStore, account, lastDeviceID string) []
for i := range sources {
s := sources[i]
// Real Bose's /streaming/account/{a}/full never emitted AUX as
// a cloud-side <source> (verified across 61 captured upstream
// /full responses in scripts/android/captures/.../
// parity_mismatches/). AUX is hardware-local — the speaker
// enumerates it via isLocal=true in its own /sources response,
// it doesn't need the cloud to list it. AfterTouch emitting a
// malformed AUX entry here (with displayName=, empty
// <credential>, non-empty <name>/<username>) is the suspected
// trigger for issue #195: the speaker's source-reconciliation
// code marks AUX as cloud-side inconsistent and refuses
// dispatch, even though the local availability check reports
// it READY. We still keep AUX in getDefaultSources() because
// other call sites (default-sources init at startup, the
// SoundTouch web UI source picker) rely on it; the filter
// just keeps it out of /full's wire shape.
if s.SourceKeyType == constants.ProviderAux {
continue
}
PrepareConfiguredSource(&s)
fullSources = append(fullSources, mapToFullResponseSource(s))
}
@@ -1816,8 +1836,26 @@ func formatRecentResponse(recentObj *models.ServiceRecent, matchingSrc *models.C
return append([]byte(header+"\n"), data...)
}
// AddDeviceToAccount adds a new device to the specified account.
func AddDeviceToAccount(ds *datastore.DataStore, account string, sourceXML []byte) (string, []byte, error) {
// AddDeviceToAccount upserts a device record for the given account.
// Called by both the device-create (POST) and device-rename (PUT)
// handlers — the persistence layer doesn't distinguish; only the
// response status differs.
//
// remoteAddr is the speaker's address as seen by the HTTP server
// (r.RemoteAddr, "host:port"). When the request body doesn't carry
// an `<ipaddress>` and the datastore has no IP for this device yet,
// we fall back to remoteAddr's host portion. An empty remoteAddr
// is treated as "no fallback available" — never errors.
//
// Timestamps:
// - CreatedOn is preserved from any existing datastore record so a
// rename doesn't reset the "first paired in 2017" semantics real
// Bose emits. New devices get CreatedOn = now() at first save.
// - UpdatedOn is set to now() on every call.
//
// Returns the persisted deviceID and the marge XML response shape
// (`<device deviceid="…"><createdOn/><ipaddress/><name/><updatedOn/></device>`).
func AddDeviceToAccount(ds *datastore.DataStore, account string, sourceXML []byte, remoteAddr string) (string, []byte, error) {
var newDeviceElem struct {
DeviceID string `xml:"deviceid,attr"`
Name string `xml:"name"`
@@ -1827,28 +1865,68 @@ func AddDeviceToAccount(ds *datastore.DataStore, account string, sourceXML []byt
return "", nil, err
}
now := FormatTime(time.Now())
// Build the info to save. Empty fields are filled in by the
// datastore's mergeWithExistingDeviceInfo (which preserves IP,
// MAC, CreatedOn, etc.) before the write — so the precedence
// here is "explicit > merged > remoteAddr fallback".
info := &models.ServiceDeviceInfo{
DeviceID: newDeviceElem.DeviceID,
Name: newDeviceElem.Name,
MacAddress: newDeviceElem.MACAddress,
// Other fields will be filled by discovery later or default
UpdatedOn: now,
}
existing, _ := ds.GetDeviceInfo(account, newDeviceElem.DeviceID)
// CreatedOn: preserve from existing record for renames; set
// now() only on first registration (no prior record OR the
// record has no CreatedOn — older AfterTouch installs may
// have records without one).
if existing != nil && existing.CreatedOn != "" {
info.CreatedOn = existing.CreatedOn
} else {
info.CreatedOn = now
}
// IPAddress: prefer existing record's IP (the speaker may be
// hitting us through a different network path right now, e.g.
// SSH port-forward, and the persisted IP is the one other
// flows like DNS hints care about). Fall back to the inbound
// connection's remote address only when there's no existing
// IP to preserve. Invalid remoteAddr leaves info.IPAddress
// empty, which the merge then handles.
if existing == nil || existing.IPAddress == "" {
if remoteAddr != "" {
if host, _, splitErr := net.SplitHostPort(remoteAddr); splitErr == nil {
info.IPAddress = host
}
}
}
if err := ds.SaveDeviceInfo(account, newDeviceElem.DeviceID, info); err != nil {
return "", nil, err
}
createdOn := FormatTime(time.Now())
res := fmt.Sprintf(`<device deviceid="%s">`, EscapeXML(newDeviceElem.DeviceID))
res += fmt.Sprintf(`<createdOn>%s</createdOn>`, EscapeXML(createdOn))
res += `<ipaddress></ipaddress>`
res += fmt.Sprintf(`<name>%s</name>`, EscapeXML(newDeviceElem.Name))
res += fmt.Sprintf(`<updatedOn>%s</updatedOn>`, EscapeXML(createdOn))
// Re-read the persisted record so the response XML reflects
// the merged state (preserved CreatedOn, preserved IP if the
// new info had none and the existing record did, etc.).
persisted, err := ds.GetDeviceInfo(account, newDeviceElem.DeviceID)
if err != nil {
return "", nil, fmt.Errorf("re-read persisted device info: %w", err)
}
res := fmt.Sprintf(`<device deviceid="%s">`, EscapeXML(persisted.DeviceID))
res += fmt.Sprintf(`<createdOn>%s</createdOn>`, EscapeXML(persisted.CreatedOn))
res += fmt.Sprintf(`<ipaddress>%s</ipaddress>`, EscapeXML(persisted.IPAddress))
res += fmt.Sprintf(`<name>%s</name>`, EscapeXML(persisted.Name))
res += fmt.Sprintf(`<updatedOn>%s</updatedOn>`, EscapeXML(persisted.UpdatedOn))
res += `</device>`
header := constants.XMLHeader
return newDeviceElem.DeviceID, append([]byte(header), []byte(res)...), nil
return persisted.DeviceID, append([]byte(header), []byte(res)...), nil
}
// RemoveDeviceFromAccount removes a device from the specified account.
+35
View File
@@ -320,6 +320,41 @@ func TestStripAfterTouchEntries_UnpairedSentinelFlagged(t *testing.T) {
// runs in CI; it's the Mozilla CCADB public dataset, no per-device
// information.
//
// Cross-model note: byte-identical to the corresponding ST10
// firmware-27 bundle (verified 2026-05-16 against
// firmware/_backup_ST10/_/etc/pki/tls/certs/ca-bundle.crt — same
// md5 2d150987b312e4280fc576b508e62b43, same 165 certs). Same
// fixture stands in for both speaker models while they're on the
// same firmware build, so expired-root hypotheses (e.g. PR #292)
// should be evaluated against this single dataset.
//
// Reproduce the #292 cert-chain probe locally — point curl at this
// fixture and try the actual TuneIn stream chain a SoundTouch
// speaker would walk. If the handshake validates here, the speaker
// can also validate it (modulo any speaker-side TLS-stack quirks
// the OpenSSL binary on your laptop doesn't share). System bundle
// shown alongside for control:
//
// BUNDLE=pkg/service/setup/testdata/ca_bundle_st20_pristine.crt
//
// # Control: system trust store
// curl -sS -o /dev/null -w "%{http_code}\n" \
// "https://maestro.emfcdn.com/stream_for/k-love/tunein/hls"
//
// # Same URL, restricted to the speaker's 2022 CCADB snapshot
// curl -sS -o /dev/null -w "%{http_code}\n" --cacert "$BUNDLE" \
// "https://maestro.emfcdn.com/stream_for/k-love/tunein/hls"
//
// # Follow the 302 to the actual audio host
// curl -sSL -o /dev/null -w "%{http_code} %{url_effective}\n" \
// --cacert "$BUNDLE" \
// "https://maestro.emfcdn.com/stream_for/k-love/tunein/hls"
//
// Both bundles handle the K-LOVE chain (Amazon Root CA 1 + DigiCert
// Global Root, valid through 2026+) cleanly — recorded against
// firmware 27 on 2026-05-16, ruling out expired-root for that
// firmware vintage.
//
// The point of this test is to catch over-eager validator changes
// before they ship. An earlier iteration of validateCABundleBytes
// called x509.ParseCertificate per block — that rejected the real
+2 -2
View File
@@ -199,7 +199,7 @@ func (m *Manager) ExecuteInitPlan(ctx context.Context, plan InitPlan, progress P
}
// applyInitPlanDefaults validates required fields and fills in defaults
// from Manager.ServerURL / sysLanguage 2 / "Bearer aftertouch".
// from Manager.ServerURL / sysLanguage 2 / DefaultMargeAuthToken.
func applyInitPlanDefaults(plan InitPlan, serverURL string) (InitPlan, error) {
if plan.DeviceIP == "" {
return plan, errors.New("InitPlan.DeviceIP is required")
@@ -218,7 +218,7 @@ func applyInitPlanDefaults(plan InitPlan, serverURL string) (InitPlan, error) {
}
if plan.AuthToken == "" {
plan.AuthToken = "Bearer aftertouch"
plan.AuthToken = DefaultMargeAuthToken
}
return plan, nil
+1 -1
View File
@@ -147,7 +147,7 @@ func TestExecuteInitPlan_FactoryReset_GeneratesAccountAndRunsAllSteps(t *testing
"Enter",
"IdentifyLeave",
"SetName(Living Room)",
"SetMargeAccount(1234567,Bearer aftertouch)",
"SetMargeAccount(1234567," + DefaultMargeAuthToken + ")",
"Leave",
"PushCustomerSupportInfo",
}
@@ -185,3 +185,56 @@ func TestGetMigrationSummary_TelnetSucceedsSSHSucceeds(t *testing.T) {
t.Errorf("TelnetVerifiedConfig = %q, want %q", summary.TelnetVerifiedConfig, target)
}
}
// TestGetMigrationSummary_TelnetOnlyMigrationDetected pins the ordering
// bug fixed in PR #294 / issue #293.
//
// Before the fix, GetMigrationSummary called checkIsMigratedFromProbe
// before draining the telnet goroutine's result, so
// summary.TelnetVerifiedConfig was empty when isTelnetMigrated read it
// — and the telnet axis was always reported false. For speakers
// migrated *only* via telnet (envswitch flip; no SSH XML rewrite,
// no DNS hook, no CA install), this misclassification meant
// summary.IsMigrated was false despite the speaker actually pointing
// at AfterTouch. The CLI's `setup verify` exited non-zero, and the
// web UI rendered "Not Migrated".
//
// The fix moves m.checkIsMigratedFromProbe(summary, probe) to run
// *after* the <-telnetCh drain, so TelnetVerifiedConfig is populated
// when isTelnetMigrated inspects it.
//
// The scenario here matches foob61451's 2026-05-16 #293 reproducer:
// SSH unavailable / disabled (every axis false), telnet getpdo reports
// the AfterTouch host, no other migration path applied.
func TestGetMigrationSummary_TelnetOnlyMigrationDetected(t *testing.T) {
target := "http://example:8000"
ft := &fakeTelnet{
banner: "BoseShell\n-> ",
responses: map[string]string{
"getpdo CurrentSystemConfiguration": "margeServerUrl=" + target + "\n",
},
}
m, host, cleanup := telnetSummaryEnv(t, nil, ft)
defer cleanup()
summary, err := m.GetMigrationSummary(host, "", "", nil)
if err != nil {
t.Fatalf("GetMigrationSummary: %v", err)
}
// Pre-condition for the test to be meaningful: the telnet probe
// must have populated TelnetVerifiedConfig. Without this, the
// downstream assertions could pass trivially.
if !strings.Contains(summary.TelnetVerifiedConfig, target) {
t.Fatalf("setup: TelnetVerifiedConfig = %q, want it to contain %q", summary.TelnetVerifiedConfig, target)
}
if !summary.TelnetMigrated {
t.Errorf("TelnetMigrated = false, want true — telnet getpdo reports %q which matches Manager.ServerURL host. Likely regression of PR #294 ordering fix in GetMigrationSummary.", target)
}
if !summary.IsMigrated {
t.Errorf("IsMigrated = false, want true — telnet axis should carry IsMigrated when SSH-driven axes are false. Likely regression of PR #294 ordering fix.")
}
}
+87 -24
View File
@@ -92,7 +92,18 @@ type MigrationSummary struct {
// flag pairing as a precondition independently of the URL flip.
IsPaired bool `json:"is_paired"`
ResolveIPError string `json:"resolve_ip_error,omitempty"`
ResolveIPError string `json:"resolve_ip_error,omitempty"`
// ResolveIPSource records where the resolved IP came from:
// "device" — authoritative answer via SSH ping (preferred for
// migration). "service" — service-side DNS lookup (fast but may
// differ when NAT or split-DNS is in play). Empty when host was
// already an IP literal or could not be resolved at all.
ResolveIPSource string `json:"resolve_ip_source,omitempty"`
// ResolveIPDurationMS measures how long the resolve call took
// (wall-clock, milliseconds). Captured during preflight so we can
// observe the SSH-ping cost in the wild.
ResolveIPDurationMS int64 `json:"resolve_ip_duration_ms,omitempty"`
MirrorEnabled bool `json:"mirror_enabled"`
MirrorEndpoints []string `json:"mirror_endpoints,omitempty"`
SkipMirrorEndpoints []string `json:"skip_mirror_endpoints,omitempty"`
@@ -323,17 +334,21 @@ func (m *Manager) GetMigrationSummary(deviceIP, targetURL, proxyURL string, opti
summary.PlannedConfig = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n" + string(xmlContent)
// 2b. Planned network config (hosts entries, resolv.conf preview, resolve error)
m.populatePlannedNetworkConfig(summary, deviceIP, targetURL)
// 2b. Planned network config (hosts entries, resolv.conf preview, resolve error).
// Pass an SSH client only when the probe succeeded — opening a fresh
// dial when we already know SSH is dead would burn ~handshake-timeout
// of wall time per refresh.
var resolveClient SSHClient
if probe.SSHOK && m.NewSSH != nil {
resolveClient = m.NewSSH(deviceIP)
}
m.populatePlannedNetworkConfig(summary, deviceIP, targetURL, resolveClient)
// 3. Provide HTTPS URL for testing (consumed by the migration UI)
summary.ServerHTTPSURL = m.buildServerHTTPSURL(targetURL)
// 4. Check if migrated (telnet axis uses the parallel preflight;
// XML/hosts/resolv axes use the probe data already gathered above).
m.checkIsMigratedFromProbe(summary, probe)
// 7. Mirroring settings
// 4. Mirroring settings
if m.DataStore != nil {
settings, err := m.DataStore.GetSettings()
if err == nil {
@@ -344,21 +359,26 @@ func (m *Manager) GetMigrationSummary(deviceIP, targetURL, proxyURL string, opti
}
}
// 8. Merge telnet preflight results (started in parallel at the top).
// 5. Merge telnet preflight results (started in parallel at the top).
telnetResult := <-telnetCh
summary.TelnetReachable = telnetResult.TelnetReachable
summary.TelnetBanner = telnetResult.TelnetBanner
summary.TelnetVerifiedConfig = telnetResult.TelnetVerifiedConfig
summary.TelnetProbeError = telnetResult.TelnetProbeError
// 9. Cross-check SSH-XML and telnet-getpdo readings; surface any
// 6. Check if migrated (must run after telnet results are merged so
// TelnetVerifiedConfig is populated). XML/hosts/resolv axes use the
// probe data already gathered above.
m.checkIsMigratedFromProbe(summary, probe)
// 7. Cross-check SSH-XML and telnet-getpdo readings; surface any
// divergence as a non-fatal warning.
m.crossCheckPreflights(summary)
return summary, nil
}
func (m *Manager) populatePlannedNetworkConfig(summary *MigrationSummary, _, targetURL string) {
func (m *Manager) populatePlannedNetworkConfig(summary *MigrationSummary, _, targetURL string, sshClient SSHClient) {
parsedURL, err := url.Parse(targetURL)
if err != nil {
return
@@ -369,14 +389,42 @@ func (m *Manager) populatePlannedNetworkConfig(summary *MigrationSummary, _, tar
return
}
// Resolve locally only. The "from-device" lookup that resolveIP can
// do via SSH (`ping -c 1 host`) costs another fresh SSH handshake
// plus the ping's own runtime — easily 25 s on firmware-27 devices
// — and the result feeds only the PlannedResolv/PlannedHosts preview.
// For the actual apply paths (migrateViaHosts/migrateViaResolv) the
// device-side resolution is still used; this is only the preview.
hostIP, resolveErr := m.resolveIP(hostName, nil)
if resolveErr != nil {
// Resolve the target hostname. When the caller provides an SSH
// client (i.e. the speaker already answered the probe), we prefer
// the device-side lookup — it's authoritative for the actual
// network path the speaker will use. When SSH isn't available we
// fall back to service-side DNS and tag the result with
// ErrResolvedFromServiceOnly so the summary can render it as
// informational rather than as a hard error.
//
// Historical note: the SSH path was previously skipped here for
// cost reasons (a comment claimed "25 s extra per preflight
// refresh"). Measured 2026-05-16 across ST10 + ST20 on firmware
// 27.0.6.46330.5043500: ~290 ms ± 10 ms per resolve, three runs.
// Well under the original estimate — promoted to the default path.
// ResolveIPDurationMS stays on the summary so any regression
// (firmware upgrade, slower kex, etc.) is visible.
start := time.Now()
hostIP, resolveErr := m.resolveIP(hostName, sshClient)
summary.ResolveIPDurationMS = time.Since(start).Milliseconds()
switch {
case resolveErr == nil && hostIP != "":
summary.ResolveIPSource = "device"
if sshClient == nil {
// Caller didn't ask for the SSH path, and we got a clean
// answer — that only happens when host was already an IP
// literal. Source is neither "device" nor "service" in a
// meaningful sense; leave it empty.
summary.ResolveIPSource = ""
}
case errors.Is(resolveErr, ErrResolvedFromServiceOnly):
summary.ResolveIPSource = "service"
// Sentinel-tagged errors are informational — the resolved IP
// is still usable for the preview, the caller just shouldn't
// treat it as authoritative. We do NOT populate ResolveIPError
// here; the CLI/UI use that field for hard failures only.
case resolveErr != nil:
summary.ResolveIPError = resolveErr.Error()
}
@@ -2388,11 +2436,20 @@ func (m *Manager) GetResolvedIP(host string) string {
return ip
}
// ErrResolvedFromServiceOnly is returned (wrapped) by resolveIP when the
// service-side DNS fallback produced an IP but the device-side SSH ping
// either wasn't attempted or didn't yield a usable result. The error
// carries the resolved IP — callers that don't need an authoritative
// device-side answer (preview/summary builders) can errors.Is()-check
// and treat the IP as informational. Apply-path callers that DO need
// authoritative resolution can bail.
var ErrResolvedFromServiceOnly = errors.New("resolved from service, not from device")
// resolveIP resolves a hostname to an IP address.
// It first tries to resolve from the device via SSH ping (authoritative for migration).
// If that fails, it falls back to resolving from the service itself.
// An error is returned whenever the SSH ping did not produce the IP, so callers that
// write config to the device can abort rather than risk writing an unresolvable hostname.
// If that fails, it falls back to resolving from the service itself, returning the
// resolved IP wrapped with ErrResolvedFromServiceOnly so callers can distinguish
// "authoritative device-side answer" from "best-effort service-side fallback".
func (m *Manager) resolveIP(host string, client SSHClient) (string, error) {
if net.ParseIP(host) != nil {
return host, nil
@@ -2438,7 +2495,8 @@ func (m *Manager) resolveIP(host string, client SSHClient) (string, error) {
resolved = ips[0].String()
}
return resolved, fmt.Errorf("resolved %q to %s from service, not from device — result may be wrong if NAT or split-DNS is in use", host, resolved)
return resolved, fmt.Errorf("%w: %q %s (NAT or split-DNS may differ from what the device would see)",
ErrResolvedFromServiceOnly, host, resolved)
}
// SyncDeviceData fetches presets, recents and sources from the device and saves them to the datastore.
@@ -2530,7 +2588,12 @@ func (m *Manager) syncPresets(deviceIP, accountID, deviceID string) {
var servicePresets []models.ServicePreset
for _, p := range ps.Preset {
if p.ContentItem == nil {
// IsEmpty catches both placeholder shapes a SoundTouch device
// can emit: self-closing <preset/> (issue #308) and
// <ContentItem source="INVALID_SOURCE"/>. Neither carries
// real playable data and persisting them would surface as
// junk entries in the admin web UI.
if p.IsEmpty() {
continue
}
+101 -14
View File
@@ -21,8 +21,53 @@ const (
// LanguageEnglish is the sysLanguage code for English. 2 is the
// value the official Bose app sends during English-locale setup.
LanguageEnglish = 2
// DefaultMargeAuthToken is the placeholder userAuthToken sent in
// <PairDeviceWithAccount> when the caller didn't supply one. The
// speaker accepts any non-empty value; a real Bose-issued token
// shape (128-char base64 per docs/reference/DEVICE-PAIRING-FLOW.md
// line 154) is not required — verified during #195 investigation
// where the speaker happily persisted "Bearer AfterTouch" and
// re-derived its post-pair state from the marge endpoints
// regardless of token content.
DefaultMargeAuthToken = "Bearer AfterTouch"
// DefaultMargePairingEmail is the synthetic accountEmail used when
// PairingExtras requests the extended <PairDeviceWithAccount> payload
// but doesn't supply an email. RFC 2606 reserves ".invalid" as a TLD
// guaranteed never to resolve, which is what we want here — the
// speaker writes it into its persistent state but no real address
// receives anything.
DefaultMargePairingEmail = "local@aftertouch.invalid"
)
// MargePairingExtras carries the optional fields that the official Bose
// Android app and Zimbo88's USB-less OpenCloudTouch script include in
// their <PairDeviceWithAccount> payloads. AfterTouch historically sent
// only <accountId> + <userAuthToken>; that minimal shape is the
// suspected trigger for the post-pair AUX/preset breakage tracked in
// issues #195 and #269.
//
// Set BoseServer (and optionally UpdateServer/AccountEmail) on the
// SessionConfig to opt into the richer payload. Empty fields are
// omitted from the XML so callers can choose any subset.
//
// Reference: docs/reference/DEVICE-PAIRING-FLOW.md and
// https://github.com/scheilch/opencloudtouch/discussions/201.
type MargePairingExtras struct {
// BoseServer is the marge server URL the speaker should use after
// pairing. Typically equal to AfterTouch's service URL.
BoseServer string
// UpdateServer is the firmware-update server URL. If empty and
// BoseServer is set, SetMargeAccount derives it as
// BoseServer + "/updates/soundtouch".
UpdateServer string
// AccountEmail is the synthetic email persisted alongside the
// account. If empty and BoseServer is set, SetMargeAccount fills
// in DefaultMargePairingEmail.
AccountEmail string
}
// StateMachine is the surface the InitPlan orchestrator drives. The
// concrete WebSocket-backed implementation is *Session; tests inject
// an in-memory fake via Manager.NewSession.
@@ -52,6 +97,11 @@ type SessionConfig struct {
WSScheme string
// WSPort overrides 8080 when deviceIP does not already carry a port.
WSPort int
// PairingExtras opts the session into the richer
// <PairDeviceWithAccount> payload (boseServer / updateServer /
// accountEmail) used by the official Bose Android app. Zero value
// retains the historical minimal payload.
PairingExtras MargePairingExtras
}
// Session is a synchronous request/response WebSocket session driving
@@ -60,10 +110,11 @@ type SessionConfig struct {
// and stateful) — setup is a short, linear sequence and benefits from a
// purpose-built transport.
type Session struct {
deviceID string
conn *websocket.Conn
reqID atomic.Int64
stepTimeout time.Duration
deviceID string
conn *websocket.Conn
reqID atomic.Int64
stepTimeout time.Duration
pairingExtras MargePairingExtras
}
// DialSession opens a WebSocket to the speaker at deviceIP and
@@ -117,7 +168,12 @@ func DialSession(deviceIP, deviceID string, cfg SessionConfig) (*Session, error)
step = defaultSetupStepTimeout
}
return &Session{deviceID: deviceID, conn: conn, stepTimeout: step}, nil
return &Session{
deviceID: deviceID,
conn: conn,
stepTimeout: step,
pairingExtras: cfg.PairingExtras,
}, nil
}
// Close sends a normal-closure frame and closes the underlying socket.
@@ -243,24 +299,55 @@ func (s *Session) SetName(ctx context.Context, name string) error {
}
// SetMargeAccount sends the canonical PairDeviceWithAccount envelope.
// authToken defaults to "Bearer aftertouch" when empty — our local
// service does not validate it, but a non-empty value matches the
// official app's shape.
// authToken defaults to DefaultMargeAuthToken when empty.
//
// If SessionConfig.PairingExtras.BoseServer is set, the payload is
// extended with <boseServer>, <updateServer>, and <accountEmail>
// matching the official Bose app's shape (and Zimbo88's OpenCloudTouch
// USB-less script). UpdateServer and AccountEmail derive from
// BoseServer when not explicitly set.
func (s *Session) SetMargeAccount(ctx context.Context, accountID, authToken string) error {
if accountID == "" {
return errors.New("SetMargeAccount: accountID is required")
}
if authToken == "" {
authToken = "Bearer aftertouch"
authToken = DefaultMargeAuthToken
}
body := fmt.Sprintf(
`<PairDeviceWithAccount><accountId>%s</accountId><userAuthToken>%s</userAuthToken></PairDeviceWithAccount>`,
xmlBodyEscape(accountID), xmlBodyEscape(authToken),
)
return s.sendStep(ctx, "setMargeAccount", "POST", buildPairDeviceWithAccountXML(accountID, authToken, s.pairingExtras))
}
return s.sendStep(ctx, "setMargeAccount", "POST", body)
// buildPairDeviceWithAccountXML serializes the <PairDeviceWithAccount>
// body. Extracted so tests can pin the exact shape without driving a
// full WebSocket session.
func buildPairDeviceWithAccountXML(accountID, authToken string, extras MargePairingExtras) string {
var b strings.Builder
b.WriteString(`<PairDeviceWithAccount>`)
b.WriteString(`<accountId>` + xmlBodyEscape(accountID) + `</accountId>`)
b.WriteString(`<userAuthToken>` + xmlBodyEscape(authToken) + `</userAuthToken>`)
if extras.BoseServer != "" {
b.WriteString(`<boseServer>` + xmlBodyEscape(extras.BoseServer) + `</boseServer>`)
updateServer := extras.UpdateServer
if updateServer == "" {
updateServer = strings.TrimRight(extras.BoseServer, "/") + "/updates/soundtouch"
}
b.WriteString(`<updateServer>` + xmlBodyEscape(updateServer) + `</updateServer>`)
email := extras.AccountEmail
if email == "" {
email = DefaultMargePairingEmail
}
b.WriteString(`<accountEmail>` + xmlBodyEscape(email) + `</accountEmail>`)
}
b.WriteString(`</PairDeviceWithAccount>`)
return b.String()
}
// Leave sends SETUP_LEAVE.
+64 -1
View File
@@ -184,7 +184,7 @@ func TestSession_SendsCanonicalEnvelopes(t *testing.T) {
mustContain(t, frames[3], `<setupState state="SETUP_ENTER"/>`)
mustContain(t, frames[4], `<setupState state="SETUP_IDENTIFY_DEVICE_LEAVE"/>`)
mustContain(t, frames[5], `url="name"`, `<name>Living Room</name>`)
mustContain(t, frames[6], `url="setMargeAccount"`, `<accountId>1234567</accountId>`, `<userAuthToken>Bearer aftertouch</userAuthToken>`)
mustContain(t, frames[6], `url="setMargeAccount"`, `<accountId>1234567</accountId>`, `<userAuthToken>`+DefaultMargeAuthToken+`</userAuthToken>`)
mustContain(t, frames[7], `<setupState state="SETUP_LEAVE"/>`)
mustContain(t, frames[8], `url="pushCustomerSupportInfoToMarge"`, `method="GET"`)
}
@@ -301,6 +301,69 @@ func TestSession_XMLAttributeEscape(t *testing.T) {
mustContain(t, frames[0], `deviceID="quoted&quot;&lt;id>"`)
}
// TestBuildPairDeviceWithAccountXML pins both the minimal-payload
// shape (historical AfterTouch behaviour) and the extended-payload
// shape introduced for #195/#269 investigation. The extended path
// mirrors what the official Bose app and Zimbo88's OpenCloudTouch
// USB-less script send (see docs/reference/DEVICE-PAIRING-FLOW.md
// and https://github.com/scheilch/opencloudtouch/discussions/201).
func TestBuildPairDeviceWithAccountXML(t *testing.T) {
t.Run("minimal payload — no extras", func(t *testing.T) {
got := buildPairDeviceWithAccountXML("1234567", "Bearer tok", MargePairingExtras{})
want := `<PairDeviceWithAccount>` +
`<accountId>1234567</accountId>` +
`<userAuthToken>Bearer tok</userAuthToken>` +
`</PairDeviceWithAccount>`
if got != want {
t.Errorf("\n got: %s\nwant: %s", got, want)
}
})
t.Run("extended payload — BoseServer triggers derived defaults", func(t *testing.T) {
got := buildPairDeviceWithAccountXML(
"1234567", "Bearer tok",
MargePairingExtras{BoseServer: "https://soundtouch.local"},
)
mustContain(t, got,
`<boseServer>https://soundtouch.local</boseServer>`,
`<updateServer>https://soundtouch.local/updates/soundtouch</updateServer>`,
`<accountEmail>`+DefaultMargePairingEmail+`</accountEmail>`,
)
})
t.Run("extended payload — explicit UpdateServer + AccountEmail honoured", func(t *testing.T) {
got := buildPairDeviceWithAccountXML(
"1234567", "Bearer tok",
MargePairingExtras{
BoseServer: "https://example.test",
UpdateServer: "https://updates.example.test/firmware",
AccountEmail: "user@example.test",
},
)
mustContain(t, got,
`<boseServer>https://example.test</boseServer>`,
`<updateServer>https://updates.example.test/firmware</updateServer>`,
`<accountEmail>user@example.test</accountEmail>`,
)
})
t.Run("extended payload — BoseServer trailing slash trimmed when deriving UpdateServer", func(t *testing.T) {
got := buildPairDeviceWithAccountXML(
"1234567", "Bearer tok",
MargePairingExtras{BoseServer: "https://soundtouch.local/"},
)
// Derived path uses TrimRight on BoseServer so we don't get
// "soundtouch.local//updates/soundtouch".
mustContain(t, got,
`<updateServer>https://soundtouch.local/updates/soundtouch</updateServer>`,
)
})
}
func mustContain(t *testing.T, s string, needles ...string) {
t.Helper()
+53
View File
@@ -2,6 +2,7 @@ package setup
import (
"encoding/base64"
"errors"
"fmt"
"net/http"
"net/http/httptest"
@@ -735,6 +736,58 @@ func TestResolveIP(t *testing.T) {
}
}
// TestResolveIP_ServiceFallbackTagsSentinel pins the #282 fix:
// service-side fallback returns the resolved IP wrapped with
// ErrResolvedFromServiceOnly. Callers can errors.Is()-check the
// sentinel to distinguish informational fallback from a hard
// failure, which fixes the long-standing CLI/UI ❌ row that appeared
// every time a hostname target was used with SSH off.
func TestResolveIP_ServiceFallbackTagsSentinel(t *testing.T) {
m := &Manager{}
// No SSH client → forces the service-side fallback path.
ip, err := m.resolveIP("localhost", nil)
if ip != "127.0.0.1" && ip != "::1" {
t.Fatalf("expected localhost to resolve service-side, got ip=%q err=%v", ip, err)
}
if err == nil {
t.Fatalf("expected service-side fallback to surface ErrResolvedFromServiceOnly, got nil err")
}
if !errors.Is(err, ErrResolvedFromServiceOnly) {
t.Errorf("expected error to wrap ErrResolvedFromServiceOnly, got %v", err)
}
}
// TestResolveIP_DeviceSuccessReturnsNilError keeps the happy-path
// guarantee explicit alongside the sentinel-tagging contract above.
func TestResolveIP_DeviceSuccessReturnsNilError(t *testing.T) {
m := &Manager{}
mock := &mockSSH{
runFunc: func(command string) (string, error) {
if strings.Contains(command, "ping -c 1 myhost") {
return "PING myhost (10.0.0.5): 56 data bytes", nil
}
return "", nil
},
}
ip, err := m.resolveIP("myhost", mock)
if ip != "10.0.0.5" {
t.Errorf("expected 10.0.0.5, got %s", ip)
}
if err != nil {
t.Errorf("device-side success must return nil error, got %v", err)
}
if errors.Is(err, ErrResolvedFromServiceOnly) {
t.Errorf("device-side success must NOT carry ErrResolvedFromServiceOnly sentinel")
}
}
func TestMigrateViaHosts_SkipCAIfTrusted(t *testing.T) {
tempDir, err := os.MkdirTemp("", "setup-test-skip-ca")
if err != nil {
+68 -16
View File
@@ -42,6 +42,11 @@ type PushWiFiCredentialsParams struct {
//
// The speaker confirms the request before disconnecting; expect to lose
// the AP link within ~30 seconds.
//
// Empirically the first POST often races the speaker's setup endpoint
// readiness — the connection times out, then a second POST a few seconds
// later succeeds immediately. We retry once internally so the caller
// doesn't have to.
func PushWiFiCredentials(ctx context.Context, p PushWiFiCredentialsParams) error {
if p.SSID == "" {
return fmt.Errorf("PushWiFiCredentials: SSID is required")
@@ -69,31 +74,78 @@ func PushWiFiCredentials(ctx context.Context, p PushWiFiCredentialsParams) error
url := "http://" + hostPort + "/addWirelessProfile"
req, err := http.NewRequestWithContext(ctx, http.MethodPost, url, strings.NewReader(body))
if err != nil {
return fmt.Errorf("build request: %w", err)
}
req.Header.Set("Content-Type", "text/xml")
httpClient := p.HTTPClient
if httpClient == nil {
httpClient = &http.Client{Timeout: 10 * time.Second}
// No client-side timeout: let the per-attempt sub-context
// govern. The CLI passes a context deadline (default 30 s
// in setupWiFiPushCmd) and a hard-coded 10 s here would
// race it for no benefit.
httpClient = &http.Client{}
}
resp, err := httpClient.Do(req)
if err != nil {
return fmt.Errorf("POST %s: %w", url, err)
// Per-attempt cap so a stuck first attempt doesn't burn the whole
// budget. 12 s is well above the typical sub-second response time
// when the endpoint is healthy, and the failure mode we're working
// around (first attempt hangs until the deadline elapses) means
// any value here is mostly a sub-budget for a stuck attempt.
const perAttemptTimeout = 12 * time.Second
// Pause between attempts gives the speaker's setup endpoint a
// moment to finish whatever initialization the first POST kicked
// off (the empirical workaround that motivated this retry).
const interAttemptDelay = 2 * time.Second
attempt := func(ctx context.Context) error {
req, err := http.NewRequestWithContext(ctx, http.MethodPost, url, strings.NewReader(body))
if err != nil {
return fmt.Errorf("build request: %w", err)
}
req.Header.Set("Content-Type", "text/xml")
resp, err := httpClient.Do(req)
if err != nil {
return fmt.Errorf("POST %s: %w", url, err)
}
defer func() { _ = resp.Body.Close() }()
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
respBody, _ := io.ReadAll(resp.Body)
return fmt.Errorf("POST %s returned %d: %s", url, resp.StatusCode, strings.TrimSpace(string(respBody)))
}
return nil
}
defer func() { _ = resp.Body.Close() }()
// Two attempts: the second is silent on the wire when the first
// already succeeded (returns at the first non-error), or carries
// the recovery when the first failed.
const maxAttempts = 2
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
respBody, _ := io.ReadAll(resp.Body)
return fmt.Errorf("POST %s returned %d: %s", url, resp.StatusCode, strings.TrimSpace(string(respBody)))
var lastErr error
for i := 0; i < maxAttempts; i++ {
if i > 0 {
select {
case <-time.After(interAttemptDelay):
case <-ctx.Done():
return fmt.Errorf("PushWiFiCredentials: %w (last attempt error: %w)", ctx.Err(), lastErr)
}
}
attemptCtx, cancel := context.WithTimeout(ctx, perAttemptTimeout)
err := attempt(attemptCtx)
cancel()
if err == nil {
return nil
}
lastErr = err
}
return nil
return fmt.Errorf("PushWiFiCredentials: both attempts failed (last: %w)", lastErr)
}
// PollConfig governs the retry cadence of WaitForAP and WaitForOnline.
+5
View File
@@ -2,6 +2,11 @@ package spotify
import "github.com/gesellix/bose-soundtouch/pkg/service/zeroconf"
// ErrAddUserNoOp re-exports zeroconf.ErrAddUserNoOp so callers in the spotify
// package don't need a direct dependency on the zeroconf package to recognise
// the benign-no-op sentinel.
var ErrAddUserNoOp = zeroconf.ErrAddUserNoOp
// ZeroConfGetInfo fetches the speaker's DH public key via GET ?action=getInfo.
func ZeroConfGetInfo(zcBaseURL string) ([]byte, error) {
return zeroconf.GetInfo(zcBaseURL)
+63
View File
@@ -12,6 +12,7 @@ import (
"crypto/sha1"
"encoding/base64"
"encoding/json"
"errors"
"fmt"
"io"
"log"
@@ -19,6 +20,7 @@ import (
"net"
"net/http"
"net/url"
"strings"
"time"
)
@@ -26,6 +28,15 @@ import (
// (AUTHENTICATION_SPOTIFY_TOKEN = 4). Both Spotify and Amazon use this value.
const AuthTypeOAuthToken uint64 = 4
// ErrAddUserNoOp signals a benign 404-with-empty-body reply from the speaker's
// ?action=addUser endpoint. SoundTouch firmware uses that exact response shape
// to mean "no transition required" — typically because the requested
// activeUser is already the active one. It is NOT a credential or transport
// failure; the speaker silently kept its current state. Callers that have
// already written the authoritative source record to marge (the path
// presets/playback actually go through) should treat this as success.
var ErrAddUserNoOp = errors.New("zeroconf: addUser no-op (speaker already in target state)")
// dhPrimeBytes is the 768-bit MODP Group 1 prime from RFC 2409 §6.1.
var dhPrimeBytes = []byte{
0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
@@ -333,12 +344,56 @@ func PushCredentials(zcBaseURL, username, accessToken string) error {
if resp.StatusCode != http.StatusOK {
body, _ := io.ReadAll(resp.Body)
if isAddUserNoOp(resp.StatusCode, body) {
logAddUserNoOp("DH", base, username, resp)
return ErrAddUserNoOp
}
logAddUserFailure("DH", base, username, resp, body)
return fmt.Errorf("pushCredentials: addUser status %d: %s", resp.StatusCode, body)
}
return nil
}
// isAddUserNoOp recognises the narrow firmware pattern (status 404, empty body)
// that signals "no transition required". Anything else — including 404 with a
// body, or any other non-2xx — falls through to the real failure path so we
// don't silently swallow genuine errors.
func isAddUserNoOp(status int, body []byte) bool {
return status == http.StatusNotFound && len(bytes.TrimSpace(body)) == 0
}
// logAddUserNoOp emits a single line marking the benign no-op explicitly —
// kept visible (not Debug-level) so the operator can correlate it with priming
// runs, but worded so it's clearly not a failure.
func logAddUserNoOp(path string, base *url.URL, username string, resp *http.Response) {
log.Printf("[ZeroConf] addUser produced expected no-op via %s path (speaker already has activeUser=%q or equivalent state): url=%s status=%d body=<empty> — marge source registration is authoritative for preset/playback",
path, username, withAction(base, "addUser"), resp.StatusCode)
}
// logAddUserFailure emits a single diagnostic line capturing what the speaker
// said about an `?action=addUser` rejection. Bose firmware often returns 4xx
// with an empty body, so the headers (libspotify version, content-type,
// content-length) are the only clue about whether the speaker refused the
// transition, the credential, or the action entirely. Kept verbose on purpose —
// these failures are rare and worth grepping for.
func logAddUserFailure(path string, base *url.URL, username string, resp *http.Response, body []byte) {
ct := resp.Header.Get("Content-Type")
cl := resp.Header.Get("Content-Length")
server := resp.Header.Get("Server")
bodySummary := strings.TrimSpace(string(body))
if bodySummary == "" {
bodySummary = "<empty>"
}
log.Printf("[ZeroConf] addUser rejected via %s path: url=%s userName=%q status=%d server=%q content-type=%q content-length=%q body=%q",
path, withAction(base, "addUser"), username, resp.StatusCode, server, ct, cl, bodySummary)
}
// pushSimplifiedToken is the fallback for firmware that does not support DH
// key exchange. It sends the raw OAuth access token directly as the blob.
func pushSimplifiedToken(zcBaseURL, username, accessToken string) error {
@@ -364,6 +419,14 @@ func pushSimplifiedToken(zcBaseURL, username, accessToken string) error {
if resp.StatusCode != http.StatusOK {
body, _ := io.ReadAll(resp.Body)
if isAddUserNoOp(resp.StatusCode, body) {
logAddUserNoOp("simplified", base, username, resp)
return ErrAddUserNoOp
}
logAddUserFailure("simplified", base, username, resp, body)
return fmt.Errorf("pushSimplifiedToken: status %d: %s", resp.StatusCode, body)
}
+110
View File
@@ -3,6 +3,7 @@ package zeroconf
import (
"encoding/base64"
"encoding/json"
"errors"
"fmt"
"net/http"
"net/http/httptest"
@@ -363,3 +364,112 @@ func TestValidateZcBaseURL(t *testing.T) {
})
}
}
// TestPushCredentials_AddUserNoOp covers the firmware quirk we observed in
// production: ?action=addUser sometimes returns 404 with an empty body when
// the speaker already has the requested user as its active one. That is NOT a
// failure — the speaker silently kept its state. PushCredentials must signal
// this via ErrAddUserNoOp so the watchdog can demote it from "Failed to prime"
// to a benign success.
func TestPushCredentials_AddUserNoOp(t *testing.T) {
_, speakerPublicBytes, err := GenerateDHKeyPair()
if err != nil {
t.Fatalf("speaker keygen: %v", err)
}
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
switch r.URL.Query().Get("action") {
case "getInfo":
w.Header().Set("Content-Type", "application/json")
_ = json.NewEncoder(w).Encode(map[string]interface{}{
"status": 101,
"publicKey": base64.StdEncoding.EncodeToString(speakerPublicBytes),
})
case "addUser":
// Firmware no-op: 404 + empty body, no Server / Content-Type header.
w.WriteHeader(http.StatusNotFound)
default:
http.NotFound(w, r)
}
}))
defer srv.Close()
err = PushCredentials(srv.URL+"/zc", "gesellix", "fresh-access-token")
if !errors.Is(err, ErrAddUserNoOp) {
t.Fatalf("PushCredentials: got %v, want ErrAddUserNoOp", err)
}
}
// TestPushCredentials_AddUserNoOpInSimplifiedPath asserts the same narrow
// pattern is recognised on the simplified-token fallback (firmware that
// 404s getInfo entirely).
func TestPushCredentials_AddUserNoOpInSimplifiedPath(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
switch r.URL.Query().Get("action") {
case "getInfo":
http.Error(w, "not supported", http.StatusNotFound)
case "addUser":
w.WriteHeader(http.StatusNotFound) // empty body
default:
http.NotFound(w, r)
}
}))
defer srv.Close()
err := PushCredentials(srv.URL+"/zc", "gesellix", "raw-access-token")
if !errors.Is(err, ErrAddUserNoOp) {
t.Fatalf("PushCredentials (simplified path): got %v, want ErrAddUserNoOp", err)
}
}
// TestPushCredentials_AddUserRealError_NotMisclassified guards the narrowness
// of isAddUserNoOp: a 404 *with* a body (or any non-404 error) must still
// surface as a regular error, not the benign sentinel. Otherwise we'd silently
// swallow genuine credential rejections that happen to come back as 4xx.
func TestPushCredentials_AddUserRealError_NotMisclassified(t *testing.T) {
_, speakerPublicBytes, err := GenerateDHKeyPair()
if err != nil {
t.Fatalf("speaker keygen: %v", err)
}
cases := []struct {
name string
status int
body string
}{
{"404 with body should NOT be no-op", http.StatusNotFound, "spotifyError=12 invalid_token"},
{"400 empty body should NOT be no-op", http.StatusBadRequest, ""},
{"500 empty body should NOT be no-op", http.StatusInternalServerError, ""},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
switch r.URL.Query().Get("action") {
case "getInfo":
w.Header().Set("Content-Type", "application/json")
_ = json.NewEncoder(w).Encode(map[string]interface{}{
"status": 101,
"publicKey": base64.StdEncoding.EncodeToString(speakerPublicBytes),
})
case "addUser":
w.WriteHeader(tc.status)
if tc.body != "" {
_, _ = w.Write([]byte(tc.body))
}
default:
http.NotFound(w, r)
}
}))
defer srv.Close()
err := PushCredentials(srv.URL+"/zc", "gesellix", "fresh-access-token")
if err == nil {
t.Fatalf("expected error, got nil")
}
if errors.Is(err, ErrAddUserNoOp) {
t.Errorf("got ErrAddUserNoOp, want a real failure for status=%d body=%q", tc.status, tc.body)
}
})
}
}
+1 -1
View File
@@ -1,7 +1,7 @@
#!/bin/bash
set -eo pipefail
VERSION=${VERSION:-0.79.0}
VERSION=${VERSION:-0.80.1}
GH_REPO=${GH_REPO:-gesellix/Bose-SoundTouch}
BINARY_URL=${BINARY_URL:-https://github.com/$GH_REPO/releases/download/v$VERSION/soundtouch-service-v$VERSION-linux-armv7}
INIT_SCRIPT_URL=${INIT_SCRIPT_URL:-https://raw.githubusercontent.com/$GH_REPO/v$VERSION/scripts/on-device-install/aftertouch}
+1 -1
View File
@@ -28,7 +28,7 @@ You can override defaults:
```bash
sudo \
VERSION=v0.79.0 \
VERSION=v0.80.1 \
HOSTNAME_FQDN=soundtouch.local \
HTTP_PORT=80 \
HTTPS_PORT=443 \
+4 -4
View File
@@ -10,7 +10,7 @@ set -euo pipefail
# Examples (override defaults via env vars):
#
# sudo \
# VERSION=v0.78.0 \
# VERSION=v0.80.0 \
# HOSTNAME_FQDN=soundtouch.local \
# HTTP_PORT=80 \
# HTTPS_PORT=443 \
@@ -18,7 +18,7 @@ set -euo pipefail
# bash install.sh
#
# Or with a version argument to perform an update:
# sudo bash install.sh v0.79.0
# sudo bash install.sh v0.80.1
#
# Notes:
# - This script downloads a release binary for your CPU (auto-detects armv7/arm64/amd64).
@@ -28,7 +28,7 @@ set -euo pipefail
# - Safe to re-run; it will update binary/config/unit and restart the service.
# ==============================================================================
VERSION="${1:-${VERSION:-v0.79.0}}"
VERSION="${1:-${VERSION:-v0.80.1}}"
# Normalize version prefix
if [[ ! "$VERSION" =~ ^v ]]; then
VERSION="v${VERSION}"
@@ -117,7 +117,7 @@ detect_arch_asset() {
download_url_for() {
local asset="$1"
# Release asset pattern used by you earlier:
# soundtouch-service-v0.17.0-linux-armv7
# soundtouch-service-v0.80.1-linux-armv7
echo "https://github.com/gesellix/Bose-SoundTouch/releases/download/${VERSION}/soundtouch-service-${VERSION}-${asset}"
}
+1
View File
@@ -1,3 +1,4 @@
2026*/
data/
integration/testdata/
integration/testdata*/
@@ -18,14 +18,20 @@ Authorization: Bearer dummy-token
client.assert(sources.nodeName === "sources", "Root element is not 'sources'");
const sourceList = sources.getElementsByTagName("source");
client.assert(sourceList.length >= 4, "Expected at least 4 source elements, found " + sourceList.length);
client.assert(sourceList.length >= 3, "Expected at least 3 source elements, found " + sourceList.length);
const expectedIds = ["10001", "10002", "10003", "10004"];
// AUX (id=10001, sourceproviderid=9) is intentionally excluded from
// cloud responses — real Bose never emitted AUX in /full or /sources;
// the speaker enumerates AUX from its own hardware via isLocal=true
// in :8090/sources. See pkg/service/marge/marge.go getAccountSources
// and commit 2b40481 (#195/#269).
const expectedIds = ["10002", "10003", "10004"];
for (let i = 0; i < sourceList.length; i++) {
const source = sourceList.item(i);
const sourceId = source.getAttribute("id");
client.assert(sourceId !== "10001", "Cloud /sources must not include AUX (id=10001)");
if (i < expectedIds.length) {
client.assert(sourceId === expectedIds[i], "Wrong source ID at index " + i);
client.assert(sourceId === expectedIds[i], "Wrong source ID at index " + i + ": got " + sourceId + ", want " + expectedIds[i]);
}
client.assert(source.getAttribute("type") === "Audio", "Wrong source type for source " + sourceId);
@@ -47,6 +47,18 @@ Authorization: Bearer {{token}}
client.assert(sources !== null, "Missing 'sources' element");
var sourceCount = sources.getElementsByTagName("source").length;
client.assert(sourceCount > 0, "No 'source' elements found in account sources");
client.assert(sourceCount === 6, "Expected 6 sources (AUX, INTERNET_RADIO, LOCAL_INTERNET_RADIO, TUNEIN, RADIO_BROWSER, Spotify) but got " + sourceCount);
// AUX (sourceproviderid=9) is intentionally excluded from cloud-side
// /full responses — real Bose never emitted it; the speaker enumerates
// AUX from its own hardware via isLocal=true in :8090/sources. See
// pkg/service/marge/marge.go getAccountSources for the reasoning and
// commit 2b40481 for the fix that closed #195/#269.
client.assert(sourceCount === 5, "Expected 5 cloud sources (INTERNET_RADIO, LOCAL_INTERNET_RADIO, TUNEIN, RADIO_BROWSER, Spotify; AUX is hardware-local) but got " + sourceCount);
// Explicit negative assertion: AUX must not appear in /full.
var sourceList = sources.getElementsByTagName("source");
for (var i = 0; i < sourceList.length; i++) {
var pid = sourceList[i].getElementsByTagName("sourceproviderid")[0];
client.assert(!pid || pid.textContent !== "9", "/full must not include AUX (sourceproviderid=9)");
}
});
%}
@@ -33,6 +33,10 @@ Authorization: Bearer {{token}}
const ipaddress = device.getElementsByTagName("ipaddress")[0];
client.assert(ipaddress !== undefined, "Response body should contain <ipaddress>");
// Capture the initial createdOn so rename_device.http can
// assert it survives a PUT later in the test sequence.
client.global.set("initialCreatedOn", createdOn.textContent);
});
%}
@@ -61,6 +65,13 @@ Authorization: Bearer {{token}}
const createdOn = device.getElementsByTagName("createdOn")[0];
client.assert(createdOn !== undefined, "Response body should contain <createdOn>");
client.assert(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|(\+\d{2}:\d{2}))$/.test(createdOn.textContent), "createdOn should be a valid ISO8601 timestamp");
// This variant POST re-uses the same deviceId as the first
// register above, so it's an upsert — issue #285 made the
// datastore preserve the original createdOn unconditionally.
// The captured global is the load-bearing assertion: if it
// ever differs here, CreatedOn preservation regressed.
client.assert(createdOn.textContent === client.global.get("initialCreatedOn"),
"createdOn (" + createdOn.textContent + ") differs from the value captured by the first POST (" + client.global.get("initialCreatedOn") + ") — upsert must preserve the original timestamp");
const name = device.getElementsByTagName("name")[0];
client.assert(name !== undefined, "Response body should contain <name>");
@@ -68,7 +79,7 @@ Authorization: Bearer {{token}}
const updatedOn = device.getElementsByTagName("updatedOn")[0];
client.assert(updatedOn !== undefined, "Response body should contain <updatedOn>");
client.assert(updatedOn.textContent === createdOn.textContent, "updatedOn should match createdOn for a new device");
client.assert(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|(\+\d{2}:\d{2}))$/.test(updatedOn.textContent), "updatedOn should be a valid ISO8601 timestamp");
const ipaddress = device.getElementsByTagName("ipaddress")[0];
client.assert(ipaddress !== undefined, "Response body should contain <ipaddress>");
@@ -0,0 +1,99 @@
### PUT /streaming/account/{accountId}/device/{deviceId} (Rename Device)
###
### Speakers fire this against AfterTouch when the user renames them
### via the Bose App or `soundtouch-cli name set`. Before issue #285's
### route fix the request fell through to the [UNHANDLED] catch-all
### and proxied to streaming.bose.com (401), so the speaker retried
### in a loop and the Bose App showed the rename spinning forever.
### This test runs after register_device.http (which creates the
### initial record) and after power_on.http (which seeds the IP at
### 192.168.1.100). The rename PUT must:
###
### - return 200 OK
### - echo the new name
### - preserve <createdOn> from the initial registration
### - preserve <ipaddress> from the power_on update (request body
### doesn't carry one; the datastore merge keeps the existing)
### - refresh <updatedOn> to "now"
PUT {{host}}/streaming/account/{{accountId}}/device/{{deviceId}}
Content-Type: application/vnd.bose.streaming-v1.2+xml
Authorization: Bearer {{token}}
<?xml version="1.0" encoding="UTF-8" ?>
<device deviceid="{{deviceId}}">
<name>{{deviceName}} (renamed)</name>
<macaddress>{{macAddress1}}</macaddress>
</device>
> {%
client.test("Rename returned 200 OK", function() {
client.assert(response.status === 200, "Response status should be 200, got " + response.status);
client.assert(response.contentType.mimeType === "application/vnd.bose.streaming-v1.2+xml", "Response Content-Type should be application/vnd.bose.streaming-v1.2+xml");
});
client.test("Response carries the new name and matches the deviceId", function() {
const doc = response.body;
const device = doc.getElementsByTagName("device")[0];
client.assert(device !== undefined, "Response body should contain <device>");
client.assert(device.getAttribute("deviceid") === client.variables.environment.get("deviceId"), "Response deviceid should match");
const name = device.getElementsByTagName("name")[0];
client.assert(name !== undefined, "Response body should contain <name>");
client.assert(name.textContent === client.variables.environment.get("deviceName") + " (renamed)", "Response should carry the renamed value");
});
client.test("createdOn preserved across rename, updatedOn refreshed", function() {
const device = response.body.getElementsByTagName("device")[0];
const createdOn = device.getElementsByTagName("createdOn")[0];
client.assert(createdOn !== undefined, "Response body should contain <createdOn>");
client.assert(createdOn.textContent.length > 0, "createdOn should not be empty (it must survive the rename, not be reset)");
client.assert(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|(\+\d{2}:\d{2}))$/.test(createdOn.textContent), "createdOn should be ISO8601");
// The load-bearing assertion: the value must match what
// register_device.http captured on the initial POST. If it
// doesn't, the rename PUT regressed the "first-paired in
// 2017" semantics — the exact bug behind the parity capture
// at data/parity_mismatches/1771797308__streaming_account_3230304_device_A81B6A536A98.json.
const initial = client.global.get("initialCreatedOn");
client.assert(initial !== undefined && initial.length > 0,
"initialCreatedOn was not captured by register_device.http — test ordering issue");
client.assert(createdOn.textContent === initial,
"createdOn (" + createdOn.textContent + ") differs from the value captured at registration (" + initial + ") — the rename PUT must preserve the original timestamp");
const updatedOn = device.getElementsByTagName("updatedOn")[0];
client.assert(updatedOn !== undefined, "Response body should contain <updatedOn>");
client.assert(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|(\+\d{2}:\d{2}))$/.test(updatedOn.textContent), "updatedOn should be ISO8601");
});
client.test("ipaddress preserved from earlier power_on payload", function() {
const device = response.body.getElementsByTagName("device")[0];
const ipaddress = device.getElementsByTagName("ipaddress")[0];
client.assert(ipaddress !== undefined, "Response body should contain <ipaddress>");
client.assert(ipaddress.textContent === client.variables.environment.get("deviceIp"),
"ipaddress should be preserved from the prior power_on (" + client.variables.environment.get("deviceIp") + "), not overwritten — got " + ipaddress.textContent);
});
%}
### PUT with mismatched deviceid in body (safety check)
###
### If the body's deviceid attribute doesn't match the URL's {device}
### segment the handler refuses with 400 rather than silently re-key
### the persisted record under the wrong account/device. Pins the
### second TestIssue285_* unit-test assertion at the integration
### layer.
PUT {{host}}/streaming/account/{{accountId}}/device/{{deviceId}}
Content-Type: application/vnd.bose.streaming-v1.2+xml
Authorization: Bearer {{token}}
<?xml version="1.0" encoding="UTF-8" ?>
<device deviceid="DEADBEEFCAFE">
<name>Rogue Rename</name>
<macaddress>DEADBEEFCAFE</macaddress>
</device>
> {%
client.test("Mismatched body deviceid returns 400", function() {
client.assert(response.status === 400, "Response status should be 400 for body/url deviceid mismatch, got " + response.status);
});
%}