sozu 0.14.2

sozu, a fast, reliable, hot reconfigurable HTTP reverse proxy
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
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
use std::{
    collections::{BTreeMap, HashSet},
    fs::File,
    io::{Read, Write},
    os::unix::io::{FromRawFd, IntoRawFd},
    os::unix::net::UnixStream,
    time::{Duration, Instant},
};

use anyhow::{bail, Context};
use async_io::Async;
use futures::{channel::mpsc::*, SinkExt, StreamExt};
use nom::{Err, HexDisplay, Offset};

use sozu_command_lib::{
    buffer::fixed::Buffer,
    command::{
        CommandRequest, CommandRequestOrder, CommandResponse, CommandResponseContent,
        CommandStatus, FrontendFilters, ListedFrontends, RunState, WorkerInfo, PROTOCOL_VERSION,
    },
    config::Config,
    logging,
    parser::parse_several_commands,
    proxy::{
        AggregatedMetricsData, MetricsConfiguration, ProxyRequest, ProxyRequestOrder,
        ProxyResponseContent, ProxyResponseStatus, Query, QueryAnswer, QueryClusterType,
    },
    scm_socket::Listeners,
    state::get_cluster_ids_by_domain,
};

use sozu::metrics::METRICS;

use crate::{
    command::{CommandMessage, CommandServer, RequestIdentifier, Response, Success, Worker},
    upgrade::fork_main_into_new_main,
    worker::start_worker,
};

impl CommandServer {
    pub async fn handle_client_request(
        &mut self,
        client_id: String,
        request: CommandRequest,
    ) -> anyhow::Result<Success> {
        trace!("Received order {:?}", request);
        let request_identifier = RequestIdentifier {
            client: client_id.to_owned(),
            request: request.id.to_owned(),
        };
        let cloned_identifier = request_identifier.clone();

        let result: anyhow::Result<Option<Success>> = match request.order {
            CommandRequestOrder::SaveState { path } => self.save_state(&path).await,
            CommandRequestOrder::DumpState => self.dump_state().await,
            CommandRequestOrder::ListWorkers => self.list_workers().await,
            CommandRequestOrder::ListFrontends(filters) => self.list_frontends(filters).await,
            CommandRequestOrder::LoadState { path } => {
                self.load_state(
                    Some(request_identifier.client),
                    request_identifier.request,
                    &path,
                )
                .await
            }
            CommandRequestOrder::LaunchWorker(tag) => {
                self.launch_worker(request_identifier, &tag).await
            }
            CommandRequestOrder::UpgradeMain => self.upgrade_main(request_identifier).await,
            CommandRequestOrder::UpgradeWorker(worker_id) => {
                self.upgrade_worker(request_identifier, worker_id).await
            }
            CommandRequestOrder::Proxy(proxy_request_order) => match *proxy_request_order {
                ProxyRequestOrder::ConfigureMetrics(config) => {
                    self.configure_metrics(request_identifier, config).await
                }
                ProxyRequestOrder::Query(query) => self.query(request_identifier, query).await,
                ProxyRequestOrder::Logging(logging_filter) => {
                    self.set_logging_level(logging_filter)
                }
                // we should have something like
                // ProxyRequestOrder::SoftStop => self.do_something(),
                // ProxyRequestOrder::HardStop => self.do_nothing_and_return_early(),
                // but it goes in there instead:
                order => {
                    self.worker_order(request_identifier, order, request.worker_id)
                        .await
                }
            },
            CommandRequestOrder::SubscribeEvents => {
                self.event_subscribers.insert(client_id.clone());
                Ok(Some(Success::SubscribeEvent(client_id.clone())))
            }
            CommandRequestOrder::ReloadConfiguration { path } => {
                self.reload_configuration(request_identifier, path).await
            }
            CommandRequestOrder::Status => self.status(request_identifier).await,
        };

        // Notify the command server by sending using his command_tx
        match result {
            Ok(Some(success)) => {
                info!("{}", success);
                return_success(self.command_tx.clone(), cloned_identifier, success).await;
            }
            Err(anyhow_error) => {
                let formatted = format!("{:#}", anyhow_error);
                error!("{:#}", formatted);
                return_error(self.command_tx.clone(), cloned_identifier, formatted).await;
            }
            Ok(None) => {
                // do nothing here. Ok(None) means the function has already returned its result
                // on its own to the command server
            }
        }

        Ok(Success::HandledClientRequest)
    }

    pub async fn save_state(&mut self, path: &str) -> anyhow::Result<Option<Success>> {
        let mut file = File::create(&path)
            .with_context(|| format!("could not open file at path: {}", &path))?;

        let counter = self
            .save_state_to_file(&mut file)
            .with_context(|| "failed writing state to file")?;

        info!("wrote {} commands to {}", counter, path);

        Ok(Some(Success::SaveState(counter, path.into())))
    }

    pub fn save_state_to_file(&mut self, file: &mut File) -> anyhow::Result<usize> {
        let mut counter = 0usize;
        let orders = self.state.generate_orders();

        let result: anyhow::Result<usize> = (move || {
            for command in orders {
                let message = CommandRequest::new(
                    format!("SAVE-{}", counter),
                    CommandRequestOrder::Proxy(Box::new(command)),
                    None,
                );

                file.write_all(
                    &serde_json::to_string(&message)
                        .map(|s| s.into_bytes())
                        .unwrap_or_default(),
                )
                .with_context(|| {
                    format!(
                        "Could not add this instruction line to the saved state file: {:?}",
                        message
                    )
                })?;

                file.write_all(&b"\n\0"[..])
                    .with_context(|| "Could not add new line to the saved state file")?;

                if counter % 1000 == 0 {
                    info!("writing command {}", counter);
                    file.sync_all()
                        .with_context(|| "Failed to sync the saved state file")?;
                }
                counter += 1;
            }
            file.sync_all()
                .with_context(|| "Failed to sync the saved state file")?;

            Ok(counter)
        })();

        result.with_context(|| "Could not write the state onto the state file")
    }

