-
Notifications
You must be signed in to change notification settings - Fork 215
/
ThingUpdaterTest.java
455 lines (392 loc) · 20.5 KB
/
ThingUpdaterTest.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
/*
* Copyright (c) 2022 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.thingsearch.service.updater.actors;
import static org.assertj.core.api.Assertions.assertThat;
import java.net.URLEncoder;
import java.nio.charset.Charset;
import java.time.Duration;
import java.util.List;
import java.util.concurrent.TimeUnit;
import org.bson.BsonArray;
import org.bson.BsonDocument;
import org.bson.BsonInt64;
import org.eclipse.ditto.base.api.common.Shutdown;
import org.eclipse.ditto.base.api.common.ShutdownReasonFactory;
import org.eclipse.ditto.base.model.acks.AcknowledgementLabel;
import org.eclipse.ditto.base.model.acks.AcknowledgementRequest;
import org.eclipse.ditto.base.model.entity.id.EntityId;
import org.eclipse.ditto.base.model.headers.DittoHeaders;
import org.eclipse.ditto.internal.utils.akka.ActorSystemResource;
import org.eclipse.ditto.internal.utils.config.DefaultScopedConfig;
import org.eclipse.ditto.json.JsonPointer;
import org.eclipse.ditto.json.JsonValue;
import org.eclipse.ditto.policies.api.PolicyReferenceTag;
import org.eclipse.ditto.policies.api.PolicyTag;
import org.eclipse.ditto.policies.model.PolicyId;
import org.eclipse.ditto.things.model.ThingId;
import org.eclipse.ditto.things.model.signals.events.AttributeModified;
import org.eclipse.ditto.thingsearch.api.UpdateReason;
import org.eclipse.ditto.thingsearch.api.commands.sudo.UpdateThing;
import org.eclipse.ditto.thingsearch.service.common.config.DittoSearchConfig;
import org.eclipse.ditto.thingsearch.service.common.config.SearchConfig;
import org.eclipse.ditto.thingsearch.service.persistence.write.model.Metadata;
import org.eclipse.ditto.thingsearch.service.persistence.write.model.ThingDeleteModel;
import org.eclipse.ditto.thingsearch.service.persistence.write.model.ThingWriteModel;
import org.eclipse.ditto.thingsearch.service.persistence.write.model.WriteResultAndErrors;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.mongodb.scala.bson.BsonInt32;
import com.mongodb.bulk.BulkWriteResult;
import com.mongodb.client.model.UpdateOneModel;
import com.typesafe.config.ConfigFactory;
import akka.NotUsed;
import akka.actor.ActorRef;
import akka.actor.ActorSystem;
import akka.actor.Props;
import akka.actor.ReceiveTimeout;
import akka.cluster.pubsub.DistributedPubSubMediator;
import akka.stream.javadsl.Flow;
import akka.stream.javadsl.Keep;
import akka.stream.javadsl.MergeHub;
import akka.stream.javadsl.Source;
import akka.stream.scaladsl.BroadcastHub;
import akka.stream.testkit.TestPublisher;
import akka.stream.testkit.TestSubscriber;
import akka.stream.testkit.javadsl.TestSink;
import akka.stream.testkit.javadsl.TestSource;
import akka.testkit.TestKit;
import akka.testkit.TestProbe;
import scala.concurrent.duration.FiniteDuration;
/**
* Tests {@link ThingUpdater}.
*/
public final class ThingUpdaterTest {
private static final FiniteDuration TEN_SECOND = FiniteDuration.apply(10, "s");
private static final SearchConfig SEARCH_CONFIG =
DittoSearchConfig.of(DefaultScopedConfig.dittoScoped(ConfigFactory.parseString("""
ditto {
search = {}
mongodb.uri = "mongodb://localhost:27017/test"
}
""")));
private static final ThingId THING_ID = ThingId.of("thing:id");
private static final long REVISION = 1234L;
private static final String ACTOR_NAME = getActorName(THING_ID.getName());
@Rule
public final ActorSystemResource actorSystemResource = ActorSystemResource.newInstance();
private ActorSystem system;
private Flow<ThingUpdater.Data, ThingUpdater.Result, NotUsed> flow;
private TestSubscriber.Probe<ThingUpdater.Data> inletProbe;
private TestPublisher.Probe<ThingUpdater.Result> outletProbe;
@Before
public void init() {
system = actorSystemResource.getActorSystem();
final var inletPair =
MergeHub.of(ThingUpdater.Data.class).toMat(TestSink.probe(system), Keep.both()).run(system);
final var outletPair =
TestSource.<ThingUpdater.Result>probe(system).toMat(BroadcastHub.sink(), Keep.both()).run(system);
flow = Flow.fromSinkAndSource(inletPair.first(), outletPair.second());
inletProbe = inletPair.second();
outletProbe = outletPair.first();
}
@Test
public void recoverLastWriteModel() {
new TestKit(system) {{
// GIVEN: ThingUpdater recovers with a write model of revision 1234
final Props props =
ThingUpdater.props(flow, id -> Source.single(getThingWriteModel()), SEARCH_CONFIG,
TestProbe.apply(system).ref());
final ActorRef underTest = watch(childActorOf(props, ACTOR_NAME));
// WHEN: An event of the same revision arrives
underTest.tell(AttributeModified.of(THING_ID, JsonPointer.of("x"), JsonValue.of(5), REVISION, null,
DittoHeaders.empty(), null), ActorRef.noSender());
// THEN: No update is sent to the database during the actor's lifetime
inletProbe.ensureSubscription();
inletProbe.request(16);
inletProbe.expectNoMessage();
underTest.tell(ThingUpdater.ShutdownTrigger.DELETE, ActorRef.noSender());
expectTerminated(underTest, TEN_SECOND);
inletProbe.expectNoMessage();
}};
}
@Test
public void updateFromEvent() {
new TestKit(system) {{
// GIVEN: ThingUpdater recovers with a write model of revision 1234
final Props props =
ThingUpdater.props(flow, id -> Source.single(getThingWriteModel()), SEARCH_CONFIG, testActor());
final ActorRef underTest = watch(childActorOf(props, ACTOR_NAME));
// WHEN: An event of the next revision arrives
final var event = AttributeModified.of(THING_ID, JsonPointer.of("x"), JsonValue.of(6), REVISION + 1, null,
DittoHeaders.empty(), null);
underTest.tell(event, ActorRef.noSender());
// THEN: 1 update is sent
inletProbe.ensureSubscription();
inletProbe.request(16);
final var data = inletProbe.expectNext();
assertThat(data.metadata().export()).isEqualTo(Metadata.of(THING_ID, REVISION + 1, null, null, null));
assertThat(data.metadata().getTimers().size()).isEqualTo(1);
assertThat(data.lastWriteModel()).isEqualTo(getThingWriteModel());
}};
}
@Test
public void handleShutdownDueToNamespacePurging() {
new TestKit(system) {{
// GIVEN: ThingUpdater recovers with a write model of revision 1234
final Props props =
ThingUpdater.props(flow, id -> Source.single(getThingWriteModel()), SEARCH_CONFIG, testActor());
final ActorRef underTest = watch(childActorOf(props, ACTOR_NAME));
expectMsgClass(DistributedPubSubMediator.Subscribe.class);
// WHEN: A shutdown command arrives
final var shutdown =
Shutdown.getInstance(ShutdownReasonFactory.getPurgeNamespaceReason(THING_ID.getNamespace()),
DittoHeaders.empty());
underTest.tell(shutdown, ActorRef.noSender());
// THEN: expect actor is terminated
expectTerminated(underTest, scala.concurrent.duration.Duration.apply(3, TimeUnit.SECONDS));
}};
}
@Test
public void handleShutdownDueToEntitiesPurging() {
new TestKit(system) {{
// GIVEN: ThingUpdater recovers with a write model of revision 1234
final Props props =
ThingUpdater.props(flow, id -> Source.single(getThingWriteModel()), SEARCH_CONFIG, testActor());
final ActorRef underTest = watch(childActorOf(props, ACTOR_NAME));
expectMsgClass(DistributedPubSubMediator.Subscribe.class);
// WHEN: A shutdown command arrives
final List<EntityId> purgedEntities = List.of(ThingId.of("some:id"), THING_ID, ThingId.of("other:id"));
final var shutdown =
Shutdown.getInstance(ShutdownReasonFactory.getPurgeEntitiesReason(purgedEntities),
DittoHeaders.empty());
underTest.tell(shutdown, ActorRef.noSender());
// THEN: expect actor is terminated
expectTerminated(underTest, scala.concurrent.duration.Duration.apply(3, TimeUnit.SECONDS));
}};
}
@Test
public void ignoreIrrelevantShutdownDueToNamespacePurging() {
new TestKit(system) {{
// GIVEN: ThingUpdater recovers with a write model of revision 1234
final Props props =
ThingUpdater.props(flow, id -> Source.single(getThingWriteModel()), SEARCH_CONFIG, testActor());
final ActorRef underTest = watch(childActorOf(props, ACTOR_NAME));
expectMsgClass(DistributedPubSubMediator.Subscribe.class);
// WHEN: A shutdown command arrives
final var shutdown =
Shutdown.getInstance(ShutdownReasonFactory.getPurgeNamespaceReason("foo"),
DittoHeaders.empty());
underTest.tell(shutdown, ActorRef.noSender());
// THEN: expect actor is not terminated
expectNoMessage(FiniteDuration.apply(1, TimeUnit.SECONDS));
}};
}
@Test
public void ignoreIrrelevantShutdownDueToEntitiesPurging() {
new TestKit(system) {{
// GIVEN: ThingUpdater recovers with a write model of revision 1234
final Props props =
ThingUpdater.props(flow, id -> Source.single(getThingWriteModel()), SEARCH_CONFIG, testActor());
final ActorRef underTest = watch(childActorOf(props, ACTOR_NAME));
expectMsgClass(DistributedPubSubMediator.Subscribe.class);
// WHEN: A shutdown command arrives
final List<EntityId> purgedEntities = List.of(ThingId.of("some:id"), ThingId.of("other:id"));
final var shutdown =
Shutdown.getInstance(ShutdownReasonFactory.getPurgeEntitiesReason(purgedEntities),
DittoHeaders.empty());
underTest.tell(shutdown, ActorRef.noSender());
// THEN: expect actor is not terminated
expectNoMessage(FiniteDuration.apply(1, TimeUnit.SECONDS));
}};
}
@Test
public void combineUpdatesFrom2Events() {
new TestKit(system) {{
// GIVEN: ThingUpdater recovers with a write model of revision 1234
final Props props =
ThingUpdater.props(flow, id -> Source.single(getThingWriteModel()), SEARCH_CONFIG,
TestProbe.apply(system).ref());
// WHEN: 2 event of the next revisions arrive
final var event1 = AttributeModified.of(THING_ID, JsonPointer.of("x"), JsonValue.of(6), REVISION + 1, null,
DittoHeaders.empty(), null);
final var event2 = AttributeModified.of(THING_ID, JsonPointer.of("x"), JsonValue.of(7), REVISION + 2, null,
DittoHeaders.empty(), null);
final ActorRef underTest = watch(childActorOf(props, ACTOR_NAME));
underTest.tell(event1, ActorRef.noSender());
underTest.tell(event2, ActorRef.noSender());
// THEN: 1 update is sent
inletProbe.ensureSubscription();
inletProbe.request(16);
final var data = inletProbe.expectNext();
assertThat(data.metadata().export()).isEqualTo(Metadata.of(THING_ID, REVISION + 2, null, null, null));
assertThat(data.metadata().getTimers().size()).isEqualTo(2);
assertThat(data.metadata().getEvents().size()).isEqualTo(2);
assertThat(data.lastWriteModel()).isEqualTo(getThingWriteModel());
// THEN: no other updates are sent
underTest.tell(ThingUpdater.ShutdownTrigger.DELETE, ActorRef.noSender());
outletProbe.ensureSubscription();
outletProbe.expectRequest();
outletProbe.sendError(new IllegalStateException("Expected exception"));
expectTerminated(underTest, TEN_SECOND);
inletProbe.expectNoMessage();
}};
}
@Test
public void stashEventsDuringPersistence() {
new TestKit(system) {{
// GIVEN: an event triggers persistence
final Props props =
ThingUpdater.props(flow, id -> Source.single(getThingWriteModel()), SEARCH_CONFIG, testActor());
final var event1 = AttributeModified.of(THING_ID, JsonPointer.of("x"), JsonValue.of(6), REVISION + 1, null,
DittoHeaders.empty(), null);
final var event2 = AttributeModified.of(THING_ID, JsonPointer.of("x"), JsonValue.of(7), REVISION + 2, null,
DittoHeaders.empty(), null);
final ActorRef underTest = watch(childActorOf(props, ACTOR_NAME));
underTest.tell(event1, ActorRef.noSender());
// WHEN: a second event arrives during persistence
inletProbe.ensureSubscription();
inletProbe.request(16);
final var data1 = inletProbe.expectNext();
assertThat(data1.metadata().export()).isEqualTo(Metadata.of(THING_ID, REVISION + 1, null, null, null));
underTest.tell(event2, ActorRef.noSender());
// THEN: no second update is sent until the first event is persisted
inletProbe.expectNoMessage();
outletProbe.ensureSubscription();
outletProbe.expectRequest();
outletProbe.sendNext(getOKResult(REVISION + 1));
final var data2 = inletProbe.expectNext(TEN_SECOND);
assertThat(data2.metadata().export()).isEqualTo(Metadata.of(THING_ID, REVISION + 2, null, null, null));
}};
}
@Test
public void policyIdChangeTriggersSync() {
new TestKit(system) {{
// GIVEN: ThingUpdater recovers with a write model without policy ID
final Props props =
ThingUpdater.props(flow, id -> Source.single(getThingWriteModel()), SEARCH_CONFIG, testActor());
final ActorRef underTest = watch(childActorOf(props, ACTOR_NAME));
// WHEN: A policy reference tag arrives with a policy ID
final var policyId = PolicyId.of(THING_ID);
final var policyTag = PolicyReferenceTag.of(THING_ID, PolicyTag.of(policyId, 1L));
underTest.tell(policyTag, ActorRef.noSender());
// THEN: 1 update is sent
inletProbe.ensureSubscription();
inletProbe.request(16);
final var data = inletProbe.expectNext();
assertThat(data.metadata().export()).isEqualTo(Metadata.of(THING_ID, REVISION, policyId, 1L, null));
assertThat(data.metadata().getUpdateReasons()).contains(UpdateReason.POLICY_UPDATE);
assertThat(data.metadata().getTimers()).isEmpty();
}};
}
@Test
public void triggerUpdateOnCommand() {
new TestKit(system) {{
final Props props =
ThingUpdater.props(flow, id -> Source.single(getThingWriteModel()), SEARCH_CONFIG, testActor());
final ActorRef underTest = watch(childActorOf(props, ACTOR_NAME));
final var command = UpdateThing.of(THING_ID, UpdateReason.MANUAL_REINDEXING, DittoHeaders.empty());
underTest.tell(command, ActorRef.noSender());
inletProbe.ensureSubscription();
inletProbe.request(16);
final var data = inletProbe.expectNext();
assertThat(data.metadata().export()).isEqualTo(Metadata.of(THING_ID, REVISION, null, null, null));
assertThat(data.metadata().getTimers()).isEmpty();
assertThat(data.lastWriteModel()).isEqualTo(getThingWriteModel());
}};
}
@Test
public void forceUpdateOnCommand() {
new TestKit(system) {{
final Props props =
ThingUpdater.props(flow, id -> Source.single(getThingWriteModel()), SEARCH_CONFIG, testActor());
final var expectedMetadata = Metadata.of(THING_ID, REVISION, null, null, null);
final ActorRef underTest = watch(childActorOf(props, ACTOR_NAME));
final var command = UpdateThing.of(THING_ID, UpdateReason.MANUAL_REINDEXING, DittoHeaders.newBuilder()
.putHeader("force-update", "true")
.build());
underTest.tell(command, ActorRef.noSender());
inletProbe.ensureSubscription();
inletProbe.request(16);
final var data = inletProbe.expectNext();
assertThat(data.metadata().export()).isEqualTo(expectedMetadata);
assertThat(data.metadata().getTimers()).isEmpty();
assertThat(data.lastWriteModel()).isEqualTo(ThingDeleteModel.of(expectedMetadata));
}};
}
@Test
public void shutdownOnCommand() {
new TestKit(system) {{
final Props recoveryProps =
ThingUpdater.props(flow, id -> Source.never(), SEARCH_CONFIG, TestProbe.apply(system).ref());
final Props props =
ThingUpdater.props(flow, id -> Source.single(getThingWriteModel()), SEARCH_CONFIG,
TestProbe.apply(system).ref());
final var shutdown =
Shutdown.getInstance(ShutdownReasonFactory.getPurgeNamespaceReason("thing"), DittoHeaders.empty());
final var event = AttributeModified.of(THING_ID, JsonPointer.of("x"), JsonValue.of(6), REVISION + 1, null,
DittoHeaders.empty(), null);
// shutdown during recovery
final var actor1 = watch(childActorOf(recoveryProps, getActorName("1")));
actor1.tell(shutdown, testActor());
expectTerminated(actor1, TEN_SECOND);
// shutdown when persisting
final var actor3 = watch(childActorOf(props, getActorName("3")));
actor3.tell(event, testActor());
inletProbe.ensureSubscription();
inletProbe.request(16);
inletProbe.expectNext();
actor3.tell(shutdown, testActor());
expectTerminated(actor3, TEN_SECOND);
// shutdown when retrying
final var actor4 = watch(childActorOf(props, getActorName("4")));
actor4.tell(event, testActor());
inletProbe.expectNext();
outletProbe.ensureSubscription();
assertThat(outletProbe.expectRequest()).isEqualTo(16);
outletProbe.sendError(new IllegalStateException("expected"));
actor4.tell(shutdown, testActor());
expectTerminated(actor4, TEN_SECOND);
// shutdown when ready
final var actor5 = watch(childActorOf(props, getActorName("5")));
actor5.tell(event, testActor());
inletProbe.expectNext();
outletProbe.sendNext(getOKResult(REVISION + 2));
actor5.tell(shutdown, testActor());
expectTerminated(actor5, TEN_SECOND);
}};
}
private static ThingUpdater.Result getOKResult(final long revision) {
final var mongoWriteModel =
MongoWriteModel.of(getThingWriteModel(revision),
new UpdateOneModel<>(new BsonDocument(), new BsonDocument()), true);
return new ThingUpdater.Result(mongoWriteModel,
WriteResultAndErrors.success(List.of(mongoWriteModel),
BulkWriteResult.acknowledged(0, 1, 0, 1, List.of(), List.of()), String.valueOf(revision))
);
}
private static ThingWriteModel getThingWriteModel() {
return getThingWriteModel(REVISION);
}
private static ThingWriteModel getThingWriteModel(final long revision) {
final var document = new BsonDocument()
.append("_revision", new BsonInt64(revision))
.append("f", new BsonArray())
.append("t", new BsonDocument().append("attributes",
new BsonDocument().append("x", BsonInt32.apply(5))));
return ThingWriteModel.of(Metadata.of(THING_ID, revision, null, null, null), document);
}
private static String getActorName(final String name) {
return URLEncoder.encode(THING_ID.getNamespace() + ":" + name, Charset.defaultCharset());
}
}