-
Notifications
You must be signed in to change notification settings - Fork 214
/
ResponseCollectorActor.java
226 lines (190 loc) · 7.56 KB
/
ResponseCollectorActor.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
/*
* 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.ArrayList;
import java.util.List;
import org.eclipse.ditto.base.model.common.HttpStatus;
import org.eclipse.ditto.base.model.exceptions.DittoRuntimeException;
import org.eclipse.ditto.base.model.signals.Signal;
import org.eclipse.ditto.base.model.signals.commands.CommandResponse;
import org.eclipse.ditto.internal.utils.pekko.logging.DittoDiagnosticLoggingAdapter;
import org.eclipse.ditto.internal.utils.pekko.logging.DittoLoggerFactory;
import org.apache.pekko.actor.AbstractActor;
import org.apache.pekko.actor.ActorRef;
import org.apache.pekko.actor.Props;
import org.apache.pekko.actor.ReceiveTimeout;
import org.apache.pekko.japi.pf.ReceiveBuilder;
/**
* Actor that collects a fixed number of command responses, which may be acknowledgements.
*
* @since 1.2.0
*/
public final class ResponseCollectorActor extends AbstractActor {
private final DittoDiagnosticLoggingAdapter log = DittoLoggerFactory.getDiagnosticLoggingAdapter(this);
private final List<CommandResponse<?>> commandResponses = new ArrayList<>();
private int expectedCount = -1;
private ActorRef querySender;
private DittoRuntimeException error;
@SuppressWarnings("unused") // called by static props() via Reflection
private ResponseCollectorActor(final Duration timeout) {
getContext().setReceiveTimeout(timeout);
}
static Props props(final Duration timeout) {
return Props.create(ResponseCollectorActor.class, timeout);
}
static Input query() {
return Query.INSTANCE;
}
public static Input setCount(final int expectedCount) {
return new SetCount(expectedCount);
}
@Override
public Receive createReceive() {
return ReceiveBuilder.create()
.matchEquals(ReceiveTimeout.getInstance(), this::onReceiveTimeout)
.matchEquals(Query.INSTANCE, this::onQuery)
.match(SetCount.class, this::onSetCount)
.match(CommandResponse.class, this::onCommandResponse)
.match(DittoRuntimeException.class, this::onDittoRuntimeException)
.matchAny(msg -> log.warning("Unhandled <{}>", msg))
.build();
}
private void onReceiveTimeout(final ReceiveTimeout receiveTimeout) {
log.debug("ReceiveTimeout");
reportOutputAndStop();
}
private void onQuery(final Query query) {
querySender = getSender();
log.debug("Query from <{}>", querySender);
reportIfAllCollected();
}
private void onSetCount(final SetCount setCount) {
expectedCount = setCount.count;
log.debug("SetCount <{}>", expectedCount);
reportIfAllCollected();
}
private void onCommandResponse(final CommandResponse<?> commandResponse) {
log.withCorrelationId(commandResponse).debug("CommandResponse <{}>", commandResponse);
commandResponses.add(commandResponse);
reportIfAllCollected();
}
private void onDittoRuntimeException(final DittoRuntimeException dittoRuntimeException) {
log.withCorrelationId(dittoRuntimeException)
.debug("DittoRuntimeException <{}>", dittoRuntimeException);
error = dittoRuntimeException;
reportIfAllCollected();
}
private void reportIfAllCollected() {
if (querySender != null && error != null && expectedCount >= 0) {
reportAndStop(error);
} else if (querySender != null && expectedCount >= 0 && commandResponses.size() >= expectedCount) {
reportOutputAndStop();
}
}
private void reportOutputAndStop() {
reportAndStop(new Output(expectedCount, commandResponses));
}
private void reportAndStop(final Object output) {
if (querySender != null) {
querySender.tell(output, ActorRef.noSender());
} else {
log.error("ReceiveTimeout without Query");
}
getContext().cancelReceiveTimeout();
getContext().stop(getSelf());
}
/**
* Query output after all responses are received or after timeout.
*/
public static final class Output {
private final int expectedCount;
private final List<CommandResponse<?>> commandResponses;
private Output(final int expectedCount, final List<CommandResponse<?>> commandResponses) {
this.expectedCount = expectedCount;
this.commandResponses = commandResponses;
}
/**
* @return The list of responses collected.
*/
public List<CommandResponse<?>> getCommandResponses() {
return commandResponses;
}
/**
* @return Whether the expected number of responses arrived.
*/
public boolean allExpectedResponsesArrived() {
// always false if expectedCount < 0 (i. e., not set by a SetCount input signal)
return expectedCount == commandResponses.size();
}
/**
* @return list of failed responses.
*/
public List<CommandResponse<?>> getFailedResponses() {
return commandResponses.stream()
.filter(Output::isFailedResponse)
.toList();
}
@Override
public String toString() {
return getClass().getSimpleName() + "[" +
"expectedCount=" + expectedCount +
", commandResponses=" + commandResponses +
"]";
}
private static boolean isFailedResponse(final CommandResponse<?> response) {
final boolean result;
final var responseHttpStatus = response.getHttpStatus();
if (isLiveResponse(response)) {
/*
* Consider live responses only as failed acknowledgement when the response timed out.
* Otherwise it would not be possible to respond with an error status code to live messages.
*/
result = HttpStatus.REQUEST_TIMEOUT.equals(responseHttpStatus);
} else {
result = responseHttpStatus.isClientError() || responseHttpStatus.isServerError();
}
return result;
}
private static boolean isLiveResponse(final CommandResponse<?> response) {
return CommandResponse.isMessageCommandResponse(response) ||
CommandResponse.isThingCommandResponse(response) &&
Signal.isChannelLive(response);
}
}
/**
* Input for the collector actor.
*/
interface Input {}
private enum Query implements Input {
INSTANCE
}
private static final class SetCount implements Input {
private final int count;
private SetCount(final int count) {
this.count = count;
}
@Override
public String toString() {
return getClass().getSimpleName() + "[" + count + "]";
}
@Override
public int hashCode() {
return count;
}
@Override
public boolean equals(final Object other) {
return other instanceof SetCount setCount && setCount.count == count;
}
}
}