kafka-client-engine 0.0.1

Execution and driver-integration layer for the native Kafka client
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
//! Heartbeat cadence, liveness, and cooperative-reconciliation loss scenarios.

use kafka_client_core::{
    ClassicGroupInput, ClassicGroupPhase, ClassicProcessingLeaseError, ClassicProcessingLeaseFence,
    GroupId, GroupPositionBatch, GroupPositionFence, GroupPositionPartitionFact, Moment,
    NextFetchOffset,
};

use crate::{clock::MonotonicClock, consumer::GroupConsumerEvent};

use super::{
    classic_group_execution::ClassicGroupExecutionError,
    classic_group_fetch::ClassicGroupFetchFront,
    classic_group_graceful_revocation::ClassicGroupRevocationTurn,
    classic_group_heartbeat::ClassicHeartbeatExecutionState,
    classic_group_heartbeat_prepare::{ClassicHeartbeatPreparationTurn, commit_local_loss},
    classic_group_position::test_support::completed_ready,
    classic_group_reconciliation_loss::ClassicGroupReconciliationLossTurn,
    classic_group_reconciliation_turn::ClassicGroupReconciliationTurn,
    registry::GroupConsumerRegistry,
    registry_event_reconciliation_test::prepared_reconciliation,
    registry_test_support::{install_session, register, started_registry, stop_registry},
};

#[test]
fn late_host_turn_revokes_instead_of_claiming_liveness() {
    let mut registry = started_registry();
    let group_id = register(&mut registry, "workers");
    install_session(&mut registry, group_id);
    let schedule = schedule(&registry, group_id);
    let clock = MonotonicClock::new();

    assert_eq!(
        registry.prepare_one_classic_heartbeat(
            Moment::from_tick(schedule.liveness_deadline().tick()),
            &clock,
        ),
        Ok(ClassicHeartbeatPreparationTurn::Progress)
    );

    let entry = registry
        .entry(group_id)
        .unwrap_or_else(|| panic!("entry expected"));
    assert_eq!(entry.classic.machine().phase(), ClassicGroupPhase::Lost);
    assert!(entry.catalog.live_assignment().is_none());
    assert!(entry.heartbeat.is_dormant());
    stop_registry(&mut registry);
}

#[test]
fn prepared_attempt_uses_the_core_deadline_mapped_by_the_shared_epoch() {
    let mut registry = started_registry();
    let group_id = register(&mut registry, "workers");
    install_session(&mut registry, group_id);
    let schedule = schedule(&registry, group_id);
    let clock = MonotonicClock::new();
    let now = Moment::from_tick(schedule.due().tick());

    assert_eq!(
        registry.prepare_one_classic_heartbeat(now, &clock),
        Ok(ClassicHeartbeatPreparationTurn::Progress)
    );
    let prepared = registry
        .entry(group_id)
        .and_then(|entry| entry.heartbeat.prepared())
        .unwrap_or_else(|| panic!("prepared Heartbeat expected"));
    let expected_core = now
        .checked_deadline_after(
            super::classic_group_test_support::heartbeat_policy().attempt_timeout_ticks(),
        )
        .map_or_else(
            || panic!("test Heartbeat deadline must fit"),
            |deadline| deadline.min(schedule.liveness_deadline()),
        );
    let expected = clock
        .operation_deadline(expected_core)
        .unwrap_or_else(|error| panic!("exact deadline mapping failed: {error}"));

    assert_eq!(prepared.key().deadline(), expected);
    stop_registry(&mut registry);
}

#[test]
fn locally_blocked_prepared_attempt_expires_and_revokes() {
    let mut registry = started_registry();
    let group_id = register(&mut registry, "workers");
    install_session(&mut registry, group_id);
    let schedule = schedule(&registry, group_id);
    let clock = MonotonicClock::new();
    registry
        .prepare_one_classic_heartbeat(Moment::from_tick(schedule.due().tick()), &clock)
        .unwrap_or_else(|error| panic!("Heartbeat preparation failed: {error:?}"));
    let deadline = registry
        .entry(group_id)
        .and_then(|entry| entry.heartbeat.prepared())
        .map_or_else(
            || panic!("prepared deadline expected"),
            |prepared| prepared.key().deadline().core(),
        );

    assert_eq!(
        registry.expire_one_prepared_heartbeat(Moment::from_tick(deadline.tick())),
        Ok(true)
    );
    let entry = registry
        .entry(group_id)
        .unwrap_or_else(|| panic!("entry expected"));
    assert_eq!(entry.classic.machine().phase(), ClassicGroupPhase::Lost);
    assert!(entry.catalog.live_assignment().is_none());
    assert!(entry.heartbeat.is_dormant());
    stop_registry(&mut registry);
}

