[205] Use Spring Modulith and JMolecules to detail the architecture o…

…f the project Bug: #205 Signed-off-by: Stéphane Bégaudeau <[email protected]>
svalyn · Sep 13, 2023 · 481ffb9 · 481ffb9
1 parent 3ff12f3
commit 481ffb9
Show file tree

Hide file tree

Showing 114 changed files with 767 additions and 64 deletions.
diff --git a/...tion/src/main/java/com/svalyn/studio/application/controllers/viewer/ViewerController.java b/...tion/src/main/java/com/svalyn/studio/application/controllers/viewer/ViewerController.java
@@ -19,7 +19,7 @@
 package com.svalyn.studio.application.controllers.viewer;
 
 import com.svalyn.studio.application.services.account.api.IAccountService;
-import com.svalyn.studio.domain.authentication.IUser;
+import com.svalyn.studio.domain.account.IUser;
 import org.springframework.graphql.data.method.annotation.QueryMapping;
 import org.springframework.security.core.annotation.AuthenticationPrincipal;
 import org.springframework.stereotype.Controller;

diff --git a/...va/com/svalyn/studio/application/listeners/notification/AccountModifiedEventListener.java b/...va/com/svalyn/studio/application/listeners/notification/AccountModifiedEventListener.java
@@ -20,7 +20,7 @@
 package com.svalyn.studio.application.listeners.notification;
 
 import com.svalyn.studio.domain.account.events.AccountModifiedEvent;
-import com.svalyn.studio.domain.authentication.UserIdProvider;
+import com.svalyn.studio.domain.account.UserIdProvider;
 import com.svalyn.studio.domain.notification.Notification;
 import com.svalyn.studio.domain.notification.repositories.INotificationRepository;
 import org.springframework.stereotype.Service;

diff --git a/...om/svalyn/studio/application/listeners/notification/OrganizationCreatedEventListener.java b/...om/svalyn/studio/application/listeners/notification/OrganizationCreatedEventListener.java
@@ -19,7 +19,7 @@
 
 package com.svalyn.studio.application.listeners.notification;
 
-import com.svalyn.studio.domain.authentication.UserIdProvider;
+import com.svalyn.studio.domain.account.UserIdProvider;
 import com.svalyn.studio.domain.notification.Notification;
 import com.svalyn.studio.domain.notification.repositories.INotificationRepository;
 import com.svalyn.studio.domain.organization.events.OrganizationCreatedEvent;

diff --git a/...ava/com/svalyn/studio/application/listeners/notification/ProjectCreatedEventListener.java b/...ava/com/svalyn/studio/application/listeners/notification/ProjectCreatedEventListener.java
@@ -19,7 +19,7 @@
 
 package com.svalyn.studio.application.listeners.notification;
 
-import com.svalyn.studio.domain.authentication.UserIdProvider;
+import com.svalyn.studio.domain.account.UserIdProvider;
 import com.svalyn.studio.domain.notification.Notification;
 import com.svalyn.studio.domain.notification.repositories.INotificationRepository;
 import com.svalyn.studio.domain.organization.Membership;

diff --git a/...ava/com/svalyn/studio/application/listeners/notification/ProjectDeletedEventListener.java b/...ava/com/svalyn/studio/application/listeners/notification/ProjectDeletedEventListener.java
@@ -19,7 +19,7 @@
 
 package com.svalyn.studio.application.listeners.notification;
 
-import com.svalyn.studio.domain.authentication.UserIdProvider;
+import com.svalyn.studio.domain.account.UserIdProvider;
 import com.svalyn.studio.domain.notification.Notification;
 import com.svalyn.studio.domain.notification.repositories.INotificationRepository;
 import com.svalyn.studio.domain.organization.Membership;

diff --git a/...va/com/svalyn/studio/application/listeners/notification/ProjectModifiedEventListener.java b/...va/com/svalyn/studio/application/listeners/notification/ProjectModifiedEventListener.java
@@ -19,7 +19,7 @@
 
 package com.svalyn.studio.application.listeners.notification;
 
-import com.svalyn.studio.domain.authentication.UserIdProvider;
+import com.svalyn.studio.domain.account.UserIdProvider;
 import com.svalyn.studio.domain.notification.Notification;
 import com.svalyn.studio.domain.notification.repositories.INotificationRepository;
 import com.svalyn.studio.domain.organization.Membership;

diff --git a/.../main/java/com/svalyn/studio/application/services/account/AuthenticationTokenService.java b/.../main/java/com/svalyn/studio/application/services/account/AuthenticationTokenService.java
@@ -35,7 +35,7 @@
 import com.svalyn.studio.domain.account.AuthenticationTokenCreated;
 import com.svalyn.studio.domain.account.repositories.IAccountRepository;
 import com.svalyn.studio.domain.account.services.api.IAccountUpdateService;
