removed "version" from DittoHeaderDefinition - too generic name for something Ditto does no longer need (only one supported version)

Author: thjaeckle

base/model/src/main/java/org/eclipse/ditto/base/model/headers/AbstractDittoHeaders.java

@@ -181,9 +181,7 @@ public Optional<ContentType> getDittoContentType() {
 
     @Override
     public Optional<JsonSchemaVersion> getSchemaVersion() {
-        return getStringForDefinition(DittoHeaderDefinition.SCHEMA_VERSION)
-                .map(Integer::valueOf)
-                .flatMap(JsonSchemaVersion::forInt);
+        return Optional.of(JsonSchemaVersion.V_2);
     }
 
     @Override

base/model/src/main/java/org/eclipse/ditto/base/model/headers/AbstractDittoHeadersBuilder.java

@@ -245,11 +245,7 @@ protected void putCharSequence(final HeaderDefinition definition, @Nullable fina
 
     @Override
     public S schemaVersion(@Nullable final JsonSchemaVersion schemaVersion) {
-        if (null != schemaVersion) {
-            putCharSequence(DittoHeaderDefinition.SCHEMA_VERSION, schemaVersion.toString());
-        } else {
-            removeHeader(DittoHeaderDefinition.SCHEMA_VERSION.getKey());
-        }
+        // no-op
         return myself;
     }
 

base/model/src/main/java/org/eclipse/ditto/base/model/headers/DittoHeaderDefinition.java

@@ -52,14 +52,6 @@ public enum DittoHeaderDefinition implements HeaderDefinition {
      */
     CORRELATION_ID("correlation-id", String.class, true, true, HeaderValueValidators.getNonEmptyValidator()),
 
-    /**
-     * Header definition for schema version value.
-     * <p>
-     * Key: {@code "version"}, Java type: {@code int}.
-     * </p>
-     */
-    SCHEMA_VERSION("version", int.class, true, true, HeaderValueValidators.getIntValidator()),
-
     /**
      * Header definition for response required value.
      * <p>

base/model/src/test/java/org/eclipse/ditto/base/model/headers/BooleanValueValidatorTest.java

@@ -84,7 +84,7 @@ public void acceptFalseCharSequence() {
 
     @Test
     public void doesNotValidateAsDefinedJavaTypeIsNotBoolean() {
-        assertThatCode(() -> underTest.accept(DittoHeaderDefinition.SCHEMA_VERSION, BOOLEAN_CHAR_SEQUENCE))
+        assertThatCode(() -> underTest.accept(DittoHeaderDefinition.CHANNEL, BOOLEAN_CHAR_SEQUENCE))
                 .doesNotThrowAnyException();
     }
 

base/model/src/test/java/org/eclipse/ditto/base/model/headers/DefaultDittoHeadersBuilderTest.java

@@ -75,7 +75,6 @@ public void emptyReturnsEmptyDittoHeaders() {
 
         DittoBaseAssertions.assertThat(dittoHeaders)
                 .hasNoCorrelationId()
-                .hasNoSchemaVersion()
                 .hasNoAuthorizationSubjects()
                 .hasNoReadGrantedSubjects();
     }
@@ -94,15 +93,6 @@ public void tryToSetEmptyCorrelationId() {
         underTest.correlationId("");
     }
 
-    @Test
-    public void setNullSchemaVersionRemovesSchemaVersion() {
-        underTest.schemaVersion(JSON_SCHEMA_VERSION);
-        underTest.schemaVersion(null);
-        final DittoHeaders dittoHeaders = underTest.build();
-
-        assertThat(dittoHeaders.getSchemaVersion()).isEmpty();
-    }
-
     @Test
     public void buildReturnsExpected() {
         final DittoHeaders dittoHeaders = underTest.correlationId(CORRELATION_ID)
@@ -175,17 +165,6 @@ public void jsonRepresentationOfDittoHeadersWithCorrelationIdOnlyIsExpected() {
                 .contains(JsonFactory.newKey(DittoHeaderDefinition.CORRELATION_ID.getKey()), CORRELATION_ID);
     }
 
-    @Test
-    public void jsonRepresentationOfDittoHeadersWithSchemaVersionOnlyIsExpected() {
-        final DittoHeaders dittoHeaders = underTest.schemaVersion(JSON_SCHEMA_VERSION).build();
-        final JsonObject jsonObject = dittoHeaders.toJson();
-
-        assertThat(jsonObject)
-                .hasSize(1)
-                .contains(JsonFactory.newKey(DittoHeaderDefinition.SCHEMA_VERSION.getKey()),
-                        JsonFactory.newValue(JSON_SCHEMA_VERSION.toInt()));
-    }
-
     @Test
     public void jsonRepresentationOfDittoHeadersWithChannelOnlyIsExpected() {
         final DittoHeaders dittoHeaders = underTest.channel(CHANNEL).build();
@@ -260,7 +239,7 @@ public void tryToCreateInstanceWithMapContainingInvalidHeader() {
 
     @Test
     public void tryToCreateInstanceWithJsonObjectContainingInvalidHeader() {
-        final String schemaVersionKey = DittoHeaderDefinition.SCHEMA_VERSION.getKey();
+        final String schemaVersionKey = DittoHeaderDefinition.RESPONSE_REQUIRED.getKey();
         final String invalidSchemaVersionValue = "meh";
 
         final JsonObject headersJsonObject = JsonFactory.newObjectBuilder()
@@ -271,7 +250,7 @@ public void tryToCreateInstanceWithJsonObjectContainingInvalidHeader() {
 
         assertThatExceptionOfType(DittoHeaderInvalidException.class)
                 .isThrownBy(() -> of(headersJsonObject))
-                .withMessage("The value '%s' of the header '%s' is not a valid int.", invalidSchemaVersionValue,
+                .withMessage("The value '%s' of the header '%s' is not a valid boolean.", invalidSchemaVersionValue,
                         schemaVersionKey)
                 .withNoCause();
     }
@@ -304,7 +283,7 @@ public void removePreconditionHeaders() {
 
     @Test
     public void tryToPutMapWithInvalidMessageHeader() {
-        final String key = DittoHeaderDefinition.SCHEMA_VERSION.getKey();
+        final String key = DittoHeaderDefinition.RESPONSE_REQUIRED.getKey();
         final String invalidValue = "bar";
 
         final Map<String, String> invalidHeaders = new HashMap<>();
@@ -313,7 +292,7 @@ public void tryToPutMapWithInvalidMessageHeader() {
 
         assertThatExceptionOfType(DittoHeaderInvalidException.class)
                 .isThrownBy(() -> underTest.putHeaders(invalidHeaders))
-                .withMessage("The value '%s' of the header '%s' is not a valid int.", invalidValue, key)
+                .withMessage("The value '%s' of the header '%s' is not a valid boolean.", invalidValue, key)
                 .withNoCause();
     }
 

base/model/src/test/java/org/eclipse/ditto/base/model/headers/ImmutableDittoHeadersTest.java

@@ -494,7 +494,6 @@ public void toJsonReturnsExpected() {
         final JsonObject expectedHeadersJsonObject = JsonFactory.newObjectBuilder()
                 .set(DittoHeaderDefinition.AUTHORIZATION_CONTEXT.getKey(), AUTH_CONTEXT.toJson())
                 .set(DittoHeaderDefinition.CORRELATION_ID.getKey(), KNOWN_CORRELATION_ID)
-                .set(DittoHeaderDefinition.SCHEMA_VERSION.getKey(), KNOWN_SCHEMA_VERSION.toInt())
                 .set(DittoHeaderDefinition.CHANNEL.getKey(), KNOWN_CHANNEL)
                 .set(DittoHeaderDefinition.RESPONSE_REQUIRED.getKey(), KNOWN_RESPONSE_REQUIRED)
                 .set(DittoHeaderDefinition.DRY_RUN.getKey(), false)
@@ -730,7 +729,6 @@ private static Map<String, String> createMapContainingAllKnownHeaders() {
         final Map<String, String> result = new LinkedHashMap<>();
         result.put(DittoHeaderDefinition.AUTHORIZATION_CONTEXT.getKey(), AUTH_CONTEXT.toJsonString());
         result.put(DittoHeaderDefinition.CORRELATION_ID.getKey(), KNOWN_CORRELATION_ID);
-        result.put(DittoHeaderDefinition.SCHEMA_VERSION.getKey(), KNOWN_SCHEMA_VERSION.toString());
         result.put(DittoHeaderDefinition.CHANNEL.getKey(), KNOWN_CHANNEL);
         result.put(DittoHeaderDefinition.RESPONSE_REQUIRED.getKey(), String.valueOf(KNOWN_RESPONSE_REQUIRED));
         result.put(DittoHeaderDefinition.DRY_RUN.getKey(), String.valueOf(false));

base/model/src/test/java/org/eclipse/ditto/base/model/headers/IntValueValidatorTest.java

@@ -13,13 +13,11 @@
 package org.eclipse.ditto.base.model.headers;
 
 import static org.assertj.core.api.Assertions.assertThatCode;
-import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
 import static org.assertj.core.api.Assertions.assertThatNullPointerException;
 import static org.mutabilitydetector.unittesting.MutabilityAssert.assertInstancesOf;
 import static org.mutabilitydetector.unittesting.MutabilityMatchers.areImmutable;
 
 import org.assertj.core.api.AutoCloseableSoftAssertions;
-import org.eclipse.ditto.base.model.exceptions.DittoHeaderInvalidException;
 import org.junit.Before;
 import org.junit.Test;
 
@@ -48,18 +46,6 @@ public void tryToAcceptNullDefinition() {
                 .withNoCause();
     }
 
-    @Test
-    public void tryToAcceptNullValue() {
-        final DittoHeaderDefinition headerDefinition = DittoHeaderDefinition.SCHEMA_VERSION;
-
-        assertThatExceptionOfType(DittoHeaderInvalidException.class)
-                .isThrownBy(() -> underTest.accept(headerDefinition, null))
-                .withMessageContaining("null")
-                .withMessageContaining(headerDefinition.getKey())
-                .withMessageEndingWith("is not a valid int.")
-                .withNoCause();
-    }
-
     @Test
     public void canValidateInteger() {
         try (final AutoCloseableSoftAssertions softly = new AutoCloseableSoftAssertions()) {
@@ -70,7 +56,7 @@ public void canValidateInteger() {
 
     @Test
     public void acceptValidCharSequence() {
-        assertThatCode(() -> underTest.accept(DittoHeaderDefinition.SCHEMA_VERSION, "2"))
+        assertThatCode(() -> underTest.accept(DittoHeaderDefinition.RESPONSE_REQUIRED, "false"))
                 .doesNotThrowAnyException();
     }
 
@@ -80,15 +66,4 @@ public void doesNotValidateAsDefinedJavaTypeIsNotInt() {
                 .doesNotThrowAnyException();
     }
 
-    @Test
-    public void acceptInvalidCharSequence() {
-        final String invalidInt = "true";
-
-        assertThatExceptionOfType(DittoHeaderInvalidException.class)
-                .isThrownBy(() -> underTest.accept(DittoHeaderDefinition.SCHEMA_VERSION, invalidInt))
-                .withMessageContaining(invalidInt)
-                .withMessageEndingWith("is not a valid int.")
-                .withNoCause();
-    }
-
 }

messages/model/src/test/java/org/eclipse/ditto/messages/model/ImmutableMessageHeadersTest.java

@@ -305,7 +305,6 @@ private static Map<String, String> createMapContainingAllKnownHeaders() {
         result.put(DittoHeaderDefinition.AUTHORIZATION_CONTEXT.getKey(),
                 AUTH_CONTEXT_WITHOUT_DUPLICATES.toJsonString());
         result.put(DittoHeaderDefinition.CORRELATION_ID.getKey(), "knownCorrelationId");
-        result.put(DittoHeaderDefinition.SCHEMA_VERSION.getKey(), KNOWN_SCHEMA_VERSION.toString());
         result.put(DittoHeaderDefinition.CHANNEL.getKey(), KNOWN_CHANNEL);
         result.put(DittoHeaderDefinition.RESPONSE_REQUIRED.getKey(), String.valueOf(KNOWN_RESPONSE_REQUIRED));
         result.put(DittoHeaderDefinition.DRY_RUN.getKey(), String.valueOf(false));

wot/integration/src/main/java/org/eclipse/ditto/wot/integration/generator/WotThingModelExtensionResolver.java

@@ -13,8 +13,10 @@
 package org.eclipse.ditto.wot.integration.generator;
 
 import java.util.concurrent.CompletionStage;
+import java.util.concurrent.Executor;
 
 import org.eclipse.ditto.base.model.headers.DittoHeaders;
+import org.eclipse.ditto.wot.integration.provider.WotThingModelFetcher;
 import org.eclipse.ditto.wot.model.ThingModel;
 
 /**
@@ -56,4 +58,15 @@ public interface WotThingModelExtensionResolver {
      * be parsed/interpreted as correct WoT ThingModel.
      */
     CompletionStage<ThingModel> resolveThingModelRefs(ThingModel thingModel, DittoHeaders dittoHeaders);
+
+    /**
+     * Creates a new instance of WotThingModelExtensionResolver with the given {@code thingModelFetcher}.
+     *
+     * @param thingModelFetcher the ThingModel fetcher to fetch linked other ThingModels during the generation process.
+     * @param executor the executor to use for async tasks.
+     * @return the created WotThingSkeletonGenerator.
+     */
+    static WotThingModelExtensionResolver of(final WotThingModelFetcher thingModelFetcher, final Executor executor) {
+        return new DefaultWotThingModelExtensionResolver(thingModelFetcher, executor);
+    }
 }

wot/integration/src/main/java/org/eclipse/ditto/wot/integration/provider/WotThingModelFetcher.java

@@ -15,7 +15,9 @@
 import java.net.URL;
 import java.util.concurrent.CompletionStage;
 
+import org.apache.pekko.actor.ActorSystem;
 import org.eclipse.ditto.base.model.headers.DittoHeaders;
+import org.eclipse.ditto.wot.integration.config.WotConfig;
 import org.eclipse.ditto.wot.model.IRI;
 import org.eclipse.ditto.wot.model.ThingModel;
 
@@ -54,4 +56,15 @@ public interface WotThingModelFetcher {
      * fetched at the given {@code url}.
      */
     CompletionStage<ThingModel> fetchThingModel(URL url, DittoHeaders dittoHeaders);
+
+    /**
+     * Creates a new instance of WotThingModelExtensionResolver with the given {@code actorSystem}.
+     *
+     * @param actorSystem the actor system to use.
+     * @param wotConfig the WoTConfig to use for creating the generator.
+     * @return the created WotThingSkeletonGenerator.
+     */
+    static WotThingModelFetcher of(final ActorSystem actorSystem, final WotConfig wotConfig) {
+        return new DefaultWotThingModelFetcher(actorSystem, wotConfig);
+    }
 }