-
Notifications
You must be signed in to change notification settings - Fork 215
/
BsonDiffVisitorIT.java
424 lines (332 loc) · 16 KB
/
BsonDiffVisitorIT.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
/*
* Copyright (c) 2021 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.persistence.write.mapping;
import static org.assertj.core.api.Assertions.assertThat;
import static org.eclipse.ditto.policies.model.PoliciesResourceType.THING;
import java.util.List;
import org.bson.BsonDocument;
import org.bson.Document;
import org.bson.codecs.DecoderContext;
import org.eclipse.ditto.internal.utils.persistence.mongo.BsonUtil;
import org.eclipse.ditto.internal.utils.persistence.mongo.DittoMongoClient;
import org.eclipse.ditto.internal.utils.persistence.mongo.MongoClientWrapper;
import org.eclipse.ditto.internal.utils.test.mongo.MongoDbResource;
import org.eclipse.ditto.json.JsonFactory;
import org.eclipse.ditto.json.JsonObject;
import org.eclipse.ditto.policies.api.Permission;
import org.eclipse.ditto.policies.model.PoliciesModelFactory;
import org.eclipse.ditto.policies.model.Policy;
import org.eclipse.ditto.policies.model.PolicyId;
import org.eclipse.ditto.policies.model.SubjectType;
import org.eclipse.ditto.things.model.ThingId;
import org.eclipse.ditto.thingsearch.service.persistence.write.model.Metadata;
import org.junit.After;
import org.junit.Before;
import org.junit.ClassRule;
import org.junit.Test;
import org.reactivestreams.Publisher;
import com.mongodb.reactivestreams.client.MongoCollection;
import akka.actor.ActorSystem;
import akka.stream.javadsl.Sink;
import akka.stream.javadsl.Source;
import akka.testkit.javadsl.TestKit;
/**
* Tests incremental update.
*/
public final class BsonDiffVisitorIT {
@ClassRule
public static final MongoDbResource MONGO_RESOURCE = new MongoDbResource();
private DittoMongoClient client;
private MongoCollection<Document> collection;
private ActorSystem system;
private Policy policy;
private Policy policy2;
@Before
public void init() {
client = MongoClientWrapper.getBuilder()
.hostnameAndPort(MONGO_RESOURCE.getBindIp(), MONGO_RESOURCE.getPort())
.defaultDatabaseName("test")
.build();
collection = client.getCollection("test");
system = ActorSystem.create();
final int n = 20;
policy = PoliciesModelFactory.newPolicyBuilder(PolicyId.of("policy", "id"))
.forLabel("grant-root")
.setSubject("grant:" + "root".repeat(n), SubjectType.GENERATED)
.setGrantedPermissions(THING, "/", Permission.READ)
.forLabel("grant-d")
.setSubject("grant:" + "dx.e".repeat(n), SubjectType.GENERATED)
.setGrantedPermissions(THING, "/d/e", Permission.READ)
.forLabel("revoke")
.setSubject("revoke:" + "dx.e".repeat(n), SubjectType.GENERATED)
.setRevokedPermissions(THING, "/d/e", Permission.READ)
.build();
policy2 = policy.toBuilder()
.forLabel("additional")
.setSubject("revoke:" + "dx.e".repeat(n), SubjectType.GENERATED)
.setGrantedPermissions(THING, "/d/e/f", Permission.READ)
.setGrantedPermissions(THING, "/d/e/h", Permission.READ)
.build();
}
@After
public void shutdown() {
cleanupAction(() -> run(collection.drop()));
cleanupAction(() -> client.close());
cleanupAction(() -> TestKit.shutdownActorSystem(system));
}
@Test
public void testAggregationUpdate() {
final var collection = client.getCollection("test");
final Metadata metadata =
Metadata.of(ThingId.of("solar.system:pluto"), 23L, PolicyId.of("solar.system:pluto"), 45L, null, null);
final JsonObject prevThing = getThing1();
final JsonObject nextThing = getThing2(); // Thing1 with some fields updated
final BsonDocument prevThingDoc =
EnforcedThingMapper.toBsonDocument(prevThing, policy, metadata);
final BsonDocument nextThingDoc =
EnforcedThingMapper.toBsonDocument(nextThing, policy, metadata);
final BsonDiff diff = BsonDiff.minusThingDocs(nextThingDoc, prevThingDoc);
final List<BsonDocument> updateDoc = diff.consumeAndExport();
assertThat(updateDoc.toString().length())
.describedAs("Incremental update should be less than half as large as replacement")
.isLessThan(nextThingDoc.toString().length() / 2);
run(collection.insertOne(toDocument(prevThingDoc)));
run(collection.updateOne(new Document(), updateDoc));
final BsonDocument incrementalUpdateResult = toBsonDocument(run(collection.find()).get(0));
assertThat(incrementalUpdateResult)
.describedAs("Incremental update result")
.isEqualTo(nextThingDoc);
}
@Test
public void testEnforcerChange() {
final var collection = client.getCollection("test");
final Metadata metadata =
Metadata.of(ThingId.of("solar.system:pluto"), 23L, PolicyId.of("solar.system:pluto"), 45L, null, null);
final JsonObject prevThing = getThing1();
final JsonObject nextThing = getThing1();
final BsonDocument prevThingDoc =
EnforcedThingMapper.toBsonDocument(prevThing, policy, metadata);
final BsonDocument nextThingDoc =
EnforcedThingMapper.toBsonDocument(nextThing, policy2, metadata);
final BsonDiff diff = BsonDiff.minusThingDocs(nextThingDoc, prevThingDoc);
final List<BsonDocument> updateDoc = diff.consumeAndExport();
assertThat(updateDoc.toString().length())
.describedAs("Incremental update should be less than replacement")
.isLessThan(nextThingDoc.toString().length() / 2);
run(collection.insertOne(toDocument(prevThingDoc)));
run(collection.updateOne(new Document(), updateDoc));
final BsonDocument incrementalUpdateResult = toBsonDocument(run(collection.find()).get(0));
assertThat(incrementalUpdateResult)
.describedAs("Incremental update result")
.isEqualTo(nextThingDoc);
}
@Test
public void testEnforcerAndThingChange() {
final var collection = client.getCollection("test");
final Metadata metadata =
Metadata.of(ThingId.of("solar.system:pluto"), 23L, PolicyId.of("solar.system:pluto"), 45L, null, null);
final JsonObject prevThing = getThing1();
final JsonObject nextThing = getThing2();
final BsonDocument prevThingDoc =
EnforcedThingMapper.toBsonDocument(prevThing, policy, metadata);
final BsonDocument nextThingDoc =
EnforcedThingMapper.toBsonDocument(nextThing, policy2, metadata);
final BsonDiff diff = BsonDiff.minusThingDocs(nextThingDoc, prevThingDoc);
final List<BsonDocument> updateDoc = diff.consumeAndExport();
assertThat(updateDoc.toString().length())
.describedAs("Incremental update should be less than half as large as replacement")
.isLessThan((int) (nextThingDoc.toString().length() * 0.75));
run(collection.insertOne(toDocument(prevThingDoc)));
run(collection.updateOne(new Document(), updateDoc));
final BsonDocument incrementalUpdateResult = toBsonDocument(run(collection.find()).get(0));
assertThat(incrementalUpdateResult)
.describedAs("Incremental update result")
.isEqualTo(nextThingDoc);
}
@Test
public void testArrayDiff() {
final var collection = client.getCollection("test");
final Metadata metadata =
Metadata.of(ThingId.of("solar.system:pluto"), 23L, PolicyId.of("solar.system:pluto"), 45L, null, null);
final JsonObject prevThing = getThing1();
final JsonObject nextThing = getThing3(); // identical to Thing1 with fields rearranged and slightly edited
final BsonDocument prevThingDoc =
EnforcedThingMapper.toBsonDocument(prevThing, policy, metadata);
final BsonDocument nextThingDoc =
EnforcedThingMapper.toBsonDocument(nextThing, policy, metadata);
assertThat(prevThingDoc).isNotEqualTo(nextThingDoc);
final BsonDiff diff = BsonDiff.minusThingDocs(nextThingDoc, prevThingDoc);
final List<BsonDocument> updateDoc = diff.consumeAndExport();
assertThat(updateDoc.toString().length())
.describedAs("Incremental update should be less than 1/5 as large as replacement")
.isLessThan(nextThingDoc.toString().length() / 5);
run(collection.insertOne(toDocument(prevThingDoc)));
run(collection.updateOne(new Document(), updateDoc));
final BsonDocument incrementalUpdateResult = toBsonDocument(run(collection.find()).get(0));
assertThat(incrementalUpdateResult)
.describedAs("Incremental update result")
.isEqualTo(nextThingDoc);
}
@Test
public void testSetEmptyObject() {
final var collection = client.getCollection("test");
final Metadata metadata =
Metadata.of(ThingId.of("solar.system:pluto"), 23L, PolicyId.of("solar.system:pluto"), 45L, null, null);
final JsonObject prevThing = getThing1();
final JsonObject nextThing = getThing4(); // identical to Thing1 with an extra fields with emtpy object as value
final BsonDocument prevThingDoc =
EnforcedThingMapper.toBsonDocument(prevThing, policy, metadata);
final BsonDocument nextThingDoc =
EnforcedThingMapper.toBsonDocument(nextThing, policy, metadata);
assertThat(prevThingDoc).isNotEqualTo(nextThingDoc);
final BsonDiff diff = BsonDiff.minusThingDocs(nextThingDoc, prevThingDoc);
final List<BsonDocument> updateDoc = diff.consumeAndExport();
assertThat(updateDoc.toString().length())
.describedAs("Incremental update should be less than 1/8 as large as replacement")
.isLessThan(nextThingDoc.toString().length() / 8);
run(collection.insertOne(toDocument(prevThingDoc)));
run(collection.updateOne(new Document(), updateDoc));
final BsonDocument incrementalUpdateResult = toBsonDocument(run(collection.find()).get(0));
assertThat(incrementalUpdateResult)
.describedAs("Incremental update result")
.isEqualTo(nextThingDoc);
}
@Test
public void testStringExpressionInUpdate() {
final var collection = client.getCollection("test");
final Metadata metadata =
Metadata.of(ThingId.of("solar.system:pluto"), 23L, PolicyId.of("solar.system:pluto"), 45L, null, null);
final JsonObject prevThing = getThing1();
final JsonObject nextThing = getThing5(); // Thing1 with string field updated to begin with '$' and end with '.'
final BsonDocument prevThingDoc =
EnforcedThingMapper.toBsonDocument(prevThing, policy, metadata);
final BsonDocument nextThingDoc =
EnforcedThingMapper.toBsonDocument(nextThing, policy, metadata);
final BsonDiff diff = BsonDiff.minusThingDocs(nextThingDoc, prevThingDoc);
final List<BsonDocument> updateDoc = diff.consumeAndExport();
assertThat(updateDoc.toString().length())
.describedAs("Incremental update should be less than 1/8 as large as replacement")
.isLessThan(nextThingDoc.toString().length() / 8);
run(collection.insertOne(toDocument(prevThingDoc)));
run(collection.updateOne(new Document(), updateDoc));
final BsonDocument incrementalUpdateResult = toBsonDocument(run(collection.find()).get(0));
assertThat(incrementalUpdateResult)
.describedAs("Incremental update result")
.isEqualTo(nextThingDoc);
}
private <T> List<T> run(final Publisher<T> publisher) {
return Source.fromPublisher(publisher).runWith(Sink.seq(), system).toCompletableFuture().join();
}
private static Document toDocument(final BsonDocument bsonDocument) {
return BsonUtil.getCodecRegistry()
.get(Document.class)
.decode(bsonDocument.asBsonReader(), DecoderContext.builder().build());
}
private static BsonDocument toBsonDocument(final Document document) {
return document.toBsonDocument(BsonDocument.class, BsonUtil.getCodecRegistry());
}
private static void cleanupAction(final Runnable cleanup) {
try {
cleanup.run();
} catch (final NullPointerException e) {
// resource not initialized
}
}
private static JsonObject getThing1() {
return JsonFactory.newObject("""
{
"thingId":"solar.system:pluto",
"_namespace":"solar.system",
"a": [ {"b": "ABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZ", "x": 5}, true ],
"d": {
"e": {
"f": "g",
"h": "lorem ipsum dolor sit amet"
},
"j": true,
"k": 6.0,
"l": 123456789012
}
}""");
}
private static JsonObject getThing2() {
return JsonFactory.newObject("""
{
"thingId":"solar.system:pluto",
"_namespace":"solar.system",
"a": [ false, {"b": "ABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZ", "x": 5} ],
"d": {
"e": {
"h": "lorem ipsum dolor sit amet"
},
"j": true,
"k": 6.0,
"l": 5,
"m": "MESSAGE"
}
}""");
}
private static JsonObject getThing3() {
return JsonFactory.newObject("""
{
"thingId":"solar.system:pluto",
"_namespace":"solar.system",
"a": [ {"b": "ABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZ", "y": 6}, true ],
"d": {
"j": true,
"k": 6.0,
"l": 123456789012,
"e": {
"f": "g",
"h": "lorem ipsum dolor sit amet"
}
}
}""");
}
private static JsonObject getThing4() {
return JsonFactory.newObject("""
{
"thingId":"solar.system:pluto",
"_namespace":"solar.system",
"a": [ {"b": "ABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZ", "x": 5}, true ],
"d": {
"e": {
"f": "g",
"h": "lorem ipsum dolor sit amet"
},
"j": true,
"k": 6.0,
"l": 123456789012,
"m": {},
"n": {"o":{}}
}
}""");
}
private static JsonObject getThing5() {
return JsonFactory.newObject("""
{
"thingId":"solar.system:pluto",
"_namespace":"solar.system",
"a": [ {"b": "ABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZ", "x": 5}, true ],
"d": {
"e": {
"f": "g",
"h": "$lorem ipsum dolor sit amet."
},
"j": true,
"k": 6.0,
"l": 123456789012
}
}""");
}
}