    pub async fn dump_state(&mut self) -> anyhow::Result<Option<Success>> {
        let state = self.state.clone();

        Ok(Some(Success::DumpState(CommandResponseContent::State(
            Box::new(state),
        ))))
    }

    pub async fn load_state(
        &mut self,
        client_id: Option<String>,
        request_id: String,
        path: &str,
    ) -> anyhow::Result<Option<Success>> {
        let mut file =
            File::open(&path).with_context(|| format!("Cannot open file at path {}", path))?;

        let mut buffer = Buffer::with_capacity(200000);

        info!("starting to load state from {}", path);

        let mut message_counter = 0usize;
        let mut diff_counter = 0usize;

        let (load_state_tx, mut load_state_rx) = futures::channel::mpsc::channel(10000);
        loop {
            let previous = buffer.available_data();
            //FIXME: we should read in streaming here
            match file.read(buffer.space()) {
                Ok(sz) => buffer.fill(sz),
                Err(e) => {
                    bail!("Error reading the saved state file: {}", e);
                }
            };

            if buffer.available_data() == 0 {
                debug!("Empty buffer");
                break;
            }

            let mut offset = 0usize;
            match parse_several_commands::<CommandRequest>(buffer.data()) {
                Ok((i, requests)) => {
                    if !i.is_empty() {
                        debug!("could not parse {} bytes", i.len());
                        if previous == buffer.available_data() {
                            bail!("error consuming load state message");
                        }
                    }
                    offset = buffer.data().offset(i);

                    if requests.iter().any(|o| {
                        if o.version > PROTOCOL_VERSION {
                            error!("configuration protocol version mismatch: Sōzu handles up to version {}, the message uses version {}", PROTOCOL_VERSION, o.version);
                            true
                        } else {
                            false
                        }
                    }) {
                        break;
                    }

                    for request in requests {
                        if let CommandRequestOrder::Proxy(order) = request.order {
                            message_counter += 1;

                            if self.state.handle_order(&order).is_ok() {
                                diff_counter += 1;

                                let mut found = false;
                                let id = format!("LOAD-STATE-{}-{}", request_id, diff_counter);

                                for ref mut worker in self.workers.iter_mut().filter(|worker| {
                                    worker.run_state != RunState::Stopping
                                        && worker.run_state != RunState::Stopped
                                }) {
                                    let worker_message_id = format!("{}-{}", id, worker.id);
                                    worker.send(worker_message_id.clone(), *order.clone()).await;
                                    self.in_flight
                                        .insert(worker_message_id, (load_state_tx.clone(), 1));

                                    found = true;
                                }

                                if !found {
                                    bail!("no worker found");
                                }
                            }
                        }
                    }
                }
                Err(Err::Incomplete(_)) => {
                    if buffer.available_data() == buffer.capacity() {
                        error!(
                            "message too big, stopping parsing:\n{}",
                            buffer.data().to_hex(16)
                        );
                        break;
                    }
                }
                Err(parse_error) => {
                    bail!("saved state parse error: {:?}", parse_error);
                }
            }
            buffer.consume(offset);
        }

        info!(
            "stopped loading data from file, remaining: {} bytes, saw {} messages, generated {} diff messages",
            buffer.available_data(), message_counter, diff_counter
        );

        if diff_counter > 0 {
            info!(
                "state loaded from {}, will start sending {} messages to workers",
                path, diff_counter
            );

            let command_tx = self.command_tx.to_owned();
            let path = path.to_owned();

            smol::spawn(async move {
                let mut ok = 0usize;
                let mut error = 0usize;
                while let Some((proxy_response, _)) = load_state_rx.next().await {
                    match proxy_response.status {
                        ProxyResponseStatus::Ok => {
                            ok += 1;
                        }
                        ProxyResponseStatus::Processing => {}
                        ProxyResponseStatus::Error(message) => {
                            error!("{}", message);
                            error += 1;
                        }
                    };
                    debug!("ok:{}, error: {}", ok, error);
                }

                let request_identifier = match client_id {
                    Some(client_id) => RequestIdentifier::new(client_id, request_id),
                    None => {
                        match error {
                            0 => info!("loading state: {} ok messages, 0 errors", ok),
                            _ => error!("loading state: {} ok messages, {} errors", ok, error),
                        }
                        return;
                    }
                };

                // notify the command server
                match error {
                    0 => {
                        return_success(
                            command_tx,
                            request_identifier,
                            Success::LoadState(path.to_string(), ok, error),
                        )
                        .await;
                    }
                    _ => {
                        return_error(
                            command_tx,
                            request_identifier,
                            format!(
                                "Loading state failed, ok: {}, error: {}, path: {}",
                                ok, error, path
                            ),
                        )
                        .await;
                    }
                }
            })
            .detach();
        } else {
            info!("no messages sent to workers: local state already had those messages");
            if let Some(client_id) = client_id {
                return_success(
                    self.command_tx.clone(),
                    RequestIdentifier::new(client_id, request_id),
                    Success::LoadState(path.to_string(), 0, 0),
                )
                .await;
            }
        }

        self.backends_count = self.state.count_backends();
        self.frontends_count = self.state.count_frontends();
        gauge!("configuration.clusters", self.state.clusters.len());
        gauge!("configuration.backends", self.backends_count);
        gauge!("configuration.frontends", self.frontends_count);
        Ok(None)
    }

