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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
//! Core-authorized Install and Revoke catalog commit scenarios.

use std::sync::Arc;

use kafka_client_core::{
    AssignmentGeneration, ClassicGeneration, ClassicGroupEffect, ClassicGroupInput,
    ClassicGroupPhase, ClassicProcessingLease, ClassicProcessingLeaseError,
    ClassicProcessingLeaseFence, ClassicProcessingLeasePolicy, Deadline, GroupAssignmentPartition,
    GroupId, GroupPositionBatch, GroupPositionFence, GroupPositionPartitionFact, Moment,
    NextFetchOffset, PartitionIndex, TopicId,
};

use super::{
    classic_group_assignment::{
        ClassicGroupAssignmentPreparationFailureKind, ClassicGroupRevocationFailureKind,
        retire_and_revoke_classic_group_assignment,
    },
    classic_group_fetch::{
        ClassicGroupFetchOwner, ClassicGroupFetchRetirement, ClassicGroupFetchRetirementError,
    },
    classic_group_owner::ClassicGroupOwner,
    classic_group_position::test_support::completed_ready,
    classic_group_test_support,
    registry_entry::DEFAULT_CLASSIC_PROCESSING_TIMEOUT_TICKS,
    session_catalog::GroupSessionCatalog,
};

fn owners() -> (GroupSessionCatalog, ClassicGroupOwner) {
    let group_id = GroupId::try_from_raw(9).unwrap_or_else(|| panic!("nonzero group identity"));
    let catalog =
        GroupSessionCatalog::try_new(group_id, Arc::from("workers"), &[Arc::from("orders")])
            .unwrap_or_else(|error| panic!("catalog creation failed: {error:?}"));
    (
        catalog,
        ClassicGroupOwner::new(
            group_id,
            classic_group_test_support::timing(),
            classic_group_test_support::heartbeat_policy(),
            classic_group_test_support::rejoin_policy(),
        ),
    )
}

#[test]
fn unsubscribed_install_failure_retains_assignment_and_candidate() {
    let (mut catalog, mut owner) = owners();
    let cycle = classic_group_test_support::begin(&mut owner);
    let candidate = catalog
        .prepare_follower_cycle(cycle, Arc::from("member-a"))
        .unwrap_or_else(|error| panic!("candidate failed: {error:?}"));
    let member_id = candidate.local_member_id();
    owner
        .stage_candidate(candidate)
        .unwrap_or_else(|error| panic!("candidate stage failed: {error:?}"));
    owner
        .apply(ClassicGroupInput::JoinFollower {
            cycle,
            now: Moment::from_tick(2),
            member_id,
            generation: ClassicGeneration::try_from_raw(7)
                .unwrap_or_else(|| panic!("classic generation")),
        })
        .unwrap_or_else(|error| panic!("Join failed: {error}"));
    let install = owner
        .apply(ClassicGroupInput::SyncSucceeded {
            cycle,
            now: Moment::from_tick(3),
            partitions: vec![GroupAssignmentPartition::new(
                TopicId::from_raw(99),
                PartitionIndex::from_raw(0),
            )],
        })
        .unwrap_or_else(|error| panic!("Sync failed: {error}"))
        .into_effects()
        .next()
        .unwrap_or_else(|| panic!("Install expected"));
    let ClassicGroupEffect::Install {
        assignment,
        classic_generation,
        heartbeat: _heartbeat,
    } = install
    else {
        panic!("Install expected");
    };
    let failure = owner
        .prepare_install(&mut catalog, assignment, classic_generation)
        .err()
        .unwrap_or_else(|| panic!("unsubscribed topic must reject"));
    assert_eq!(
        failure.kind,
        ClassicGroupAssignmentPreparationFailureKind::UnsubscribedTopic
    );
    assert_eq!(
        failure.assignment.partitions()[0].topic_id(),
        TopicId::from_raw(99)
    );
    assert!(owner.pending().is_some());
    assert!(catalog.live_assignment().is_none());
}

