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
//! The reactor manager creates new reactors and allows relaying requests to the correct reactor
//! based on names.

use crate::event_hub::SubscriptionRequest;
use crate::reactors::executors::{GenerationError, ReactorExecutorFactory};
use crate::reactors::reactor::ReactorWorkflowUpdate;
use crate::reactors::{start_reactor, ReactorDefinition, ReactorRequest};
use futures::future::BoxFuture;
use futures::stream::FuturesUnordered;
use futures::{FutureExt, StreamExt};
use std::collections::{HashMap, HashSet};
use tokio::sync::mpsc::{unbounded_channel, UnboundedReceiver, UnboundedSender};
use tokio::sync::oneshot::Sender;
use tracing::{error, info, instrument, warn};

/// Requests that can be made to the reactor manager
#[derive(Debug)]
pub enum ReactorManagerRequest {
    /// Requests a reactor to be created based on the specified definition
    CreateReactor {
        definition: ReactorDefinition,
        response_channel: Sender<CreateReactorResult>,
    },

    /// Requests that the specified reactor start a workflow based on the specified stream name
    CreateWorkflowForStreamName {
        /// The name of the reactor to send this request to
        reactor_name: String,

        /// The name of the stream to look up a workflow for
        stream_name: String,

        /// Channel that will be used to keep the created workflow alive. When the sender end of
        /// the channel is closed, that will be a signal to the reactor to remove the created
        /// workflow.
        response_channel: UnboundedSender<ReactorWorkflowUpdate>,
    },
}

#[derive(Debug)]
pub enum CreateReactorResult {
    Success,
    DuplicateReactorName,
    ExecutorGeneratorError(GenerationError),
    ExecutorReturnedError(Box<dyn std::error::Error + Sync + Send>),
}

pub fn start_reactor_manager(
    executor_factory: ReactorExecutorFactory,
    event_hub_subscriber: UnboundedSender<SubscriptionRequest>,
) -> UnboundedSender<ReactorManagerRequest> {
    let (sender, receiver) = unbounded_channel();
    let actor = Actor::new(executor_factory, receiver, event_hub_subscriber);
    tokio::spawn(actor.run());

    sender
}

enum FutureResult {
    AllConsumersGone,
    RequestReceived(
        ReactorManagerRequest,
        UnboundedReceiver<ReactorManagerRequest>,
    ),
}

struct Actor {
    executor_factory: ReactorExecutorFactory,
    event_hub_subscriber: UnboundedSender<SubscriptionRequest>,
    futures: FuturesUnordered<BoxFuture<'static, FutureResult>>,
    reactors: HashMap<String, UnboundedSender<ReactorRequest>>,
}

unsafe impl Send for Actor {}

impl Actor {
    fn new(
        executor_factory: ReactorExecutorFactory,
        receiver: UnboundedReceiver<ReactorManagerRequest>,
        event_hub_subscriber: UnboundedSender<SubscriptionRequest>,
    ) -> Self {
        let futures = FuturesUnordered::new();
        futures.push(wait_for_request(receiver).boxed());

        Actor {
            executor_factory,
            event_hub_subscriber,
            futures,
            reactors: HashMap::new(),
        }
    }

    #[instrument(name = "Reactor Manager Execution", skip(self))]
    async fn run(mut self) {
        info!("Starting reactor manager");

        while let Some(result) = self.futures.next().await {
            match result {
                FutureResult::AllConsumersGone => {
                    info!("All consumers gone");
                    break;
                }

                FutureResult::RequestReceived(request, receiver) => {
                    self.futures.push(wait_for_request(receiver).boxed());
                    self.handle_request(request);
                }
            }
        }

        info!("Reactor manager closing");
    }

