-
Notifications
You must be signed in to change notification settings - Fork 219
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#288 implement MergeThingStrategy and ThingMergedStrategy
Signed-off-by: Dominik Guggemos <dominik.guggemos@bosch.io>
- Loading branch information
Showing
11 changed files
with
550 additions
and
54 deletions.
There are no files selected for viewing
162 changes: 162 additions & 0 deletions
162
...ipse/ditto/services/things/persistence/actors/strategies/commands/MergeThingStrategy.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| /* | ||
| * 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.services.things.persistence.actors.strategies.commands; | ||
|
|
||
| import java.time.Instant; | ||
| import java.util.Optional; | ||
|
|
||
| import javax.annotation.Nullable; | ||
| import javax.annotation.concurrent.Immutable; | ||
|
|
||
| import org.eclipse.ditto.json.JsonFactory; | ||
| import org.eclipse.ditto.json.JsonObject; | ||
| import org.eclipse.ditto.model.base.entity.metadata.Metadata; | ||
| import org.eclipse.ditto.model.base.headers.DittoHeaders; | ||
| import org.eclipse.ditto.model.base.headers.WithDittoHeaders; | ||
| import org.eclipse.ditto.model.base.headers.entitytag.EntityTag; | ||
| import org.eclipse.ditto.model.base.json.JsonSchemaVersion; | ||
| import org.eclipse.ditto.model.things.Thing; | ||
| import org.eclipse.ditto.model.things.ThingBuilder; | ||
| import org.eclipse.ditto.model.things.ThingId; | ||
| import org.eclipse.ditto.model.things.ThingsModelFactory; | ||
| import org.eclipse.ditto.services.utils.persistentactors.results.Result; | ||
| import org.eclipse.ditto.services.utils.persistentactors.results.ResultFactory; | ||
| import org.eclipse.ditto.signals.commands.things.ThingCommandSizeValidator; | ||
| import org.eclipse.ditto.signals.commands.things.modify.MergeThing; | ||
| import org.eclipse.ditto.signals.commands.things.modify.MergeThingResponse; | ||
| import org.eclipse.ditto.signals.events.things.ThingEvent; | ||
| import org.eclipse.ditto.signals.events.things.ThingMerged; | ||
|
|
||
| /** | ||
| * This strategy handles the {@link org.eclipse.ditto.signals.commands.things.modify.MergeThing} command for an already | ||
| * existing Thing. | ||
| */ | ||
| @Immutable | ||
| final class MergeThingStrategy extends AbstractThingCommandStrategy<MergeThing> { | ||
|
|
||
| MergeThingStrategy() { | ||
| super(MergeThing.class); | ||
| } | ||
|
|
||
| @Override | ||
| protected Result<ThingEvent> doApply(final Context<ThingId> context, @Nullable final Thing thing, | ||
| final long nextRevision, | ||
| final MergeThing command, @Nullable final Metadata metadata) { | ||
|
|
||
| final Thing nonNullThing = getEntityOrThrow(thing); | ||
|
|
||
| final JsonObject thingJsonObject = nonNullThing.toJson(); | ||
| ThingCommandSizeValidator.getInstance().ensureValidSize( | ||
| thingJsonObject::getUpperBoundForStringSize, | ||
| () -> thingJsonObject.toString().length(), | ||
| command::getDittoHeaders); | ||
|
|
||
| final Instant eventTs = getEventTimestamp(); | ||
|
|
||
| // merge is not supported for V1 | ||
| if (JsonSchemaVersion.V_1.equals(command.getImplementedSchemaVersion())) { | ||
| // TODO exception | ||
| throw new UnsupportedOperationException("V1 not supported"); | ||
| } | ||
|
|
||
| // from V2 upwards, use this logic: | ||
| return handleMergeExistingWithV2Command(context, nonNullThing, eventTs, nextRevision, command, metadata); | ||
| } | ||
|
|
||
| private Result<ThingEvent> handleMergeExistingWithV2Command(final Context<ThingId> context, final Thing thing, | ||
| final Instant eventTs, final long nextRevision, final MergeThing command, | ||
| @Nullable final Metadata metadata) { | ||
|
|
||
| if (JsonSchemaVersion.V_1.equals(thing.getImplementedSchemaVersion())) { | ||
| // TODO exception | ||
| throw new UnsupportedOperationException("V1 not supported"); | ||
| } else { | ||
| return handleMergeExistingV2WithV2Command(context, thing, eventTs, nextRevision, command, metadata); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Handles a {@link MergeThing} command that was sent via API v2 and targets a Thing with API version V2. | ||
| */ | ||
| private Result<ThingEvent> handleMergeExistingV2WithV2Command(final Context<ThingId> context, | ||
| final Thing thing, final Instant eventTs, final long nextRevision, | ||
| final MergeThing command, @Nullable final Metadata metadata) { | ||
| return applyMergeCommand(context, thing, eventTs, nextRevision, command, metadata); | ||
| } | ||
|
|
||
| private Result<ThingEvent> applyMergeCommand(final Context<ThingId> context, final Thing thing, | ||
| final Instant eventTs, final long nextRevision, final MergeThing command, | ||
| @Nullable final Metadata metadata) { | ||
|
|
||
| // make sure that the ThingMerged-Event contains all data contained in the resulting existingThing (this is | ||
| // required e.g. for updating the search-index) | ||
| final DittoHeaders dittoHeaders = command.getDittoHeaders(); | ||
|
|
||
| final Thing mergedThing = mergeThing(command, thing, eventTs, nextRevision); | ||
|
|
||
| final ThingEvent<?> event = | ||
| ThingMerged.of(command.getThingEntityId(), command.getPath(), command.getValue(), | ||
| nextRevision, eventTs, | ||
| dittoHeaders, metadata); | ||
| final MergeThingResponse mergeThingResponse = | ||
| MergeThingResponse.of(command.getThingEntityId(), command.getPath(), command.getValue(), | ||
| dittoHeaders); | ||
| final WithDittoHeaders<?> response = appendETagHeaderIfProvided(command, mergeThingResponse, mergedThing); | ||
| return ResultFactory.newMutationResult(command, event, response); | ||
| } | ||
|
|
||
| private Thing mergeThing(final MergeThing command, final Thing thing, final Instant eventTs, | ||
| final long nextRevision) { | ||
|
|
||
| final ThingBuilder.FromCopy thingWithModifications = thing.toBuilder() | ||
| .setModified(eventTs) | ||
| .setRevision(nextRevision); | ||
|
|
||
| final JsonObject jsonObject = thing.toJson(); | ||
|
|
||
| // TODO move this to model? | ||
| final JsonObject mergePatch; | ||
| if (command.getPath().isEmpty()) { | ||
| if (command.getValue().isObject()) { | ||
| mergePatch = command.getValue().asObject(); | ||
| } else { | ||
| // TODO exception | ||
| throw new IllegalArgumentException("Patch must be a JsonObject if path is empty."); | ||
| } | ||
| } else { | ||
| mergePatch = JsonObject.newBuilder().set(command.getPath(), command.getValue()).build(); | ||
| } | ||
|
|
||
| final JsonObject mergedJson = JsonFactory.newObjectWithoutNullValues(jsonObject, mergePatch); | ||
|
|
||
| final Thing mergedThing = ThingsModelFactory.newThing(mergedJson); | ||
|
|
||
| mergedThing.getPolicyEntityId().ifPresent(thingWithModifications::setPolicyId); | ||
| mergedThing.getDefinition().ifPresent(thingWithModifications::setDefinition); | ||
| mergedThing.getAttributes().ifPresent(thingWithModifications::setAttributes); | ||
| mergedThing.getFeatures().ifPresent(thingWithModifications::setFeatures); | ||
|
|
||
| return thingWithModifications.build(); | ||
| } | ||
|
|
||
| @Override | ||
| public Optional<EntityTag> previousEntityTag(final MergeThing command, @Nullable final Thing previousEntity) { | ||
| return Optional.ofNullable(previousEntity).flatMap(EntityTag::fromEntity); | ||
| } | ||
|
|
||
| @Override | ||
| public Optional<EntityTag> nextEntityTag(final MergeThing thingCommand, @Nullable final Thing newEntity) { | ||
| return Optional.of(getEntityOrThrow(newEntity)).flatMap(EntityTag::fromEntity); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
75 changes: 75 additions & 0 deletions
75
...lipse/ditto/services/things/persistence/actors/strategies/events/ThingMergedStrategy.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| /* | ||
| * Copyright (c) 2017 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.services.things.persistence.actors.strategies.events; | ||
|
|
||
| import javax.annotation.Nullable; | ||
| import javax.annotation.concurrent.Immutable; | ||
|
|
||
| import org.eclipse.ditto.json.JsonFactory; | ||
| import org.eclipse.ditto.json.JsonObject; | ||
| import org.eclipse.ditto.json.JsonValue; | ||
| import org.eclipse.ditto.model.things.Thing; | ||
| import org.eclipse.ditto.model.things.ThingBuilder; | ||
| import org.eclipse.ditto.model.things.ThingLifecycle; | ||
| import org.eclipse.ditto.model.things.ThingsModelFactory; | ||
| import org.eclipse.ditto.signals.events.things.ThingMerged; | ||
|
|
||
| /** | ||
| * This strategy handles the {@link org.eclipse.ditto.signals.events.things.ThingMerged} event. | ||
| */ | ||
| @Immutable | ||
| final class ThingMergedStrategy extends AbstractThingEventStrategy<ThingMerged> { | ||
|
|
||
| protected ThingMergedStrategy() { | ||
| super(); | ||
| } | ||
|
|
||
| @Nullable | ||
| @Override | ||
| public Thing handle(final ThingMerged event, @Nullable final Thing thing, final long revision) { | ||
| if (null != thing) { | ||
| final ThingBuilder.FromCopy thingBuilder = thing.toBuilder() | ||
| .setRevision(revision) | ||
| .setModified(event.getTimestamp().orElse(null)) | ||
| .setLifecycle(ThingLifecycle.ACTIVE) | ||
| .setMetadata(mergeMetadata(thing, event)); | ||
|
|
||
| final JsonObject existingJson = thing.toJson(); | ||
|
|
||
| // TODO move this to model? | ||
| final JsonObject mergePatch; | ||
| if (event.getResourcePath().isEmpty()) { | ||
| if (event.getValue().isObject()) { | ||
| mergePatch = event.getValue().asObject(); | ||
| } else { | ||
| // TODO exception | ||
| throw new IllegalArgumentException("Patch must be a JsonObject if path is empty."); | ||
| } | ||
| } else { | ||
| mergePatch = JsonObject.newBuilder().set(event.getResourcePath(), event.getValue()).build(); | ||
| } | ||
|
|
||
| final JsonValue mergedJson = JsonFactory.newObjectWithoutNullValues(existingJson, mergePatch); | ||
| final Thing mergedThing = ThingsModelFactory.newThing(mergedJson.asObject()); | ||
|
|
||
| mergedThing.getPolicyEntityId().ifPresent(thingBuilder::setPolicyId); | ||
| mergedThing.getAttributes().ifPresent(thingBuilder::setAttributes); | ||
| mergedThing.getDefinition().ifPresent(thingBuilder::setDefinition); | ||
| mergedThing.getFeatures().ifPresent(thingBuilder::setFeatures); | ||
|
|
||
| return thingBuilder.build(); | ||
| } else { | ||
| return null; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.