Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 115 additions & 23 deletions apps/music-controller/src/model.rs
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ pub struct Model {
active: Option<Active>,
commands: [Command; COMMAND_QUEUE_MAX],
command_head: usize,
/// Pending commands, including the active command while it is at the queue head.
command_len: usize,
cache_dirty: bool,
}
Expand Down Expand Up @@ -158,9 +159,9 @@ impl Model {
}

if self.command_len > 0 && due(now, self.next_command) {
// Keep the active command at the queue head until a valid reply completes it. If it
// times out or cannot be sent, the same slot is retried before later commands.
let command = self.commands[self.command_head];
self.command_head = (self.command_head + 1) % COMMAND_QUEUE_MAX;
self.command_len -= 1;
self.id = self.id.wrapping_add(1);
self.active = Some(Active::Command {
id: self.id,
Expand All @@ -185,6 +186,8 @@ impl Model {

/// Queue a playback or volume command and update the visible state immediately.
pub fn command(&mut self, command: u8, value: u8) -> bool {
// The active command remains in the queue, so this bounds all pending commands rather
// than allowing an in-flight command plus a full queue of later commands.
if self.command_len == COMMAND_QUEUE_MAX
|| !matches!(
command,
Expand Down Expand Up @@ -223,8 +226,9 @@ impl Model {
true
}

/// Recover immediately when the loader could not queue a request. A command is put back at the
/// front of the queue so a transient outbox or host failure does not silently drop it.
/// Recover immediately when the loader could not queue a request. An active command stays at
/// the front of the bounded queue so a transient outbox or host failure does not drop it or
/// move it behind commands that were entered later.
pub fn send_failed(&mut self, now: u32) {
let Some(active) = self.active.take() else {
return;
Expand All @@ -233,22 +237,7 @@ impl Model {
Active::Snapshot { .. } => {
self.next_poll = now.wrapping_add(self.backoff);
}
Active::Command {
command,
value,
before,
..
} => {
if self.command_len < COMMAND_QUEUE_MAX {
self.command_head =
(self.command_head + COMMAND_QUEUE_MAX - 1) % COMMAND_QUEUE_MAX;
self.commands[self.command_head] = Command {
code: command,
value,
before,
};
self.command_len += 1;
}
Active::Command { .. } => {
self.next_command = now.wrapping_add(self.backoff);
self.next_poll = now.wrapping_add(self.backoff);
}
Expand All @@ -269,14 +258,22 @@ impl Model {
match active {
Active::Command { id, before, .. } if id == reply.id => {
self.active = None;
self.remove_active_command();
self.next_poll = now.wrapping_add(COMMAND_REFRESH_MS);
self.next_command = now.wrapping_add(COMMAND_REFRESH_MS);
self.status = if reply.status == rpc::OK {

let malformed = !reply.is_command_result();
self.status = if malformed {
Status::Unavailable
} else if reply.status == rpc::OK {
Status::Ok
} else {
status_of(reply.status)
};
let rolled_back = reply.status != rpc::OK && self.rollback_command(before);
// A malformed result is not a successful command. Treat it like a rejected
// command so the optimistic effect cannot survive without a valid acknowledgement.
let rolled_back =
(malformed || reply.status != rpc::OK) && self.rollback_command(before);
self.rev += 1;
if rolled_back {
self.cache_dirty = true;
Expand All @@ -290,6 +287,13 @@ impl Model {
}
}

/// Remove the command currently at the queue head after a terminal reply.
fn remove_active_command(&mut self) {
debug_assert!(self.command_len > 0);
self.command_head = (self.command_head + 1) % COMMAND_QUEUE_MAX;
self.command_len -= 1;
}

/// Restore the state before a denied command, then reapply commands still queued behind it.
fn rollback_command(&mut self, before: Metadata) -> bool {
let old = self.metadata;
Expand Down Expand Up @@ -351,7 +355,9 @@ impl Model {
self.next_poll = now.wrapping_add(POLL_MS);
self.active = None;

if !old.same_data(&metadata) {
// Compare the effective state after queued optimistic commands are reapplied. The raw
// snapshot can equal the old optimistic value even though the final visible state differs.
if !old.same_data(&self.metadata) {
self.rev += 1;
self.cache_dirty = true;
Got::Save
Expand Down Expand Up @@ -691,6 +697,35 @@ mod tests {
));
}

#[test]
fn a_timed_out_command_at_queue_capacity_is_not_lost() {
let mut model = Model::new();
for _ in 0..COMMAND_QUEUE_MAX {
assert!(model.command(rpc::VOLUME_UP, 0));
}

let first_id = match model.poll(0).unwrap() {
rpc::Request::Command(bytes) => bytes[3],
_ => panic!("expected command"),
};
// The active command still occupies a queue slot, so later input cannot hide it.
assert!(!model.command(rpc::VOLUME_DOWN, 0));
assert!(model.poll(COMMAND_TIMEOUT_MS).is_none());

let retry_at = COMMAND_TIMEOUT_MS + RETRY_MS * 2;
let retry_id = match model.poll(retry_at).unwrap() {
rpc::Request::Command(bytes) => bytes[3],
_ => panic!("expected retried command"),
};
assert_ne!(retry_id, first_id);
assert_eq!(
model.reply(&reply(retry_id, 0, 0, 0, &[]), retry_at + 1, 100),
Got::Changed
);
// Completing the head frees exactly one slot.
assert!(model.command(rpc::VOLUME_DOWN, 0));
}

#[test]
fn an_optimistic_command_marks_the_cache_dirty() {
let mut model = Model::new();
Expand All @@ -708,6 +743,63 @@ mod tests {
assert!(!model.cache_dirty());
}

#[test]
fn snapshot_saves_when_reapplied_optimistic_state_changes() {
let mut model = Model::new();
let id = match model.poll(0).unwrap() {
rpc::Request::Snapshot(bytes) => bytes[3],
_ => panic!("expected snapshot"),
};
model.reply(&reply(id, 0, 0, 1, &metadata_record(3, 7, 15)), 10, 100);
model.cache_saved();

let id = match model.poll(POLL_MS + 10).unwrap() {
rpc::Request::Snapshot(bytes) => bytes[3],
_ => panic!("expected snapshot"),
};
assert!(model.command(rpc::VOLUME_UP, 0));
assert_eq!(model.volume(), 8);
model.cache_saved();

// The raw snapshot equals the old optimistic value, but replaying the queued command
// changes the effective value that must be written to the cache.
assert_eq!(
model.reply(
&reply(id, 0, 0, 1, &metadata_record(3, 8, 15)),
POLL_MS + 11,
100,
),
Got::Save
);
assert_eq!(model.volume(), 9);
assert!(model.cache_dirty());
}

#[test]
fn malformed_command_reply_is_not_accepted_as_success() {
let mut model = Model::new();
let id = match model.poll(0).unwrap() {
rpc::Request::Snapshot(bytes) => bytes[3],
_ => panic!("expected snapshot"),
};
model.reply(&reply(id, 0, 0, 1, &metadata_record(3, 7, 15)), 10, 100);
assert!(model.command(rpc::VOLUME_UP, 0));
assert_eq!(model.volume(), 8);

let id = match model.poll(11).unwrap() {
rpc::Request::Command(bytes) => bytes[3],
_ => panic!("expected command"),
};
// OK with a non-empty result shape is not a valid command acknowledgement.
assert_eq!(
model.reply(&reply(id, rpc::OK, 0, 1, &[]), 12, 100),
Got::Save
);
assert_eq!(model.volume(), 7);
assert_eq!(model.status, Status::Unavailable);
assert!(model.cache_dirty());
}

#[test]
fn denied_command_rolls_back_and_reapplies_later_optimistic_commands() {
let mut model = Model::new();
Expand Down
9 changes: 9 additions & 0 deletions apps/music-controller/src/rpc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,13 @@ pub struct Reply<'a> {
pub record: &'a [u8],
}

impl Reply<'_> {
/// Whether this reply has the empty result shape required for a command.
pub fn is_command_result(&self) -> bool {
self.index == 0 && self.total == 0 && self.record.is_empty()
}
}

/// A reply on this channel; anything else is ignored.
pub fn reply(message: &[u8]) -> Option<Reply<'_>> {
match message {
Expand Down Expand Up @@ -195,10 +202,12 @@ mod tests {
),
(7, OK, 0, 0, &[][..])
);
assert!(first.is_command_result());
let second_bytes = hex("4d3141080000010003070f");
let second = reply(&second_bytes).unwrap();
assert_eq!(second.total, 1);
assert_eq!(second.record, &hex("0003070f")[..]);
assert!(!second.is_command_result());
let invalid = hex("4d31510701");
assert!(reply(&invalid).is_none());
assert!(reply(&hex("52314105000000")).is_none());
Expand Down
2 changes: 1 addition & 1 deletion apps/music-controller/store.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ The standalone Android **Music Companion** app shows the current track and its n
## Requirements

- The [patched firmware](/firmware) with the channel key and the [App Loader](/firmware).
- The standalone [Android Music Companion](https://github.com/boxmol71-gif/music-companion) app. [Download the v0.1.0 companion APK](https://github.com/boxmol71-gif/music-companion/releases/download/v0.1.0/MusicCompanion-0.1.0-debug.apk), then enable its watch bridge and grant notification-listener access.
- The standalone [Android Music Companion](https://github.com/boxmol71-gif/music-companion) app. [Download the v0.1.1 companion APK](https://github.com/boxmol71-gif/music-companion/releases/download/v0.1.1/MusicCompanion-0.1.1-debug.apk), then enable its watch bridge and grant notification-listener access.
2 changes: 1 addition & 1 deletion apps/music-controller/store.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name = "Music Controller"
summary = "Private playback and music-volume controls"
version = "0.1.0"
version = "0.1.1"
author = "CMF Tech Community"
screenshots = ["shots/playing.png", "shots/waiting.png"]
Loading