#[test]
fn cooperative_reconciliation_heartbeat_deadline_retires_the_previous_assignment() {
    let (mut registry, group_id, schedule) = staged_reconciliation_registry();
    let clock = MonotonicClock::new();

    assert_eq!(
        registry.prepare_one_classic_heartbeat(Moment::from_tick(schedule.due().tick()), &clock),
        Ok(ClassicHeartbeatPreparationTurn::Progress)
    );
    let deadline = registry
        .entry(group_id)
        .and_then(|entry| entry.heartbeat.prepared())
        .map_or_else(
            || panic!("prepared replacement heartbeat"),
            |prepared| prepared.key().deadline().core(),
        );
    assert_eq!(
        registry.expire_one_prepared_heartbeat(Moment::from_tick(deadline.tick())),
        Ok(true),
        "replacement loss is staged without catalog AssignmentMismatch"
    );

    let entry = registry
        .entry(group_id)
        .unwrap_or_else(|| panic!("cooperative entry"));
    assert_eq!(entry.classic.machine().phase(), ClassicGroupPhase::Lost);
    assert!(entry.catalog.live_assignment().is_some());
    assert!(
        entry
            .classic_reconciliation
            .as_ref()
            .is_some_and(super::classic_group_reconciliation::PreparedClassicGroupReconciliation::assignment_loss_is_staged)
    );
    assert!(entry.heartbeat.is_dormant());

    drain_reconciliation_loss(&mut registry);
    assert_reconciliation_loss_retired(&mut registry, group_id);
    let Some(GroupConsumerEvent::PartitionsLost(lost)) = registry
        .entries
        .iter_mut()
        .find(|entry| entry.group_id() == group_id)
        .and_then(|entry| entry.catalog.take_event())
    else {
        panic!("full previous assignment loss");
    };
    assert_eq!(lost.assignment_epoch(), 1);
    assert_eq!(lost.partitions().len(), 2);
    assert_eq!(lost.partitions()[0].partition(), 0);
    assert_eq!(lost.partitions()[1].partition(), 1);
    stop_registry(&mut registry);
}

#[test]
fn observed_partial_revocation_is_followed_by_full_loss_on_heartbeat_failure() {
    let (mut registry, group_id, schedule) = staged_reconciliation_registry();
    let Some(GroupConsumerEvent::PartitionsRevoked(revoked)) = registry
        .entries
        .iter_mut()
        .find(|entry| entry.group_id() == group_id)
        .and_then(|entry| entry.catalog.take_event())
    else {
        panic!("cooperative partial revocation");
    };
    assert_eq!(revoked.assignment_epoch(), 1);
    assert_eq!(revoked.partitions().len(), 1);
    assert_eq!(revoked.partitions()[0].partition(), 1);

    let clock = MonotonicClock::new();
    assert_eq!(
        registry.prepare_one_classic_heartbeat(Moment::from_tick(schedule.due().tick()), &clock),
        Ok(ClassicHeartbeatPreparationTurn::Progress)
    );
    let entry = registry
        .entries
        .iter_mut()
        .find(|entry| entry.group_id() == group_id)
        .unwrap_or_else(|| panic!("cooperative entry"));
    let transition = entry
        .classic
        .apply(ClassicGroupInput::HeartbeatFailed {
            attempt: schedule.attempt(),
        })
        .unwrap_or_else(|error| panic!("replacement heartbeat failure: {error}"));
    commit_local_loss(entry, transition)
        .unwrap_or_else(|error| panic!("stage reconciliation loss: {error:?}"));
    entry
        .heartbeat
        .clear_local()
        .unwrap_or_else(|error| panic!("clear failed heartbeat: {error:?}"));

    drain_reconciliation_loss(&mut registry);
    assert_reconciliation_loss_retired(&mut registry, group_id);
    let Some(GroupConsumerEvent::PartitionsLost(lost)) = registry
        .entries
        .iter_mut()
        .find(|entry| entry.group_id() == group_id)
        .and_then(|entry| entry.catalog.take_event())
    else {
        panic!("full loss follows the observed subset revocation");
    };
    assert_eq!(lost.assignment_epoch(), 1);
    assert_eq!(lost.partitions().len(), 2);
    assert_eq!(lost.partitions()[0].partition(), 0);
    assert_eq!(lost.partitions()[1].partition(), 1);
    stop_registry(&mut registry);
}