    pub async fn list_frontends(
        &mut self,
        filters: FrontendFilters,
    ) -> anyhow::Result<Option<Success>> {
        info!(
            "Received a request to list frontends, along these filters: {:?}",
            filters
        );

        // if no http / https / tcp filter is provided, list all of them
        let list_all = !filters.http && !filters.https && !filters.tcp;

        let mut listed_frontends = ListedFrontends::default();

        if filters.http || list_all {
            for http_frontend in self.state.http_fronts.iter().filter(|f| {
                if let Some(domain) = &filters.domain {
                    f.1.hostname.contains(domain)
                } else {
                    true
                }
            }) {
                listed_frontends
                    .http_frontends
                    .push(http_frontend.1.to_owned());
            }
        }

        if filters.https || list_all {
            for https_frontend in self.state.https_fronts.iter().filter(|f| {
                if let Some(domain) = &filters.domain {
                    f.1.hostname.contains(domain)
                } else {
                    true
                }
            }) {
                listed_frontends
                    .https_frontends
                    .push(https_frontend.1.to_owned());
            }
        }

        if (filters.tcp || list_all) && filters.domain.is_none() {
            for tcp_frontend in self.state.tcp_fronts.values().flat_map(|v| v.iter()) {
                listed_frontends.tcp_frontends.push(tcp_frontend.to_owned())
            }
        }

        Ok(Some(Success::ListFrontends(
            CommandResponseContent::FrontendList(listed_frontends),
        )))
    }

    pub async fn list_workers(&mut self) -> anyhow::Result<Option<Success>> {
        let workers: Vec<WorkerInfo> = self
            .workers
            .iter()
            .map(|worker| WorkerInfo {
                id: worker.id,
                pid: worker.pid,
                run_state: worker.run_state,
            })
            .collect();

        debug!("workers: {:#?}", workers);

        Ok(Some(Success::ListWorkers(CommandResponseContent::Workers(
            workers,
        ))))
    }

    pub async fn launch_worker(
        &mut self,
        request_identifier: RequestIdentifier,
        _tag: &str,
    ) -> anyhow::Result<Option<Success>> {
        let mut worker = start_worker(
            self.next_worker_id,
            &self.config,
            self.executable_path.clone(),
            &self.state,
            None,
        )
        .with_context(|| format!("Failed at creating worker {}", self.next_worker_id))?;

        return_processing(
            self.command_tx.clone(),
            request_identifier.clone(),
            "Sending configuration orders to the new worker...",
        )
        .await;

        info!("created new worker: {}", worker.id);

        self.next_worker_id += 1;

        let sock = worker
            .worker_channel
            .take()
            .expect("No channel on the worker being launched")
            .sock;
        let (worker_tx, worker_rx) = channel(10000);
        worker.sender = Some(worker_tx);

        let stream = Async::new(unsafe {
            let fd = sock.into_raw_fd();
            UnixStream::from_raw_fd(fd)
        })?;

        let id = worker.id;
        let command_tx = self.command_tx.clone();

        smol::spawn(async move {
            super::worker_loop(id, stream, command_tx, worker_rx).await;
        })
        .detach();

        info!(
            "sending listeners: to the new worker: {:?}",
            worker.scm_socket.send_listeners(&Listeners {
                http: Vec::new(),
                tls: Vec::new(),
                tcp: Vec::new(),
            })
        );

        let activate_orders = self.state.generate_activate_orders();
        for (count, order) in activate_orders.into_iter().enumerate() {
            worker
                .send(format!("{}-ACTIVATE-{}", id, count), order)
                .await;
        }

        self.workers.push(worker);

        return_success(
            self.command_tx.clone(),
            request_identifier,
            Success::WorkerLaunched(id),
        )
        .await;
        Ok(None)
    }

    pub async fn upgrade_main(
        &mut self,
        request_identifier: RequestIdentifier,
    ) -> anyhow::Result<Option<Success>> {
        self.disable_cloexec_before_upgrade()?;

        return_processing(
            self.command_tx.clone(),
            request_identifier,
            "The proxy is processing the upgrade command.",
        )
        .await;

        let upgrade_data = self.generate_upgrade_data();

        let (new_main_pid, mut fork_confirmation_channel) =
            fork_main_into_new_main(self.executable_path.clone(), upgrade_data)
                .with_context(|| "Could not start a new main process")?;

        if let Err(e) = fork_confirmation_channel.blocking() {
            error!(
                "Could not block the fork confirmation channel: {}. This is not normal, you may need to restart sozu",
                e
            );
        }
        let received_ok_from_new_process = fork_confirmation_channel.read_message();
        debug!("upgrade channel sent {:?}", received_ok_from_new_process);

        // signaling the accept loop that it should stop
        if let Err(e) = self
            .accept_cancel
            .take() // we should create a method on Self for this frequent procedure
            .expect("No channel on the main process")
            .send(())
        {
            error!("could not close the accept loop: {:?}", e);
        }

        if !received_ok_from_new_process
            .with_context(|| "Did not receive fork confirmation from new worker")?
        {
            bail!("forking the new worker failed")
        }
        info!("wrote final message, closing");
        Ok(Some(Success::UpgradeMain(new_main_pid)))
    }

