iris-chat 0.1.57

fn ready_group_retry_core() -> (
    AppCore,
    flume::Receiver<CoreMsg>,
    flume::Receiver<CoreMsg>,
    Arc<SwitchableFailStorage>,
    String,
) {
    let storage = Arc::new(SwitchableFailStorage::new());
    let mut devices = sender_key_matrix_devices(2);
    devices[1].engine =
        test_protocol_engine_with_storage(&devices[1].owner, &devices[1].device, storage.clone());
    observe_sender_key_matrix_protocol_state(&mut devices);
    let recipient = devices[1].owner.public_key();
    let created = devices[0]
        .engine
        .create_group(
            "ready retry continuation".into(),
            vec![recipient],
            unix_now(),
        )
        .unwrap();
    let group_id = created.snapshot.unwrap().group_id;
    // Authenticate/decrypt recipient carriers in a disposable copy whose group
    // controls are ready. The low-level retry engine below deliberately lacks
    // those controls, so it can exercise bounded sender-key recovery without
    // bypassing the ratchet sender binding at the wire boundary.
    let carrier_storage = Arc::new(InMemoryStorage::new());
    for key in storage.list("").unwrap() {
        if let Some(value) = storage.get(&key).unwrap() {
            carrier_storage.put(&key, value).unwrap();
        }
    }
    let mut carrier_receiver =
        test_protocol_engine_with_storage(&devices[1].owner, &devices[1].device, carrier_storage);
    deliver_protocol_effects_to_engine(&mut carrier_receiver, &created.effects);
    for index in 0..20 {
        let (rumor, id) = runtime_rumor_json(
            devices[0].owner.public_key(),
            CHAT_MESSAGE_KIND,
            &format!("ready message {index}"),
            unix_now().get(),
            vec![],
        );
        let sent = devices[0]
            .engine
            .send_group_payload(&group_id, rumor.into_bytes(), Some(id))
            .unwrap();
        let outer = take_private_group_cipher_for_test(&mut carrier_receiver, &sent.effects);
        let waiting = devices[1].engine.process_group_outer_event(&outer).unwrap();
        assert!(waiting.consumed && waiting.events.is_empty());
    }
    assert_eq!(
        devices[1]
            .engine
            .debug_snapshot()
            .pending_group_sender_key_message_count,
        20
    );
    devices[1].engine.enter_batch();
    let initial = deliver_protocol_effects_to_engine(&mut devices[1].engine, &created.effects);
    devices[1].engine.exit_batch().unwrap();
    let remaining = devices[1]
        .engine
        .debug_snapshot()
        .pending_group_sender_key_message_count;
    assert!(
        remaining > 0,
        "late metadata must leave a bounded ready remainder: {remaining}"
    );
    let receiver = devices.pop().unwrap();
    let mut core = logged_in_test_core_with_storage(
        "ready-group-retry",
        &receiver.owner,
        &receiver.device,
        storage.clone(),
    );
    core.preferences.send_read_receipts = false;
    receiver.engine.enable_background_history_recovery_pacing();
    core.protocol_engine = Some(receiver.engine);
    for event in initial {
        core.apply_group_decrypted_event(event);
    }
    let (background_tx, background_rx) = flume::unbounded();
    let (priority_tx, priority_rx) = flume::unbounded();
    core.core_sender = background_tx;
    core.priority_sender = priority_tx;
    (
        core,
        background_rx,
        priority_rx,
        storage,
        group_chat_id(&group_id),
    )
}

