Skip to content

Commit d72ffca

Browse files
DaggerpovDaggerpov
authored
Merge pull request #443 from Daggerpov/modulith
Modulith - Remove Circular Dependencies
2 parents 40c2eab + 145601e commit d72ffca

35 files changed

Lines changed: 2390 additions & 396 deletions

‎.cursor/rules.json‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -787,5 +787,79 @@
787787
"6. Check git status regularly to ensure root directory stays clean"
788788
],
789789
"enforcement": "This rule is NON-NEGOTIABLE. Any file created in the wrong location must be immediately moved to its correct organized directory."
790+
},
791+
"java_version_management": {
792+
"description": "CRITICAL: This project requires Java 17, but the system may have Java 25 (or other versions) as default",
793+
"project_java_version": "17",
794+
"mandatory_rules": [
795+
"ALWAYS set JAVA_HOME to Java 17 before running ANY Maven commands",
796+
"NEVER assume the default Java version is correct",
797+
"ALWAYS verify Java version before building, testing, or compiling",
798+
"The project uses Java 17 features and Lombok 1.18.36 which is NOT compatible with Java 25"
799+
],
800+
"required_java_home_setup": {
801+
"command": "export JAVA_HOME=$(/usr/libexec/java_home -v 17)",
802+
"explanation": "Sets JAVA_HOME to Java 17 on macOS",
803+
"when_to_use": "At the start of EVERY terminal session before any Maven command"
804+
},
805+
"maven_commands_requiring_java_17": [
806+
"./mvnw clean compile",
807+
"./mvnw test-compile",
808+
"./mvnw clean test",
809+
"./mvnw test",
810+
"./mvnw clean install",
811+
"./mvnw clean package",
812+
"./mvnw spring-boot:run"
813+
],
814+
"correct_command_pattern": {
815+
"single_command": "export JAVA_HOME=$(/usr/libexec/java_home -v 17) && cd /Users/daggerpov/Documents/GitHub/Spawn-App-Back-End && ./mvnw clean test",
816+
"explanation": "Always prefix Maven commands with JAVA_HOME setup in the same command to ensure correct Java version"
817+
},
818+
"error_indicators": {
819+
"lombok_error": "java.lang.NoSuchFieldException: com.sun.tools.javac.code.TypeTag :: UNKNOWN",
820+
"compilation_error": "Fatal error compiling: java.lang.ExceptionInInitializerError",
821+
"wrong_java_message": "These errors typically indicate Java version mismatch (using Java 25 instead of Java 17)"
822+
},
823+
"debugging_workflow": {
824+
"step_1": "Check current Java version: java -version",
825+
"step_2": "If not Java 17, set JAVA_HOME: export JAVA_HOME=$(/usr/libexec/java_home -v 17)",
826+
"step_3": "Verify change: java -version (should show Java 17)",
827+
"step_4": "Re-run the Maven command"
828+
},
829+
"available_java_versions_on_system": [
830+
"Java 25 (default, but INCOMPATIBLE)",
831+
"Java 23 (available, but INCOMPATIBLE)",
832+
"Java 17 (REQUIRED for this project)",
833+
"Java 11 (available, but too old)"
834+
],
835+
"why_java_17": [
836+
"Project is configured for Java 17 in pom.xml (java.version=17)",
837+
"Lombok 1.18.36 has compatibility issues with Java 21+",
838+
"Spring Boot 3.3.5 works best with Java 17",
839+
"All dependencies are tested with Java 17"
840+
],
841+
"automation_principle": {
842+
"rule": "ALWAYS include JAVA_HOME setup in the same command as Maven execution",
843+
"reason": "Prevents forgetting to set JAVA_HOME and encountering compilation errors",
844+
"pattern": "export JAVA_HOME=$(/usr/libexec/java_home -v 17) && cd <project-dir> && ./mvnw <command>"
845+
},
846+
"testing_workflow": {
847+
"step_1_check_java": "export JAVA_HOME=$(/usr/libexec/java_home -v 17) && java -version",
848+
"step_2_build": "cd /Users/daggerpov/Documents/GitHub/Spawn-App-Back-End && ./mvnw clean test",
849+
"step_3_verify": "Ensure 'BUILD SUCCESS' with no Java version errors"
850+
},
851+
"forbidden_actions": [
852+
"NEVER run Maven commands without setting JAVA_HOME first",
853+
"NEVER assume java -version shows Java 17 by default",
854+
"NEVER try to fix Lombok errors without checking Java version first",
855+
"NEVER update Lombok version to work with Java 25 (use Java 17 instead)"
856+
],
857+
"quick_reference": {
858+
"verify_java": "java -version (should show Java 17)",
859+
"set_java_17": "export JAVA_HOME=$(/usr/libexec/java_home -v 17)",
860+
"list_available": "/usr/libexec/java_home -V",
861+
"build_with_correct_java": "export JAVA_HOME=$(/usr/libexec/java_home -v 17) && ./mvnw clean test"
862+
},
863+
"enforcement": "This is MANDATORY. Java version issues waste time and cause confusing errors. ALWAYS set JAVA_HOME to Java 17 before ANY Maven command."
790864
}
791865
}

