refactor(subscription): enforce lifecycle invariants, unify exception naming, move AggregateRoot to domain.model

imDMK · imDMK · commit 8d7db2cd87b5 · 2026-02-05T12:58:56.000+01:00
diff --git a/order-bootstrap/src/main/java/dev/imdmk/ordersystem/bootstrap/subscription/SubscriptionExpirationJob.java b/order-bootstrap/src/main/java/dev/imdmk/ordersystem/bootstrap/subscription/SubscriptionExpirationJob.java
@@ -18,7 +18,7 @@ public SubscriptionExpirationJob(
         this.expirationService = Objects.requireNonNull(expirationService, "expirationService must not be null");
     }
 
-    @Scheduled(cron = "*/10 * * * * *")
+    @Scheduled(cron = "0 */5 * * * *")
     public void run() {
         expirationService.expireDueSubscriptions(Instant.now());
     }
diff --git a/order-domain/src/main/java/dev/imdmk/ordersystem/domain/model/AggregateRoot.java b/order-domain/src/main/java/dev/imdmk/ordersystem/domain/model/AggregateRoot.java
@@ -1,4 +1,4 @@
-package dev.imdmk.ordersystem.domain.common;
+package dev.imdmk.ordersystem.domain.model;
 
 import dev.imdmk.ordersystem.domain.event.DomainEvent;
 