    pub async fn upgrade_worker(
        &mut self,
        request_identifier: RequestIdentifier,
        id: u32,
    ) -> anyhow::Result<Option<Success>> {
        info!(
            "client[{}] msg {} wants to upgrade worker {}",
            request_identifier.client, request_identifier.request, id
        );

        if !self.workers.iter().any(|worker| {
            worker.id == id
                && worker.run_state != RunState::Stopping
                && worker.run_state != RunState::Stopped
            // should we add this?
            // && worker.run_state != RunState::NotAnswering
        }) {
            bail!(format!(
                "The worker {} does not exist, or is stopped / stopping.",
                &id
            ));
        }

        // same as launch_worker
        let next_id = self.next_worker_id;
        let mut new_worker = start_worker(
            next_id,
            &self.config,
            self.executable_path.clone(),
            &self.state,
            None,
        )
        .with_context(|| "failed at creating worker")?;

        return_processing(
            self.command_tx.clone(),
            request_identifier.clone(),
            "Sending configuration orders to the worker",
        )
        .await;

        info!("created new worker: {}", next_id);

        self.next_worker_id += 1;

        let sock = new_worker
            .worker_channel
            .take()
            .with_context(|| "No channel on new worker".to_string())?
            .sock;
        let (worker_tx, worker_rx) = channel(10000);
        new_worker.sender = Some(worker_tx);

        new_worker
            .sender
            .as_mut()
            .with_context(|| "No sender on new worker".to_string())?
            .send(ProxyRequest {
                id: format!("UPGRADE-{}-STATUS", id),
                order: ProxyRequestOrder::Status,
            })
            .await
            .with_context(|| {
                format!(
                    "could not send status message to worker {:?}",
                    new_worker.id,
                )
            })?;

        let mut listeners = None;
        {
            let old_worker: &mut Worker = self
                .workers
                .iter_mut()
                .find(|worker| worker.id == id)
                .unwrap();

            /*
            old_worker.channel.set_blocking(true);
            old_worker.channel.write_message(&ProxyRequest { id: String::from(message_id), order: ProxyRequestOrder::ReturnListenSockets });
            info!("sent returnlistensockets message to worker");
            old_worker.channel.set_blocking(false);
            */
            let (sockets_return_tx, mut sockets_return_rx) = futures::channel::mpsc::channel(3);
            let id = format!("{}-return-sockets", request_identifier.client);
            self.in_flight.insert(id.clone(), (sockets_return_tx, 1));
            old_worker
                .send(id.clone(), ProxyRequestOrder::ReturnListenSockets)
                .await;

            info!("sent ReturnListenSockets to old worker");

            let cloned_command_tx = self.command_tx.clone();
            let cloned_req_id = request_identifier.clone();
            smol::spawn(async move {
                while let Some((proxy_response, _)) = sockets_return_rx.next().await {
                    match proxy_response.status {
                        ProxyResponseStatus::Ok => {
                            info!("returnsockets OK");
                            break;
                        }
                        ProxyResponseStatus::Processing => {
                            info!("returnsockets processing");
                        }
                        ProxyResponseStatus::Error(message) => {
                            return_error(cloned_command_tx, cloned_req_id, message).await;
                            break;
                        }
                    };
                }
            })
            .detach();

            let mut counter = 0usize;

            loop {
                info!("waiting for listen sockets from the old worker");
                if let Err(e) = old_worker.scm_socket.set_blocking(true) {
                    error!("Could not set the old worker socket to blocking: {}", e);
                };
                match old_worker.scm_socket.receive_listeners() {
                    Ok(l) => {
                        listeners = Some(l);
                        break;
                    }
                    Err(error) => {
                        error!(
                            "Could not receive listerners from scm socket with file descriptor {}:\n{:?}",
                            old_worker.scm_socket.fd, error
                        );
                        counter += 1;
                        if counter == 50 {
                            break;
                        }
                        std::thread::sleep(Duration::from_millis(100));
                    }
                }
            }
            info!("got the listen sockets from the old worker");
            old_worker.run_state = RunState::Stopping;

            let (softstop_tx, mut softstop_rx) = futures::channel::mpsc::channel(10);
            let softstop_id = format!("{}-softstop", request_identifier.client);
            self.in_flight.insert(softstop_id.clone(), (softstop_tx, 1));
            old_worker
                .send(softstop_id.clone(), ProxyRequestOrder::SoftStop)
                .await;

            let mut command_tx = self.command_tx.clone();
            let cloned_request_identifier = request_identifier.clone();
            let worker_id = old_worker.id;
            smol::spawn(async move {
                while let Some((proxy_response, _)) = softstop_rx.next().await {
                    match proxy_response.status {
                        // should we send all this to the command server?
                        ProxyResponseStatus::Ok => {
                            info!("softstop OK"); // this doesn't display :-(
                            if let Err(e) = command_tx
                                .send(CommandMessage::WorkerClose { worker_id })
                                .await
                            {
                                error!(
                                    "could not send worker close message to {}: {:?}",
                                    worker_id, e
                                );
                            }
                            break;
                        }
                        ProxyResponseStatus::Processing => {
                            info!("softstop processing");
                        }
                        ProxyResponseStatus::Error(message) => {
                            info!("softstop error: {:?}", message);
                            break;
                        }
                    };
                }
                return_processing(
                    command_tx.clone(),
                    cloned_request_identifier,
                    "Processing softstop responses from the workers...",
                )
                .await;
            })
            .detach();
        }

        match listeners {
            Some(l) => {
                info!(
                    "sending listeners: to the new worker: {:?}",
                    new_worker.scm_socket.send_listeners(&l)
                );
                l.close();
            }
            None => error!("could not get the list of listeners from the previous worker"),
        };

        let stream = Async::new(unsafe {
            let fd = sock.into_raw_fd();
            UnixStream::from_raw_fd(fd)
        })?;

        let id = new_worker.id;
        let command_tx = self.command_tx.clone();
        smol::spawn(async move {
            super::worker_loop(id, stream, command_tx, worker_rx).await;
        })
        .detach();

        let activate_orders = self.state.generate_activate_orders();
        for (count, order) in activate_orders.into_iter().enumerate() {
            new_worker
                .send(
                    format!("{}-ACTIVATE-{}", request_identifier.client, count),
                    order,
                )
                .await;
        }

        info!("sent config messages to the new worker");
        self.workers.push(new_worker);

        info!("finished upgrade");
        Ok(Some(Success::UpgradeWorker(id)))
    }

