ractor 0.16.5

A actor framework for Rust
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
// Copyright (c) Sean Lawlor
//
// This source code is licensed under both the MIT license found in the
// LICENSE-MIT file in the root directory of this source tree.

use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Arc;

use crate::concurrency::Duration;
use crate::factory::*;
use crate::rpc::CallResult;
use crate::{Actor, ActorProcessingErr, ActorRef, MessagingErr, RpcReplyPort};

#[derive(Debug)]
enum TestMessage {
    Increment,
    Echo(usize, RpcReplyPort<usize>),
}

#[cfg(feature = "cluster")]
impl crate::Message for TestMessage {}

struct TestWorker {
    handled: Arc<AtomicUsize>,
    generation: usize,
}

#[cfg_attr(feature = "async-trait", crate::async_trait)]
impl Worker for TestWorker {
    type Key = ();
    type Message = TestMessage;
    type State = ();
    type Arguments = ();

    async fn pre_start(
        &self,
        _wid: WorkerId,
        _factory: &FactoryRef<Self::Key, Self::Message>,
        arguments: Self::Arguments,
    ) -> Result<Self::State, ActorProcessingErr> {
        Ok(arguments)
    }

    async fn handle(
        &self,
        _wid: WorkerId,
        _factory: &ActorRef<FactoryMessage<Self::Key, Self::Message>>,
        Job { key, msg, .. }: Job<Self::Key, Self::Message>,
        _state: &mut Self::State,
    ) -> Result<Self::Key, ActorProcessingErr> {
        self.handled.fetch_add(self.generation, Ordering::Relaxed);
        if let TestMessage::Echo(value, reply) = msg {
            let _ = reply.send(value);
        }
        Ok(key)
    }
}

#[derive(Default)]
struct NewJobStats {
    count: AtomicUsize,
}

// All callbacks other than the one this test needs use the trait's no-op defaults.
impl FactoryStatsLayer for NewJobStats {
    fn new_job(&self, _factory: &str) {
        self.count.fetch_add(1, Ordering::Relaxed);
    }
}

#[crate::concurrency::test]
async fn factory_ref_and_closure_builder_cover_common_operations() {
    let handled = Arc::new(AtomicUsize::new(0));
    let builds = Arc::new(AtomicUsize::new(0));
    let stats = Arc::new(NewJobStats::default());
    let worker_handled = handled.clone();
    let worker_builds = builds.clone();
    let mut generation = 0;
    let builder = worker_builder(move |_wid| {
        generation += 1;
        worker_builds.store(generation, Ordering::Relaxed);
        (
            TestWorker {
                handled: worker_handled.clone(),
                generation,
            },
            (),
        )
    });

    let definition = Factory::<
        (),
        TestMessage,
        (),
        TestWorker,
        routing::QueuerRouting<(), TestMessage>,
        queues::DefaultQueue<(), TestMessage>,
    >::default();
    let arguments = FactoryArguments::builder()
        .worker_builder(Box::new(builder))
        .num_initial_workers(1)
        .router(routing::QueuerRouting::default())
        .queue(queues::DefaultQueue::default())
        .stats(stats.clone())
        .build();

    let (factory, handle) = Actor::spawn(None, definition, arguments)
        .await
        .expect("factory should start");
    let factory: FactoryRef<(), TestMessage> = factory;
    let timeout = Some(Duration::from_secs(1));

    assert_eq!(
        CallResult::Success(1),
        factory
            .available_capacity(timeout)
            .await
            .expect("capacity query should be sent")
    );

    factory
        .dispatch((), TestMessage::Increment)
        .expect("message should be dispatched");
    factory
        .dispatch_with_options(
            (),
            TestMessage::Increment,
            JobOptions::new(Some(Duration::from_secs(1))),
        )
        .expect("message with options should be dispatched");
    factory
        .dispatch_job(Job::new((), TestMessage::Increment))
        .expect("configured job should be dispatched");

    assert_eq!(
        CallResult::Success(42),
        factory
            .call_job((), |reply| TestMessage::Echo(42, reply), timeout)
            .await
            .expect("worker call should be sent")
    );
    assert_eq!(
        CallResult::Success(84),
        factory
            .call_job_with_options(
                (),
                |reply| TestMessage::Echo(84, reply),
                JobOptions::default(),
                timeout,
            )
            .await
            .expect("worker call with options should be sent")
    );

    assert!(factory
        .queue_depth(timeout)
        .await
        .expect("queue depth query should be sent")
        .is_success());
    assert!(factory
        .active_workers(timeout)
        .await
        .expect("active worker query should be sent")
        .is_success());

    factory
        .adjust_worker_pool(2)
        .expect("pool adjustment should be sent");
    assert!(factory
        .available_capacity(timeout)
        .await
        .expect("capacity query should be sent")
        .is_success());
    assert_eq!(2, builds.load(Ordering::Relaxed));
    factory
        .update_settings(UpdateSettingsRequest::builder().worker_count(1).build())
        .expect("settings update should be sent");

    factory
        .drain_requests()
        .expect("drain request should be sent");
    crate::concurrency::timeout(Duration::from_secs(1), handle)
        .await
        .expect("factory should drain within the timeout")
        .expect("factory should exit cleanly");

    assert_eq!(5, handled.load(Ordering::Relaxed));
    assert_eq!(5, stats.count.load(Ordering::Relaxed));
}