#[test]
fn pre_stage_heartbeat_loss_drains_the_embedded_position_owner() {
    let (mut registry, group_id, schedule) = reconciliation_registry(false);
    let clock = MonotonicClock::new();
    assert_eq!(
        registry.prepare_one_classic_heartbeat(Moment::from_tick(schedule.due().tick()), &clock),
        Ok(ClassicHeartbeatPreparationTurn::Progress)
    );
    let deadline = registry
        .entry(group_id)
        .and_then(|entry| entry.heartbeat.prepared())
        .map_or_else(
            || panic!("prepared replacement heartbeat"),
            |prepared| prepared.key().deadline().core(),
        );
    assert_eq!(
        registry.expire_one_prepared_heartbeat(Moment::from_tick(deadline.tick())),
        Ok(true)
    );

    assert_eq!(
        registry.turn_one_classic_group_reconciliation_loss(Moment::from_tick(30)),
        Ok(ClassicGroupReconciliationLossTurn::Progress),
        "embedded position transfers before retirement"
    );
    assert_eq!(
        registry.turn_one_classic_group_reconciliation_loss(Moment::from_tick(31)),
        Ok(ClassicGroupReconciliationLossTurn::Progress),
        "transferred position closes through the ordinary owner"
    );

    let entry = registry
        .entries
        .iter_mut()
        .find(|entry| entry.group_id() == group_id)
        .unwrap_or_else(|| panic!("cooperative entry"));
    let assignment = entry
        .catalog
        .live_assignment()
        .unwrap_or_else(|| panic!("previous catalog assignment"));
    let previous_cycle = entry
        .catalog
        .membership_cycle()
        .unwrap_or_else(|| panic!("previous catalog cycle"));
    let correct_fence = ClassicProcessingLeaseFence::new(
        group_id,
        previous_cycle,
        assignment.assignment_generation(),
    );
    entry
        .processing_lease
        .prepare_revocation(correct_fence)
        .unwrap_or_else(|error| panic!("release previous processing lease: {error:?}"))
        .commit();
    let wrong_fence = ClassicProcessingLeaseFence::new(
        group_id,
        previous_cycle
            .checked_next()
            .unwrap_or_else(|| panic!("alternate cycle")),
        assignment.assignment_generation(),
    );
    entry
        .processing_lease
        .prepare_activation(wrong_fence, Moment::from_tick(32))
        .unwrap_or_else(|error| panic!("install mismatched processing lease: {error:?}"))
        .commit();
    assert_eq!(
        registry.turn_one_classic_group_reconciliation_loss(Moment::from_tick(32)),
        Err(ClassicGroupExecutionError::ProcessingLease(
            ClassicProcessingLeaseError::FenceMismatch,
        )),
        "a retryable retirement mismatch retains every exact owner"
    );
    let entry = registry
        .entries
        .iter_mut()
        .find(|entry| entry.group_id() == group_id)
        .unwrap_or_else(|| panic!("retained cooperative entry"));
    assert!(entry.fault.is_none());
    assert!(entry.classic_reconciliation.is_some());
    assert!(entry.catalog.live_assignment().is_some());
    entry
        .processing_lease
        .prepare_revocation(wrong_fence)
        .unwrap_or_else(|error| panic!("release mismatched processing lease: {error:?}"))
        .commit();
    entry
        .processing_lease
        .prepare_activation(correct_fence, Moment::from_tick(33))
        .unwrap_or_else(|error| panic!("restore previous processing lease: {error:?}"))
        .commit();
    assert_eq!(
        registry.turn_one_classic_group_reconciliation_loss(Moment::from_tick(33)),
        Ok(ClassicGroupReconciliationLossTurn::Progress),
        "the retained loss owner retries exact retirement"
    );
    assert_reconciliation_loss_retired(&mut registry, group_id);
    stop_registry(&mut registry);
}

fn staged_reconciliation_registry() -> (
    GroupConsumerRegistry,
    GroupId,
    kafka_client_core::ClassicHeartbeatSchedule,
) {
    reconciliation_registry(true)
}