    pub async fn reload_configuration(
        &mut self,
        request_identifier: RequestIdentifier,
        config_path: Option<String>,
    ) -> anyhow::Result<Option<Success>> {
        // check that this works
        let path = config_path.as_deref().unwrap_or(&self.config.config_path);
        let new_config = Config::load_from_path(path)
            .with_context(|| format!("cannot load configuration from '{}'", path))?;

        let mut diff_counter = 0usize;

        let (load_state_tx, mut load_state_rx) = futures::channel::mpsc::channel(10000);

        return_processing(
            self.command_tx.clone(),
            request_identifier.clone(),
            "Reloading configuration, sending config messages to workers...",
        )
        .await;

        for message in new_config.generate_config_messages() {
            if let CommandRequestOrder::Proxy(order) = message.order {
                if self.state.handle_order(&order).is_ok() {
                    diff_counter += 1;

                    let mut found = false;
                    let id = format!(
                        "LOAD-STATE-{}-{}",
                        &request_identifier.request, diff_counter
                    );

                    for ref mut worker in self.workers.iter_mut().filter(|worker| {
                        worker.run_state != RunState::Stopping
                            && worker.run_state != RunState::Stopped
                    }) {
                        let worker_message_id = format!("{}-{}", id, worker.id);
                        worker.send(worker_message_id.clone(), *order.clone()).await;
                        self.in_flight
                            .insert(worker_message_id, (load_state_tx.clone(), 1));

                        found = true;
                    }

                    if !found {
                        // FIXME: should send back error here
                        error!("no worker found");
                    }
                }
            }
        }

        // clone everything we will need in the detached thread
        let command_tx = self.command_tx.clone();
        let cloned_identifier = request_identifier.clone();

        if diff_counter > 0 {
            info!(
                "state loaded from {}, will start sending {} messages to workers",
                new_config.config_path, diff_counter
            );
            smol::spawn(async move {
                let mut ok = 0usize;
                let mut error = 0usize;
                while let Some((proxy_response, _)) = load_state_rx.next().await {
                    match proxy_response.status {
                        ProxyResponseStatus::Ok => {
                            ok += 1;
                        }
                        ProxyResponseStatus::Processing => {}
                        ProxyResponseStatus::Error(message) => {
                            error!("{}", message);
                            error += 1;
                        }
                    };
                    debug!("ok:{}, error: {}", ok, error);
                }

                if error == 0 {
                    return_success(
                        command_tx,
                        cloned_identifier,
                        Success::ReloadConfiguration(ok, error),
                    )
                    .await;
                } else {
                    return_error(
                        command_tx,
                        cloned_identifier,
                        format!(
                            "Reloading configuration failed. ok: {} messages, error: {}",
                            ok, error
                        ),
                    )
                    .await;
                }
            })
            .detach();
        } else {
            info!("no messages sent to workers: local state already had those messages");
        }

        self.backends_count = self.state.count_backends();
        self.frontends_count = self.state.count_frontends();
        gauge!("configuration.clusters", self.state.clusters.len());
        gauge!("configuration.backends", self.backends_count);
        gauge!("configuration.frontends", self.frontends_count);

        self.config = new_config;

        Ok(None)
    }

    pub async fn status(
        &mut self,
        request_identifier: RequestIdentifier,
    ) -> anyhow::Result<Option<Success>> {
        info!("Requesting the status of all workers.");

        let (status_tx, mut status_rx) = futures::channel::mpsc::channel(self.workers.len() * 2);

        // create a status list with the available info of the main process
        let mut worker_info_map: BTreeMap<String, WorkerInfo> = BTreeMap::new();

        let prefix = format!("{}-status-", request_identifier.client);

        return_processing(
            self.command_tx.clone(),
            request_identifier.clone(),
            "Sending status requests to workers...",
        )
        .await;

        let mut count = 0usize;
        for ref mut worker in self.workers.iter_mut() {
            info!("Worker {} is {}", worker.id, worker.run_state);

            // create request ids even if we don't send any request, as keys in the tree map
            let worker_request_id = format!("{}{}", prefix, worker.id);
            // send a status request to supposedly running workers to update the list afterwards
            if worker.run_state == RunState::Running {
                info!("Summoning status of worker {}", worker.id);
                worker
                    .send(worker_request_id.clone(), ProxyRequestOrder::Status)
                    .await;
                count += 1;
                self.in_flight
                    .insert(worker_request_id.clone(), (status_tx.clone(), 1));
            }
            worker_info_map.insert(worker_request_id, worker.info());
        }

        let command_tx = self.command_tx.clone();
        let thread_request_identifier = request_identifier.clone();

        let now = Instant::now();

        smol::spawn(async move {
            let mut i = 0;

            while let Some((proxy_response, _)) = status_rx.next().await {
                info!(
                    "received response with id {}: {:?}",
                    proxy_response.id, proxy_response
                );
                let new_run_state = match proxy_response.status {
                    ProxyResponseStatus::Ok => RunState::Running,
                    ProxyResponseStatus::Processing => continue,
                    ProxyResponseStatus::Error(_) => RunState::NotAnswering,
                };
                worker_info_map
                    .entry(proxy_response.id)
                    .and_modify(|worker_info| worker_info.run_state = new_run_state);

                i += 1;
                if i == count || now.elapsed() > Duration::from_secs(10) {
                    break;
                }
            }

            let worker_info_vec: Vec<WorkerInfo> = worker_info_map
                .iter()
                .map(|(_, worker_info)| worker_info.to_owned())
                .collect();

            return_success(
                command_tx,
                thread_request_identifier,
                Success::Status(CommandResponseContent::Status(worker_info_vec)),
            )
            .await;
        })
        .detach();
        Ok(None)
    }

