/
ConnectionActor.java
1060 lines (937 loc) · 50.1 KB
/
ConnectionActor.java
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
/*
* Copyright (c) 2017-2018 Bosch Software Innovations GmbH.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/org/documents/epl-2.0/index.php
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.services.connectivity.messaging;
import static org.eclipse.ditto.model.base.common.ConditionChecker.checkNotNull;
import static org.eclipse.ditto.services.models.connectivity.ConnectivityMessagingConstants.CLUSTER_ROLE;
import java.text.MessageFormat;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.function.Consumer;
import java.util.stream.Collectors;
import javax.annotation.Nullable;
import org.eclipse.ditto.model.base.common.HttpStatusCode;
import org.eclipse.ditto.model.base.exceptions.DittoRuntimeException;
import org.eclipse.ditto.model.base.headers.DittoHeaders;
import org.eclipse.ditto.model.base.headers.WithDittoHeaders;
import org.eclipse.ditto.model.connectivity.Connection;
import org.eclipse.ditto.model.connectivity.ConnectionConfigurationInvalidException;
import org.eclipse.ditto.model.connectivity.ConnectionMetrics;
import org.eclipse.ditto.model.connectivity.ConnectionStatus;
import org.eclipse.ditto.model.connectivity.ConnectivityModelFactory;
import org.eclipse.ditto.model.connectivity.FilteredTopic;
import org.eclipse.ditto.model.connectivity.Target;
import org.eclipse.ditto.model.connectivity.Topic;
import org.eclipse.ditto.services.connectivity.messaging.amqp.AmqpValidator;
import org.eclipse.ditto.services.connectivity.messaging.mqtt.MqttValidator;
import org.eclipse.ditto.services.connectivity.messaging.persistence.ConnectionMongoSnapshotAdapter;
import org.eclipse.ditto.services.connectivity.messaging.rabbitmq.RabbitMQValidator;
import org.eclipse.ditto.services.connectivity.messaging.validation.CompoundConnectivityCommandInterceptor;
import org.eclipse.ditto.services.connectivity.messaging.validation.ConnectionValidator;
import org.eclipse.ditto.services.connectivity.messaging.validation.DittoConnectivityCommandValidator;
import org.eclipse.ditto.services.connectivity.util.ConnectionConfigReader;
import org.eclipse.ditto.services.models.connectivity.OutboundSignal;
import org.eclipse.ditto.services.models.connectivity.OutboundSignalFactory;
import org.eclipse.ditto.services.models.connectivity.placeholder.PlaceholderFilter;
import org.eclipse.ditto.services.utils.akka.LogUtil;
import org.eclipse.ditto.services.utils.persistence.SnapshotAdapter;
import org.eclipse.ditto.signals.base.Signal;
import org.eclipse.ditto.signals.commands.base.Command;
import org.eclipse.ditto.signals.commands.base.CommandResponse;
import org.eclipse.ditto.signals.commands.connectivity.AggregatedConnectivityCommandResponse;
import org.eclipse.ditto.signals.commands.connectivity.ConnectivityCommand;
import org.eclipse.ditto.signals.commands.connectivity.ConnectivityCommandResponse;
import org.eclipse.ditto.signals.commands.connectivity.ConnectivityErrorResponse;
import org.eclipse.ditto.signals.commands.connectivity.exceptions.ConnectionConflictException;
import org.eclipse.ditto.signals.commands.connectivity.exceptions.ConnectionFailedException;
import org.eclipse.ditto.signals.commands.connectivity.exceptions.ConnectionNotAccessibleException;
import org.eclipse.ditto.signals.commands.connectivity.modify.CloseConnection;
import org.eclipse.ditto.signals.commands.connectivity.modify.CloseConnectionResponse;
import org.eclipse.ditto.signals.commands.connectivity.modify.CreateConnection;
import org.eclipse.ditto.signals.commands.connectivity.modify.CreateConnectionResponse;
import org.eclipse.ditto.signals.commands.connectivity.modify.DeleteConnection;
import org.eclipse.ditto.signals.commands.connectivity.modify.DeleteConnectionResponse;
import org.eclipse.ditto.signals.commands.connectivity.modify.ModifyConnection;
import org.eclipse.ditto.signals.commands.connectivity.modify.ModifyConnectionResponse;
import org.eclipse.ditto.signals.commands.connectivity.modify.OpenConnection;
import org.eclipse.ditto.signals.commands.connectivity.modify.OpenConnectionResponse;
import org.eclipse.ditto.signals.commands.connectivity.modify.TestConnection;
import org.eclipse.ditto.signals.commands.connectivity.modify.TestConnectionResponse;
import org.eclipse.ditto.signals.commands.connectivity.query.RetrieveConnection;
import org.eclipse.ditto.signals.commands.connectivity.query.RetrieveConnectionMetrics;
import org.eclipse.ditto.signals.commands.connectivity.query.RetrieveConnectionMetricsResponse;
import org.eclipse.ditto.signals.commands.connectivity.query.RetrieveConnectionResponse;
import org.eclipse.ditto.signals.commands.connectivity.query.RetrieveConnectionStatus;
import org.eclipse.ditto.signals.commands.connectivity.query.RetrieveConnectionStatusResponse;
import org.eclipse.ditto.signals.events.base.Event;
import org.eclipse.ditto.signals.events.connectivity.ConnectionClosed;
import org.eclipse.ditto.signals.events.connectivity.ConnectionCreated;
import org.eclipse.ditto.signals.events.connectivity.ConnectionDeleted;
import org.eclipse.ditto.signals.events.connectivity.ConnectionModified;
import org.eclipse.ditto.signals.events.connectivity.ConnectionOpened;
import akka.actor.AbstractActor;
import akka.actor.ActorRef;
import akka.actor.Cancellable;
import akka.actor.PoisonPill;
import akka.actor.Props;
import akka.actor.ReceiveTimeout;
import akka.actor.Status;
import akka.cluster.pubsub.DistributedPubSubMediator;
import akka.cluster.routing.ClusterRouterPool;
import akka.cluster.routing.ClusterRouterPoolSettings;
import akka.event.DiagnosticLoggingAdapter;
import akka.japi.Creator;
import akka.japi.pf.ReceiveBuilder;
import akka.pattern.PatternsCS;
import akka.persistence.AbstractPersistentActor;
import akka.persistence.RecoveryCompleted;
import akka.persistence.SaveSnapshotSuccess;
import akka.persistence.SnapshotOffer;
import akka.routing.Broadcast;
import akka.routing.RoundRobinPool;
import scala.concurrent.ExecutionContextExecutor;
import scala.concurrent.duration.Duration;
import scala.concurrent.duration.FiniteDuration;
/**
* Handles {@code *Connection} commands and manages the persistence of connection. The actual connection handling to the
* remote server is delegated to a child actor that uses a specific client (AMQP 1.0 or 0.9.1).
*/
public final class ConnectionActor extends AbstractPersistentActor {
private static final FiniteDuration DELETED_ACTOR_LIFETIME = Duration.create(10L, TimeUnit.SECONDS);
private static final String PERSISTENCE_ID_PREFIX = "connection:";
private static final String JOURNAL_PLUGIN_ID = "akka-contrib-mongodb-persistence-connection-journal";
private static final String SNAPSHOT_PLUGIN_ID = "akka-contrib-mongodb-persistence-connection-snapshots";
private static final String UNRESOLVER_PLACEHOLDERS_MESSAGE =
"Failed to substitute all placeholders in '{}', target is dropped.";
private static final long DEFAULT_TIMEOUT_MS = 5000;
private static final String PUB_SUB_GROUP_PREFIX = "connection:";
/**
* Message to self to trigger termination after deletion.
*/
private static final Object STOP_SELF_IF_DELETED = new Object();
/**
* Validator of all supported connections.
*/
private static final ConnectionValidator CONNECTION_VALIDATOR = ConnectionValidator.of(
RabbitMQValidator.newInstance(),
AmqpValidator.newInstance(),
MqttValidator.newInstance());
private final DiagnosticLoggingAdapter log = LogUtil.obtain(this);
private final String connectionId;
private final ActorRef pubSubMediator;
private final ActorRef conciergeForwarder;
private final long snapshotThreshold;
private final SnapshotAdapter<Connection> snapshotAdapter;
private final ClientActorPropsFactory propsFactory;
private final Consumer<ConnectivityCommand<?>> commandValidator;
private final Receive connectionCreatedBehaviour;
private Instant connectionClosedAt = null;
@Nullable private ActorRef clientActorRouter;
@Nullable private Connection connection;
@Nullable private SignalFilter signalFilter = null;
private long lastSnapshotSequenceNr = -1L;
private boolean snapshotInProgress = false;
private final PlaceholderFilter placeholdersFilter = new PlaceholderFilter();
private Set<Topic> uniqueTopics = Collections.emptySet();
private final FiniteDuration flushPendingResponsesTimeout;
@Nullable private Cancellable stopSelfIfDeletedTrigger;
private ConnectionActor(final String connectionId,
final ActorRef pubSubMediator,
final ActorRef conciergeForwarder,
final ClientActorPropsFactory propsFactory,
@Nullable final Consumer<ConnectivityCommand<?>> customCommandValidator) {
this.connectionId = connectionId;
this.pubSubMediator = pubSubMediator;
this.conciergeForwarder = conciergeForwarder;
this.propsFactory = propsFactory;
final DittoConnectivityCommandValidator dittoCommandValidator =
new DittoConnectivityCommandValidator(propsFactory, conciergeForwarder, CONNECTION_VALIDATOR);
if (customCommandValidator != null) {
this.commandValidator =
new CompoundConnectivityCommandInterceptor(dittoCommandValidator, customCommandValidator);
} else {
this.commandValidator = dittoCommandValidator;
}
final ConnectionConfigReader configReader =
ConnectionConfigReader.fromRawConfig(getContext().system().settings().config());
snapshotThreshold = configReader.snapshotThreshold();
snapshotAdapter = new ConnectionMongoSnapshotAdapter();
connectionCreatedBehaviour = createConnectionCreatedBehaviour();
final java.time.Duration javaFlushTimeout = configReader.flushPendingResponsesTimeout();
flushPendingResponsesTimeout = Duration.create(javaFlushTimeout.toMillis(), TimeUnit.MILLISECONDS);
}
/**
* Creates Akka configuration object for this actor.
*
* @param connectionId the connection ID.
* @param pubSubMediator Akka pub-sub mediator.
* @param conciergeForwarder proxy of concierge service.
* @param propsFactory factory of props of client actors for various protocols.
* @return the Akka configuration Props object
*/
public static Props props(final String connectionId,
final ActorRef pubSubMediator,
final ActorRef conciergeForwarder,
final ClientActorPropsFactory propsFactory,
@Nullable final Consumer<ConnectivityCommand<?>> commandValidator) {
return Props.create(ConnectionActor.class, new Creator<ConnectionActor>() {
private static final long serialVersionUID = 1L;
@Override
public ConnectionActor create() {
return new ConnectionActor(connectionId, pubSubMediator, conciergeForwarder, propsFactory,
commandValidator);
}
});
}
@Override
public String persistenceId() {
return PERSISTENCE_ID_PREFIX + connectionId;
}
@Override
public String journalPluginId() {
return JOURNAL_PLUGIN_ID;
}
@Override
public String snapshotPluginId() {
return SNAPSHOT_PLUGIN_ID;
}
@Override
public void postStop() {
log.info("stopped connection <{}>", connectionId);
cancelStopSelfIfDeletedTrigger();
super.postStop();
}
@Override
public Receive createReceiveRecover() {
return ReceiveBuilder.create()
// # Snapshot handling
.match(SnapshotOffer.class, ss -> {
final Connection fromSnapshotStore = snapshotAdapter.fromSnapshotStore(ss);
log.info("Received SnapshotOffer containing connection: <{}>", fromSnapshotStore);
if (fromSnapshotStore != null) {
restoreConnection(fromSnapshotStore);
}
lastSnapshotSequenceNr = ss.metadata().sequenceNr();
})
.match(ConnectionCreated.class, event -> restoreConnection(event.getConnection()))
.match(ConnectionModified.class, event -> restoreConnection(event.getConnection()))
.match(ConnectionOpened.class, event -> restoreConnection(connection != null ? connection.toBuilder()
.connectionStatus(ConnectionStatus.OPEN).build() : null))
.match(ConnectionClosed.class, event -> restoreConnection(connection != null ? connection.toBuilder()
.connectionStatus(ConnectionStatus.CLOSED).build() : null))
.match(ConnectionDeleted.class, event -> restoreConnection(null))
.match(RecoveryCompleted.class, rc -> {
log.info("Connection <{}> was recovered: {}", connectionId, connection);
if (connection != null) {
if (ConnectionStatus.OPEN.equals(connection.getConnectionStatus())) {
log.debug("Opening connection <{}> after recovery.", connectionId);
final OpenConnection connect = OpenConnection.of(connectionId, DittoHeaders.empty());
final ActorRef origin = getSender();
askClientActor(connect,
response -> log.info("OpenConnection result: {}", response),
error -> handleException("recovery-connect", origin, error)
);
subscribeForEvents();
}
getContext().become(connectionCreatedBehaviour);
} else {
stopSelfIfDeletedAfterDelay();
}
getContext().getParent().tell(ConnectionSupervisorActor.ManualReset.getInstance(), getSelf());
})
.matchAny(m -> {
if (m == null) {
// connection persistence is corrupted.
restoreConnection(null);
log.warning("Invalid persistence of Connection <{}>", connectionId);
} else {
log.warning("Unknown recover message: {}", m);
}
})
.build();
}
private void restoreConnection(@Nullable final Connection theConnection) {
connection = theConnection;
if (theConnection != null) {
signalFilter = new SignalFilter(theConnection);
}
}
@Override
public Receive createReceive() {
return ReceiveBuilder.create()
.match(TestConnection.class, testConnection -> validateAndForward(testConnection, this::testConnection))
.match(CreateConnection.class,
createConnection -> validateAndForward(createConnection, this::createConnection))
.match(ConnectivityCommand.class, this::handleCommandDuringInitialization)
.match(Status.Failure.class, f -> log.warning("Got failure in initial behaviour with cause {}: {}",
f.cause().getClass().getSimpleName(), f.cause().getMessage()))
.match(PerformTask.class, this::performTask)
.matchEquals(STOP_SELF_IF_DELETED, msg -> stopSelf())
.matchAny(m -> {
log.warning("Unknown message: {}", m);
unhandled(m);
}).build();
}
private Receive createConnectionCreatedBehaviour() {
return ReceiveBuilder.create()
.match(TestConnection.class, testConnection ->
getSender().tell(TestConnectionResponse.alreadyCreated(testConnection.getConnectionId(),
testConnection.getDittoHeaders()), getSelf()))
.match(CreateConnection.class, createConnection -> {
enhanceLogUtil(createConnection);
log.info("Connection <{}> already exists! Responding with conflict.", createConnection.getId());
final ConnectionConflictException conflictException =
ConnectionConflictException.newBuilder(createConnection.getId())
.dittoHeaders(createConnection.getDittoHeaders())
.build();
getSender().tell(conflictException, getSelf());
})
.match(ModifyConnection.class,
modifyConnection -> validateAndForward(modifyConnection, this::modifyConnection))
.match(OpenConnection.class, this::openConnection)
.match(CloseConnection.class, this::closeConnection)
.match(DeleteConnection.class, this::deleteConnection)
.match(RetrieveConnection.class, this::retrieveConnection)
.match(RetrieveConnectionStatus.class, this::retrieveConnectionStatus)
.match(RetrieveConnectionMetrics.class, this::retrieveConnectionMetrics)
.match(Signal.class, this::handleSignal)
.match(DistributedPubSubMediator.SubscribeAck.class, this::handleSubscribeAck)
.match(DistributedPubSubMediator.UnsubscribeAck.class, this::handleUnsubscribeAck)
.match(SaveSnapshotSuccess.class, this::handleSnapshotSuccess)
.match(Status.Failure.class, f -> log.warning("Got failure in connectionCreated behaviour with " +
"cause {}: {}", f.cause().getClass().getSimpleName(), f.cause().getMessage()))
.match(PerformTask.class, this::performTask)
.matchEquals(STOP_SELF_IF_DELETED, msg -> {
// do nothing; this connection is not deleted.
cancelStopSelfIfDeletedTrigger();
})
.matchAny(m -> {
log.warning("Unknown message: {}", m);
unhandled(m);
}).build();
}
private void enhanceLogUtil(final WithDittoHeaders<?> createConnection) {
LogUtil.enhanceLogWithCorrelationId(log, createConnection);
LogUtil.enhanceLogWithCustomField(log, BaseClientData.MDC_CONNECTION_ID, connectionId);
}
private void performTask(final PerformTask performTask) {
log.info("Running <{}>", performTask);
performTask.run(this);
}
private void handleSignal(final Signal<?> signal) {
// Do not flush pending responses - pub/sub may not be ready on all nodes
enhanceLogUtil(signal);
if (clientActorRouter == null) {
log.debug("Signal dropped: Client actor not ready.");
return;
}
if (connection == null || signalFilter == null) {
log.debug("Signal dropped: No Connection or signalFilter configuration available.");
return;
}
if (uniqueTopics.isEmpty()) {
log.debug("Signal dropped: No topics present.");
return;
}
if (connectionId.equals(signal.getDittoHeaders().getOrigin().orElse(null))) {
log.debug("Signal dropped: was sent by myself.");
return;
}
final Set<Target> subscribedAndAuthorizedTargets = signalFilter.filter(signal);
if (subscribedAndAuthorizedTargets.isEmpty()) {
log.debug("Signal dropped: No subscribed and authorized targets present");
return;
}
// forward to client actor if topic was subscribed and there are targets that are authorized to read
final Set<Target> filteredTargets =
placeholdersFilter.filterTargets(subscribedAndAuthorizedTargets, signal.getId(),
unresolvedPlaceholder -> log.info(UNRESOLVER_PLACEHOLDERS_MESSAGE, unresolvedPlaceholder));
log.debug("Forwarding signal <{}> to client actor with targets: {}.", signal.getType(), filteredTargets);
final OutboundSignal outbound = OutboundSignalFactory.newOutboundSignal(signal, filteredTargets);
clientActorRouter.tell(outbound, getSelf());
}
private void testConnection(final TestConnection command) {
final ActorRef origin = getSender();
final ActorRef self = getSelf();
restoreConnection(command.getConnection());
final PerformTask stopSelfTask = new PerformTask("stop self after test", ConnectionActor::stopSelf);
askClientActor(command, response -> {
origin.tell(TestConnectionResponse.success(command.getConnectionId(), response.toString(),
command.getDittoHeaders()), self);
// terminate this actor's supervisor after a connection test again:
self.tell(stopSelfTask, ActorRef.noSender());
}, error -> {
handleException("test", origin, error);
// terminate this actor's supervisor after a connection test again:
self.tell(stopSelfTask, ActorRef.noSender());
});
}
private <T extends ConnectivityCommand> void validateAndForward(final T command, final Consumer<T> target) {
final ActorRef origin = getSender();
try {
commandValidator.accept(command);
target.accept(command);
} catch (final Exception e) {
handleException(command.getType(), origin, e);
stopSelf();
}
}
private void createConnection(final CreateConnection command) {
final ActorRef origin = getSender();
final ActorRef self = getSelf();
final ActorRef parent = getContext().getParent();
persistEvent(ConnectionCreated.of(command.getConnection(), command.getDittoHeaders()), persistedEvent -> {
restoreConnection(persistedEvent.getConnection());
getContext().become(connectionCreatedBehaviour);
if (ConnectionStatus.OPEN.equals(connection.getConnectionStatus())) {
log.debug("Connection <{}> has status <{}> and will therefore be opened.",
connection.getId(),
connection.getConnectionStatus().getName());
final OpenConnection openConnection = OpenConnection.of(connectionId, command.getDittoHeaders());
askClientActor(openConnection,
response -> {
final ConnectivityCommandResponse commandResponse =
CreateConnectionResponse.of(connection, command.getDittoHeaders());
final PerformTask performTask =
new PerformTask("subscribe for events and schedule CreateConnectionResponse",
subscribeForEventsAndScheduleResponse(commandResponse, origin));
parent.tell(ConnectionSupervisorActor.ManualReset.getInstance(), self);
self.tell(performTask, ActorRef.noSender());
},
error -> {
// log error but send response anyway
handleException("connect", origin, error, false);
respondWithCreateConnectionResponse(connection, command, origin);
}
);
} else {
log.debug("Connection <{}> has status <{}> and will therefore stay closed.",
connection.getId(),
connection.getConnectionStatus().getName());
respondWithCreateConnectionResponse(connection, command, origin);
}
});
}
private void respondWithCreateConnectionResponse(final Connection connection,
final CreateConnection command,
final ActorRef origin) {
origin.tell(CreateConnectionResponse.of(connection, command.getDittoHeaders()), getSelf());
getContext().getParent().tell(ConnectionSupervisorActor.ManualReset.getInstance(), getSelf());
}
private void modifyConnection(final ModifyConnection command) {
final ActorRef origin = getSender();
final ActorRef self = getSelf();
if (connection != null &&
!connection.getConnectionType().equals(command.getConnection().getConnectionType())) {
handleException("modify", origin, ConnectionConfigurationInvalidException
.newBuilder("ConnectionType <" + connection.getConnectionType().getName() +
"> of existing connection <" + connectionId + "> cannot be changed!")
.dittoHeaders(command.getDittoHeaders())
.build()
);
return;
}
persistEvent(ConnectionModified.of(command.getConnection(), command.getDittoHeaders()), persistedEvent -> {
restoreConnection(persistedEvent.getConnection());
getContext().become(connectionCreatedBehaviour);
// if client actor is started: send an artificial CloseConnection command to gracefully disconnect and stop the child actors
askClientActorIfStarted(CloseConnection.of(connectionId, DittoHeaders.empty()),
onSuccess -> {
final PerformTask modifyTask = createModifyConnectionTask(true, command, origin);
self.tell(modifyTask, ActorRef.noSender());
},
error -> handleException("connect-after-modify", origin, error),
() -> {
final PerformTask modifyTask = createModifyConnectionTask(false, command, origin);
self.tell(modifyTask, ActorRef.noSender());
});
});
}
private PerformTask createModifyConnectionTask(final boolean stopClientActor, final ModifyConnection command,
final ActorRef origin) {
final String description = (stopClientActor ? "stop client actor and " : "") + "handle modify connection";
return new PerformTask(description,
connectionActor -> {
if (stopClientActor) {
log.debug("Connection {} was modified, stopping client actor.", connectionId);
connectionActor.stopClientActor();
}
connectionActor.handleModifyConnection(command, origin);
});
}
/*
* NOT thread-safe.
*/
private void handleModifyConnection(final ModifyConnection command, final ActorRef origin) {
checkNotNull(connection, "Connection");
final ActorRef self = getSelf();
final ActorRef parent = getContext().getParent();
final DittoHeaders dittoHeaders = command.getDittoHeaders();
final ConnectivityCommandResponse commandResponse =
ModifyConnectionResponse.modified(connectionId, dittoHeaders);
if (ConnectionStatus.OPEN.equals(connection.getConnectionStatus())) {
final OpenConnection openConnectionAfterModification = OpenConnection.of(connectionId, dittoHeaders);
log.debug("Desired connection state is {}, forwarding {} to client actor.",
connection.getConnectionStatus(), openConnectionAfterModification);
askClientActor(openConnectionAfterModification,
response -> {
final PerformTask performTask =
new PerformTask("subscribe for events and schedule ModifyConnectionResponse",
subscribeForEventsAndScheduleResponse(commandResponse, origin));
parent.tell(ConnectionSupervisorActor.ManualReset.getInstance(), self);
self.tell(performTask, ActorRef.noSender());
},
error -> handleException("connect-after-modify", origin, error)
);
} else {
log.debug("Desired connection state is {}, do not open connection.", connection.getConnectionStatus());
origin.tell(commandResponse, getSelf());
}
}
private void openConnection(final OpenConnection command) {
checkConnectionNotNull();
final ConnectionOpened connectionOpened =
ConnectionOpened.of(command.getConnectionId(), command.getDittoHeaders());
final ActorRef origin = getSender();
final ActorRef self = getSelf();
persistEvent(connectionOpened, persistedEvent -> {
restoreConnection(connection.toBuilder().connectionStatus(ConnectionStatus.OPEN).build());
askClientActor(command, response -> {
final ConnectivityCommandResponse commandResponse =
OpenConnectionResponse.of(connectionId, command.getDittoHeaders());
final PerformTask performTask = new PerformTask("open connection",
subscribeForEventsAndScheduleResponse(commandResponse, origin));
self.tell(performTask, ActorRef.noSender());
},
error -> handleException("open-connection", origin, error)
);
});
}
private void checkConnectionNotNull() {
checkNotNull(connection, "Connection");
}
private void closeConnection(final CloseConnection command) {
checkConnectionNotNull();
final ConnectionClosed connectionClosed =
ConnectionClosed.of(command.getConnectionId(), command.getDittoHeaders());
final ActorRef origin = getSender();
final ActorRef self = getSelf();
persistEvent(connectionClosed, persistedEvent -> {
if (connection != null) {
restoreConnection(connection.toBuilder().connectionStatus(ConnectionStatus.CLOSED).build());
}
final CloseConnectionResponse closeConnectionResponse =
CloseConnectionResponse.of(connectionId, command.getDittoHeaders());
askClientActorIfStarted(command,
response -> {
final PerformTask performTask =
new PerformTask(
"unsubscribe from events on connection closed, stop client actor and schdeule response",
connectionActor -> {
connectionActor.unsubscribeFromEvents();
connectionActor.stopClientActor();
origin.tell(closeConnectionResponse, getSelf());
});
self.tell(performTask, ActorRef.noSender());
},
error -> handleException("disconnect", origin, error),
() -> {
log.debug("Client actor was not started, responding directly.");
origin.tell(closeConnectionResponse, getSelf());
}
);
});
}
private void deleteConnection(final DeleteConnection command) {
final ConnectionDeleted connectionDeleted =
ConnectionDeleted.of(command.getConnectionId(), command.getDittoHeaders());
final ActorRef origin = getSender();
final ActorRef self = getSelf();
persistEvent(connectionDeleted, persistedEvent -> {
stopClientActor();
origin.tell(DeleteConnectionResponse.of(connectionId, command.getDittoHeaders()), self);
stopSelf();
// All subscriptions stop automatically once this actor stops.
// connectionActor.unsubscribeFromEvents();
});
}
/*
* NOT thread-safe.
*/
private void askClientActor(final Command<?> cmd, final Consumer<Object> onSuccess,
final Consumer<Throwable> onError) {
startClientActorIfRequired();
final long timeout = Optional.ofNullable(cmd.getDittoHeaders().get("timeout"))
.map(Long::parseLong)
.orElse(DEFAULT_TIMEOUT_MS);
// wrap in Broadcast message because these management messages must be delivered to each client actor
if (clientActorRouter != null && connection != null) {
final ActorRef aggregationActor = getContext().actorOf(
AggregateActor.props(connectionId, clientActorRouter, connection.getClientCount(), timeout));
PatternsCS.ask(aggregationActor, cmd, timeout)
.whenComplete((response, exception) -> {
log.debug("Got response to {}: {}", cmd.getType(),
exception == null ? response : exception);
if (exception != null) {
onError.accept(exception);
} else if (response instanceof Status.Failure) {
final Throwable cause = ((Status.Failure) response).cause();
onError.accept(cause);
} else if (response instanceof DittoRuntimeException) {
onError.accept((DittoRuntimeException) response);
} else {
onSuccess.accept(response);
}
});
} else {
final String message =
MessageFormat.format(
"NOT asking client actor <{0}> for connection <{1}> because one of them is null.",
clientActorRouter, connection);
final NullPointerException nullPointerException = new NullPointerException(message);
log.error(message);
onError.accept(nullPointerException);
}
}
/*
* NOT thread-safe.
*/
private void askClientActorIfStarted(final Command<?> cmd, final Consumer<Object> onSuccess,
final Consumer<Throwable> onError, final Runnable onClientActorNotStarted) {
if (clientActorRouter != null && connection != null) {
askClientActor(cmd, onSuccess, onError);
} else {
onClientActorNotStarted.run();
}
}
/*
* Thread-safe because Actor.getSelf() is thread-safe.
*/
private void handleException(final String action, final ActorRef origin, final Throwable exception) {
handleException(action, origin, exception, true);
}
private void handleException(final String action,
final ActorRef origin,
final Throwable exception,
final boolean sendExceptionResponse) {
final DittoRuntimeException dre;
if (exception instanceof DittoRuntimeException) {
dre = (DittoRuntimeException) exception;
} else {
dre = ConnectionFailedException.newBuilder(connectionId)
.description(exception.getMessage())
.cause(exception)
.build();
}
if (sendExceptionResponse) {
origin.tell(dre, getSelf());
}
log.warning("Operation <{}> on connection <{}> failed due to {}: {}.", action, connectionId,
dre.getClass().getSimpleName(), dre.getMessage());
}
private void retrieveConnection(final RetrieveConnection command) {
checkConnectionNotNull();
getSender().tell(RetrieveConnectionResponse.of(connection, command.getDittoHeaders()), getSelf());
}
private void retrieveConnectionStatus(final RetrieveConnectionStatus command) {
checkConnectionNotNull();
getSender().tell(RetrieveConnectionStatusResponse.of(connectionId, connection.getConnectionStatus(),
command.getDittoHeaders()), getSelf());
}
private void retrieveConnectionMetrics(final RetrieveConnectionMetrics command) {
checkConnectionNotNull();
final ActorRef origin = getSender();
askClientActorIfStarted(command,
response -> origin.tell(response, getSelf()),
error -> handleException("retrieve-metrics", origin, error),
() -> respondWithEmptyMetrics(command, origin));
}
private void respondWithEmptyMetrics(final RetrieveConnectionMetrics command, final ActorRef origin) {
log.debug("ClientActor not started, responding with empty connection metrics with status closed.");
final ConnectionMetrics metrics =
ConnectivityModelFactory.newConnectionMetrics(ConnectionStatus.CLOSED,
"connection is closed",
connectionClosedAt != null ? connectionClosedAt : Instant.ofEpochSecond(0),
BaseClientState.DISCONNECTED.name(), Collections.emptyList(),
Collections.emptyList());
final RetrieveConnectionMetricsResponse metricsResponse =
RetrieveConnectionMetricsResponse.of(connectionId, metrics, command.getDittoHeaders());
final String responseType = metricsResponse.getType();
final AggregatedConnectivityCommandResponse response =
AggregatedConnectivityCommandResponse.of(connectionId, Collections.singletonList(metricsResponse),
responseType,
HttpStatusCode.OK, command.getDittoHeaders());
origin.tell(response, getSelf());
}
private void subscribeForEvents() {
checkConnectionNotNull();
// unsubscribe to previously subscribed topics
unsubscribeFromEvents();
uniqueTopics = connection.getTargets().stream()
.flatMap(target -> target.getTopics().stream().map(FilteredTopic::getTopic))
.collect(Collectors.toSet());
forEachPubSubTopicDo(pubSubTopic -> {
final DistributedPubSubMediator.Subscribe subscribe =
new DistributedPubSubMediator.Subscribe(pubSubTopic, PUB_SUB_GROUP_PREFIX + connectionId,
getSelf());
log.debug("Subscribing to pub-sub topic <{}> for connection <{}>.", pubSubTopic, connectionId);
pubSubMediator.tell(subscribe, getSelf());
});
}
private void unsubscribeFromEvents() {
forEachPubSubTopicDo(pubSubTopic -> {
log.debug("Unsubscribing from pub-sub topic <{}> for connection <{}>.", pubSubTopic, connectionId);
final DistributedPubSubMediator.Unsubscribe unsubscribe =
new DistributedPubSubMediator.Unsubscribe(pubSubTopic, PUB_SUB_GROUP_PREFIX + connectionId,
getSelf());
pubSubMediator.tell(unsubscribe, getSelf());
});
}
private void forEachPubSubTopicDo(final Consumer<String> topicConsumer) {
uniqueTopics.stream()
.map(Topic::getPubSubTopic)
.forEach(topicConsumer);
}
private void handleCommandDuringInitialization(final ConnectivityCommand command) {
log.debug("Unexpected command during initialization of actor received: {} - "
+ "Terminating this actor and sending 'ConnectionNotAccessibleException' to requester ...",
command.getType());
getSender().tell(ConnectionNotAccessibleException.newBuilder(command.getId())
.dittoHeaders(command.getDittoHeaders())
.build(), getSelf());
}
private <E extends Event> void persistEvent(final E event, final Consumer<E> consumer) {
persist(event, persistedEvent -> {
log.debug("Successfully persisted Event <{}>.", persistedEvent.getType());
consumer.accept(persistedEvent);
pubSubMediator.tell(new DistributedPubSubMediator.Publish(event.getType(), event, true), getSelf());
// save a snapshot if there were too many changes since the last snapshot
if ((lastSequenceNr() - lastSnapshotSequenceNr) > snapshotThreshold) {
doSaveSnapshot();
}
});
}
private void doSaveSnapshot() {
if (snapshotInProgress) {
log.debug("Already requested taking a Snapshot - not doing it again");
} else if (connection != null) {
snapshotInProgress = true;
log.info("Attempting to save Snapshot for Connection: <{}> ...", connection);
// save a snapshot
final Object snapshotToStore = snapshotAdapter.toSnapshotStore(connection);
saveSnapshot(snapshotToStore);
} else {
log.warning("Connection and MappingContext must not be null when taking snapshot.");
}
}
private void startClientActorIfRequired() {
checkNotNull(connectionId, "connectionId");
checkConnectionNotNull();
if (clientActorRouter == null) {
final int clientCount = connection.getClientCount();
log.info("Starting ClientActor for connection <{}> with <{}> clients.", connectionId, clientCount);
final Props props = propsFactory.getActorPropsForType(connection, conciergeForwarder);
final ClusterRouterPoolSettings clusterRouterPoolSettings =
new ClusterRouterPoolSettings(clientCount, 1, true,
Collections.singleton(CLUSTER_ROLE));
final RoundRobinPool roundRobinPool = new RoundRobinPool(clientCount);
final Props clusterRouterPoolProps =
new ClusterRouterPool(roundRobinPool, clusterRouterPoolSettings).props(props);
// start client actor without name so it does not conflict with its previous incarnation
clientActorRouter = getContext().actorOf(clusterRouterPoolProps);
} else {
log.debug("ClientActor already started.");
}
}
private void stopClientActor() {
if (clientActorRouter != null) {
connectionClosedAt = Instant.now();
log.debug("Stopping the client actor.");
stopChildActor(clientActorRouter);
clientActorRouter = null;
}
}
private void stopChildActor(final ActorRef actor) {
log.debug("Stopping child actor <{}>.", actor.path());
getContext().stop(actor);
}
private void stopSelf() {
log.debug("Shutting down");
// stop the supervisor (otherwise it'd restart this actor) which causes this actor to stop, too.
getContext().getParent().tell(PoisonPill.getInstance(), getSelf());
}
private void stopSelfIfDeletedAfterDelay() {
final ExecutionContextExecutor dispatcher = getContext().dispatcher();
cancelStopSelfIfDeletedTrigger();
stopSelfIfDeletedTrigger = getContext().system()
.scheduler()
.scheduleOnce(DELETED_ACTOR_LIFETIME, getSelf(), STOP_SELF_IF_DELETED, dispatcher, ActorRef.noSender());
}
private void cancelStopSelfIfDeletedTrigger() {
if (stopSelfIfDeletedTrigger != null) {
stopSelfIfDeletedTrigger.cancel();
stopSelfIfDeletedTrigger = null;
}
}
private void handleSubscribeAck(final DistributedPubSubMediator.SubscribeAck subscribeAck) {
log.debug("Successfully subscribed to distributed pub/sub on topic <{}>.",
subscribeAck.subscribe().topic());
}
private void handleUnsubscribeAck(final DistributedPubSubMediator.UnsubscribeAck unsubscribeAck) {
log.debug("Successfully unsubscribed from distributed pub/sub on topic <{}>.",
unsubscribeAck.unsubscribe().topic());
}
private void handleSnapshotSuccess(final SaveSnapshotSuccess sss) {
log.debug("Snapshot was saved successfully: {}", sss);
}
private void schedulePendingResponse(final ConnectivityCommandResponse response, final ActorRef sender) {
getContext().system().scheduler()
.scheduleOnce(flushPendingResponsesTimeout,
sender,
response,
getContext().dispatcher(),
getSelf());
}
private static Consumer<ConnectionActor> subscribeForEventsAndScheduleResponse(
final ConnectivityCommandResponse response,
final ActorRef sender) {
return connectionActor -> {
connectionActor.subscribeForEvents();
connectionActor.schedulePendingResponse(response, sender);
};
}
/**
* Self-message for future tasks to run synchronously in actor's thread.
* Minimal wrapping of thread-unsafe operations so that they do not corrupt actor state.
* The results of such operations are not guaranteed to make sense.
*/
private static final class PerformTask {
final String description;
final Consumer<ConnectionActor> task;
private PerformTask(final String description, final Consumer<ConnectionActor> task) {
this.description = description;
this.task = task;
}
private void run(final ConnectionActor thisActor) {
task.accept(thisActor);
}
@Override
public final String toString() {
return String.format("PerformTask(%s)", description);
}
}
/**
* Local helper-actor which is started for aggregating several CommandResponses sent back by potentially several
* {@code clientActors} (behind a cluster Router running on different cluster nodes).
*/
private static final class AggregateActor extends AbstractActor {
private final DiagnosticLoggingAdapter log = LogUtil.obtain(this);
private final List<CommandResponse<?>> aggregatedResults;
private final Map<String, Status.Status> aggregatedStatus;
private final String connectionId;
private final ActorRef clientActor;
private final int expectedResponses;
private final long timeout;
private int responseCount = 0;
@Nullable private ActorRef origin;
@Nullable private DittoHeaders originHeaders;
/**
* Creates Akka configuration object for this actor.
*
* @return the Akka configuration Props object
*/
static Props props(final String connectionId,
final ActorRef clientActor,
final int expectedResponses,
final long timeout) {
return Props.create(AggregateActor.class, connectionId, clientActor, expectedResponses, timeout);
}
private AggregateActor(final String connectionId,
final ActorRef clientActor,
final int expectedResponses,
final long timeout) {
this.connectionId = connectionId;
this.clientActor = clientActor;
this.expectedResponses = expectedResponses;
this.timeout = timeout;
aggregatedResults = new ArrayList<>();
aggregatedStatus = new HashMap<>();
}
@Override
public Receive createReceive() {
return ReceiveBuilder.create()
.match(Command.class, command -> {
clientActor.tell(new Broadcast(command), getSelf());
originHeaders = command.getDittoHeaders();