-
Notifications
You must be signed in to change notification settings - Fork 215
/
OutboundDispatchingActor.java
284 lines (249 loc) · 13 KB
/
OutboundDispatchingActor.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
/*
* Copyright (c) 2020 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.connectivity.service.messaging;
import java.time.Duration;
import java.util.Collection;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.function.Predicate;
import org.eclipse.ditto.base.model.acks.AcknowledgementLabel;
import org.eclipse.ditto.base.model.acks.AcknowledgementLabelNotDeclaredException;
import org.eclipse.ditto.base.model.acks.AcknowledgementRequest;
import org.eclipse.ditto.base.model.entity.id.EntityId;
import org.eclipse.ditto.base.model.entity.id.WithEntityId;
import org.eclipse.ditto.base.model.exceptions.DittoRuntimeException;
import org.eclipse.ditto.base.model.headers.DittoHeaderDefinition;
import org.eclipse.ditto.base.model.headers.WithDittoHeaders;
import org.eclipse.ditto.base.model.signals.Signal;
import org.eclipse.ditto.base.model.signals.acks.Acknowledgement;
import org.eclipse.ditto.base.model.signals.commands.Command;
import org.eclipse.ditto.base.model.signals.commands.CommandResponse;
import org.eclipse.ditto.connectivity.api.InboundSignal;
import org.eclipse.ditto.connectivity.api.OutboundSignalFactory;
import org.eclipse.ditto.connectivity.model.Connection;
import org.eclipse.ditto.connectivity.model.Target;
import org.eclipse.ditto.edge.service.acknowledgements.AcknowledgementForwarderActor;
import org.eclipse.ditto.internal.utils.akka.logging.DittoLoggerFactory;
import org.eclipse.ditto.internal.utils.akka.logging.ThreadSafeDittoLoggingAdapter;
import org.eclipse.ditto.thingsearch.model.signals.events.SubscriptionEvent;
import akka.actor.AbstractActor;
import akka.actor.ActorRef;
import akka.actor.ActorSelection;
import akka.actor.CoordinatedShutdown;
import akka.actor.PoisonPill;
import akka.actor.Props;
import akka.actor.Terminated;
import akka.japi.pf.ReceiveBuilder;
import akka.pattern.Patterns;
/**
* This Actor makes the decision whether to dispatch outbound signals and their acknowledgements or to drop them.
*/
final class OutboundDispatchingActor extends AbstractActor {
/**
* The name of this Actor in the ActorSystem.
*/
public static final String ACTOR_NAME = "outboundDispatching";
private final ThreadSafeDittoLoggingAdapter logger = DittoLoggerFactory.getThreadSafeDittoLoggingAdapter(this);
private final OutboundMappingSettings settings;
private final ActorRef outboundMappingProcessorActor;
private final OutboundAcksCounter acksCounter;
@SuppressWarnings("unused")
private OutboundDispatchingActor(final OutboundMappingSettings settings,
final ActorRef outboundMappingProcessorActor, final Connection connection) {
this.settings = settings;
this.outboundMappingProcessorActor = outboundMappingProcessorActor;
this.acksCounter = OutboundAcksCounter.of(connection);
}
static Props props(final OutboundMappingSettings settings, final ActorRef outboundMappingProcessorActor,
final Connection connection) {
return Props.create(OutboundDispatchingActor.class, settings, outboundMappingProcessorActor, connection);
}
@Override
public Receive createReceive() {
return ReceiveBuilder.create()
.match(InboundSignal.class, this::inboundSignal)
.match(CommandResponse.class, this::forwardWithoutCheck)
.match(SubscriptionEvent.class, this::forwardWithoutCheck)
.match(DittoRuntimeException.class, this::forwardWithoutCheck)
.match(Signal.class, this::handleSignal)
.match(Terminated.class, this::actorTerminated)
.matchEquals(Control.SHUTDOWN, this::gracefulShutdown)
.matchAny(message -> logger.warning("Unknown message: <{}>", message))
.build();
}
@Override
public void preStart() {
final var system = getContext().getSystem();
final var coordinatedShutdown = CoordinatedShutdown.get(system);
final var id = getSelf().path().toString();
coordinatedShutdown.addActorTerminationTask(CoordinatedShutdown.PhaseServiceRequestsDone(),
"service-requests-done-" + id, getSelf(), Optional.of(Control.SHUTDOWN));
}
private void inboundSignal(final InboundSignal inboundSignal) {
handleInboundResponseOrAcknowledgement(inboundSignal.getSignal());
}
private void forwardWithoutCheck(final Object message) {
outboundMappingProcessorActor.tell(message, getSender());
}
private void handleSignal(final Signal<?> signal) {
if (settings.getConnectionId().toString().equals(signal.getDittoHeaders().getOrigin().orElse(null))) {
logDroppedSignal(signal, signal.getType(), "Was sent by myself.");
return;
}
final List<Target> subscribedAndAuthorizedTargets = settings.getSignalFilter().filter(signal);
if (subscribedAndAuthorizedTargets.isEmpty()) {
logDroppedSignal(signal, signal.getType(), "No subscribed and authorized targets present");
// issue weak acks here as the signal will not reach OutboundMappingProcessorActor
issueWeakAcknowledgements(signal);
return;
}
final Optional<EntityId> entityIdOptional = WithEntityId.getEntityIdOfType(EntityId.class, signal);
final Signal<?> signalToForward;
if (entityIdOptional.isPresent()) {
signalToForward = adjustSignalAndStartAckForwarder(signal, entityIdOptional.get());
} else {
signalToForward = signal;
}
logger.debug("Forwarding signal <{}> to client actor with targets: {}.", signalToForward.getType(),
subscribedAndAuthorizedTargets);
final var outbound = OutboundSignalFactory.newOutboundSignal(signalToForward, subscribedAndAuthorizedTargets);
outboundMappingProcessorActor.tell(outbound, getSender());
}
private void logDroppedSignal(final WithDittoHeaders withDittoHeaders, final String type, final String reason) {
logger.withCorrelationId(withDittoHeaders).debug("Signal ({}) dropped: {}", type, reason);
}
private void issueWeakAcknowledgements(final Signal<?> signal) {
OutboundMappingProcessorActor.issueWeakAcknowledgements(signal,
this::isSourceDeclaredOrTargetIssuedAck,
getContext(),
logger);
}
private boolean isNotSourceDeclaredAck(final Acknowledgement acknowledgement) {
return !settings.getSourceDeclaredAcks().contains(acknowledgement.getLabel());
}
private boolean isSourceDeclaredOrTargetIssuedAck(final AcknowledgementLabel label) {
return settings.getSourceDeclaredAcks().contains(label) || settings.getTargetIssuedAcks().contains(label);
}
private Signal<?> adjustSignalAndStartAckForwarder(final Signal<?> signal, final EntityId entityId) {
final Collection<AcknowledgementRequest> ackRequests = signal.getDittoHeaders().getAcknowledgementRequests();
final Predicate<AcknowledgementLabel> isSourceDeclaredAck = settings.getSourceDeclaredAcks()::contains;
final boolean hasSourceDeclaredAcks = ackRequests.stream()
.map(AcknowledgementRequest::getLabel)
.anyMatch(isSourceDeclaredAck);
final boolean liveCommandExpectingResponse = isLiveCommandExpectingResponse(signal);
if (!liveCommandExpectingResponse && ackRequests.isEmpty()) {
return signal;
}
final Set<AcknowledgementLabel> targetIssuedAcks = settings.getTargetIssuedAcks();
if (hasSourceDeclaredAcks || liveCommandExpectingResponse) {
// start ackregator for source declared acks
final var signalWithAckForwarder =
AcknowledgementForwarderActor.startAcknowledgementForwarderForSignal(getContext(),
self(),
settings.getProxyActor(),
entityId,
signal,
settings.getAcknowledgementConfig(),
this::isSourceDeclaredOrTargetIssuedAck
);
acksCounter.register(signalWithAckForwarder, getContext());
return signalWithAckForwarder.first();
} else {
// no need to start ackregator for target-issued acks; they go to the sender directly
return signal.setDittoHeaders(signal.getDittoHeaders().toBuilder()
.acknowledgementRequests(ackRequests.stream()
.filter(request -> targetIssuedAcks.contains(request.getLabel()))
.toList())
.build());
}
}
private void actorTerminated(final Terminated event) {
acksCounter.terminated(event);
if (acksCounter.shouldTerminateOutboundDispatchingActor()) {
logger.debug("All tasks done, shutting down");
getContext().stop(getSelf());
}
}
private static boolean isLiveCommandExpectingResponse(final Signal<?> signal) {
final var headers = signal.getDittoHeaders();
return Command.isCommand(signal) &&
headers.isResponseRequired() &&
Signal.isChannelLive(signal);
}
private void handleInboundResponseOrAcknowledgement(final Signal<?> responseOrAck) {
if (Acknowledgement.TYPE.equals(responseOrAck.getType())) {
final var acknowledgement = (Acknowledgement) responseOrAck;
if (isNotSourceDeclaredAck(acknowledgement)) {
denyNonSourceDeclaredAck(acknowledgement);
return;
}
}
final var context = getContext();
final var proxyActor = settings.getProxyActor();
final var ackForwarderOptional =
context.findChild(AcknowledgementForwarderActor.determineActorName(responseOrAck.getDittoHeaders()));
if (ackForwarderOptional.isPresent()) {
final var acknowledgementForwarder = ackForwarderOptional.get();
acknowledgementForwarder.forward(responseOrAck, context);
acksCounter.countDown(acknowledgementForwarder);
if (acksCounter.shouldTerminateOutboundDispatchingActor()) {
logger.debug("Terminating after dispatching the last acknowledgement");
// wait for ack forwarder to process the final response or acknowledgement before stopping self
final Duration shutdownTimeout = Duration.ofMinutes(2);
final var ping = AcknowledgementForwarderActor.Control.PING;
final var poisonPillFuture =
Patterns.ask(acknowledgementForwarder, ping, shutdownTimeout)
.handle((result, error) -> PoisonPill.getInstance());
Patterns.pipe(poisonPillFuture, getContext().dispatcher()).to(getSelf());
}
} else {
final var forwarderActorClassName = AcknowledgementForwarderActor.class.getSimpleName();
final var template = "No {} found. Forwarding signal to proxy actor: <{}>";
if (logger.isDebugEnabled()) {
logger.withCorrelationId(responseOrAck).debug(template, forwarderActorClassName, responseOrAck);
} else {
logger.withCorrelationId(responseOrAck)
.info(template, forwarderActorClassName, responseOrAck.getClass().getCanonicalName());
}
proxyActor.tell(responseOrAck, ActorRef.noSender());
}
}
private void denyNonSourceDeclaredAck(final Acknowledgement ack) {
final String ackregatorAddress = ack.getDittoHeaders()
.get(DittoHeaderDefinition.DITTO_ACKREGATOR_ADDRESS.getKey());
if (null != ackregatorAddress) {
final ActorSelection acknowledgementRequester = getContext().actorSelection(ackregatorAddress);
acknowledgementRequester.tell(
AcknowledgementLabelNotDeclaredException.of(ack.getLabel(), ack.getDittoHeaders()),
ActorRef.noSender());
} else {
logger.withCorrelationId(ack)
.error("Received Acknowledgement <{}> did not contain header of acknowledgement aggregator " +
"address", ack);
}
}
private void gracefulShutdown(final Control trigger) {
acksCounter.shutdown();
if (acksCounter.shouldTerminateOutboundDispatchingActor()) {
logger.debug("Stopping due to coordinated shutdown.");
getContext().stop(getSelf());
} else {
logger.info("Waiting for pending issued acknowledgements before shutting down: {}",
acksCounter.describeState());
}
}
private enum Control {
SHUTDOWN
}
}