    // This handles the CLI's "metrics enable", "metrics disable", "metrics clear"
    // To get the proxy's metrics, the cli command is "metrics get", handled by the query() function
    pub async fn configure_metrics(
        &mut self,
        request_identifier: RequestIdentifier,
        config: MetricsConfiguration,
    ) -> anyhow::Result<Option<Success>> {
        let (metrics_tx, mut metrics_rx) = futures::channel::mpsc::channel(self.workers.len() * 2);
        let mut count = 0usize;
        for ref mut worker in self
            .workers
            .iter_mut()
            .filter(|worker| worker.run_state != RunState::Stopped)
        {
            let req_id = format!("{}-metrics-{}", request_identifier.client, worker.id);
            worker
                .send(
                    req_id.clone(),
                    ProxyRequestOrder::ConfigureMetrics(config.clone()),
                )
                .await;
            count += 1;
            self.in_flight.insert(req_id, (metrics_tx.clone(), 1));
        }

        let prefix = format!("{}-metrics-", request_identifier.client);

        let command_tx = self.command_tx.clone();
        let thread_request_identifier = request_identifier.clone();
        smol::spawn(async move {
            let mut responses = Vec::new();
            let mut i = 0;
            while let Some((proxy_response, _)) = metrics_rx.next().await {
                match proxy_response.status {
                    ProxyResponseStatus::Ok => {
                        let tag = proxy_response.id.trim_start_matches(&prefix).to_string();
                        responses.push((tag, proxy_response));
                    }
                    ProxyResponseStatus::Processing => {
                        //info!("metrics processing");
                        continue;
                    }
                    ProxyResponseStatus::Error(_) => {
                        let tag = proxy_response.id.trim_start_matches(&prefix).to_string();
                        responses.push((tag, proxy_response));
                    }
                };

                i += 1;
                if i == count {
                    break;
                }
            }

            let mut messages = vec![];
            let mut has_error = false;
            for response in responses.iter() {
                match response.1.status {
                    ProxyResponseStatus::Error(ref e) => {
                        messages.push(format!("{}: {}", response.0, e));
                        has_error = true;
                    }
                    _ => messages.push(format!("{}: OK", response.0)),
                }
            }

            if has_error {
                return_error(command_tx, thread_request_identifier, messages.join(", ")).await;
            } else {
                return_success(
                    command_tx,
                    thread_request_identifier,
                    Success::Metrics(config),
                )
                .await;
            }
        })
        .detach();
        Ok(None)
    }

    pub async fn query(
        &mut self,
        request_identifier: RequestIdentifier,
        query: Query,
    ) -> anyhow::Result<Option<Success>> {
        debug!("Received this query: {:?}", query);
        let (query_tx, mut query_rx) = futures::channel::mpsc::channel(self.workers.len() * 2);
        let mut count = 0usize;
        for ref mut worker in self
            .workers
            .iter_mut()
            .filter(|worker| worker.run_state != RunState::Stopped)
        {
            let req_id = format!("{}-query-{}", request_identifier.client, worker.id);
            worker
                .send(req_id.clone(), ProxyRequestOrder::Query(query.clone()))
                .await;
            count += 1;
            self.in_flight.insert(req_id, (query_tx.clone(), 1));
        }

        return_processing(
            self.command_tx.clone(),
            request_identifier.clone(),
            "Query was sent to the workers...",
        )
        .await;

        let mut main_query_answer = None;
        match &query {
            Query::ClustersHashes => {
                main_query_answer = Some(QueryAnswer::ClustersHashes(self.state.hash_state()));
            }
            Query::Clusters(query_type) => {
                main_query_answer = Some(QueryAnswer::Clusters(match query_type {
                    QueryClusterType::ClusterId(cluster_id) => {
                        vec![self.state.cluster_state(cluster_id)]
                    }
                    QueryClusterType::Domain(domain) => {
                        let cluster_ids = get_cluster_ids_by_domain(
                            &self.state,
                            domain.hostname.clone(),
                            domain.path.clone(),
                        );
                        cluster_ids
                            .iter()
                            .map(|cluster_id| self.state.cluster_state(cluster_id))
                            .collect()
                    }
                }));
            }
            Query::Certificates(_) => {}
            Query::Metrics(_) => {}
        };

        // all these are passed to the thread
        let command_tx = self.command_tx.clone();
        let cloned_identifier = request_identifier.clone();

        // this may waste resources and time in case of queries others than Metrics
        let main_metrics =
            METRICS.with(|metrics| (*metrics.borrow_mut()).dump_local_proxy_metrics());

        smol::spawn(async move {
            let mut responses = Vec::new();
            let mut i = 0;
            while let Some((proxy_response, worker_id)) = query_rx.next().await {
                match proxy_response.status {
                    ProxyResponseStatus::Ok => {
                        responses.push((worker_id, proxy_response));
                    }
                    ProxyResponseStatus::Processing => {
                        info!("metrics processing");
                        continue;
                    }
                    ProxyResponseStatus::Error(_) => {
                        responses.push((worker_id, proxy_response));
                    }
                };

                i += 1;
                if i == count {
                    break;
                }
            }

            let mut proxy_responses_map: BTreeMap<String, QueryAnswer> = responses
                .into_iter()
                .filter_map(|(worker_id, proxy_response)| {
                    if let Some(ProxyResponseContent::Query(d)) = proxy_response.content {
                        Some((worker_id.to_string(), d))
                    } else {
                        None
                    }
                })
                .collect();

            let success = match &query {
                &Query::ClustersHashes | &Query::Clusters(_) => {
                    let main = main_query_answer.unwrap(); // we should refactor to avoid this unwrap()
                    proxy_responses_map.insert(String::from("main"), main);
                    Success::Query(CommandResponseContent::Query(proxy_responses_map))
                }
                &Query::Certificates(_) => {
                    info!(
                        "certificates query answer received: {:?}",
                        proxy_responses_map
                    );
                    Success::Query(CommandResponseContent::Query(proxy_responses_map))
                }
                Query::Metrics(options) => {
                    debug!("metrics query answer received: {:?}", proxy_responses_map);

                    if options.list {
                        Success::Query(CommandResponseContent::Query(proxy_responses_map))
                    } else {
                        Success::Query(CommandResponseContent::Metrics(AggregatedMetricsData {
                            main: main_metrics,
                            workers: proxy_responses_map,
                        }))
                    }
                }
            };

            return_success(command_tx, cloned_identifier, success).await;
        })
        .detach();

        Ok(None)
    }

