Merge pull request #2276 from beyonnex-io/bugfix/duplicate-wot-submodel-exception-fix

thjaeckle · web-flow · commit b347bccd002a · 2025-11-21T11:34:33.000+01:00
fix wrong exceptions being thrown when duplicates occur in WoT parsing
diff --git a/wot/api/src/main/java/org/eclipse/ditto/wot/api/resolver/DefaultWotThingModelResolver.java b/wot/api/src/main/java/org/eclipse/ditto/wot/api/resolver/DefaultWotThingModelResolver.java
@@ -16,6 +16,7 @@
 import java.net.URL;
 import java.time.Duration;
 import java.util.AbstractMap;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.CompletableFuture;
@@ -130,7 +131,11 @@ public CompletionStage<Map<ThingSubmodel, ThingModel>> resolveThingModelSubmodel
         return CompletableFuture.allOf(futureList.toArray(CompletableFuture<?>[]::new))
                 .thenApplyAsync(aVoid -> futureList.stream()
                         .map(CompletableFuture::join) // joining does not block anything here as "allOf" already guaranteed that all futures are ready
-                        .collect(Collectors.toMap(AbstractMap.SimpleEntry::getKey, AbstractMap.SimpleEntry::getValue))
+                        .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (u, v) -> {
+                            throw WotThingModelInvalidException.newBuilder(String.format("Thing submodels: Duplicate key %s", u))
+                                    .dittoHeaders(dittoHeaders)
+                                    .build();
+                        }, LinkedHashMap::new))
                 );
     }
 
diff --git a/wot/api/src/main/java/org/eclipse/ditto/wot/api/validator/DefaultWotThingModelValidator.java b/wot/api/src/main/java/org/eclipse/ditto/wot/api/validator/DefaultWotThingModelValidator.java
@@ -53,6 +53,7 @@
 import org.eclipse.ditto.wot.api.resolver.ThingSubmodel;
 import org.eclipse.ditto.wot.api.resolver.WotThingModelResolver;
 import org.eclipse.ditto.wot.model.ThingModel;
+import org.eclipse.ditto.wot.model.WotThingModelInvalidException;
 import org.eclipse.ditto.wot.validation.JsonSchemaCacheKey;
 import org.eclipse.ditto.wot.validation.ValidationContext;
 import org.eclipse.ditto.wot.validation.WotThingModelPayloadValidationException;
@@ -991,7 +992,11 @@ private CompletionStage<Void> doValidateMergeThingAffectedFeatures(final Thing t
                 .filter(subModel ->
                         affectedFeatures.contains(subModel.getKey().instanceName())
                 )
-                .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
+                .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (u, v) -> {
+                    throw WotThingModelInvalidException.newBuilder(String.format("Thing submodels: Duplicate key %s", u))
+                            .dittoHeaders(context.dittoHeaders())
+                            .build();
+                }, LinkedHashMap::new));
         final Features filteredFeatures = thing.getFeatures()
                 .map(features -> Features.newBuilder()
                         .setAll(features.stream()
diff --git a/wot/model/src/main/java/org/eclipse/ditto/wot/model/Actions.java b/wot/model/src/main/java/org/eclipse/ditto/wot/model/Actions.java
@@ -34,7 +34,8 @@ static Actions fromJson(final JsonObject jsonObject) {
                 field -> field.getKey().toString(),
                 field -> Action.fromJson(field.getKey().toString(), field.getValue().asObject()),
                 (u, v) -> {
-                    throw new IllegalStateException(String.format("Duplicate key %s", u));
+                    throw WotThingModelInvalidException.newBuilder(String.format("Actions: Duplicate key %s", u))
+                            .build();
                 },
                 LinkedHashMap::new)
         ));
@@ -45,7 +46,8 @@ static Actions from(final Collection<Action> actions) {
                 Action::getActionName,
                 a -> a,
                 (u, v) -> {
-                    throw new IllegalStateException(String.format("Duplicate key %s", u));
+                    throw WotThingModelInvalidException.newBuilder(String.format("Actions: Duplicate key %s", u))
+                            .build();
                 },
                 LinkedHashMap::new)
         ));
diff --git a/wot/model/src/main/java/org/eclipse/ditto/wot/model/Descriptions.java b/wot/model/src/main/java/org/eclipse/ditto/wot/model/Descriptions.java
@@ -33,7 +33,8 @@ static Descriptions fromJson(final JsonObject jsonObject) {
                 field -> new Locale(field.getKey().toString()),
                 field -> Description.of(field.getValue().asString()),
                 (u, v) -> {
-                    throw new IllegalStateException(String.format("Duplicate key %s", u));
+                    throw WotThingModelInvalidException.newBuilder(String.format("Descriptions: Duplicate key %s", u))
+                            .build();
                 },
                 LinkedHashMap::new)
         ));
