-
Notifications
You must be signed in to change notification settings - Fork 214
/
SubscriptionManager.java
222 lines (197 loc) · 9.65 KB
/
SubscriptionManager.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
/*
* 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.internal.utils.search;
import java.time.Duration;
import java.util.Collection;
import java.util.Optional;
import java.util.stream.Stream;
import javax.annotation.Nullable;
import org.eclipse.ditto.base.model.exceptions.DittoRuntimeException;
import org.eclipse.ditto.base.service.config.limits.DefaultLimitsConfig;
import org.eclipse.ditto.base.service.config.limits.LimitsConfig;
import org.eclipse.ditto.internal.utils.pekko.logging.DittoDiagnosticLoggingAdapter;
import org.eclipse.ditto.internal.utils.pekko.logging.DittoLoggerFactory;
import org.eclipse.ditto.internal.utils.config.DefaultScopedConfig;
import org.eclipse.ditto.json.JsonArray;
import org.eclipse.ditto.json.JsonCollectors;
import org.eclipse.ditto.json.JsonValue;
import org.eclipse.ditto.rql.parser.thingsearch.RqlOptionParser;
import org.eclipse.ditto.thingsearch.model.SizeOption;
import org.eclipse.ditto.thingsearch.model.signals.commands.ThingSearchCommand;
import org.eclipse.ditto.thingsearch.model.signals.commands.exceptions.InvalidOptionException;
import org.eclipse.ditto.thingsearch.model.signals.commands.exceptions.SubscriptionNotFoundException;
import org.eclipse.ditto.thingsearch.model.signals.commands.subscription.CancelSubscription;
import org.eclipse.ditto.thingsearch.model.signals.commands.subscription.CreateSubscription;
import org.eclipse.ditto.thingsearch.model.signals.commands.subscription.RequestFromSubscription;
import org.eclipse.ditto.thingsearch.model.signals.events.SubscriptionFailed;
import org.reactivestreams.Subscriber;
import org.apache.pekko.NotUsed;
import org.apache.pekko.actor.AbstractActor;
import org.apache.pekko.actor.ActorRef;
import org.apache.pekko.actor.ActorSelection;
import org.apache.pekko.actor.Props;
import org.apache.pekko.japi.pf.ReceiveBuilder;
import org.apache.pekko.stream.Materializer;
import org.apache.pekko.stream.javadsl.Sink;
import org.apache.pekko.stream.javadsl.Source;
/**
* Actor that manages search subscriptions for 1 websocket connection or 1 ConnectionPersistenceActor.
*
* @since 1.1.0
*/
public final class SubscriptionManager extends AbstractActor {
/**
* Name of this actor.
*/
public static final String ACTOR_NAME = "subscriptionManager";
private final Duration idleTimeout;
private final ActorRef pubSubMediator;
private final ActorSelection proxyActor;
private final Materializer materializer;
private final DittoDiagnosticLoggingAdapter log;
private final int defaultPageSize;
private final int maxPageSize;
private int subscriptionIdCounter = 0;
SubscriptionManager(final Duration idleTimeout,
final ActorRef pubSubMediator,
final ActorSelection proxyActor,
final Materializer materializer) {
this.idleTimeout = idleTimeout;
this.pubSubMediator = pubSubMediator;
this.proxyActor = proxyActor;
this.materializer = materializer;
log = DittoLoggerFactory.getDiagnosticLoggingAdapter(this);
final LimitsConfig limitsConfig =
DefaultLimitsConfig.of(DefaultScopedConfig.dittoScoped(getContext().getSystem().settings().config()));
defaultPageSize = limitsConfig.getThingsSearchDefaultPageSize();
maxPageSize = limitsConfig.getThingsSearchMaxPageSize();
}
/**
* Create Props for a subscription manager.
*
* @param idleTimeout lifetime of an idle SubscriptionActor.
* @param pubSubMediator pub-sub mediator for reporting of out-of-sync things.
* @param proxyActor recipient of thing and StreamThings commands.
* @param materializer materializer for the search streams.
* @return Props of the actor.
*/
public static Props props(final Duration idleTimeout,
final ActorRef pubSubMediator,
final ActorSelection proxyActor,
final Materializer materializer) {
return Props.create(SubscriptionManager.class, idleTimeout, pubSubMediator, proxyActor, materializer);
}
private static JsonArray asJsonArray(final Collection<String> strings) {
return strings.stream().map(JsonValue::of).collect(JsonCollectors.valuesToArray());
}
private int getPageSize(@Nullable final String optionString) {
if (optionString == null) {
return defaultPageSize;
} else {
final int pageSize = RqlOptionParser.parseOptions(optionString)
.stream()
.flatMap(option -> option instanceof SizeOption sizeOption
? Stream.of(sizeOption.getSize())
: Stream.empty())
.findFirst()
.orElse(defaultPageSize);
if (pageSize > 0 && pageSize <= maxPageSize) {
return pageSize;
} else {
throw InvalidOptionException.newBuilder()
.message("Invalid option: '" + optionString + "'")
.description("size(n) -- n must be between 1 and " + maxPageSize)
.build();
}
}
}
@Override
public Receive createReceive() {
return ReceiveBuilder.create()
.match(RequestFromSubscription.class, this::requestSubscription)
.match(CreateSubscription.class, this::createSubscription)
.match(CancelSubscription.class, this::cancelSubscription)
.build();
}
private void requestSubscription(final RequestFromSubscription requestFromSubscription) {
forwardToChild(requestFromSubscription.getSubscriptionId(), requestFromSubscription);
}
private void cancelSubscription(final CancelSubscription cancelSubscription) {
forwardToChild(cancelSubscription.getSubscriptionId(), cancelSubscription);
}
private void forwardToChild(final String subscriptionId, final ThingSearchCommand<?> command) {
final Optional<ActorRef> subscriptionActor = getContext().findChild(subscriptionId);
if (subscriptionActor.isPresent()) {
log.withCorrelationId(command).debug("Forwarding to child: <{}>", command);
subscriptionActor.get().tell(command, getSender());
} else {
// most likely a user error
log.withCorrelationId(command)
.info("SubscriptionID not found, responding with SubscriptionFailed: <{}>", command);
final SubscriptionNotFoundException error =
SubscriptionNotFoundException.of(subscriptionId, command.getDittoHeaders());
final SubscriptionFailed subscriptionFailed =
SubscriptionFailed.of(subscriptionId, error, command.getDittoHeaders());
getSender().tell(subscriptionFailed, ActorRef.noSender());
}
}
private void createSubscription(final CreateSubscription createSubscription) {
log.withCorrelationId(createSubscription).info("Processing <{}>", createSubscription);
final String subscriptionId = nextSubscriptionId(createSubscription);
final Props props = SubscriptionActor.props(idleTimeout, getSender(), createSubscription.getDittoHeaders());
final ActorRef subscriptionActor = getContext().actorOf(props, subscriptionId);
final Source<JsonArray, NotUsed> pageSource = getPageSource(createSubscription);
connect(subscriptionActor, pageSource);
}
private void connect(final ActorRef subscriptionActor, final Source<JsonArray, NotUsed> pageSource) {
final Subscriber<JsonArray> subscriber = SubscriptionActor.asSubscriber(subscriptionActor);
lazify(pageSource).runWith(Sink.fromSubscriber(subscriber), materializer);
}
private Source<JsonArray, NotUsed> getPageSource(final CreateSubscription createSubscription) {
final String optionString = createSubscription.getOptions().orElse(null);
final JsonArray namespaces = createSubscription.getNamespaces()
.filter(ns -> !ns.isEmpty())
.map(SubscriptionManager::asJsonArray)
.orElse(null);
try {
final SearchSource searchSource = SearchSource.newBuilder()
.pubSubMediator(pubSubMediator)
.commandForwarder(proxyActor)
.namespaces(namespaces)
.filter(createSubscription.getFilter().orElse(null))
.fields(createSubscription.getSelectedFields().orElse(null))
.options(optionString)
.dittoHeaders(createSubscription.getDittoHeaders())
.build();
return searchSource.start(builder -> {})
.grouped(getPageSize(optionString))
.map(JsonArray::of);
} catch (final DittoRuntimeException e) {
return Source.failed(e);
}
}
private String nextSubscriptionId(final CreateSubscription createSubscription) {
final String prefix = createSubscription.getPrefix().orElse("");
return prefix + subscriptionIdCounter++;
}
/**
* Make a source that never completes until downstream request.
*
* @param upstream the source to lazify.
* @param <T> the type of elements.
* @return the lazified source.
*/
private static <T> Source<T, ?> lazify(final Source<T, ?> upstream) {
return Source.lazySource(() -> upstream);
}
}