#[crate::concurrency::test]
async fn one_way_helper_recovers_job_when_factory_is_stopped() {
    let handled = Arc::new(AtomicUsize::new(0));
    let definition = Factory::<
        (),
        TestMessage,
        (),
        TestWorker,
        routing::QueuerRouting<(), TestMessage>,
        queues::DefaultQueue<(), TestMessage>,
    >::default();
    let arguments = FactoryArguments::builder()
        .worker_builder(Box::new(worker_builder(move |_wid| {
            (
                TestWorker {
                    handled: handled.clone(),
                    generation: 1,
                },
                (),
            )
        })))
        .num_initial_workers(1)
        .router(routing::QueuerRouting::default())
        .queue(queues::DefaultQueue::default())
        .build();

    let (factory, handle) = Actor::spawn(None, definition, arguments)
        .await
        .expect("factory should start");
    factory.stop(None);
    handle.await.expect("factory should stop cleanly");

    let error = factory
        .dispatch((), TestMessage::Increment)
        .expect_err("dispatch to a stopped factory should fail");
    match *error {
        MessagingErr::SendErr(FactoryMessage::Dispatch(Job {
            key: (),
            msg: TestMessage::Increment,
            accepted: None,
            ..
        })) => {}
        other => panic!("expected the failed job to be returned, got {other:?}"),
    }
}

#[crate::concurrency::test]
async fn worker_queue_capacity_includes_each_workers_queue() {
    let handled = Arc::new(AtomicUsize::new(0));
    let definition = Factory::<
        (),
        TestMessage,
        (),
        TestWorker,
        routing::KeyPersistentRouting<(), TestMessage>,
        queues::DefaultQueue<(), TestMessage>,
    >::default();
    let arguments = FactoryArguments::builder()
        .worker_builder(Box::new(worker_builder(move |_wid| {
            (
                TestWorker {
                    handled: handled.clone(),
                    generation: 1,
                },
                (),
            )
        })))
        .num_initial_workers(2)
        .router(routing::KeyPersistentRouting::default())
        .queue(queues::DefaultQueue::default())
        .discard_settings(DiscardSettings::Static {
            limit: 3,
            mode: DiscardMode::Newest,
        })
        .build();
    let (factory, handle) = Actor::spawn(None, definition, arguments)
        .await
        .expect("factory should start");
    let factory: FactoryRef<(), TestMessage> = factory;

    assert_eq!(
        CallResult::Success(8),
        factory
            .available_capacity(Some(Duration::from_secs(1)))
            .await
            .expect("capacity query should be sent")
    );

    factory.stop(None);
    handle.await.expect("factory should stop cleanly");
}