fn assert_ready_group_retry_completes(
    core: &mut AppCore,
    background: &flume::Receiver<CoreMsg>,
    priority: &flume::Receiver<CoreMsg>,
    chat_id: &str,
) -> usize {
    assert!(core.logged_in.as_ref().unwrap().relay_urls.is_empty());
    let deadline = Instant::now() + Duration::from_secs(10);
    core.schedule_fast_protocol_retry_if_pending();
    let continuation = background
        .recv_timeout(Duration::from_millis(500))
        .expect("ready decryptions should resume on the background queue within one second");
    assert!(
        priority.is_empty(),
        "ready work must not bypass foreground queue fairness"
    );
    core.handle_messages(vec![continuation]);
    let mut callbacks = 1;
    let mut no_progress_callbacks = 0;
    loop {
        let pending = core
            .protocol_engine
            .as_ref()
            .unwrap()
            .debug_snapshot()
            .pending_group_sender_key_message_count;
        let remaining = deadline.saturating_duration_since(Instant::now());
        assert!(!remaining.is_zero(),
            "ready decryption timed out: pending={pending} callbacks={callbacks} no_progress={no_progress_callbacks}");
        if pending == 0 {
            break;
        }
        // A callback need not decrypt a message: unrelated completions, stale
        // timers and paced turns share this queue. Require actual completion
        // within a fixed budget, without extending it after partial progress.
        let callback = background
            .recv_timeout(remaining.min(Duration::from_millis(500)))
            .unwrap_or_else(|error| panic!(
                "ready continuation missing: {error}; pending={pending} callbacks={callbacks} no_progress={no_progress_callbacks} due={:?} pacing={:?}",
                core.protocol_subscription_runtime.ready_retry_due_at,
                core.protocol_engine.as_ref().unwrap().group_sender_key_retry_delay(),
            ));
        core.handle_messages(vec![callback]);
        callbacks += 1;
        if core.protocol_engine.as_ref().unwrap().debug_snapshot()
            .pending_group_sender_key_message_count == pending
        {
            no_progress_callbacks += 1;
        }
    }
    assert_eq!(
        core.protocol_engine
            .as_ref()
            .unwrap()
            .debug_snapshot()
            .pending_group_sender_key_message_count,
        0
    );
    assert_eq!(
        core.threads[chat_id]
            .messages
            .iter()
            .filter(|message| message.body.starts_with("ready message "))
            .count(),
        20
    );
    assert!(core
        .protocol_subscription_runtime
        .ready_retry_due_at
        .is_none());
    assert!(!core
        .protocol_engine
        .as_ref()
        .unwrap()
        .has_ready_group_sender_key_retry_work());
    assert!(core.logged_in.as_ref().unwrap().relay_urls.is_empty());
    assert!(priority.try_iter().all(|callback| !matches!(
        callback,
        CoreMsg::Internal(event)
            if matches!(*event, InternalEvent::RetryReadyProtocolWork { .. })
    )), "ready work must stay on the background queue");
    callbacks
}

#[test]
fn protocol_ready_retry_continues_decryption_on_background_queue_without_network_wait() {
    let (mut core, background, priority, _, chat_id) = ready_group_retry_core();
    assert_ready_group_retry_completes(&mut core, &background, &priority, &chat_id);
}

#[test]
fn protocol_ready_retry_completes_with_unrelated_and_superseded_background_callbacks() {
    let (mut core, background, priority, _, chat_id) = ready_group_retry_core();
    // The old pump stopped after 21 arbitrary callbacks (one initial + 20),
    // even though this queue also carries unrelated and superseded work. Put
    // that many callbacks before the real timer, without timing assumptions.
    let stale_due_at = Instant::now() - Duration::from_secs(1);
    for index in 0..21 {
        let event = if index % 2 == 0 {
            InternalEvent::RetryReadyProtocolWork { due_at: stale_due_at }
        } else {
            InternalEvent::DebugLog {
                category: "test.unrelated_background_callback".into(),
                detail: index.to_string(),
            }
        };
        core.core_sender.send(CoreMsg::Internal(Box::new(event))).unwrap();
    }
    let callbacks = assert_ready_group_retry_completes(
        &mut core, &background, &priority, &chat_id,
    );
    assert!(callbacks > 21, "completion must outlive unrelated callbacks");
}

#[test]
fn protocol_ready_retry_coalesces_and_ignores_callbacks_after_runtime_reset() {
    let (mut core, _, _, _, _) = ready_group_retry_core();
    core.schedule_fast_protocol_retry_if_pending();
    let due_at = core
        .protocol_subscription_runtime
        .ready_retry_due_at
        .unwrap();
    assert!(due_at <= Instant::now() + Duration::from_secs(1));
    for _ in 0..10 {
        core.schedule_fast_protocol_retry_if_pending();
    }
    assert_eq!(
        core.protocol_subscription_runtime.ready_retry_due_at,
        Some(due_at)
    );
    assert!(core.logged_in.as_ref().unwrap().relay_urls.is_empty());
    core.request_protocol_subscription_refresh();
    assert_eq!(
        core.protocol_subscription_runtime.ready_retry_due_at,
        Some(due_at),
        "no-relay refresh must preserve the coalesced continuation"
    );

    let pending = core
        .protocol_engine
        .as_ref()
        .unwrap()
        .debug_snapshot()
        .pending_group_sender_key_message_count;
    core.protocol_subscription_runtime = ProtocolSubscriptionRuntime::default();
    core.handle_internal(InternalEvent::RetryReadyProtocolWork { due_at });
    assert_eq!(
        core.protocol_engine
            .as_ref()
            .unwrap()
            .debug_snapshot()
            .pending_group_sender_key_message_count,
        pending
    );
    assert!(core
        .protocol_subscription_runtime
        .ready_retry_due_at
        .is_none());
    core.schedule_fast_protocol_retry_if_pending();
    let replacement = core
        .protocol_subscription_runtime
        .ready_retry_due_at
        .unwrap();
    assert_ne!(due_at, replacement);
    core.handle_internal(InternalEvent::RetryReadyProtocolWork { due_at });
    assert_eq!(
        core.protocol_subscription_runtime.ready_retry_due_at,
        Some(replacement)
    );
    assert_eq!(
        core.protocol_engine
            .as_ref()
            .unwrap()
            .debug_snapshot()
            .pending_group_sender_key_message_count,
        pending
    );
}