    pub fn set_logging_level(&mut self, logging_filter: String) -> anyhow::Result<Option<Success>> {
        debug!("Changing main process log level to {}", logging_filter);
        logging::LOGGER.with(|l| {
            let directives = logging::parse_logging_spec(&logging_filter);
            l.borrow_mut().set_directives(directives);
        });
        // also change / set the content of RUST_LOG so future workers / main thread
        // will have the new logging filter value
        ::std::env::set_var("RUST_LOG", &logging_filter);
        debug!("Logging level now: {}", ::std::env::var("RUST_LOG")?);
        Ok(Some(Success::Logging(logging_filter)))
    }

    pub async fn worker_order(
        &mut self,
        request_identifier: RequestIdentifier,
        order: ProxyRequestOrder,
        worker_id: Option<u32>,
    ) -> anyhow::Result<Option<Success>> {
        if let &ProxyRequestOrder::AddCertificate(_) = &order {
            debug!("workerconfig client order AddCertificate()");
        } else {
            debug!("workerconfig client order {:?}", order);
        }

        self.state
            .handle_order(&order)
            .with_context(|| "Could not execute order on the state")?;

        if self.config.automatic_state_save
            & (order != ProxyRequestOrder::SoftStop || order != ProxyRequestOrder::HardStop)
        {
            if let Some(path) = self.config.saved_state.clone() {
                return_processing(
                    self.command_tx.clone(),
                    request_identifier.clone(),
                    "Saving state to file",
                )
                .await;
                let mut file = File::create(&path)
                    .with_context(|| "Could not create file to automatically save the state")?;

                self.save_state_to_file(&mut file)
                    .with_context(|| format!("could not save state automatically to {}", path))?;
            }
        }

        return_processing(
            self.command_tx.clone(),
            request_identifier.clone(),
            match worker_id {
                Some(id) => format!("Sending the order to worker {}", id),
                None => "Sending the order to all workers".to_owned(),
            },
        )
        .await;

        let (worker_order_tx, mut worker_order_rx) =
            futures::channel::mpsc::channel(self.workers.len() * 2);
        let mut found = false;
        let mut stopping_workers = HashSet::new();
        let mut worker_count = 0usize;
        for ref mut worker in self.workers.iter_mut().filter(|worker| {
            worker.run_state != RunState::Stopping && worker.run_state != RunState::Stopped
        }) {
            // sort out the specifically targeted worker, if provided
            if let Some(id) = worker_id {
                if id != worker.id {
                    continue;
                }
            }

            let should_stop_worker =
                order == ProxyRequestOrder::SoftStop || order == ProxyRequestOrder::HardStop;
            if should_stop_worker {
                worker.run_state = RunState::Stopping;
                stopping_workers.insert(worker.id);
            }

            // let request_id = request_identifier.to_worker_request_id();
            let req_id = format!("{}-worker-{}", request_identifier.client, worker.id);
            worker.send(req_id.clone(), order.clone()).await;
            self.in_flight.insert(req_id, (worker_order_tx.clone(), 1));

            found = true;
            worker_count += 1;
        }

        let should_stop_main = (order == ProxyRequestOrder::SoftStop
            || order == ProxyRequestOrder::HardStop)
            && worker_id.is_none();

        let mut command_tx = self.command_tx.clone();
        let thread_request_identifier = request_identifier.clone();

        smol::spawn(async move {
            let mut responses = Vec::new();
            let mut response_count = 0usize;
            while let Some((proxy_response, worker_id)) = worker_order_rx.next().await {
                match proxy_response.status {
                    ProxyResponseStatus::Ok => {
                        responses.push((worker_id, proxy_response));

                        if stopping_workers.contains(&worker_id) {
                            if let Err(e) = command_tx
                                .send(CommandMessage::WorkerClose { worker_id })
                                .await
                            {
                                error!(
                                    "could not send worker close message to {}: {:?}",
                                    worker_id, e
                                );
                            }
                        }
                    }
                    ProxyResponseStatus::Processing => {
                        info!("Order is processing");
                        continue;
                    }
                    ProxyResponseStatus::Error(_) => {
                        responses.push((worker_id, proxy_response));
                    }
                };

                response_count += 1;
                if response_count == worker_count {
                    break;
                }
            }

            // send the order to kill the main process only after all workers responded
            if should_stop_main {
                if let Err(e) = command_tx.send(CommandMessage::MasterStop).await {
                    error!("could not send main stop message: {:?}", e);
                }
            }

            let mut messages = vec![];
            let mut has_error = false;
            for response in responses.iter() {
                match response.1.status {
                    ProxyResponseStatus::Error(ref e) => {
                        messages.push(format!("{}: {}", response.0, e));
                        has_error = true;
                    }
                    _ => messages.push(format!("{}: OK", response.0)),
                }
            }

            if has_error {
                return_error(command_tx, thread_request_identifier, messages.join(", ")).await;
            } else {
                return_success(
                    command_tx,
                    thread_request_identifier,
                    Success::WorkerOrder(worker_id),
                )
                .await;
            }
        })
        .detach();

        if !found {
            // FIXME: should send back error here
            // is this fix OK?
            bail!("no worker found");
        }

        match order {
            ProxyRequestOrder::AddBackend(_) | ProxyRequestOrder::RemoveBackend(_) => {
                self.backends_count = self.state.count_backends()
            }
            ProxyRequestOrder::AddHttpFrontend(_)
            | ProxyRequestOrder::AddHttpsFrontend(_)
            | ProxyRequestOrder::AddTcpFrontend(_)
            | ProxyRequestOrder::RemoveHttpFrontend(_)
            | ProxyRequestOrder::RemoveHttpsFrontend(_)
            | ProxyRequestOrder::RemoveTcpFrontend(_) => {
                self.frontends_count = self.state.count_frontends()
            }
            _ => {}
        };

        gauge!("configuration.clusters", self.state.clusters.len());
        gauge!("configuration.backends", self.backends_count);
        gauge!("configuration.frontends", self.frontends_count);

        Ok(None)
    }

