-
Notifications
You must be signed in to change notification settings - Fork 215
/
ThingWriteModel.java
267 lines (239 loc) · 11.9 KB
/
ThingWriteModel.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
/*
* Copyright (c) 2019 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.model;
import static org.eclipse.ditto.thingsearch.service.persistence.PersistenceConstants.FIELD_F_ARRAY;
import static org.eclipse.ditto.thingsearch.service.persistence.PersistenceConstants.FIELD_GLOBAL_READ;
import static org.eclipse.ditto.thingsearch.service.persistence.PersistenceConstants.FIELD_ID;
import static org.eclipse.ditto.thingsearch.service.persistence.PersistenceConstants.FIELD_NAMESPACE;
import static org.eclipse.ditto.thingsearch.service.persistence.PersistenceConstants.FIELD_POLICY;
import static org.eclipse.ditto.thingsearch.service.persistence.PersistenceConstants.FIELD_POLICY_ID;
import static org.eclipse.ditto.thingsearch.service.persistence.PersistenceConstants.FIELD_POLICY_REVISION;
import static org.eclipse.ditto.thingsearch.service.persistence.PersistenceConstants.FIELD_REVISION;
import static org.eclipse.ditto.thingsearch.service.persistence.PersistenceConstants.FIELD_THING;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import org.bson.BsonArray;
import org.bson.BsonDocument;
import org.bson.BsonInt64;
import org.bson.BsonInvalidOperationException;
import org.bson.BsonString;
import org.bson.conversions.Bson;
import org.eclipse.ditto.internal.utils.akka.logging.DittoLoggerFactory;
import org.eclipse.ditto.internal.utils.akka.logging.ThreadSafeDittoLogger;
import org.eclipse.ditto.internal.utils.metrics.DittoMetrics;
import org.eclipse.ditto.internal.utils.metrics.instruments.counter.Counter;
import org.eclipse.ditto.thingsearch.service.persistence.PersistenceConstants;
import org.eclipse.ditto.thingsearch.service.persistence.write.mapping.BsonDiff;
import org.eclipse.ditto.thingsearch.service.updater.actors.MongoWriteModel;
import org.eclipse.ditto.thingsearch.service.updater.actors.ThingUpdater;
import org.mongodb.scala.bson.BsonNumber;
import com.mongodb.client.model.Filters;
import com.mongodb.client.model.ReplaceOneModel;
import com.mongodb.client.model.ReplaceOptions;
import com.mongodb.client.model.UpdateOneModel;
import com.mongodb.client.model.WriteModel;
/**
* Write model for an entire Thing.
*/
@NotThreadSafe
public final class ThingWriteModel extends AbstractWriteModel {
private static final ThreadSafeDittoLogger LOGGER = DittoLoggerFactory.getThreadSafeLogger(ThingUpdater.class);
private static final Counter PATCH_UPDATE_COUNT = DittoMetrics.counter("wildcard_search_patch_updates");
private static final Counter PATCH_SKIP_COUNT = DittoMetrics.counter("wildcard_search_patch_skips");
private static final Counter FULL_UPDATE_COUNT = DittoMetrics.counter("wildcard_search_full_updates");
private final BsonDocument thingDocument;
private final boolean isPatchUpdate;
private final long previousRevision;
private ThingWriteModel(final Metadata metadata, final BsonDocument thingDocument, final boolean isPatchUpdate,
final long previousRevision) {
super(metadata);
this.thingDocument = thingDocument;
this.isPatchUpdate = isPatchUpdate;
this.previousRevision = previousRevision;
}
/**
* Create a Thing write model.
*
* @param metadata the metadata.
* @param thingDocument the document to write into the search index.
* @return a Thing write model.
*/
public static ThingWriteModel of(final Metadata metadata, final BsonDocument thingDocument) {
return new ThingWriteModel(metadata, thingDocument, false, 0L);
}
/**
* Create a Thing write model which only preserves "toplevel" fields:
* <ul>
* <li>{@link org.eclipse.ditto.thingsearch.service.persistence.PersistenceConstants#FIELD_ID}</li>
* <li>{@link org.eclipse.ditto.thingsearch.service.persistence.PersistenceConstants#FIELD_NAMESPACE}</li>
* <li>{@link org.eclipse.ditto.thingsearch.service.persistence.PersistenceConstants#FIELD_REVISION}</li>
* <li>{@link org.eclipse.ditto.thingsearch.service.persistence.PersistenceConstants#FIELD_POLICY_ID}</li>
* <li>{@link org.eclipse.ditto.thingsearch.service.persistence.PersistenceConstants#FIELD_POLICY_REVISION}</li>
* </ul>
* and "emtpies" all other fields, e.g. containing the thing payload.
*
* @param metadata the metadata.
* @return a Thing write model.
*/
public static ThingWriteModel ofEmptiedOut(final Metadata metadata) {
final BsonDocument emptiedOutThingDocument = new BsonDocument()
.append(FIELD_ID, new BsonString(metadata.getThingId().toString()))
.append(FIELD_NAMESPACE, new BsonString(metadata.getThingId().getNamespace()))
.append(FIELD_GLOBAL_READ, new BsonArray())
.append(FIELD_REVISION, new BsonInt64(metadata.getThingRevision()))
.append(FIELD_POLICY_ID, new BsonString(metadata.getPolicyIdInPersistence()))
.append(FIELD_POLICY_REVISION, new BsonInt64(metadata.getPolicyRevision().orElse(0L)))
.append(FIELD_THING, new BsonDocument())
.append(FIELD_POLICY, new BsonDocument())
.append(FIELD_F_ARRAY, new BsonArray());
return new ThingWriteModel(metadata, emptiedOutThingDocument, false, 0L);
}
@Override
public Optional<MongoWriteModel> toIncrementalMongo(@Nullable final AbstractWriteModel previousWriteModel,
final int maxWireVersion) {
if (previousWriteModel instanceof ThingWriteModel thingWriteModel) {
return computeDiff(thingWriteModel, maxWireVersion);
} else {
return super.toIncrementalMongo(previousWriteModel, maxWireVersion);
}
}
/**
* Return a copy of this object as patch update.
*
* @param previousRevision The expected previous revision. The patch will not be applied if the previous revision
* differ.
* @return The patch update.
*/
public ThingWriteModel asPatchUpdate(final long previousRevision) {
return new ThingWriteModel(getMetadata(), thingDocument, true, previousRevision);
}
@Override
public WriteModel<BsonDocument> toMongo() {
return new ReplaceOneModel<>(getFilter(), thingDocument, upsertOption());
}
@Override
public ThingWriteModel setMetadata(final Metadata metadata) {
return new ThingWriteModel(metadata, thingDocument, isPatchUpdate, previousRevision);
}
/**
* @return the Thing document to be written in the persistence.
*/
public BsonDocument getThingDocument() {
return thingDocument;
}
@Override
public Bson getFilter() {
if (isPatchUpdate) {
return Filters.and(
super.getFilter(),
Filters.eq(PersistenceConstants.FIELD_REVISION, BsonNumber.apply(previousRevision))
);
} else {
return super.getFilter();
}
}
private ReplaceOptions upsertOption() {
return new ReplaceOptions().upsert(!isPatchUpdate);
}
@Override
public boolean equals(@Nullable final Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
if (!super.equals(o)) {
return false;
}
final ThingWriteModel that = (ThingWriteModel) o;
return thingDocument.equals(that.thingDocument) &&
isPatchUpdate == that.isPatchUpdate &&
previousRevision == that.previousRevision;
}
@Override
public int hashCode() {
return Objects.hash(super.hashCode(), thingDocument, isPatchUpdate, previousRevision);
}
@Override
public String toString() {
return super.toString() +
", thingDocument=" + thingDocument +
", isPatchUpdate=" + isPatchUpdate +
", previousRevision=" + previousRevision +
"]";
}
private Optional<MongoWriteModel> computeDiff(final ThingWriteModel lastWriteModel, final int maxWireVersion) {
final WriteModel<BsonDocument> mongoWriteModel;
final boolean isPatchUpdate;
if (isNextWriteModelOutDated(lastWriteModel, this)) {
// possible due to background sync
LOGGER.debug("Received out-of-date write model. this=<{}>, lastWriteModel=<{}>", this, lastWriteModel);
PATCH_SKIP_COUNT.increment();
return Optional.empty();
}
final var diff = tryComputeDiff(getThingDocument(), lastWriteModel.getThingDocument(), maxWireVersion);
if (diff.isPresent() && diff.get().isDiffSmaller()) {
final var aggregationPipeline = diff.get().consumeAndExport();
if (aggregationPipeline.isEmpty()) {
LOGGER.debug("Skipping update due to {} <{}>", "empty diff",
((AbstractWriteModel) this).getClass().getSimpleName());
LOGGER.trace("Skipping update due to {} <{}>", "empty diff", this);
PATCH_SKIP_COUNT.increment();
return Optional.empty();
}
final var filter = asPatchUpdate(lastWriteModel.getMetadata().getThingRevision()).getFilter();
mongoWriteModel = new UpdateOneModel<>(filter, aggregationPipeline);
LOGGER.debug("Using incremental update <{}>", mongoWriteModel.getClass().getSimpleName());
LOGGER.trace("Using incremental update <{}>", mongoWriteModel);
PATCH_UPDATE_COUNT.increment();
isPatchUpdate = true;
} else {
mongoWriteModel = this.toMongo();
LOGGER.debug("Using replacement because diff is bigger or nonexistent: <{}>",
mongoWriteModel.getClass().getSimpleName());
if (LOGGER.isTraceEnabled()) {
LOGGER.trace("Using replacement because diff is bigger or nonexistent. Diff=<{}>",
diff.map(BsonDiff::consumeAndExport));
}
FULL_UPDATE_COUNT.increment();
isPatchUpdate = false;
}
return Optional.of(MongoWriteModel.of(this, mongoWriteModel, isPatchUpdate));
}
private Optional<BsonDiff> tryComputeDiff(final BsonDocument minuend, final BsonDocument subtrahend,
final int maxWireVersion) {
try {
return Optional.of(BsonDiff.minusThingDocs(minuend, subtrahend, maxWireVersion));
} catch (final BsonInvalidOperationException e) {
LOGGER.error("Failed to compute BSON diff between <{}> and <{}>", minuend, subtrahend, e);
return Optional.empty();
}
}
private static boolean isNextWriteModelOutDated(final AbstractWriteModel lastWriteModel,
final AbstractWriteModel nextWriteModel) {
final var lastMetadata = lastWriteModel.getMetadata();
final var nextMetadata = nextWriteModel.getMetadata();
final boolean isStrictlyOlder = nextMetadata.getThingRevision() < lastMetadata.getThingRevision() ||
nextMetadata.getThingRevision() == lastMetadata.getThingRevision() &&
nextMetadata.getPolicyRevision().flatMap(nextPolicyRevision ->
lastMetadata.getPolicyRevision().map(lastPolicyRevision ->
nextPolicyRevision < lastPolicyRevision))
.orElse(false);
final boolean hasSameRevisions = nextMetadata.getThingRevision() == lastMetadata.getThingRevision() &&
nextMetadata.getPolicyRevision().equals(lastMetadata.getPolicyRevision());
return isStrictlyOlder || hasSameRevisions;
}
}