diff --git a/wot/model/src/main/java/org/eclipse/ditto/wot/model/Events.java b/wot/model/src/main/java/org/eclipse/ditto/wot/model/Events.java
@@ -34,7 +34,8 @@ static Events fromJson(final JsonObject jsonObject) {
                 field -> field.getKey().toString(),
                 field -> Event.fromJson(field.getKey().toString(), field.getValue().asObject()),
                 (u, v) -> {
-                    throw new IllegalStateException(String.format("Duplicate key %s", u));
+                    throw WotThingModelInvalidException.newBuilder(String.format("Events: Duplicate key %s", u))
+                            .build();
                 },
                 LinkedHashMap::new)
         ));
@@ -45,7 +46,8 @@ static Events from(final Collection<Event> events) {
                 Event::getEventName,
                 e -> e,
                 (u, v) -> {
-                    throw new IllegalStateException(String.format("Duplicate key %s", u));
+                    throw WotThingModelInvalidException.newBuilder(String.format("Events: Duplicate key %s", u))
+                            .build();
                 },
                 LinkedHashMap::new)
         ));
diff --git a/wot/model/src/main/java/org/eclipse/ditto/wot/model/ImmutableObjectSchema.java b/wot/model/src/main/java/org/eclipse/ditto/wot/model/ImmutableObjectSchema.java
@@ -52,7 +52,8 @@ public Map<String, SingleDataSchema> getProperties() {
                         f -> f.getKey().toString(),
                         f -> SingleDataSchema.fromJson(f.getValue().asObject()),
                         (u, v) -> {
-                            throw new IllegalStateException(String.format("Duplicate key %s", u));
+                            throw WotThingModelInvalidException.newBuilder(String.format("Object properties: Duplicate key %s", u))
+                                    .build();
                         },
                         LinkedHashMap::new
                 ));
diff --git a/wot/model/src/main/java/org/eclipse/ditto/wot/model/Properties.java b/wot/model/src/main/java/org/eclipse/ditto/wot/model/Properties.java
@@ -34,7 +34,8 @@ static Properties fromJson(final JsonObject jsonObject) {
                 field -> field.getKey().toString(),
                 field -> Property.fromJson(field.getKey().toString(), field.getValue().asObject()),
                 (u, v) -> {
-                    throw new IllegalStateException(String.format("Duplicate key %s", u));
+                    throw WotThingModelInvalidException.newBuilder(String.format("Properties: Duplicate key %s", u))
+                            .build();
                 },
                 LinkedHashMap::new)
         ));
@@ -45,7 +46,8 @@ static Properties from(final Collection<Property> properties) {
                 Property::getPropertyName,
                 p -> p,
                 (u, v) -> {
-                    throw new IllegalStateException(String.format("Duplicate key %s", u));
+                    throw WotThingModelInvalidException.newBuilder(String.format("Properties: Duplicate key %s", u))
+                            .build();
                 },
                 LinkedHashMap::new)
         ));
diff --git a/wot/model/src/main/java/org/eclipse/ditto/wot/model/SchemaDefinitions.java b/wot/model/src/main/java/org/eclipse/ditto/wot/model/SchemaDefinitions.java
@@ -33,7 +33,8 @@ static SchemaDefinitions fromJson(final JsonObject jsonObject) {
                 field -> field.getKey().toString(),
                 field -> SingleDataSchema.fromJson(field.getValue().asObject()),
                 (u, v) -> {
-                    throw new IllegalStateException(String.format("Duplicate key %s", u));
+                    throw WotThingModelInvalidException.newBuilder(String.format("SingleDataSchemas: Duplicate key %s", u))
+                            .build();
                 },
                 LinkedHashMap::new)
         ));
diff --git a/wot/model/src/main/java/org/eclipse/ditto/wot/model/SecurityDefinitions.java b/wot/model/src/main/java/org/eclipse/ditto/wot/model/SecurityDefinitions.java
@@ -33,7 +33,8 @@ static SecurityDefinitions fromJson(final JsonObject jsonObject) {
                 field -> field.getKey().toString(),
                 field -> SecurityScheme.fromJson(field.getKey().toString(), field.getValue().asObject()),
                 (u, v) -> {
-                    throw new IllegalStateException(String.format("Duplicate key %s", u));
+                    throw WotThingModelInvalidException.newBuilder(String.format("SecuritySchemes: Duplicate key %s", u))
+                            .build();
                 },
                 LinkedHashMap::new)
         ));
@@ -44,7 +45,8 @@ static SecurityDefinitions from(final Collection<SecurityScheme> securityDefinit
                 SecurityScheme::getSecuritySchemeName,
                 s -> s,
                 (u, v) -> {
-                    throw new IllegalStateException(String.format("Duplicate key %s", u));
+                    throw WotThingModelInvalidException.newBuilder(String.format("SecuritySchemes: Duplicate key %s", u))
+                            .build();
                 },
                 LinkedHashMap::new)
         ));