-import com.svalyn.studio.domain.authentication.UserIdProvider;
+import com.svalyn.studio.domain.account.UserIdProvider;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.PageImpl;
 import org.springframework.data.domain.PageRequest;

diff --git a/...rc/main/java/com/svalyn/studio/application/services/notification/NotificationService.java b/...rc/main/java/com/svalyn/studio/application/services/notification/NotificationService.java
@@ -30,7 +30,7 @@
 import com.svalyn.studio.domain.Failure;
 import com.svalyn.studio.domain.Success;
 import com.svalyn.studio.domain.account.repositories.IAccountRepository;
-import com.svalyn.studio.domain.authentication.UserIdProvider;
+import com.svalyn.studio.domain.account.UserIdProvider;
 import com.svalyn.studio.domain.notification.Notification;
 import com.svalyn.studio.domain.notification.NotificationStatus;
 import com.svalyn.studio.domain.notification.repositories.INotificationRepository;

diff --git a/.../src/main/java/com/svalyn/studio/application/services/organization/InvitationService.java b/.../src/main/java/com/svalyn/studio/application/services/organization/InvitationService.java
@@ -34,7 +34,7 @@
 import com.svalyn.studio.domain.Failure;
 import com.svalyn.studio.domain.Success;
 import com.svalyn.studio.domain.account.repositories.IAccountRepository;
-import com.svalyn.studio.domain.authentication.UserIdProvider;
+import com.svalyn.studio.domain.account.UserIdProvider;
 import com.svalyn.studio.domain.message.api.IMessageService;
 import com.svalyn.studio.domain.organization.Invitation;
 import com.svalyn.studio.domain.organization.Organization;

diff --git a/...rc/main/java/com/svalyn/studio/application/services/organization/OrganizationService.java b/...rc/main/java/com/svalyn/studio/application/services/organization/OrganizationService.java
@@ -34,7 +34,7 @@
 import com.svalyn.studio.domain.Failure;
 import com.svalyn.studio.domain.Success;
 import com.svalyn.studio.domain.account.repositories.IAccountRepository;
-import com.svalyn.studio.domain.authentication.UserIdProvider;
+import com.svalyn.studio.domain.account.UserIdProvider;
 import com.svalyn.studio.domain.organization.Organization;
 import com.svalyn.studio.domain.organization.repositories.IOrganizationRepository;
 import com.svalyn.studio.domain.organization.services.api.IOrganizationCreationService;

diff --git a/backend/svalyn-studio-domain/pom.xml b/backend/svalyn-studio-domain/pom.xml
@@ -40,6 +40,25 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>
 
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <groupId>org.springframework.modulith</groupId>
+                <artifactId>spring-modulith-bom</artifactId>
+                <version>1.0.0</version>
+                <scope>import</scope>
+                <type>pom</type>
+            </dependency>
+            <dependency>
+                <groupId>org.jmolecules</groupId>
+                <artifactId>jmolecules-bom</artifactId>
+                <version>2023.1.0</version>
+                <scope>import</scope>
+                <type>pom</type>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+
     <dependencies>
         <dependency>
             <groupId>org.springframework.boot</groupId>
@@ -78,5 +97,29 @@
             <artifactId>org.eclipse.emf.ecore.xmi</artifactId>
             <version>2.17.0</version>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.modulith</groupId>
+            <artifactId>spring-modulith-core</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.jmolecules</groupId>
+            <artifactId>jmolecules-ddd</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.jmolecules</groupId>
+            <artifactId>jmolecules-events</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.modulith</groupId>
+            <artifactId>spring-modulith-starter-test</artifactId>
+            <version>1.0.0</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 </project>
diff --git a/backend/svalyn-studio-domain/src/main/java/com/svalyn/studio/domain/account/Account.java b/backend/svalyn-studio-domain/src/main/java/com/svalyn/studio/domain/account/Account.java
@@ -27,7 +27,7 @@
 import com.svalyn.studio.domain.account.events.AuthenticationTokenCreatedEvent;
 import com.svalyn.studio.domain.account.events.AuthenticationTokenModifiedEvent;
 import com.svalyn.studio.domain.account.events.OAuth2MetadataCreatedEvent;
-import com.svalyn.studio.domain.authentication.ProfileProvider;
+import org.jmolecules.ddd.annotation.AggregateRoot;
 import org.springframework.data.annotation.Id;
 import org.springframework.data.annotation.Transient;
 import org.springframework.data.domain.Persistable;