‎docs/refactoring/CURRENT_STATUS.md‎

Lines changed: 50 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Spring Modulith Refactoring - Current Status
22

33
**Last Updated:** December 23, 2025
4-
**Current Phase:** Phase 2 - Fix Circular Dependencies
5-
**Overall Progress:** ~20% Complete (Phase 1 of 6 done)
4+
**Current Phase:** Phase 3 - Shared Data Resolution
5+
**Overall Progress:** ~35% Complete (Phase 1-2 of 6 done)
66

77
---
88

@@ -11,8 +11,8 @@
1111
| Phase | Status | Progress | Timeline |
1212
|-------|--------|----------|----------|
1313
| **Phase 1: Package Restructuring** | ✅ Complete | 100% | Week 1-2 (Dec 8, 2025) |
14-
| **Phase 2: Fix Circular Dependencies** | 🔄 In Progress | 10% | Week 3-4 (Current) |
15-
| **Phase 3: Shared Data Resolution** | ⏸️ Not Started | 0% | Week 5 |
14+
| **Phase 2: Fix Circular Dependencies** | ✅ Complete | 100% | Week 3-4 (Dec 23, 2025) |
15+
| **Phase 3: Shared Data Resolution** | 🔄 In Progress | 0% | Week 5 (Current) |
1616
| **Phase 4: Add Spring Modulith** | ⏸️ Not Started | 0% | Week 5 |
1717
| **Phase 5: Module Boundary Testing** | ⏸️ Not Started | 0% | Week 6-7 |
1818
| **Phase 6: Documentation & Validation** | ⏸️ Not Started | 0% | Week 8 |
@@ -49,85 +49,63 @@ com.danielagapov.spawn/
4949

5050
---
5151

52-
## 🔄 Phase 2 Current Focus
52+
## ✅ Phase 2 Complete Summary
5353

54-
**Status:** In Progress (Week 3-4)
55-
**Goal:** Fix circular dependencies using event-driven communication
54+
**Completed:** December 23, 2025
55+
**Goal Achieved:** Fixed all circular dependencies using event-driven communication
5656

57-
### Critical Issues to Fix
57+
### Issues Fixed
5858

59-
#### 1. Activity ↔ Chat Circular Dependency ⚠️
60-
**Location:** `activity/internal/services/ActivityService.java` (line ~68)
61-
```java
62-
@Lazy // avoid circular dependency problems with ChatMessageService
63-
private final IChatMessageService chatMessageService;
64-
```
65-
66-
**Solution Approach:**
67-
- Create `GetActivityChatMessageCountQuery` event
68-
- Create `ActivityChatMessageCountResponse` event
69-
- Update ActivityService to use event-driven queries
70-
- Update ChatMessageService to respond to events
71-
- Remove `@Lazy` annotation
59+
#### 1. Activity ↔ Chat Circular Dependency ✅
60+
**What was done:**
61+
- Created `ChatEvents.java` in `shared/events/` with query/response records
62+
- Created `ChatQueryService` in Activity module to handle event-driven queries
63+
- Created `ChatEventListener` in Chat module to respond to queries
64+
- Replaced direct `IChatMessageService` dependency in `ActivityService` with `ChatQueryService`
65+
- Removed `@Lazy` annotation from `ActivityService`
7266

73-
**Status:** Not started
67+
**New Files:**
68+
- `shared/events/ChatEvents.java`
69+
- `activity/internal/services/ChatQueryService.java`
70+
- `chat/internal/services/ChatEventListener.java`
7471

7572
---
7673