    pub async fn notify_advancement_to_client(
        &mut self,
        request_identifier: RequestIdentifier,
        response: Response,
    ) -> anyhow::Result<Success> {
        let RequestIdentifier {
            client: client_id,
            request: request_id,
        } = request_identifier.to_owned();

        let command_response = match response {
            Response::Ok(success) => {
                let success_message = success.to_string();

                let command_response_data = match success {
                    // should list Success::Metrics(crd) as well
                    Success::DumpState(crd)
                    | Success::ListFrontends(crd)
                    | Success::ListWorkers(crd)
                    | Success::Query(crd)
                    | Success::Status(crd) => Some(crd),
                    _ => None,
                };

                CommandResponse::new(
                    request_id.clone(),
                    CommandStatus::Ok,
                    success_message,
                    command_response_data,
                )
            }
            Response::Processing(processing_message) => CommandResponse::new(
                request_id.clone(),
                CommandStatus::Processing,
                processing_message,
                None,
            ),
            Response::Error(error_message) => CommandResponse::new(
                request_id.clone(),
                CommandStatus::Error,
                error_message,
                None,
            ),
        };

        trace!(
            "Sending response to request {} of client {}: {:?}",
            request_id,
            client_id,
            command_response
        );

        match self.clients.get_mut(&client_id) {
            Some(client_tx) => {
                trace!("sending from main process to client loop");
                client_tx.send(command_response).await.with_context(|| {
                    format!(
                        "Could not notify client {} about request {}",
                        client_id, request_identifier.request,
                    )
                })?;
            }
            None => bail!(format!("Could not find client {}", client_id)),
        }

        Ok(Success::NotifiedClient(client_id))
    }
}

// Those return functions are meant to be called in detached threads
// to notify the command server of an order's advancement.
async fn return_error<T>(
    mut command_tx: Sender<CommandMessage>,
    request_identifier: RequestIdentifier,
    error_message: T,
) where
    T: ToString,
{
    let error_command_message = CommandMessage::Advancement {
        request_identifier,
        response: Response::Error(error_message.to_string()),
    };

    trace!("return_error: sending event to the command server");
    if let Err(e) = command_tx.send(error_command_message).await {
        error!("Error while return error to the command server: {}", e)
    }
}

async fn return_processing<T>(
    mut command_tx: Sender<CommandMessage>,
    request_identifier: RequestIdentifier,
    processing_message: T,
) where
    T: ToString,
{
    let processing_command_message = CommandMessage::Advancement {
        request_identifier,
        response: Response::Processing(processing_message.to_string()),
    };

    trace!("return_processing: sending event to the command server");
    if let Err(e) = command_tx.send(processing_command_message).await {
        error!(
            "Error while returning processing to the command server: {}",
            e
        )
    }
}

async fn return_success(
    mut command_tx: Sender<CommandMessage>,
    request_identifier: RequestIdentifier,
    success: Success,
) {
    let success_command_message = CommandMessage::Advancement {
        request_identifier,
        response: Response::Ok(success),
    };
    trace!("return_success: sending event to the command server");
    if let Err(e) = command_tx.send(success_command_message).await {
        error!("Error while returning success to the command server: {}", e)
    }
}