@@ -8,7 +8,7 @@
 
 public abstract class AggregateRoot {
 
-    private final List<DomainEvent> domainEvents = new ArrayList<>();
+    private final List<DomainEvent> domainEvents = new ArrayList<>(4);
 
     protected void registerEvent(DomainEvent event) {
         Objects.requireNonNull(event, "event must not be null");
diff --git a/order-domain/src/main/java/dev/imdmk/ordersystem/domain/order/Order.java b/order-domain/src/main/java/dev/imdmk/ordersystem/domain/order/Order.java
@@ -1,6 +1,6 @@
 package dev.imdmk.ordersystem.domain.order;
 
-import dev.imdmk.ordersystem.domain.common.AggregateRoot;
+import dev.imdmk.ordersystem.domain.model.AggregateRoot;
 import dev.imdmk.ordersystem.domain.order.event.OrderCancelEvent;
 import dev.imdmk.ordersystem.domain.order.event.OrderPaidEvent;
 import dev.imdmk.ordersystem.domain.order.state.CancelledOrder;
diff --git a/order-domain/src/main/java/dev/imdmk/ordersystem/domain/subscription/Subscription.java b/order-domain/src/main/java/dev/imdmk/ordersystem/domain/subscription/Subscription.java
@@ -1,55 +1,70 @@
 package dev.imdmk.ordersystem.domain.subscription;
 
-import dev.imdmk.ordersystem.domain.common.AggregateRoot;
+import dev.imdmk.ordersystem.domain.model.AggregateRoot;
 import dev.imdmk.ordersystem.domain.order.OrderId;
 import dev.imdmk.ordersystem.domain.subscription.event.SubscriptionCancelledEvent;
 import dev.imdmk.ordersystem.domain.subscription.event.SubscriptionExpiredEvent;
 import dev.imdmk.ordersystem.domain.subscription.event.SubscriptionStartedEvent;
+import dev.imdmk.ordersystem.domain.subscription.exception.CannotCancelExpiredSubscriptionException;
+import dev.imdmk.ordersystem.domain.subscription.exception.CannotExpireCancelledSubscriptionException;
 import dev.imdmk.ordersystem.domain.subscription.exception.CannotExpirePermanentSubscriptionException;
 import dev.imdmk.ordersystem.domain.subscription.exception.SubscriptionAlreadyCancelledException;
 import dev.imdmk.ordersystem.domain.subscription.exception.SubscriptionAlreadyExpiredException;
+import dev.imdmk.ordersystem.domain.subscription.exception.SubscriptionNotYetExpiredException;
 
 import java.util.Objects;
 
 public final class Subscription extends AggregateRoot {
 
     private final SubscriptionId id;
     private final OrderId orderId;
-    private SubscriptionStatus status;
     private final Expiration expiration;
+    private SubscriptionStatus status;
 
     private Subscription(
             SubscriptionId id,
             OrderId orderId,
-            SubscriptionStatus status,
-            Expiration expiration
+            Expiration expiration,
+            SubscriptionStatus status
     ) {
         this.id = Objects.requireNonNull(id, "id must not be null");
         this.orderId = Objects.requireNonNull(orderId, "orderId must not be null");
-        this.status = Objects.requireNonNull(status, "status must not be null");
         this.expiration = Objects.requireNonNull(expiration, "expiration must not be null");
+        this.status = Objects.requireNonNull(status, "status must not be null");
     }
 
-    public static Subscription from(SubscriptionId id, OrderId orderId, SubscriptionStatus status, Expiration expiration) {
-        return new Subscription(id, orderId, status, expiration);
+    public static Subscription from(
+            SubscriptionId id,
+            OrderId orderId,
+            Expiration expiration,
+            SubscriptionStatus status
+    ) {
+        return new Subscription(id, orderId, expiration, status);
     }
 
     public static Subscription start(
             OrderId orderId,
             Expiration expiration
     ) {
         final SubscriptionId subscriptionId = SubscriptionId.newId();
-        final Subscription subscription = from(subscriptionId, orderId, SubscriptionStatus.ACTIVE, expiration);
+        final Subscription subscription = from(subscriptionId, orderId, expiration, SubscriptionStatus.ACTIVE);
+
+        subscription.registerEvent(
+                SubscriptionStartedEvent.now(subscription.id, subscription.orderId)
+        );
 
-        subscription.registerEvent(SubscriptionStartedEvent.now(subscription.id, subscription.orderId));
         return subscription;
     }
 
     public void cancel() {
-        if (isCancelled()) {
+        if (status == SubscriptionStatus.CANCELLED) {
             throw new SubscriptionAlreadyCancelledException(id);
         }
 
+        if (status == SubscriptionStatus.EXPIRED) {
+            throw new CannotCancelExpiredSubscriptionException(id);
+        }
+
         this.status = SubscriptionStatus.CANCELLED;
         registerEvent(SubscriptionCancelledEvent.now(id, orderId));
     }
@@ -59,22 +74,42 @@ public void expire() {
             throw new SubscriptionAlreadyExpiredException(id);
         }
 
+        if (status == SubscriptionStatus.CANCELLED) {
+            throw new CannotExpireCancelledSubscriptionException(id);
+        }
+
         if (expiration.isPermanent()) {
             throw new CannotExpirePermanentSubscriptionException(id);
         }
 
+        if (!expiration.isExpired()) {
+            throw new SubscriptionNotYetExpiredException(id);
+        }
+
         this.status = SubscriptionStatus.EXPIRED;
         registerEvent(SubscriptionExpiredEvent.now(id, orderId));
     }
 
     public boolean isActive() {
-        return status == SubscriptionStatus.ACTIVE && !expiration.isExpired();
+        if (status != SubscriptionStatus.ACTIVE) {
+            return false;
+        }
+
+        if (expiration.isPermanent()) {
+            return true;
+        }
+
+        return !expiration.isExpired();
     }
 
     public boolean isCancelled() {
         return status == SubscriptionStatus.CANCELLED;
     }
 
+    public boolean isExpired() {
+        return status == SubscriptionStatus.EXPIRED;
+    }
+
     public SubscriptionId getId() {
         return id;
     }
diff --git a/order-domain/src/main/java/dev/imdmk/ordersystem/domain/subscription/exception/CannotCancelExpiredSubscriptionException.java b/order-domain/src/main/java/dev/imdmk/ordersystem/domain/subscription/exception/CannotCancelExpiredSubscriptionException.java
@@ -0,0 +1,9 @@
+package dev.imdmk.ordersystem.domain.subscription.exception;
+
+import dev.imdmk.ordersystem.domain.subscription.SubscriptionId;
+
+public class CannotCancelExpiredSubscriptionException extends RuntimeException {
+    public CannotCancelExpiredSubscriptionException(SubscriptionId id) {
+        super("Cannot cancel expired subscription: " + id);
+    }
+}
diff --git a/order-domain/src/main/java/dev/imdmk/ordersystem/domain/subscription/exception/CannotExpireCancelledSubscriptionException.java b/order-domain/src/main/java/dev/imdmk/ordersystem/domain/subscription/exception/CannotExpireCancelledSubscriptionException.java
@@ -0,0 +1,9 @@
+package dev.imdmk.ordersystem.domain.subscription.exception;
+
+import dev.imdmk.ordersystem.domain.subscription.SubscriptionId;
+
+public class CannotExpireCancelledSubscriptionException extends RuntimeException {
+    public CannotExpireCancelledSubscriptionException(SubscriptionId id) {
+        super("Cannot expire cancelled subscription: " + id);
+    }
+}
diff --git a/order-domain/src/main/java/dev/imdmk/ordersystem/domain/subscription/exception/CannotExpirePermanentSubscriptionException.java b/order-domain/src/main/java/dev/imdmk/ordersystem/domain/subscription/exception/CannotExpirePermanentSubscriptionException.java
@@ -2,8 +2,8 @@
 
 import dev.imdmk.ordersystem.domain.subscription.SubscriptionId;
 
-public final class CannotExpirePermanentSubscriptionException extends RuntimeException {
-    public CannotExpirePermanentSubscriptionException(SubscriptionId subscriptionId) {
-        super("Permanent subscription with id %s cannot expire".formatted(subscriptionId));
+public class CannotExpirePermanentSubscriptionException extends RuntimeException {
+    public CannotExpirePermanentSubscriptionException(SubscriptionId id) {
+        super("Cannot expire permanent subscription: " + id);
     }
 }
diff --git a/order-domain/src/main/java/dev/imdmk/ordersystem/domain/subscription/exception/SubscriptionAlreadyActiveException.java b/order-domain/src/main/java/dev/imdmk/ordersystem/domain/subscription/exception/SubscriptionAlreadyActiveException.java
diff --git a/order-domain/src/main/java/dev/imdmk/ordersystem/domain/subscription/exception/SubscriptionAlreadyCancelledException.java b/order-domain/src/main/java/dev/imdmk/ordersystem/domain/subscription/exception/SubscriptionAlreadyCancelledException.java
@@ -2,8 +2,8 @@
 
 import dev.imdmk.ordersystem.domain.subscription.SubscriptionId;
 
-public final class SubscriptionAlreadyCancelledException extends RuntimeException {
-    public SubscriptionAlreadyCancelledException(SubscriptionId subscriptionId) {
-        super("Subscription with id %s is already cancelled".formatted(subscriptionId));
+public class SubscriptionAlreadyCancelledException extends RuntimeException {
+    public SubscriptionAlreadyCancelledException(SubscriptionId id) {
+        super("Subscription already cancelled: " + id);
     }
 }
diff --git a/order-domain/src/main/java/dev/imdmk/ordersystem/domain/subscription/exception/SubscriptionAlreadyExpiredException.java b/order-domain/src/main/java/dev/imdmk/ordersystem/domain/subscription/exception/SubscriptionAlreadyExpiredException.java
@@ -2,8 +2,8 @@
 
 import dev.imdmk.ordersystem.domain.subscription.SubscriptionId;
 
-public final class SubscriptionAlreadyExpiredException extends RuntimeException {
-    public SubscriptionAlreadyExpiredException(SubscriptionId subscriptionId) {
-        super("Subscription with id %s already expired".formatted(subscriptionId));
+public class SubscriptionAlreadyExpiredException extends RuntimeException {
+    public SubscriptionAlreadyExpiredException(SubscriptionId id) {
+        super("Subscription already expired: " + id);
     }
 }
diff --git a/order-domain/src/main/java/dev/imdmk/ordersystem/domain/subscription/exception/SubscriptionNotYetExpiredException.java b/order-domain/src/main/java/dev/imdmk/ordersystem/domain/subscription/exception/SubscriptionNotYetExpiredException.java
@@ -0,0 +1,9 @@
+package dev.imdmk.ordersystem.domain.subscription.exception;
+
+import dev.imdmk.ordersystem.domain.subscription.SubscriptionId;
+
+public class SubscriptionNotYetExpiredException extends RuntimeException {
+    public SubscriptionNotYetExpiredException(SubscriptionId id) {
+        super("Subscription has not yet expired: " + id);
+    }
+}
diff --git a/order-infrastructure/src/main/java/dev/imdmk/ordersystem/infrastructure/subscription/persistence/SubscriptionEntityMapper.java b/order-infrastructure/src/main/java/dev/imdmk/ordersystem/infrastructure/subscription/persistence/SubscriptionEntityMapper.java
@@ -20,8 +20,8 @@ public static Subscription toDomain(SubscriptionEntity entity) {
         return Subscription.from(
                 new SubscriptionId(entity.getId()),
                 new OrderId(entity.getOrderId()),
-                SubscriptionStatus.valueOf(entity.getStatus().name()),
-                expiration
+                expiration,
+                SubscriptionStatus.valueOf(entity.getStatus().name())
         );
     }
 

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ public SubscriptionExpirationJob(`
`18`	`18`	`this.expirationService = Objects.requireNonNull(expirationService, "expirationService must not be null");`
`19`	`19`	`}`
`20`	`20`
`21`		`- @Scheduled(cron = "/10 * * * *")`
	`21`	`+ @Scheduled(cron = "0 /5 * * *")`
`22`	`22`	`public void run() {`
`23`	`23`	`expirationService.expireDueSubscriptions(Instant.now());`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,8 @@`
`2`	`2`
`3`	`3`	`import dev.imdmk.ordersystem.domain.subscription.SubscriptionId;`
`4`	`4`
`5`		`-public final class CannotExpirePermanentSubscriptionException extends RuntimeException {`
`6`		`- public CannotExpirePermanentSubscriptionException(SubscriptionId subscriptionId) {`
`7`		`- super("Permanent subscription with id %s cannot expire".formatted(subscriptionId));`
	`5`	`+public class CannotExpirePermanentSubscriptionException extends RuntimeException {`
	`6`	`+ public CannotExpirePermanentSubscriptionException(SubscriptionId id) {`
	`7`	`+ super("Cannot expire permanent subscription: " + id);`
`8`	`8`	`}`
`9`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,8 @@`
`2`	`2`
`3`	`3`	`import dev.imdmk.ordersystem.domain.subscription.SubscriptionId;`
`4`	`4`
`5`		`-public final class SubscriptionAlreadyCancelledException extends RuntimeException {`
`6`		`- public SubscriptionAlreadyCancelledException(SubscriptionId subscriptionId) {`
`7`		`- super("Subscription with id %s is already cancelled".formatted(subscriptionId));`
	`5`	`+public class SubscriptionAlreadyCancelledException extends RuntimeException {`
	`6`	`+ public SubscriptionAlreadyCancelledException(SubscriptionId id) {`
	`7`	`+ super("Subscription already cancelled: " + id);`
`8`	`8`	`}`
`9`	`9`	`}`