#[test]
fn dropping_prepared_install_preserves_candidate_catalog_and_cursors() {
    let (mut catalog, mut owner) = owners();
    let cycle = classic_group_test_support::begin(&mut owner);
    let member_cursor = catalog.next_member_id;
    let candidate = catalog
        .prepare_follower_cycle(cycle, Arc::from("member-a"))
        .unwrap_or_else(|error| panic!("candidate failed: {error:?}"));
    let member_id = candidate.local_member_id();
    owner
        .stage_candidate(candidate)
        .unwrap_or_else(|error| panic!("candidate stage failed: {error:?}"));
    owner
        .apply(ClassicGroupInput::JoinFollower {
            cycle,
            now: Moment::from_tick(2),
            member_id,
            generation: ClassicGeneration::try_from_raw(7)
                .unwrap_or_else(|| panic!("classic generation")),
        })
        .unwrap_or_else(|error| panic!("Join failed: {error}"));
    let effect = owner
        .apply(ClassicGroupInput::SyncSucceeded {
            cycle,
            now: Moment::from_tick(3),
            partitions: Vec::new(),
        })
        .unwrap_or_else(|error| panic!("Sync failed: {error}"))
        .into_effects()
        .next()
        .unwrap_or_else(|| panic!("Install expected"));
    let ClassicGroupEffect::Install {
        assignment,
        classic_generation,
        heartbeat: _heartbeat,
    } = effect
    else {
        panic!("Install expected");
    };
    let prepared = owner
        .prepare_install(&mut catalog, assignment, classic_generation)
        .unwrap_or_else(|failure| panic!("install preparation failed: {:?}", failure.kind));
    drop(prepared);

    assert!(owner.pending().is_some());
    assert!(catalog.live_assignment().is_none());
    assert_eq!(catalog.next_member_id, member_cursor);
}

#[test]
fn dropping_prepared_revoke_preserves_the_catalog_session() {
    let (mut catalog, mut owner) = owners();
    classic_group_test_support::install_follower(
        &mut catalog,
        &mut owner,
        "member-a",
        7,
        Vec::new(),
    );
    let cycle = owner
        .machine()
        .active_cycle()
        .unwrap_or_else(|| panic!("stable cycle expected"));
    let effect = owner
        .apply(ClassicGroupInput::AssignmentLost { cycle })
        .unwrap_or_else(|error| panic!("assignment loss failed: {error}"))
        .into_effects()
        .next()
        .unwrap_or_else(|| panic!("Revoke expected"));
    let ClassicGroupEffect::Revoke {
        assignment,
        classic_generation,
    } = effect
    else {
        panic!("Revoke expected");
    };
    let prepared = owner
        .prepare_revoke(&mut catalog, assignment, classic_generation)
        .unwrap_or_else(|failure| panic!("revoke preparation failed: {:?}", failure.kind));
    drop(prepared);
    owner
        .apply(ClassicGroupInput::Begin {
            now: Moment::from_tick(4),
            deadline: Deadline::from_tick(100),
        })
        .unwrap_or_else(|error| panic!("next cycle failed after revoke drop: {error}"));

    assert_eq!(owner.machine().phase(), ClassicGroupPhase::Joining);
    assert!(catalog.live_assignment().is_some());
    assert_eq!(
        catalog.current_member().map(std::convert::AsRef::as_ref),
        Some("member-a")
    );
    assert_eq!(catalog.classic_generation(), Some(7));
}

#[test]
fn foreign_lost_owner_cannot_authorize_another_groups_revoke() {
    let (mut catalog_a, mut owner_a) = owners();
    classic_group_test_support::install_follower(
        &mut catalog_a,
        &mut owner_a,
        "member-a",
        7,
        Vec::new(),
    );
    let cycle_a = owner_a
        .machine()
        .active_cycle()
        .unwrap_or_else(|| panic!("stable cycle expected"));
    owner_a
        .apply(ClassicGroupInput::AssignmentLost { cycle: cycle_a })
        .unwrap_or_else(|error| panic!("assignment loss failed: {error}"));

    let group_b = GroupId::try_from_raw(10).unwrap_or_else(|| panic!("nonzero group identity"));
    let mut catalog_b =
        GroupSessionCatalog::try_new(group_b, Arc::from("payments"), &[Arc::from("payments")])
            .unwrap_or_else(|error| panic!("catalog creation failed: {error:?}"));
    let mut owner_b = ClassicGroupOwner::new(
        group_b,
        classic_group_test_support::timing(),
        classic_group_test_support::heartbeat_policy(),
        classic_group_test_support::rejoin_policy(),
    );
    classic_group_test_support::install_follower(
        &mut catalog_b,
        &mut owner_b,
        "member-b",
        11,
        Vec::new(),
    );
    let cycle_b = owner_b
        .machine()
        .active_cycle()
        .unwrap_or_else(|| panic!("stable cycle expected"));
    let effect = owner_b
        .apply(ClassicGroupInput::AssignmentLost { cycle: cycle_b })
        .unwrap_or_else(|error| panic!("assignment loss failed: {error}"))
        .into_effects()
        .next()
        .unwrap_or_else(|| panic!("Revoke expected"));
    let ClassicGroupEffect::Revoke {
        assignment,
        classic_generation,
    } = effect
    else {
        panic!("Revoke expected");
    };

    let failure = owner_a
        .prepare_revoke(&mut catalog_b, assignment, classic_generation)
        .err()
        .unwrap_or_else(|| panic!("foreign owner must reject"));
    assert_eq!(
        failure.kind,
        ClassicGroupAssignmentPreparationFailureKind::GroupMismatch
    );
    assert_eq!(failure.assignment.group_id(), group_b);
    assert!(catalog_b.live_assignment().is_some());
}