#[test]
fn protocol_ready_retry_earlier_allowance_replaces_old_history_deadline() {
    let (mut core, background, _, _, _) = ready_group_retry_core();
    let old_history_deadline = Instant::now() + Duration::from_secs(30);
    core.protocol_subscription_runtime.ready_retry_due_at = Some(old_history_deadline);
    let pending = core.protocol_engine.as_ref().unwrap().debug_snapshot()
        .pending_group_sender_key_message_count;
    core.schedule_fast_protocol_retry_if_pending();
    let replacement = core.protocol_subscription_runtime.ready_retry_due_at.unwrap();
    assert!(replacement < Instant::now() + Duration::from_secs(1));
    assert!(replacement < old_history_deadline);
    core.handle_internal(InternalEvent::RetryReadyProtocolWork { due_at: old_history_deadline });
    assert_eq!(core.protocol_subscription_runtime.ready_retry_due_at, Some(replacement));
    assert_eq!(core.protocol_engine.as_ref().unwrap().debug_snapshot()
        .pending_group_sender_key_message_count, pending);
    let callback = background.recv_timeout(Duration::from_millis(500))
        .expect("earlier work must not wait behind the old history timer");
    core.handle_messages(vec![callback]);
    assert!(core.protocol_engine.as_ref().unwrap().debug_snapshot()
        .pending_group_sender_key_message_count < pending);
}

#[test]
fn protocol_ready_retry_storage_failure_keeps_slow_backoff_and_recovers() {
    let (mut core, background, _, storage, _) = ready_group_retry_core();
    core.schedule_fast_protocol_retry_if_pending();
    let cancelled = core
        .protocol_subscription_runtime
        .ready_retry_due_at
        .unwrap();
    let pending = core
        .protocol_engine
        .as_ref()
        .unwrap()
        .debug_snapshot()
        .pending_group_sender_key_message_count;
    storage.set_fail_puts(true);
    core.retry_protocol_engine_pending_work("ready_retry_failure");
    assert!(core
        .debug_log
        .iter()
        .any(|entry| entry.category == "appcore.protocol.retry.error"));
    assert!(
        core.protocol_subscription_runtime
            .ready_retry_due_at
            .is_none(),
        "failed storage must not create a 25 ms retry loop"
    );
    assert!(
        core.protocol_subscription_runtime.liveness_due_at.unwrap()
            > Instant::now() + Duration::from_secs(1)
    );
    // Failed transactional work still consumed CPU. The recovery request below
    // must respect its measured allowance even after storage becomes healthy.
    let recovery_not_before = Instant::now()
        + core.protocol_engine.as_ref().unwrap().group_sender_key_retry_delay();
    core.handle_internal(InternalEvent::RetryReadyProtocolWork { due_at: cancelled });
    assert_eq!(
        core.protocol_engine
            .as_ref()
            .unwrap()
            .debug_snapshot()
            .pending_group_sender_key_message_count,
        pending
    );
    storage.set_fail_puts(false);
    core.retry_protocol_engine_pending_work("ready_retry_recovery");
    if core.protocol_engine.as_ref().unwrap().debug_snapshot()
        .pending_group_sender_key_message_count == pending
    {
        let recovery_due_at = core.protocol_subscription_runtime.ready_retry_due_at
            .expect("healthy storage must schedule the retained recovery work");
        assert!(recovery_due_at >= recovery_not_before,
            "recovery must not erase measured work from the failed save");
        assert!(recovery_due_at <= Instant::now() + Duration::from_secs(1));
        // The old cancelled callback can already be in the channel. Exercise
        // real timer delivery and its stale-callback guard, not a manual retry
        // loop or a reset of the protocol's resource accounting.
        let timeout = Instant::now() + Duration::from_secs(1);
        while core.protocol_engine.as_ref().unwrap().debug_snapshot()
            .pending_group_sender_key_message_count == pending
        {
            let callback = background.recv_timeout(timeout.saturating_duration_since(Instant::now()))
                .expect("healthy recovery must progress through its scheduled callback within one second");
            core.handle_messages(vec![callback]);
        }
    }
    assert!(
        core.protocol_engine
            .as_ref()
            .unwrap()
            .debug_snapshot()
            .pending_group_sender_key_message_count
            < pending
    );
}