Upgrade to DynamiaTools 5.4.7 and improved javadocs#10
Upgrade to DynamiaTools 5.4.7 and improved javadocs#10marioserrano09 merged 2 commits intomasterfrom
Conversation
… asynchronous methods Signed-off-by: Mario Serrano <mario@dynamiasoluciones.com>
… UI, and update dependencies Signed-off-by: Mario Serrano <mario@dynamiasoluciones.com>
There was a problem hiding this comment.
Pull request overview
This PR upgrades the project's dependencies and enhances API documentation. The main change is upgrading from DynamiaTools 5.4.0 to 5.4.7, along with updating Spring Boot to 3.5.8 and AWS SDK to 2.39.5. The module version is bumped from 3.4.0 to 3.5.0.
Key changes include:
- Migration from
FuturetoCompletableFuturereturn types in async email and OTP service methods - Comprehensive javadoc improvements across service interfaces with detailed parameter descriptions, return value documentation, and usage examples
- Cleanup of unused imports and removal of leading blank lines in some source files
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| sources/pom.xml | Updated parent module version to 3.5.0 and upgraded dependencies: DynamiaTools (5.4.0→5.4.7), SaaS (3.4.0→3.5.0), Spring Boot (3.5.3→3.5.8), AWS SDK (2.31.61→2.39.5) |
| sources/core/pom.xml | Updated module and parent version to 3.5.0 |
| sources/ui/pom.xml | Updated module, parent, and email dependency versions to 3.5.0 |
| sources/core/src/main/java/tools/dynamia/modules/email/services/impl/OTPServiceImpl.java | Changed return type from Future to CompletableFuture, removed unused TaskWithResult import, updated to use lambda with SchedulerUtil.runWithResult() |
| sources/core/src/main/java/tools/dynamia/modules/email/services/impl/EmailServiceImpl.java | Changed return type from Future to CompletableFuture for async send methods |
| sources/core/src/main/java/tools/dynamia/modules/email/services/SMSService.java | Enhanced interface and method javadocs with detailed descriptions, parameter documentation, and return value specifications |
| sources/core/src/main/java/tools/dynamia/modules/email/services/OTPService.java | Added comprehensive class and method javadocs, changed return type from Future to CompletableFuture, added CompletableFuture import |
| sources/core/src/main/java/tools/dynamia/modules/email/services/EmailService.java | Extensively improved javadocs for all methods with detailed parameter descriptions and usage guidance, changed return types from Future to CompletableFuture, removed unused import |
| sources/core/src/main/java/tools/dynamia/modules/email/SMSServiceListener.java | Enhanced interface and method javadocs with lifecycle explanations and usage guidelines, documented the "Sended" naming for backward compatibility |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| import tools.dynamia.modules.email.OTPSendResult; | ||
|
|
||
| import java.util.concurrent.CompletableFuture; | ||
| import java.util.concurrent.Future; |
There was a problem hiding this comment.
Unused import: java.util.concurrent.Future is imported but no longer used in this interface. The return type has been changed to CompletableFuture and this import should be removed.
| import java.util.concurrent.Future; |
| * <p> | ||
| * The selected transport(s) depend on implementation and the {@link OTPMessage} fields (e.g., presence of | ||
| * email address, phone number, or explicit channel selection). Delivery may happen asynchronously; use the | ||
| * returned {@link Future} to check completion and obtain the {@link OTPSendResult}. |
There was a problem hiding this comment.
Inconsistent documentation: The javadoc references {@link Future} but the actual return type is CompletableFuture. The javadoc should be updated to {@link CompletableFuture} for accuracy.
| * @return a {@link Future} that completes with {@link OTPSendResult} indicating success, failure, and relevant | ||
| * details (e.g., which channels were used). The future may complete exceptionally if an unrecoverable error occurs. |
There was a problem hiding this comment.
Inconsistent documentation: The javadoc references {@link Future} but the actual return type is CompletableFuture. The javadoc should be updated to {@link CompletableFuture} for accuracy.
1 participant
No description provided.