diff --git a/wot/model/src/main/java/org/eclipse/ditto/wot/model/Titles.java b/wot/model/src/main/java/org/eclipse/ditto/wot/model/Titles.java
@@ -34,7 +34,8 @@ static Titles fromJson(final JsonObject jsonObject) {
                 field -> new Locale(field.getKey().toString()),
                 field -> Title.of(field.getValue().asString()),
                 (u, v) -> {
-                    throw new IllegalStateException(String.format("Duplicate key %s", u));
+                    throw WotThingModelInvalidException.newBuilder(String.format("Titles: Duplicate key %s", u))
+                            .build();
                 },
                 LinkedHashMap::new)
         ));
diff --git a/wot/model/src/main/java/org/eclipse/ditto/wot/model/UriVariables.java b/wot/model/src/main/java/org/eclipse/ditto/wot/model/UriVariables.java
@@ -32,7 +32,8 @@ static UriVariables fromJson(final JsonObject jsonObject) {
                 field -> field.getKey().toString(),
                 field -> SingleDataSchema.fromJson(field.getValue().asObject()),
                 (u, v) -> {
-                    throw new IllegalStateException(String.format("Duplicate key %s", u));
+                    throw WotThingModelInvalidException.newBuilder(String.format("SingleDataSchemas: Duplicate key %s", u))
+                            .build();
                 },
                 LinkedHashMap::new)
         ));
diff --git a/wot/validation/src/main/java/org/eclipse/ditto/wot/validation/InternalValidation.java b/wot/validation/src/main/java/org/eclipse/ditto/wot/validation/InternalValidation.java
@@ -41,6 +41,7 @@
 import org.eclipse.ditto.wot.model.SingleUriAtContext;
 import org.eclipse.ditto.wot.model.ThingModel;
 import org.eclipse.ditto.wot.model.TmOptionalElement;
+import org.eclipse.ditto.wot.model.WotThingModelInvalidException;
 
 import com.networknt.schema.JsonSchema;
 import com.networknt.schema.output.OutputUnit;
@@ -465,7 +466,9 @@ Map<Property, OutputUnit> determineInvalidProperties(final Properties tdProperti
                                 .filter(entry -> !entry.getValue().isValid())
                                 .stream()
                 ).collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (u, v) -> {
-                    throw new IllegalStateException(String.format("Duplicate key %s", u));
+                    throw WotThingModelInvalidException.newBuilder(String.format("Invalid properties: Duplicate key %s", u))
+                            .dittoHeaders(context.dittoHeaders())
+                            .build();
                 }, LinkedHashMap::new));
     }
 
diff --git a/wot/validation/src/main/java/org/eclipse/ditto/wot/validation/WotThingModelPayloadValidationException.java b/wot/validation/src/main/java/org/eclipse/ditto/wot/validation/WotThingModelPayloadValidationException.java
@@ -45,6 +45,7 @@
 import org.eclipse.ditto.json.JsonPointer;
 import org.eclipse.ditto.json.JsonValue;
 import org.eclipse.ditto.wot.model.WotException;
+import org.eclipse.ditto.wot.model.WotThingModelInvalidException;
 
 /**
  * Exception thrown when a Ditto Thing (or parts of it), so the payload, could not be validated against the WoT Model.
@@ -105,7 +106,7 @@ public static WotThingModelPayloadValidationException fromJson(final JsonObject
             final DittoHeaders dittoHeaders) {
 
         return DittoRuntimeException.fromJson(jsonObject, dittoHeaders,
-                new Builder(readValidationDetails(jsonObject))
+                new Builder(readValidationDetails(jsonObject, dittoHeaders))
         );
     }
 
@@ -120,7 +121,8 @@ public DittoRuntimeException setDittoHeaders(final DittoHeaders dittoHeaders) {
                 .build();
     }
 
-    private static Map<JsonPointer, List<String>> readValidationDetails(final JsonObject jsonObject) {
+    private static Map<JsonPointer, List<String>> readValidationDetails(final JsonObject jsonObject,
+            final DittoHeaders dittoHeaders) {
         checkNotNull(jsonObject, "JSON object");
         return jsonObject.getValue(JsonFields.VALIDATION_DETAILS)
                 .map(validationDetails -> validationDetails.stream()
@@ -131,7 +133,9 @@ private static Map<JsonPointer, List<String>> readValidationDetails(final JsonOb
                 ).stream()
                 .flatMap(Function.identity())
                 .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (u, v) -> {
-                    throw new IllegalStateException(String.format("Duplicate key %s", u));
+                    throw WotThingModelInvalidException.newBuilder(String.format("Validation details: Duplicate key %s", u))
+                            .dittoHeaders(dittoHeaders)
+                            .build();
                 }, LinkedHashMap::new));
     }
 
