eclipse-ditto#1843 add Migrated Command, enhance ThingMigrated Event

Author: hu-ahmed

base/model/src/main/java/org/eclipse/ditto/base/model/signals/commands/Command.java

@@ -150,6 +150,11 @@ enum Category {
          */
         MERGE,
 
+        /**
+         * Category of commands that change the state of entities.
+         */
+        MIGRATE,
+
         /**
          * Category of commands that delete entities.
          */

protocol/src/main/java/org/eclipse/ditto/protocol/mapper/ThingMigratedEventSignalMapper.java

@@ -29,7 +29,7 @@ final class ThingMigratedEventSignalMapper extends AbstractSignalMapper<ThingMig
     void enhancePayloadBuilder(final ThingMigrated signal, final PayloadBuilder payloadBuilder) {
         payloadBuilder.withRevision(signal.getRevision())
                 .withTimestamp(signal.getTimestamp().orElse(null))
-                .withValue(signal.getValue());
+                .withValue(signal.getThing().toJson());
     }
 
     @Override

protocol/src/main/java/org/eclipse/ditto/protocol/mappingstrategies/ThingMigratedEventMappingStrategies.java

@@ -18,7 +18,6 @@
 import javax.annotation.Nullable;
 
 import org.eclipse.ditto.json.JsonMissingFieldException;
-import org.eclipse.ditto.json.JsonPointer;
 import org.eclipse.ditto.base.model.entity.metadata.Metadata;
 import org.eclipse.ditto.protocol.Adaptable;
 import org.eclipse.ditto.protocol.JsonifiableMapper;
@@ -47,9 +46,7 @@ public JsonifiableMapper<ThingMigrated> find(final String type) {
 
     private static ThingMigrated thingMigrated(final Adaptable adaptable) {
         return ThingMigrated.of(
-                thingIdFrom(adaptable),
-                JsonPointer.of(adaptable.getPayload().getPath().toString()),
-                adaptable.getPayload().getValue().orElse(null),
+                thingFrom(adaptable),
                 revisionFrom(adaptable),
                 timestampFrom(adaptable),
                 dittoHeadersFrom(adaptable),

things/model/src/main/java/org/eclipse/ditto/things/model/signals/commands/modify/MigrateThingDefinition.java

@@ -73,7 +73,7 @@ private MigrateThingDefinition(final ThingId thingId,
             final Map<ResourceKey, String> patchConditions,
             final boolean initializeMissingPropertiesFromDefaults,
             final DittoHeaders dittoHeaders) {
-        super(TYPE, FeatureToggle.checkMergeFeatureEnabled(TYPE, dittoHeaders));
+        super(TYPE, dittoHeaders);
         this.thingId = checkNotNull(thingId, "thingId");
         this.thingDefinitionUrl = checkNotNull(thingDefinitionUrl, "thingDefinitionUrl");
         this.migrationPayload = checkJsonSize(checkNotNull(migrationPayload, "migrationPayload"), dittoHeaders);
@@ -185,7 +185,7 @@ public boolean changesAuthorization() {
 
     @Override
     public Category getCategory() {
-        return Category.MODIFY;
+        return Category.MIGRATE;
     }
 
     @Override

things/model/src/main/java/org/eclipse/ditto/things/model/signals/events/ThingEventToThingConverter.java

@@ -122,16 +122,7 @@ private static Map<Class<?>, BiFunction<ThingEvent<?>, ThingBuilder.FromScratch,
                 }
         );
         mappers.put(ThingMigrated.class,
-                (te, tb) -> {
-                    final ThingMigrated thingMigrated = (ThingMigrated) te;
-                    final JsonPointer resourcePath = thingMigrated.getResourcePath();
-                    final JsonValue nonNullValue = filterNullValuesInJsonValue(thingMigrated.getValue());
-                    final JsonObject mergedFields = JsonFactory.newObject(resourcePath, nonNullValue);
-                    final JsonObject thingWithoutMergedFields = tb.build().toJson(FieldType.all());
-                    final JsonValue mergedJson = JsonFactory.mergeJsonValues(thingWithoutMergedFields, mergedFields);
-                    return ThingsModelFactory.newThing(mergedJson.asObject());
-                }
-        );
+                (te, tb) -> ((ThingMigrated) te).getThing().toBuilder().setRevision(te.getRevision()).build());
         mappers.put(ThingDeleted.class,
                 (te, tb) -> tb.build());
 

things/model/src/main/java/org/eclipse/ditto/things/model/signals/events/ThingMigrated.java

@@ -12,7 +12,6 @@
  */
 package org.eclipse.ditto.things.model.signals.events;
 
-import static org.eclipse.ditto.base.model.common.ConditionChecker.checkNotNull;
 
 import java.time.Instant;
 import java.util.Objects;
@@ -27,7 +26,6 @@
 import org.eclipse.ditto.base.model.json.FieldType;
 import org.eclipse.ditto.base.model.json.JsonParsableEvent;
 import org.eclipse.ditto.base.model.json.JsonSchemaVersion;
-import org.eclipse.ditto.base.model.signals.FeatureToggle;
 import org.eclipse.ditto.base.model.signals.UnsupportedSchemaVersionException;
 import org.eclipse.ditto.base.model.signals.commands.Command;
 import org.eclipse.ditto.base.model.signals.events.EventJsonDeserializer;
@@ -38,7 +36,8 @@
 import org.eclipse.ditto.json.JsonObjectBuilder;
 import org.eclipse.ditto.json.JsonPointer;
 import org.eclipse.ditto.json.JsonValue;
-import org.eclipse.ditto.things.model.ThingId;
+import org.eclipse.ditto.things.model.Thing;
+import org.eclipse.ditto.things.model.ThingsModelFactory;
 
 /**
  * This event is emitted after a {@link org.eclipse.ditto.things.model.Thing} was successfully migrated.
@@ -59,44 +58,34 @@ public final class ThingMigrated extends AbstractThingEvent<ThingMigrated> imple
      */
     public static final String TYPE = TYPE_PREFIX + NAME;
 
-    private final ThingId thingId;
-    private final JsonPointer path;
-    private final JsonValue value;
+    private final Thing thing;
 
-    private ThingMigrated(final ThingId thingId,
-            final JsonPointer path,
-            final JsonValue value,
-            final long revision,
-            @Nullable final Instant timestamp,
-            final DittoHeaders dittoHeaders,
-            @Nullable final Metadata metadata) {
-        super(TYPE, thingId, revision, timestamp, FeatureToggle.checkMergeFeatureEnabled(TYPE, dittoHeaders), metadata);
-        this.thingId = checkNotNull(thingId, "thingId");
-        this.path = checkNotNull(path, "path");
-        this.value = checkNotNull(value, "value");
+    private ThingMigrated(final Thing thing,
+                          final long revision,
+                          @Nullable final Instant timestamp,
+                          final DittoHeaders dittoHeaders,
+                          @Nullable final Metadata metadata) {
+        super(TYPE, thing.getEntityId().orElseThrow(() -> new NullPointerException("Thing has no ID!")), revision, timestamp, dittoHeaders, metadata);
+        this.thing = thing;
         checkSchemaVersion();
     }
 
     /**
      * Creates an event of a migrated thing.
      *
-     * @param thingId          The thing ID.
-     * @param path             The path where the changes were applied.
-     * @param value            The value describing the changes that were migrated.
+     * @param thing the created {@link org.eclipse.ditto.things.model.Thing}.
      * @param revision         The revision number of the thing.
      * @param timestamp        The event timestamp.
      * @param dittoHeaders     The Ditto headers.
      * @param metadata         The metadata associated with the event.
      * @return The created {@code ThingMigrated} event.
      */
-    public static ThingMigrated of(final ThingId thingId,
-            final JsonPointer path,
-            final JsonValue value,
+    public static ThingMigrated of(final Thing thing,
             final long revision,
             @Nullable final Instant timestamp,
             final DittoHeaders dittoHeaders,
             @Nullable final Metadata metadata) {
-        return new ThingMigrated(thingId, path, value, revision, timestamp, dittoHeaders, metadata);
+        return new ThingMigrated(thing, revision, timestamp, dittoHeaders, metadata);
     }
 
     /**
@@ -109,25 +98,23 @@ public static ThingMigrated of(final ThingId thingId,
     public static ThingMigrated fromJson(final JsonObject jsonObject, final DittoHeaders dittoHeaders) {
         return new EventJsonDeserializer<ThingMigrated>(TYPE, jsonObject).deserialize(
                 (revision, timestamp, metadata) -> {
-                    final ThingId thingId = ThingId.of(jsonObject.getValueOrThrow(ThingEvent.JsonFields.THING_ID));
-                    final JsonPointer path = JsonPointer.of(jsonObject.getValueOrThrow(JsonFields.JSON_PATH));
-                    final JsonValue value = jsonObject.getValueOrThrow(JsonFields.JSON_VALUE);
+                    final JsonObject thingJsonObject = jsonObject.getValueOrThrow(ThingEvent.JsonFields.THING);
+                    final Thing extractedThing = ThingsModelFactory.newThing(thingJsonObject);
 
-                    return of(thingId, path, value, revision, timestamp, dittoHeaders, metadata);
+                    return of(extractedThing, revision, timestamp, dittoHeaders, metadata);
                 });
     }
 
     @Override
     protected void appendPayload(final JsonObjectBuilder jsonObjectBuilder,
-            final JsonSchemaVersion schemaVersion, final Predicate<JsonField> predicate) {
-        jsonObjectBuilder.set(ThingEvent.JsonFields.THING_ID, thingId.toString(), predicate);
-        jsonObjectBuilder.set(JsonFields.JSON_PATH, path.toString(), predicate);
-        jsonObjectBuilder.set(JsonFields.JSON_VALUE, value, predicate);
+            final JsonSchemaVersion schemaVersion, final Predicate<JsonField> thePredicate) {
+        final Predicate<JsonField> predicate = schemaVersion.and(thePredicate);
+        jsonObjectBuilder.set(ThingEvent.JsonFields.THING, thing.toJson(schemaVersion, thePredicate), predicate);
     }
 
     @Override
     public ThingMigrated setDittoHeaders(final DittoHeaders dittoHeaders) {
-        return of(thingId, path, value, getRevision(), getTimestamp().orElse(null), dittoHeaders,
+        return of(thing, getRevision(), getTimestamp().orElse(null), dittoHeaders,
                 getMetadata().orElse(null));
     }
 
@@ -138,28 +125,26 @@ public Command.Category getCommandCategory() {
 
     @Override
     public ThingMigrated setRevision(final long revision) {
-        return of(thingId, path, value, revision, getTimestamp().orElse(null), getDittoHeaders(),
+        return of(thing, revision, getTimestamp().orElse(null), getDittoHeaders(),
                 getMetadata().orElse(null));
     }
 
-    @Override
-    public JsonPointer getResourcePath() {
-        return path;
-    }
-
-    public JsonValue getValue() {
-        return value;
+    /**
+     * @return the value describing the changes that were applied to the existing thing.
+     */
+    public Thing getThing() {
+        return thing;
     }
 
     @Override
-    public Optional<JsonValue> getEntity() {
-        return Optional.of(value);
+    public Optional<JsonValue> getEntity(final JsonSchemaVersion schemaVersion) {
+        return Optional.of(thing.toJson(schemaVersion, FieldType.notHidden()));
     }
 
     @Override
     public ThingMigrated setEntity(final JsonValue entity) {
-        return of(thingId, path, entity, getRevision(), getTimestamp().orElse(null), getDittoHeaders(),
-                getMetadata().orElse(null));
+        return of(ThingsModelFactory.newThing(entity.asObject()), getRevision(), getTimestamp().orElse(null),
+                getDittoHeaders(), getMetadata().orElse(null));
     }
 
     @Override
@@ -186,23 +171,25 @@ public boolean equals(final Object o) {
             return false;
         }
         final ThingMigrated that = (ThingMigrated) o;
-        return that.canEqual(this) && thingId.equals(that.thingId) &&
-                path.equals(that.path) &&
-                value.equals(that.value);
+        return that.canEqual(this) && thing.equals(that.thing);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(super.hashCode(), thingId, path, value);
+        return Objects.hash(super.hashCode(), thing);
     }
     @Override
     public String toString() {
         return getClass().getSimpleName() + " [" + super.toString() +
-                ", path=" + path +
-                ", value=" + value +
+                ", thing=" + thing +
                 "]";
     }
 
+    @Override
+    public JsonPointer getResourcePath() {
+        return JsonPointer.empty();
+    }
+
     /**
      * An enumeration of the JSON fields of a {@code ThingMigrated} event.
      */
@@ -212,9 +199,6 @@ private JsonFields() {
             throw new AssertionError();
         }
 
-        public static final JsonFieldDefinition<String> JSON_PATH =
-                JsonFactory.newStringFieldDefinition("path", FieldType.REGULAR, JsonSchemaVersion.V_2);
-
         public static final JsonFieldDefinition<JsonValue> JSON_VALUE =
                 JsonFactory.newJsonValueFieldDefinition("value", FieldType.REGULAR, JsonSchemaVersion.V_2);
     }

things/model/src/test/java/org/eclipse/ditto/things/model/signals/events/ThingMigratedTest.java

@@ -21,6 +21,7 @@
 import org.eclipse.ditto.base.model.signals.events.EventsourcedEvent;
 import org.eclipse.ditto.json.JsonFactory;
 import org.eclipse.ditto.json.JsonObject;
+import org.eclipse.ditto.json.JsonPointer;
 import org.junit.Test;
 
 import nl.jqno.equalsverifier.EqualsVerifier;
@@ -36,8 +37,7 @@ public final class ThingMigratedTest {
             .set(Event.JsonFields.METADATA, TestConstants.METADATA.toJson())
             .set(EventsourcedEvent.JsonFields.REVISION, TestConstants.Thing.REVISION_NUMBER)
             .set(ThingEvent.JsonFields.THING_ID, TestConstants.Thing.THING_ID.toString())
-            .set(ThingMigrated.JsonFields.JSON_PATH, TestConstants.Thing.ABSOLUTE_LOCATION_ATTRIBUTE_POINTER.toString())
-            .set(ThingMigrated.JsonFields.JSON_VALUE, TestConstants.Thing.LOCATION_ATTRIBUTE_VALUE)
+            .set(ThingEvent.JsonFields.THING, TestConstants.Thing.THING.toJson())
             .build();
 
     /**
@@ -60,14 +60,12 @@ public void testHashCodeAndEquals() {
     @Test
     public void toJsonReturnsExpected() {
         final ThingMigrated underTest =
-                ThingMigrated.of(TestConstants.Thing.THING_ID,
-                        TestConstants.Thing.ABSOLUTE_LOCATION_ATTRIBUTE_POINTER,
-                        TestConstants.Thing.LOCATION_ATTRIBUTE_VALUE,
+                ThingMigrated.of(TestConstants.Thing.THING,
                         TestConstants.Thing.REVISION_NUMBER,
                         TestConstants.TIMESTAMP,
                         TestConstants.EMPTY_DITTO_HEADERS,
                         TestConstants.METADATA);
-        final JsonObject actualJson = underTest.toJson(FieldType.regularOrSpecial());
+        final JsonObject actualJson = underTest.toJson(FieldType.notHidden());
 
         assertThat(actualJson).isEqualTo(KNOWN_JSON);
     }
@@ -82,8 +80,7 @@ public void createInstanceFromValidJson() {
 
         assertThat(underTest).isNotNull();
         assertThat((Object) underTest.getEntityId()).isEqualTo(TestConstants.Thing.THING_ID);
-        assertThat(underTest.getResourcePath()).isEqualTo(TestConstants.Thing.ABSOLUTE_LOCATION_ATTRIBUTE_POINTER);
-        assertThat(underTest.getValue()).isEqualTo(TestConstants.Thing.LOCATION_ATTRIBUTE_VALUE);
+        assertThat(underTest.getResourcePath()).isEqualTo(JsonPointer.empty());
         assertThat(underTest.getMetadata()).contains(TestConstants.METADATA);
         assertThat(underTest.getRevision()).isEqualTo(TestConstants.Thing.REVISION_NUMBER);
         assertThat(underTest.getTimestamp()).contains(TestConstants.TIMESTAMP);

things/service/src/main/java/org/eclipse/ditto/things/service/persistence/actors/strategies/commands/MigrateThingDefinitionStrategy.java

@@ -117,7 +117,6 @@ private Result<ThingEvent<?>> handleMigrateDefinition(
 
         final DittoHeaders dittoHeaders = command.getDittoHeaders();
         final boolean isDryRun = dittoHeaders.isDryRun();
-        final JsonPointer path = JsonPointer.empty();
 
         // 1. Evaluate Patch Conditions and modify the migrationPayload
         final JsonObject adjustedMigrationPayload = evaluatePatchConditions(
@@ -153,7 +152,7 @@ private Result<ThingEvent<?>> handleMigrateDefinition(
 
         // 4. Apply migration and generate event
         final CompletionStage<ThingEvent<?>> eventStage = validatedStage.thenApply(pair -> ThingMigrated.of(
-                pair.second().getEntityId(), path, pair.first().toJson(), nextRevision, eventTs, dittoHeaders,
+                pair.first(), nextRevision, eventTs, dittoHeaders,
                 metadata));
 
         final CompletionStage<WithDittoHeaders> responseStage = validatedStage.thenApply(pair ->
@@ -337,6 +336,7 @@ private Thing applyMigrationPayload(final Context<ThingId> context, final Thing
                 () -> dittoHeaders);
 
         return ThingsModelFactory.newThingBuilder(mergedJson)
+                .setId(context.getState())
                 .setModified(eventTs)
                 .setRevision(nextRevision)
                 .build();

things/service/src/main/java/org/eclipse/ditto/things/service/persistence/actors/strategies/events/ThingMigratedStrategy.java

@@ -38,7 +38,7 @@ final class ThingMigratedStrategy extends AbstractThingEventStrategy<ThingMigrat
     public Thing handle(final ThingMigrated event, @Nullable final Thing thing, final long revision) {
         if (null != thing) {
             final JsonObject jsonObject = thing.toJson(FieldType.all());
-            final JsonObject mergePatch = JsonFactory.newObject(event.getResourcePath(), event.getValue());
+            final JsonObject mergePatch = event.getThing().toJson();
             final JsonObject mergedJson = JsonFactory.mergeJsonValues(mergePatch, jsonObject).asObject();
             return ThingsModelFactory.newThingBuilder(mergedJson)
                     .setRevision(revision)