@@ -48,6 +48,7 @@
  *
  * @author sbegaudeau
  */
+@AggregateRoot
 @Table(name = "account")
 public class Account extends AbstractValidatingAggregateRoot<Account> implements Persistable<UUID> {
 

diff --git a/...lyn-studio-domain/src/main/java/com/svalyn/studio/domain/account/AuthenticationToken.java b/...lyn-studio-domain/src/main/java/com/svalyn/studio/domain/account/AuthenticationToken.java
@@ -19,6 +19,7 @@
 
 package com.svalyn.studio.domain.account;
 
+import org.jmolecules.ddd.annotation.Entity;
 import org.springframework.data.annotation.Id;
 import org.springframework.data.relational.core.mapping.Table;
 
@@ -31,6 +32,7 @@
  *
  * @author sbegaudeau
  */
+@Entity
 @Table(name = "authentication_token")
 public class AuthenticationToken {
 

diff --git a/...n/studio/domain/authentication/IUser.java → ...m/svalyn/studio/domain/account/IUser.java b/...n/studio/domain/authentication/IUser.java → ...m/svalyn/studio/domain/account/IUser.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 Stéphane Bégaudeau.
+ * Copyright (c) 2022-2023 Stéphane Bégaudeau.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
  * associated documentation files (the "Software"), to deal in the Software without restriction,
@@ -16,7 +16,7 @@
  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
-package com.svalyn.studio.domain.authentication;
+package com.svalyn.studio.domain.account;
 
 import java.util.UUID;
 

diff --git a/...d/svalyn-studio-domain/src/main/java/com/svalyn/studio/domain/account/OAuth2Metadata.java b/...d/svalyn-studio-domain/src/main/java/com/svalyn/studio/domain/account/OAuth2Metadata.java
@@ -19,6 +19,7 @@
 
 package com.svalyn.studio.domain.account;
 
+import org.jmolecules.ddd.annotation.Entity;
 import org.springframework.data.annotation.Id;
 import org.springframework.data.relational.core.mapping.Table;
 
@@ -31,6 +32,7 @@
  *
  * @author sbegaudeau
  */
+@Entity
 @Table(name = "oauth2_metadata")
 public class OAuth2Metadata {
 

diff --git a/...lyn-studio-domain/src/main/java/com/svalyn/studio/domain/account/PasswordCredentials.java b/...lyn-studio-domain/src/main/java/com/svalyn/studio/domain/account/PasswordCredentials.java
@@ -19,6 +19,7 @@
 
 package com.svalyn.studio.domain.account;
 
+import org.jmolecules.ddd.annotation.Entity;
 import org.springframework.data.annotation.Id;
 import org.springframework.data.relational.core.mapping.Table;
 
@@ -31,6 +32,7 @@
  *
  * @author sbegaudeau
  */
+@Entity
 @Table(name = "password_credentials")
 public class PasswordCredentials {
 

diff --git a/...omain/authentication/ProfileProvider.java → ...tudio/domain/account/ProfileProvider.java b/...omain/authentication/ProfileProvider.java → ...tudio/domain/account/ProfileProvider.java
@@ -17,7 +17,7 @@
  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-package com.svalyn.studio.domain.authentication;
+package com.svalyn.studio.domain.account;
 
 import com.svalyn.studio.domain.Profile;
 import org.springframework.security.core.Authentication;

diff --git a/...domain/authentication/UserIdProvider.java → ...studio/domain/account/UserIdProvider.java b/...domain/authentication/UserIdProvider.java → ...studio/domain/account/UserIdProvider.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 Stéphane Bégaudeau.
+ * Copyright (c) 2022-2023 Stéphane Bégaudeau.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
  * associated documentation files (the "Software"), to deal in the Software without restriction,
@@ -16,9 +16,8 @@
  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
-package com.svalyn.studio.domain.authentication;
+package com.svalyn.studio.domain.account;
 
-import com.svalyn.studio.domain.account.Account;
 import org.springframework.data.jdbc.core.mapping.AggregateReference;
 import org.springframework.security.core.Authentication;
 import org.springframework.security.core.context.SecurityContextHolder;

diff --git a/...dio-domain/src/main/java/com/svalyn/studio/domain/account/events/AccountCreatedEvent.java b/...dio-domain/src/main/java/com/svalyn/studio/domain/account/events/AccountCreatedEvent.java
@@ -21,6 +21,7 @@
 import com.svalyn.studio.domain.Profile;
 import com.svalyn.studio.domain.account.Account;
 import jakarta.validation.constraints.NotNull;
+import org.jmolecules.event.annotation.DomainEvent;
 
 import java.time.Instant;
 import java.util.UUID;
@@ -30,6 +31,7 @@
  *
  * @author sbegaudeau
  */
+@DomainEvent
 public record AccountCreatedEvent(
         @NotNull UUID id,
         @NotNull Instant createdOn,

diff --git a/...dio-domain/src/main/java/com/svalyn/studio/domain/account/events/AccountDeletedEvent.java b/...dio-domain/src/main/java/com/svalyn/studio/domain/account/events/AccountDeletedEvent.java
@@ -22,6 +22,7 @@
 import com.svalyn.studio.domain.Profile;
 import com.svalyn.studio.domain.account.Account;
 import jakarta.validation.constraints.NotNull;
+import org.jmolecules.event.annotation.DomainEvent;
 
 import java.time.Instant;
 import java.util.UUID;
@@ -31,6 +32,7 @@
  *
  * @author sbegaudeau
  */
+@DomainEvent
 public record AccountDeletedEvent(
         @NotNull UUID id,
         @NotNull Instant createdOn,

diff --git a/...io-domain/src/main/java/com/svalyn/studio/domain/account/events/AccountModifiedEvent.java b/...io-domain/src/main/java/com/svalyn/studio/domain/account/events/AccountModifiedEvent.java
@@ -21,6 +21,7 @@
 import com.svalyn.studio.domain.Profile;
 import com.svalyn.studio.domain.account.Account;
 import jakarta.validation.constraints.NotNull;
+import org.jmolecules.event.annotation.DomainEvent;
 
 import java.time.Instant;
 import java.util.UUID;
@@ -30,6 +31,7 @@
  *
  * @author sbegaudeau
  */
+@DomainEvent
 public record AccountModifiedEvent(
         @NotNull UUID id,
         @NotNull Instant createdOn,

diff --git a/...rc/main/java/com/svalyn/studio/domain/account/events/AuthenticationTokenCreatedEvent.java b/...rc/main/java/com/svalyn/studio/domain/account/events/AuthenticationTokenCreatedEvent.java
@@ -22,6 +22,7 @@
 import com.svalyn.studio.domain.Profile;
 import com.svalyn.studio.domain.account.Account;
 import jakarta.validation.constraints.NotNull;
+import org.jmolecules.event.annotation.DomainEvent;
 
 import java.time.Instant;
 import java.util.UUID;
@@ -31,6 +32,7 @@
  *
  * @author sbegaudeau
  */
+@DomainEvent
 public record AuthenticationTokenCreatedEvent(
         @NotNull UUID id,
         @NotNull Instant createdOn,

diff --git a/...c/main/java/com/svalyn/studio/domain/account/events/AuthenticationTokenModifiedEvent.java b/...c/main/java/com/svalyn/studio/domain/account/events/AuthenticationTokenModifiedEvent.java
@@ -22,6 +22,7 @@
 import com.svalyn.studio.domain.Profile;
 import com.svalyn.studio.domain.account.Account;
 import jakarta.validation.constraints.NotNull;
+import org.jmolecules.event.annotation.DomainEvent;
 
 import java.time.Instant;
 import java.util.UUID;
@@ -31,6 +32,7 @@
  *
  * @author sbegaudeau
  */
+@DomainEvent
 public record AuthenticationTokenModifiedEvent(
         @NotNull UUID id,
         @NotNull Instant createdOn,

diff --git a/...ain/src/main/java/com/svalyn/studio/domain/account/events/OAuth2MetadataCreatedEvent.java b/...ain/src/main/java/com/svalyn/studio/domain/account/events/OAuth2MetadataCreatedEvent.java
@@ -22,6 +22,7 @@
 import com.svalyn.studio.domain.Profile;
 import com.svalyn.studio.domain.account.Account;
 import jakarta.validation.constraints.NotNull;
+import org.jmolecules.event.annotation.DomainEvent;
 
 import java.time.Instant;
 import java.util.UUID;
@@ -31,6 +32,7 @@
  *
  * @author sbegaudeau
  */
+@DomainEvent
 public record OAuth2MetadataCreatedEvent(
         @NotNull UUID id,
         @NotNull Instant createdOn,

diff --git a/...end/svalyn-studio-domain/src/main/java/com/svalyn/studio/domain/account/package-info.java b/...end/svalyn-studio-domain/src/main/java/com/svalyn/studio/domain/account/package-info.java
@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2023 Stéphane Bégaudeau.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+ * associated documentation files (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+ * LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+/**
+ * The account bounded context.
+ *
+ * @author sbegaudeau
+ */
+@ApplicationModule(
+        allowedDependencies = { "message::api" }
+)
+package com.svalyn.studio.domain.account;
+
+import org.springframework.modulith.ApplicationModule;