fn reconciliation_registry(
    stage: bool,
) -> (
    GroupConsumerRegistry,
    GroupId,
    kafka_client_core::ClassicHeartbeatSchedule,
) {
    let mut entry = prepared_reconciliation();
    let group_id = entry.group_id();
    let assignment = entry
        .catalog
        .live_assignment()
        .unwrap_or_else(|| panic!("previous catalog assignment"));
    let cycle = entry
        .catalog
        .membership_cycle()
        .unwrap_or_else(|| panic!("previous catalog cycle"));
    let position_fence = GroupPositionFence::new(
        group_id,
        cycle,
        assignment.member_id(),
        assignment.assignment_generation(),
    );
    entry
        .processing_lease
        .prepare_activation(
            ClassicProcessingLeaseFence::new(group_id, cycle, assignment.assignment_generation()),
            Moment::from_tick(10),
        )
        .unwrap_or_else(|error| panic!("previous processing lease: {error:?}"))
        .commit();
    let facts = assignment
        .partitions()
        .iter()
        .copied()
        .map(|partition| {
            GroupPositionPartitionFact::committed(
                partition,
                NextFetchOffset::try_from_raw(17).unwrap_or_else(|| panic!("positive next offset")),
            )
        })
        .collect();
    entry
        .fetch
        .try_activate(
            completed_ready(
                position_fence,
                Moment::from_tick(11),
                GroupPositionBatch::new(0, facts),
            ),
            position_fence,
        )
        .unwrap_or_else(|_error| panic!("previous Fetch activation"));
    let fetch_clock = MonotonicClock::new();
    for _effect in 0..assignment.partitions().len() {
        assert_eq!(
            entry
                .fetch
                .interpret_front_effect(&entry.catalog, &fetch_clock),
            ClassicGroupFetchFront::Interpreted,
            "previous Fetch activation effects drain before cooperative fencing"
        );
    }
    assert_eq!(
        entry
            .fetch
            .interpret_front_effect(&entry.catalog, &fetch_clock),
        ClassicGroupFetchFront::Idle
    );
    let pending = entry
        .classic_reconciliation
        .as_mut()
        .unwrap_or_else(|| panic!("pending cooperative reconciliation"));
    pending.confirm_sync();
    let schedule = pending.reconciliation().heartbeat();
    entry
        .heartbeat
        .prepare_install(schedule)
        .unwrap_or_else(|error| panic!("replacement heartbeat: {error:?}"))
        .commit();

    let retained_bytes = entry.group_bytes();
    let mut registry = GroupConsumerRegistry::start()
        .unwrap_or_else(|error| panic!("cooperative registry: {error}"));
    registry.retained_group_bytes = retained_bytes;
    registry.next_group_id = GroupId::try_from_raw(2);
    registry.entries.push(entry);
    if stage {
        assert_eq!(
            registry.stage_one_classic_group_reconciliation(Moment::from_tick(20)),
            Ok(ClassicGroupReconciliationTurn::Progress)
        );
    }
    (registry, group_id, schedule)
}

fn drain_reconciliation_loss(registry: &mut GroupConsumerRegistry) {
    assert_eq!(
        registry.turn_one_classic_group_reconciliation_loss(Moment::from_tick(30)),
        Ok(ClassicGroupReconciliationLossTurn::Progress),
        "active partial-revocation owner becomes lost"
    );
    assert_eq!(
        registry.turn_graceful_revocation(Moment::from_tick(31)),
        Ok(ClassicGroupRevocationTurn::Progress),
        "lost partial-revocation owner settles before reconciliation removal"
    );
    assert_eq!(
        registry.turn_one_classic_group_reconciliation_loss(Moment::from_tick(32)),
        Ok(ClassicGroupReconciliationLossTurn::Progress),
        "embedded replacement-position owner closes"
    );
    assert_eq!(
        registry.turn_one_classic_group_reconciliation_loss(Moment::from_tick(33)),
        Ok(ClassicGroupReconciliationLossTurn::Progress),
        "exact previous assignment owners retire"
    );
}

fn assert_reconciliation_loss_retired(registry: &mut GroupConsumerRegistry, group_id: GroupId) {
    let entry = registry
        .entry(group_id)
        .unwrap_or_else(|| panic!("retired cooperative entry"));
    assert!(entry.classic_reconciliation.is_none());
    assert!(entry.catalog.live_assignment().is_none());
    assert!(entry.processing_lease.active_schedule().is_none());
    assert!(entry.processing_lease.pending_expiration().is_none());
    assert_eq!(entry.fetch.machine_assignment_epoch(), None);
    assert!(entry.revocation.is_dormant());
    assert!(entry.position.is_dormant());
}

fn schedule(
    registry: &super::registry::GroupConsumerRegistry,
    group_id: kafka_client_core::GroupId,
) -> kafka_client_core::ClassicHeartbeatSchedule {
    match registry
        .entry(group_id)
        .unwrap_or_else(|| panic!("entry expected"))
        .heartbeat
        .state()
    {
        ClassicHeartbeatExecutionState::Waiting(schedule) => *schedule,
        _ => panic!("waiting Heartbeat expected"),
    }
}