#[crate::concurrency::test]
async fn shared_queue_capacity_saturates_after_limit_reduction() {
    let handled = Arc::new(AtomicUsize::new(0));
    let definition = Factory::<
        (),
        TestMessage,
        (),
        TestWorker,
        routing::QueuerRouting<(), TestMessage>,
        queues::DefaultQueue<(), TestMessage>,
    >::default();
    let arguments = FactoryArguments::builder()
        .worker_builder(Box::new(worker_builder({
            let handled = handled.clone();
            move |_wid| {
                (
                    TestWorker {
                        handled: handled.clone(),
                        generation: 1,
                    },
                    (),
                )
            }
        })))
        .num_initial_workers(1)
        .router(routing::QueuerRouting::default())
        .queue(queues::DefaultQueue::default())
        .build();
    let (factory, handle) = Actor::spawn(None, definition, arguments)
        .await
        .expect("factory should start");
    let factory: FactoryRef<(), TestMessage> = factory;

    for _ in 0..32 {
        factory
            .dispatch((), TestMessage::Increment)
            .expect("message should be dispatched");
    }
    factory
        .update_settings(
            UpdateSettingsRequest::builder()
                .discard_settings(DiscardSettings::Static {
                    limit: 0,
                    mode: DiscardMode::Newest,
                })
                .build(),
        )
        .expect("settings update should be sent");

    assert_eq!(
        CallResult::Success(0),
        factory
            .available_capacity(Some(Duration::from_secs(1)))
            .await
            .expect("capacity query should be sent")
    );

    factory.stop(None);
    handle.await.expect("factory should stop cleanly");
}

#[crate::concurrency::test]
async fn zero_initial_worker_pool_queues_until_resized() {
    let handled = Arc::new(AtomicUsize::new(0));
    let definition = Factory::<
        (),
        TestMessage,
        (),
        TestWorker,
        routing::RoundRobinRouting<(), TestMessage>,
        queues::DefaultQueue<(), TestMessage>,
    >::default();
    let arguments = FactoryArguments::builder()
        .worker_builder(Box::new(worker_builder({
            let handled = handled.clone();
            move |_wid| {
                (
                    TestWorker {
                        handled: handled.clone(),
                        generation: 1,
                    },
                    (),
                )
            }
        })))
        .num_initial_workers(0)
        .router(routing::RoundRobinRouting::default())
        .queue(queues::DefaultQueue::default())
        .build();

    let (factory, handle) = Actor::spawn(None, definition, arguments).await.unwrap();
    factory
        .cast(FactoryMessage::Dispatch(Job::new(
            (),
            TestMessage::Increment,
        )))
        .unwrap();
    assert_eq!(handled.load(Ordering::Relaxed), 0);

    factory.cast(FactoryMessage::AdjustWorkerPool(1)).unwrap();
    crate::periodic_check(
        || handled.load(Ordering::Relaxed) == 1,
        Duration::from_secs(1),
    )
    .await;

    factory.stop(None);
    handle.await.unwrap();
}

#[crate::concurrency::test]
async fn invalid_custom_worker_selection_is_bounded_to_the_pool() {
    struct InvalidHasher;

    impl routing::CustomHashFunction<()> for InvalidHasher {
        fn hash(&self, _key: &(), worker_count: usize) -> usize {
            worker_count
        }
    }

    let handled = Arc::new(AtomicUsize::new(0));
    let definition = Factory::<
        (),
        TestMessage,
        (),
        TestWorker,
        routing::CustomRouting<(), TestMessage, InvalidHasher>,
        queues::DefaultQueue<(), TestMessage>,
    >::default();
    let arguments = FactoryArguments::builder()
        .worker_builder(Box::new(worker_builder({
            let handled = handled.clone();
            move |_wid| {
                (
                    TestWorker {
                        handled: handled.clone(),
                        generation: 1,
                    },
                    (),
                )
            }
        })))
        .num_initial_workers(1)
        .router(routing::CustomRouting::new(InvalidHasher))
        .queue(queues::DefaultQueue::default())
        .build();
    let (factory, handle) = Actor::spawn(None, definition, arguments).await.unwrap();
    let (accepted, receiver) = crate::concurrency::oneshot();

    factory
        .cast(FactoryMessage::Dispatch(Job {
            key: (),
            msg: TestMessage::Increment,
            options: JobOptions::default(),
            accepted: Some(accepted.into()),
        }))
        .unwrap();

    assert!(receiver.await.unwrap().is_none());
    crate::periodic_check(
        || handled.load(Ordering::Relaxed) == 1,
        Duration::from_secs(1),
    )
    .await;
    assert!(factory.get_status() < crate::ActorStatus::Stopping);

    factory.stop(None);
    handle.await.unwrap();
}