#[test]
fn shared_revoke_retires_exact_fetch_assignment_before_catalog_commit() {
    let (mut catalog, mut owner) = owners();
    let topic_id = catalog
        .topic_id("orders")
        .unwrap_or_else(|| panic!("orders topic identity"));
    classic_group_test_support::install_follower(
        &mut catalog,
        &mut owner,
        "member-a",
        7,
        vec![GroupAssignmentPartition::new(
            topic_id,
            PartitionIndex::from_raw(0),
        )],
    );
    let mut fetch =
        ClassicGroupFetchOwner::try_new().unwrap_or_else(|error| panic!("Fetch owner: {error:?}"));
    activate_fetch(&catalog, &owner, &mut fetch, None);
    let mut processing_lease = active_processing_lease(&catalog, &owner, None);
    let assignment_epoch = fetch
        .machine_assignment_epoch()
        .unwrap_or_else(|| panic!("active Fetch assignment"));
    let (assignment, generation) = lose_assignment(&mut owner);

    let retirement = retire_and_revoke_classic_group_assignment(
        &owner,
        &mut catalog,
        &mut processing_lease,
        &mut fetch,
        assignment,
        generation,
    )
    .unwrap_or_else(|failure| panic!("shared revoke failed: {:?}", failure.kind));

    assert!(matches!(
        retirement,
        ClassicGroupFetchRetirement::Retired {
            assignment_epoch: retired,
            controls: 1,
            ..
        } if retired == assignment_epoch
    ));
    assert!(catalog.live_assignment().is_none());
    assert_eq!(processing_lease.next_deadline(), None);
    assert!(fetch.activation().is_none());
    assert_eq!(fetch.machine_assignment_epoch(), None);
}

#[test]
fn fetch_retirement_failure_retains_exact_revoke_and_catalog_session() {
    let (mut catalog, mut owner) = owners();
    let topic_id = catalog
        .topic_id("orders")
        .unwrap_or_else(|| panic!("orders topic identity"));
    classic_group_test_support::install_follower(
        &mut catalog,
        &mut owner,
        "member-a",
        7,
        vec![GroupAssignmentPartition::new(
            topic_id,
            PartitionIndex::from_raw(0),
        )],
    );
    let live_generation = catalog
        .live_assignment()
        .unwrap_or_else(|| panic!("catalog assignment"))
        .assignment_generation();
    let foreign_generation = AssignmentGeneration::try_from_raw(
        live_generation
            .get()
            .checked_add(1)
            .unwrap_or_else(|| panic!("test generation")),
    )
    .unwrap_or_else(|| panic!("foreign assignment generation"));
    let mut fetch =
        ClassicGroupFetchOwner::try_new().unwrap_or_else(|error| panic!("Fetch owner: {error:?}"));
    activate_fetch(&catalog, &owner, &mut fetch, Some(foreign_generation));
    let mut processing_lease = active_processing_lease(&catalog, &owner, None);
    let (assignment, generation) = lose_assignment(&mut owner);

    let failure = retire_and_revoke_classic_group_assignment(
        &owner,
        &mut catalog,
        &mut processing_lease,
        &mut fetch,
        assignment,
        generation,
    )
    .err()
    .unwrap_or_else(|| panic!("foreign Fetch binding must reject revocation"));

    assert!(matches!(
        failure.kind,
        ClassicGroupRevocationFailureKind::Fetch(
            ClassicGroupFetchRetirementError::AssignmentIdentityMismatch { .. }
        )
    ));
    assert_eq!(failure.classic_generation, generation);
    assert_eq!(catalog.live_assignment(), Some(&failure.assignment));
    assert!(fetch.activation().is_some());
    assert!(fetch.fault().is_none());
    assert!(processing_lease.next_deadline().is_some());
}