    fn handle_request(&mut self, request: ReactorManagerRequest) {
        match request {
            ReactorManagerRequest::CreateReactor {
                definition,
                response_channel,
            } => {
                if self.reactors.contains_key(&definition.name) {
                    let _ = response_channel.send(CreateReactorResult::DuplicateReactorName);
                    return;
                }

                let generator = match self.executor_factory.get_generator(&definition.executor) {
                    Ok(generator) => generator,
                    Err(error) => {
                        warn!(
                            reactor_name = %definition.name,
                            executor_name = %definition.executor,
                            "Reactor {} is configured to use executor {}, but the factory \
                            returned an error when trying to get it: {:?}",
                            definition.name, definition.executor, error
                        );

                        let _ = response_channel
                            .send(CreateReactorResult::ExecutorGeneratorError(error));
                        return;
                    }
                };

                let executor = match generator.generate(&definition.parameters) {
                    Ok(executor) => executor,
                    Err(error) => {
                        warn!(
                            reactor_name = %definition.name,
                            "Executor failed to be generated for reactor {}: {:?}",
                            definition.name, error
                        );

                        let _ = response_channel
                            .send(CreateReactorResult::ExecutorReturnedError(error));
                        return;
                    }
                };

                let reactor = start_reactor(
                    definition.name.clone(),
                    executor,
                    self.event_hub_subscriber.clone(),
                    definition.update_interval,
                );

                self.reactors.insert(definition.name, reactor);

                let _ = response_channel.send(CreateReactorResult::Success);
            }

            ReactorManagerRequest::CreateWorkflowForStreamName {
                reactor_name,
                stream_name,
                response_channel,
            } => {
                let reactor = match self.reactors.get(&reactor_name) {
                    Some(reactor) => reactor,
                    None => {
                        error!(
                            reactor_name = %reactor_name,
                            "Request received for reactor {}, but no reactor exists with that name",
                            reactor_name,
                        );

                        let _ = response_channel.send(ReactorWorkflowUpdate {
                            is_valid: false,
                            routable_workflow_names: HashSet::new(),
                        });

                        return;
                    }
                };

                let _ = reactor.send(ReactorRequest::CreateWorkflowNameForStream {
                    stream_name,
                    response_channel,
                });
            }
        }
    }
}