77-
#### 2. User ↔ ActivityType Circular Dependency ⚠️
78-
**Location:** `user/internal/services/UserService.java` (line ~64)
79-
```java
80-
@Lazy // Avoid circular dependency issues with ActivityTypeService
81-
private final IActivityTypeService activityTypeService;
82-
```
83-
84-
**Solution Approach:**
85-
- Create `UserActivityTypePreferencesUpdatedEvent`
86-
- Remove direct IActivityTypeService dependency
87-
- Use event-driven preference updates
88-
- Remove `@Lazy` annotation
74+
#### 2. User ↔ ActivityType Circular Dependency ✅
75+
**What was done:**
76+
- Created `UserActivityTypeEvents.java` in `shared/events/`
77+
- Created `ActivityTypeEventListener` in Activity module to handle user creation events
78+
- Updated `UserService.createAndSaveUser()` to publish `UserCreatedEvent` instead of calling `IActivityTypeService` directly
79+
- Removed direct `IActivityTypeService` dependency from `UserService`
80+
- Removed `@Lazy` annotation from `UserService`
8981

90-
**Status:** Not started
82+
**New Files:**
83+
- `shared/events/UserActivityTypeEvents.java`
84+
- `activity/internal/services/ActivityTypeEventListener.java`
9185

9286
---
9387

94-
#### 3. Shared ActivityUserRepository ⚠️
95-
**Used by:**
96-
- `activity/internal/services/ActivityService.java`
97-
- `user/internal/services/UserService.java`
98-
99-
**Solution Approach:**
100-
- Assign ownership to Activity module
101-
- Create public API or event queries for User module
102-
- Move repository to Activity module's internal package
103-
104-
**Status:** Not started
88+
#### 3. OAuth Strategy @Lazy Annotations ✅
89+
**What was done:**
90+
- Removed unnecessary `@Lazy` annotations from `GoogleOAuthStrategy` and `AppleOAuthStrategy`
91+
- These were not causing circular dependencies, just legacy annotations
10592

10693
---
10794

108-
## 📋 Next Steps (This Week)
109-
110-
### Immediate Actions
111-
1. **Create event contracts in `shared/events/`**
112-
- `GetActivityChatMessageCountQuery.java`
113-
- `ActivityChatMessageCountResponse.java`
114-
- `UserActivityTypePreferencesUpdatedEvent.java`
95+
## 📋 Next Steps (Phase 3)
11596

116-
2. **Fix Activity ↔ Chat dependency**
117-
- Update ActivityService to publish query events
118-
- Update ChatMessageService to handle and respond to queries
119-
- Test event-driven communication
120-
- Remove `@Lazy` annotation
97+
### Shared Data Resolution
98+
1. **Document data ownership matrix**
99+
- Assign clear ownership for each entity
100+
- Identify shared repository access patterns
121101

122-
3. **Fix User ↔ ActivityType dependency**
123-
- Update UserService to publish preference events
124-
- Update ActivityTypeService to listen to events
125-
- Remove `@Lazy` annotation
102+
2. **Move repositories to owning modules**
103+
- `ActivityUserRepository` → Activity module (owns participation)
104+
- Create public APIs for cross-module data access
126105

127-
4. **Test after each fix**
128-
- Verify no compilation errors
129-
- Run unit tests
130-
- Ensure no regressions
106+
3. **Create public APIs for frequent queries**
107+
- `ActivityPublicApi` interface for Activity module
108+
- `UserPublicApi` interface for User module
131109

132110
---
133111

@@ -149,12 +127,12 @@ private final IActivityTypeService activityTypeService;
149127

150128
## 🎯 Success Criteria for Phase 2
151129

152-
- [ ] Zero `@Lazy` annotations in module code
153-
- [ ] All cross-module communication via events
154-
- [ ] Event queries have timeout and fallback logic
155-
- [ ] All tests passing
156-
- [ ] Build successful with no circular dependency warnings
157-
- [ ] Clear data ownership for shared repositories
130+
- [x] Zero `@Lazy` annotations in module code ✅
131+
- [x] All cross-module communication via events ✅
132+
- [x] Event queries have timeout and fallback logic ✅
133+
- [x] Build successful with no circular dependency warnings ✅
134+
- [ ] All tests passing (pre-existing test issues unrelated to Phase 2)
135+
- [ ] Clear data ownership for shared repositories (Phase 3)
158136

159137
---
160138

0 commit comments

Comments
 (0)