🐛 fix: clashing IDs with same String representation for different Aggregate types (#15)

Author: MateuszNaKodach

src/main/java/com/dddheroes/heroesofddd/astrologers/write/AstrologersId.java

@@ -4,10 +4,13 @@
 
 public record AstrologersId(String raw) {
 
+    private final static String AGGREGATE_TYPE = "Astrologers";
+
     public AstrologersId {
         if (raw == null || raw.isBlank()) {
             throw new IllegalArgumentException("Astrologers id cannot be null or empty");
         }
+        raw = withType(raw);
     }
 
     public static AstrologersId of(String raw) {
@@ -22,4 +25,8 @@ public static AstrologersId random() {
     public String toString() {
         return raw;
     }
+
+    private static String withType(String id) {
+        return id.startsWith(AGGREGATE_TYPE + ":") ? id : AGGREGATE_TYPE + ":" + id;
+    }
 }

src/main/java/com/dddheroes/heroesofddd/calendar/write/CalendarId.java

@@ -4,10 +4,13 @@
 
 public record CalendarId(String raw) {
 
+    private final static String AGGREGATE_TYPE = "Calendar";
+
     public CalendarId {
         if (raw == null || raw.isBlank()) {
             throw new IllegalArgumentException("Calendar id cannot be null or empty");
         }
+        raw = withType(raw);
     }
 
     public static CalendarId of(String raw) {
@@ -22,4 +25,8 @@ public static CalendarId random() {
     public String toString() {
         return raw;
     }
+
+    private static String withType(String id) {
+        return id.startsWith(AGGREGATE_TYPE + ":") ? id : AGGREGATE_TYPE + ":" + id;
+    }
 }

src/main/java/com/dddheroes/heroesofddd/creaturerecruitment/write/DwellingId.java

@@ -4,10 +4,13 @@
 
 public record DwellingId(String raw) {
 
+    private final static String AGGREGATE_TYPE = "Dwelling";
+
     public DwellingId {
         if (raw == null || raw.isBlank()) {
             throw new IllegalArgumentException("Dwelling id cannot be null or empty");
         }
+        raw = withType(raw);
     }
 
     public static DwellingId of(String raw) {
@@ -22,4 +25,8 @@ public static DwellingId random() {
     public String toString() {
         return raw;
     }
+
+    private static String withType(String id) {
+        return id.startsWith(AGGREGATE_TYPE + ":") ? id : AGGREGATE_TYPE + ":" + id;
+    }
 }

src/main/java/com/dddheroes/heroesofddd/resourcespool/write/ResourcesPoolId.java

@@ -4,10 +4,13 @@
 
 public record ResourcesPoolId(String raw) {
 
+    private final static String AGGREGATE_TYPE = "ResourcesPool";
+
     public ResourcesPoolId {
         if (raw == null || raw.isBlank()) {
             throw new IllegalArgumentException("Resources Pool ID cannot be null or empty");
         }
+        raw = withType(raw);
     }
 
     public static ResourcesPoolId of(String raw) {
@@ -22,4 +25,8 @@ public static ResourcesPoolId random() {
     public String toString() {
         return raw;
     }
+
+    private static String withType(String id) {
+        return id.startsWith(AGGREGATE_TYPE + ":") ? id : AGGREGATE_TYPE + ":" + id;
+    }
 }

src/main/java/com/dddheroes/heroesofddd/shared/ArmyId.java

@@ -4,10 +4,13 @@
 
 public record ArmyId(String raw) {
 
+    private final static String AGGREGATE_TYPE = "Army";
+
     public ArmyId {
         if (raw == null || raw.isBlank()) {
             throw new IllegalArgumentException("Army id cannot be null or empty");
         }
+        raw = withType(raw);
     }
 
     public static ArmyId of(String raw) {
@@ -22,4 +25,8 @@ public static ArmyId random() {
     public String toString() {
         return raw;
     }
+
+    private static String withType(String id) {
+        return id.startsWith(AGGREGATE_TYPE + ":") ? id : AGGREGATE_TYPE + ":" + id;
+    }
 }

src/test/java/com/dddheroes/heroesofddd/creaturerecruitment/write/DwellingIdTest.java

@@ -0,0 +1,50 @@
+package com.dddheroes.heroesofddd.creaturerecruitment.write;
+
+import org.junit.jupiter.api.*;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+class DwellingIdTest {
+
+    @Test
+    void shouldThrowExceptionWhenRawIsNull() {
+        IllegalArgumentException exception = assertThrows(IllegalArgumentException.class, () -> new DwellingId(null));
+        assertEquals("Dwelling id cannot be null or empty", exception.getMessage());
+    }
+
+    @Test
+    void shouldThrowExceptionWhenRawIsEmpty() {
+        IllegalArgumentException exception = assertThrows(IllegalArgumentException.class, () -> new DwellingId(""));
+        assertEquals("Dwelling id cannot be null or empty", exception.getMessage());
+    }
+
+    @Test
+    void shouldAddAggregateTypeWhenNotPresent() {
+        DwellingId dwellingId = new DwellingId("12345");
+        assertEquals("Dwelling:12345", dwellingId.raw());
+    }
+
+    @Test
+    void shouldNotAddAggregateTypeWhenAlreadyPresent() {
+        DwellingId dwellingId = new DwellingId("Dwelling:12345");
+        assertEquals("Dwelling:12345", dwellingId.raw());
+    }
+
+    @Test
+    void factoryMethodShouldAddAggregateTypeWhenNotPresent() {
+        DwellingId dwellingId = DwellingId.of("12345");
+        assertEquals("Dwelling:12345", dwellingId.raw());
+    }
+
+    @Test
+    void factoryMethodShouldNotAddAggregateTypeWhenAlreadyPresent() {
+        DwellingId dwellingId = new DwellingId("Dwelling:12345");
+        assertEquals("Dwelling:12345", dwellingId.raw());
+    }
+
+    @Test
+    void shouldReturnRawStringInToString() {
+        DwellingId dwellingId = new DwellingId("12345");
+        assertEquals("Dwelling:12345", dwellingId.toString());
+    }
+}

src/test/java/com/dddheroes/heroesofddd/shared/AggregateIdsDoNotClashTest.java

@@ -0,0 +1,63 @@
+package com.dddheroes.heroesofddd.shared;
+
+import com.dddheroes.heroesofddd.TestcontainersConfiguration;
+import com.dddheroes.heroesofddd.astrologers.write.AstrologersId;
+import com.dddheroes.heroesofddd.calendar.write.CalendarId;
+import com.dddheroes.heroesofddd.creaturerecruitment.write.DwellingId;
+import com.dddheroes.heroesofddd.resourcespool.write.ResourcesPoolId;
+import org.axonframework.eventhandling.DomainEventMessage;
+import org.axonframework.eventhandling.GenericDomainEventMessage;
+import org.axonframework.eventsourcing.eventstore.EventStore;
+import org.junit.jupiter.api.*;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.context.annotation.Import;
+
+import java.util.Map;
+import java.util.UUID;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+@Import(TestcontainersConfiguration.class)
+@SpringBootTest
+public class AggregateIdsDoNotClashTest {
+
+    @Autowired
+    private EventStore eventStore;
+
+    @Test
+    void givenSameIdValueForDifferentAggregateTypes_WhenStoreEvent_ThenDoNotClash() {
+        // given
+        var rawId = UUID.randomUUID().toString();
+        var differentAggregateTypeIds = Map.of(
+                "Army", ArmyId.of(rawId),
+                "Astrologers", AstrologersId.of(rawId),
+                "Calendar", CalendarId.of(rawId),
+                "Dwelling", DwellingId.of(rawId),
+                "ResourcesPool", ResourcesPoolId.of(rawId)
+        );
+
+        // when/then
+        assertDoesNotThrow(() -> {
+            differentAggregateTypeIds.forEach(this::storeAggregateEvent);
+        });
+    }
+
+    private void storeAggregateEvent(String aggregateType, Object aggregateId) {
+        eventStore.publish(domainEvent(aggregateType, aggregateId.toString(), "payload"));
+    }
+
+
+    private static DomainEventMessage<?> domainEvent(
+            String aggregateType,
+            String identifier,
+            Object payload
+    ) {
+        return new GenericDomainEventMessage<>(
+                aggregateType,
+                identifier,
+                0,
+                payload
+        );
+    }
+}