#[test]
fn processing_fence_mismatch_preserves_fetch_and_catalog_before_retirement() {
    let (mut catalog, mut owner) = owners();
    let topic_id = catalog
        .topic_id("orders")
        .unwrap_or_else(|| panic!("orders topic identity"));
    classic_group_test_support::install_follower(
        &mut catalog,
        &mut owner,
        "member-a",
        7,
        vec![GroupAssignmentPartition::new(
            topic_id,
            PartitionIndex::from_raw(0),
        )],
    );
    let live_generation = catalog
        .live_assignment()
        .unwrap_or_else(|| panic!("catalog assignment"))
        .assignment_generation();
    let foreign_generation = AssignmentGeneration::try_from_raw(
        live_generation
            .get()
            .checked_add(1)
            .unwrap_or_else(|| panic!("test generation")),
    )
    .unwrap_or_else(|| panic!("foreign assignment generation"));
    let mut fetch =
        ClassicGroupFetchOwner::try_new().unwrap_or_else(|error| panic!("Fetch owner: {error:?}"));
    activate_fetch(&catalog, &owner, &mut fetch, None);
    let mut processing_lease = active_processing_lease(&catalog, &owner, Some(foreign_generation));
    let (assignment, generation) = lose_assignment(&mut owner);

    let failure = retire_and_revoke_classic_group_assignment(
        &owner,
        &mut catalog,
        &mut processing_lease,
        &mut fetch,
        assignment,
        generation,
    )
    .err()
    .unwrap_or_else(|| panic!("foreign processing fence must reject revocation"));

    assert_eq!(
        failure.kind,
        ClassicGroupRevocationFailureKind::ProcessingLease(
            ClassicProcessingLeaseError::FenceMismatch,
        )
    );
    assert_eq!(catalog.live_assignment(), Some(&failure.assignment));
    assert!(processing_lease.next_deadline().is_some());
    assert!(fetch.activation().is_some());
    assert!(fetch.fault().is_none());
}

fn activate_fetch(
    catalog: &GroupSessionCatalog,
    owner: &ClassicGroupOwner,
    fetch: &mut ClassicGroupFetchOwner,
    generation_override: Option<AssignmentGeneration>,
) {
    let assignment = catalog
        .live_assignment()
        .unwrap_or_else(|| panic!("catalog assignment"));
    let fence = GroupPositionFence::new(
        assignment.group_id(),
        owner
            .machine()
            .active_cycle()
            .unwrap_or_else(|| panic!("active membership cycle")),
        assignment.member_id(),
        generation_override.unwrap_or_else(|| assignment.assignment_generation()),
    );
    let facts = assignment
        .partitions()
        .iter()
        .copied()
        .map(|partition| {
            GroupPositionPartitionFact::committed(
                partition,
                NextFetchOffset::try_from_raw(17)
                    .unwrap_or_else(|| panic!("nonnegative next offset")),
            )
        })
        .collect();
    if fetch
        .try_activate(
            completed_ready(
                fence,
                Moment::from_tick(41),
                GroupPositionBatch::new(0, facts),
            ),
            fence,
        )
        .is_err()
    {
        panic!("Fetch activation failed");
    }
}

fn active_processing_lease(
    catalog: &GroupSessionCatalog,
    owner: &ClassicGroupOwner,
    generation_override: Option<AssignmentGeneration>,
) -> ClassicProcessingLease {
    let policy = ClassicProcessingLeasePolicy::try_new(DEFAULT_CLASSIC_PROCESSING_TIMEOUT_TICKS)
        .unwrap_or_else(|error| panic!("positive processing policy: {error}"));
    let mut lease = ClassicProcessingLease::new(policy);
    let assignment = catalog
        .live_assignment()
        .unwrap_or_else(|| panic!("catalog assignment"));
    let cycle = owner
        .machine()
        .active_cycle()
        .unwrap_or_else(|| panic!("active membership cycle"));
    let fence = ClassicProcessingLeaseFence::new(
        assignment.group_id(),
        cycle,
        generation_override.unwrap_or_else(|| assignment.assignment_generation()),
    );
    lease
        .prepare_activation(fence, Moment::from_tick(3))
        .unwrap_or_else(|error| panic!("processing activation failed: {error:?}"))
        .commit();
    lease
}

fn lose_assignment(
    owner: &mut ClassicGroupOwner,
) -> (kafka_client_core::LiveGroupAssignment, ClassicGeneration) {
    let cycle = owner
        .machine()
        .active_cycle()
        .unwrap_or_else(|| panic!("active membership cycle"));
    let effect = owner
        .apply(ClassicGroupInput::AssignmentLost { cycle })
        .unwrap_or_else(|error| panic!("assignment loss failed: {error}"))
        .into_effects()
        .next()
        .unwrap_or_else(|| panic!("Revoke expected"));
    let ClassicGroupEffect::Revoke {
        assignment,
        classic_generation,
    } = effect
    else {
        panic!("Revoke expected");
    };
    (assignment, classic_generation)
}