async fn wait_for_request(mut receiver: UnboundedReceiver<ReactorManagerRequest>) -> FutureResult {
    match receiver.recv().await {
        Some(request) => FutureResult::RequestReceived(request, receiver),
        None => FutureResult::AllConsumersGone,
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::reactors::executors::{
        ReactorExecutionResult, ReactorExecutor, ReactorExecutorGenerator,
    };
    use crate::test_utils;
    use crate::workflows::definitions::WorkflowDefinition;
    use std::error::Error;
    use std::time::Duration;
    use tokio::sync::oneshot::channel;

    #[tokio::test]
    async fn successful_result_for_new_reactor() {
        let context = TestContext::new();

        let mut parameters = HashMap::new();
        parameters.insert("abc".to_string(), None);

        let (sender, receiver) = channel();
        context
            .manager
            .send(ReactorManagerRequest::CreateReactor {
                definition: ReactorDefinition {
                    name: "reactor".to_string(),
                    update_interval: Duration::new(0, 0),
                    parameters,
                    executor: "exe".to_string(),
                },
                response_channel: sender,
            })
            .expect("Failed to send create request");

        let response = test_utils::expect_oneshot_response(receiver).await;
        match response {
            CreateReactorResult::Success => (),
            response => panic!("Expected a success response, instead got {:?}", response),
        }
    }

    #[tokio::test]
    async fn duplicate_name_error_when_multiple_reactors_have_same_name() {
        let context = TestContext::new();

        let mut parameters = HashMap::new();
        parameters.insert("abc".to_string(), None);

        let (sender, receiver) = channel();
        context
            .manager
            .send(ReactorManagerRequest::CreateReactor {
                definition: ReactorDefinition {
                    name: "reactor".to_string(),
                    update_interval: Duration::new(0, 0),
                    parameters: parameters.clone(),
                    executor: "exe".to_string(),
                },
                response_channel: sender,
            })
            .expect("Failed to send create request");

        let _ = test_utils::expect_oneshot_response(receiver).await;

        let (sender, receiver) = channel();
        context
            .manager
            .send(ReactorManagerRequest::CreateReactor {
                definition: ReactorDefinition {
                    name: "reactor".to_string(),
                    update_interval: Duration::new(0, 0),
                    parameters: parameters.clone(),
                    executor: "exe".to_string(),
                },
                response_channel: sender,
            })
            .expect("Failed to send create request");

        let response = test_utils::expect_oneshot_response(receiver).await;
        match response {
            CreateReactorResult::DuplicateReactorName => (),
            response => panic!("Expected a success response, instead got {:?}", response),
        }
    }

    #[tokio::test]
    async fn error_when_generator_fails() {
        let context = TestContext::new();

        let mut parameters = HashMap::new();
        parameters.insert("abcd".to_string(), None);

        let (sender, receiver) = channel();
        context
            .manager
            .send(ReactorManagerRequest::CreateReactor {
                definition: ReactorDefinition {
                    name: "reactor".to_string(),
                    update_interval: Duration::new(0, 0),
                    parameters,
                    executor: "exe".to_string(),
                },
                response_channel: sender,
            })
            .expect("Failed to send create request");

        let response = test_utils::expect_oneshot_response(receiver).await;
        match response {
            CreateReactorResult::ExecutorReturnedError(_) => (),
            response => panic!("Expected a success response, instead got {:?}", response),
        }
    }

    #[tokio::test]
    async fn error_when_generator_not_found() {
        let context = TestContext::new();

        let mut parameters = HashMap::new();
        parameters.insert("abc".to_string(), None);

        let (sender, receiver) = channel();
        context
            .manager
            .send(ReactorManagerRequest::CreateReactor {
                definition: ReactorDefinition {
                    name: "reactor".to_string(),
                    update_interval: Duration::new(0, 0),
                    parameters,
                    executor: "exe2".to_string(),
                },
                response_channel: sender,
            })
            .expect("Failed to send create request");

        let response = test_utils::expect_oneshot_response(receiver).await;
        match response {
            CreateReactorResult::ExecutorGeneratorError(
                GenerationError::NoRegisteredGenerator(name),
            ) => {
                assert_eq!(&name, "exe2", "Error contained an unexpected name");
            }
            response => panic!("Expected a success response, instead got {:?}", response),
        }
    }

    #[tokio::test]
    async fn create_workflow_request_sends_to_correct_reactor() {
        let context = TestContext::new();

        let mut parameters = HashMap::new();
        parameters.insert("abc".to_string(), None);

        let (sender, receiver) = channel();
        context
            .manager
            .send(ReactorManagerRequest::CreateReactor {
                definition: ReactorDefinition {
                    name: "reactor".to_string(),
                    update_interval: Duration::new(0, 0),
                    parameters,
                    executor: "exe".to_string(),
                },
                response_channel: sender,
            })
            .expect("Failed to send create request");

        let response = test_utils::expect_oneshot_response(receiver).await;
        match response {
            CreateReactorResult::Success => (),
            response => panic!("Expected a success response, instead got {:?}", response),
        }

        let (sender, mut receiver) = unbounded_channel();
        context
            .manager
            .send(ReactorManagerRequest::CreateWorkflowForStreamName {
                reactor_name: "reactor".to_string(),
                stream_name: "def".to_string(),
                response_channel: sender,
            })
            .expect("Failed to send create workflow request");

        let response = test_utils::expect_mpsc_response(&mut receiver).await;
        assert!(
            response.is_valid,
            "Expected response to have an is_valid flag of true"
        );
    }

    #[tokio::test]
    async fn create_workflow_request_returns_not_valid_when_no_reactor_has_specified_name() {
        let context = TestContext::new();

        let mut parameters = HashMap::new();
        parameters.insert("abc".to_string(), None);

        let (sender, receiver) = channel();
        context
            .manager
            .send(ReactorManagerRequest::CreateReactor {
                definition: ReactorDefinition {
                    name: "reactor".to_string(),
                    update_interval: Duration::new(0, 0),
                    parameters,
                    executor: "exe".to_string(),
                },
                response_channel: sender,
            })
            .expect("Failed to send create request");

        let response = test_utils::expect_oneshot_response(receiver).await;
        match response {
            CreateReactorResult::Success => (),
            response => panic!("Expected a success response, instead got {:?}", response),
        }

        let (sender, mut receiver) = unbounded_channel();
        context
            .manager
            .send(ReactorManagerRequest::CreateWorkflowForStreamName {
                reactor_name: "reactor2".to_string(),
                stream_name: "def".to_string(),
                response_channel: sender,
            })
            .expect("Failed to send create workflow request");

        let response = test_utils::expect_mpsc_response(&mut receiver).await;
        assert!(
            !response.is_valid,
            "Expected response to have an is_valid flag of false"
        );
    }

    struct TestContext {
        manager: UnboundedSender<ReactorManagerRequest>,
        _event_receiver: UnboundedReceiver<SubscriptionRequest>,
    }

    struct TestExecutorGenerator;
    struct TestExecutor;

    impl TestContext {
        fn new() -> Self {
            let mut factory = ReactorExecutorFactory::new();
            factory
                .register("exe".to_string(), Box::new(TestExecutorGenerator))
                .expect("Registration failed");

            let (event_sender, event_receiver) = unbounded_channel();
            let manager = start_reactor_manager(factory, event_sender);

            TestContext {
                manager,
                _event_receiver: event_receiver,
            }
        }
    }

    impl ReactorExecutor for TestExecutor {
        fn get_workflow(&self, _stream_name: String) -> BoxFuture<'static, ReactorExecutionResult> {
            async {
                ReactorExecutionResult::valid(vec![WorkflowDefinition {
                    name: "test".to_string(),
                    routed_by_reactor: false,
                    steps: Vec::new(),
                }])
            }
            .boxed()
        }
    }

    impl ReactorExecutorGenerator for TestExecutorGenerator {
        fn generate(
            &self,
            parameters: &HashMap<String, Option<String>>,
        ) -> Result<Box<dyn ReactorExecutor>, Box<dyn Error + Sync + Send>> {
            if parameters.contains_key("abc") {
                Ok(Box::new(TestExecutor))
            } else {
                Err("Test".into())
            }
        }
    }
}