Microservices pattern : Self-Registration #3245
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
PR SummaryThis PR implements a microservices self-registration pattern using Spring Boot, Eureka, and OpenFeign. It includes a Eureka server and two microservices (Greeting and Context) that register with Eureka and communicate with each other. The project also includes unit tests and health checks. Changes
autogenerated by presubmit.ai |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (4)
Files Processed (30)
- microservices-self-registration/README.md (1 hunk)
- microservices-self-registration/contextservice/.gitattributes (1 hunk)
- microservices-self-registration/contextservice/.gitignore (1 hunk)
- microservices-self-registration/contextservice/.mvn/wrapper/maven-wrapper.properties (1 hunk)
- microservices-self-registration/contextservice/application.log.2025-04-05.0.gz (0 hunks)
- microservices-self-registration/contextservice/mvnw (1 hunk)
- microservices-self-registration/contextservice/mvnw.cmd (1 hunk)
- microservices-self-registration/contextservice/pom.xml (1 hunk)
- microservices-self-registration/contextservice/src/main/java/com/learning/contextservice/ContextserviceApplication.java (1 hunk)
- microservices-self-registration/contextservice/src/main/java/com/learning/contextservice/MyCustomHealthCheck.java (1 hunk)
- microservices-self-registration/contextservice/src/main/java/com/learning/contextservice/client/GreetingServiceClient.java (1 hunk)
- microservices-self-registration/contextservice/src/main/java/com/learning/contextservice/controller/ContextController.java (1 hunk)
- microservices-self-registration/contextservice/src/main/resources/application.yml (1 hunk)
- microservices-self-registration/contextservice/src/test/java/com/learning/contextservice/ContextControllerTest.java (1 hunk)
- microservices-self-registration/contextservice/src/test/java/com/learning/contextservice/ContextserviceApplicationTests.java (1 hunk)
- microservices-self-registration/eurekaserver/.gitattributes (1 hunk)
- microservices-self-registration/eurekaserver/.gitignore (1 hunk)
- microservices-self-registration/eurekaserver/.mvn/wrapper/maven-wrapper.properties (1 hunk)
- microservices-self-registration/eurekaserver/mvnw (1 hunk)
- microservices-self-registration/eurekaserver/mvnw.cmd (1 hunk)
- microservices-self-registration/eurekaserver/pom.xml (1 hunk)
- microservices-self-registration/eurekaserver/src/main/java/com/learning/eurekaserver/EurekaserverApplication.java (1 hunk)
- microservices-self-registration/eurekaserver/src/main/resources/application.yml (1 hunk)
- microservices-self-registration/eurekaserver/src/test/java/com/learning/eurekaserver/EurekaserverApplicationTests.java (1 hunk)
- microservices-self-registration/greetingservice/.gitattributes (1 hunk)
- microservices-self-registration/greetingservice/.gitignore (1 hunk)
- microservices-self-registration/greetingservice/.mvn/wrapper/maven-wrapper.properties (1 hunk)
- microservices-self-registration/greetingservice/application.log.2025-04-05.0.gz (0 hunks)
- microservices-self-registration/greetingservice/mvnw (1 hunk)
- microservices-self-registration/greetingservice/mvnw.cmd (1 hunk)
Actionable Comments (0)
Skipped Comments (0)
iluwatar
requested changes
Apr 7, 2025
iluwatar
requested changes
Apr 7, 2025
microservices-self-registration/contextservice/.mvn/wrapper/maven-wrapper.properties
Outdated
Show resolved
Hide resolved
...gistration/contextservice/src/main/java/com/learning/contextservice/MyCustomHealthCheck.java
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (1)
- 93c6653: Merge branch 'iluwatar:master' into master
Files Processed (5)
- microservices-self-registration/README.md (1 hunk)
- microservices-self-registration/contextservice/application.log.2025-04-05.0.gz (0 hunks)
- microservices-self-registration/contextservice/pom.xml (1 hunk)
- microservices-self-registration/contextservice/src/test/java/com/learning/contextservice/ContextControllerTest.java (1 hunk)
- microservices-self-registration/greetingservice/application.log.2025-04-05.0.gz (0 hunks)
Actionable Comments (0)
Skipped Comments (0)
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (3)
- 030643b: Merge branch 'master' of https://github.com/naman-sriv/java-design-patterns
- 796b421: Merge branch 'master' of https://github.com/naman-sriv/java-design-patterns
- 13bc41f: pom.xml, clean up, java version update and slf4j logging added
Files Processed (5)
- microservices-self-registration/contextservice/application.log.2025-04-07.0.gz (0 hunks)
- microservices-self-registration/contextservice/pom.xml (1 hunk)
- microservices-self-registration/contextservice/src/main/java/com/learning/contextservice/MyCustomHealthCheck.java (1 hunk)
- microservices-self-registration/eurekaserver/pom.xml (1 hunk)
- microservices-self-registration/greetingservice/application.log.2025-04-07.0.gz (0 hunks)
Actionable Comments (0)
Skipped Comments (0)
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (1)
- 20d34ec: pom files updated
Files Processed (2)
- microservices-self-registration/contextservice/pom.xml (1 hunk)
- microservices-self-registration/eurekaserver/pom.xml (1 hunk)
Actionable Comments (0)
Skipped Comments (0)
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (1)
- c2c13ae: Merge branch 'iluwatar:master' into master
Files Processed (0)
Actionable Comments (0)
Skipped Comments (0)
iluwatar
requested changes
Apr 10, 2025
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (1)
- 17d019f: Merge branch 'iluwatar:master' into master
Files Processed (0)
Actionable Comments (0)
Skipped Comments (0)
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (3)
- 142fe8b: Merge branch 'master' of https://github.com/naman-sriv/java-design-patterns
- 8b08728: Microservice-self-registration added to pom file
- 2bd955d: Removed children maven wrappers
Files Processed (2)
- microservices-self-registration/contextservice/application.log.2025-04-09.0.gz (0 hunks)
- microservices-self-registration/greetingservice/application.log.2025-04-09.0.gz (0 hunks)
Actionable Comments (0)
Skipped Comments (0)
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (1)
- d06d61e: POM file updated for self-registration
Files Processed (0)
Actionable Comments (0)
Skipped Comments (0)
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (1)
- aa788f0: pom file updated
Files Processed (0)
Actionable Comments (0)
Skipped Comments (0)
correction to mudule name
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (2)
- 7d0152b: Merge branch 'master' of https://github.com/naman-sriv/java-design-patterns
- 6b1c680: SonarQube comments addressed
Files Processed (4)
- microservices-self-registration/contextservice/src/main/java/com/learning/contextservice/controller/ContextController.java (1 hunk)
- microservices-self-registration/contextservice/src/test/java/com/learning/contextservice/ContextControllerTest.java (1 hunk)
- microservices-self-registration/contextservice/src/test/java/com/learning/contextservice/ContextserviceApplicationTests.java (1 hunk)
- microservices-self-registration/eurekaserver/src/test/java/com/learning/eurekaserver/EurekaserverApplicationTests.java (1 hunk)
Actionable Comments (0)
Skipped Comments (1)
-
microservices-self-registration/contextservice/src/test/java/com/learning/contextservice/ContextControllerTest.java [28-35]
enhancement: "Improve ContextControllerTest test robustness."
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (1)
- ab2c8ac: sonarqube comments on coverage addressed
Files Processed (3)
- microservices-self-registration/application.log.2025-04-09.0.gz (0 hunks)
- microservices-self-registration/contextservice/src/test/java/com/learning/contextservice/ContextControllerTest.java (1 hunk)
- microservices-self-registration/contextservice/src/test/java/com/learning/contextservice/TestConfig.java (1 hunk)
Actionable Comments (0)
Skipped Comments (1)
-
microservices-self-registration/contextservice/src/test/java/com/learning/contextservice/ContextControllerTest.java [20-50]
best practice: "Use @WebMvcTest for unit tests."
There was a problem hiding this comment.
🚨 Pull request needs attention.
Review Summary
Commits Considered (1)
- c4b33cd: Code coverage for custom health checks
Files Processed (1)
- microservices-self-registration/contextservice/src/test/java/com/learning/contextservice/myCustomHealthCheckTest.java (1 hunk)
Actionable Comments (1)
-
microservices-self-registration/contextservice/src/test/java/com/learning/contextservice/myCustomHealthCheckTest.java [40-59]
possible bug: "Flaky test due to time dependency."
Skipped Comments (0)
Comment on lines
40
to
59
| // Force performHealthCheck to return true (by time simulation - might be flaky) | ||
| long currentTimeForTrue = System.currentTimeMillis(); | ||
| while (currentTimeForTrue % 10000 >= 5000) { | ||
| Thread.sleep(10); // Wait until time is in the "true" range | ||
| currentTimeForTrue = System.currentTimeMillis(); | ||
| } | ||
| ReflectionTestUtils.invokeMethod(healthCheck, "performHealthCheck"); | ||
| healthCheck.updateHealthStatus(); | ||
| assertTrue((Boolean) ReflectionTestUtils.getField(healthCheck, "isHealthy"), "Health should be true"); | ||
|
|
||
| // Force performHealthCheck to return false (by time simulation - might be flaky) | ||
| long currentTimeForFalse = System.currentTimeMillis(); | ||
| while (currentTimeForFalse % 10000 < 5000) { | ||
| Thread.sleep(10); // Wait until time is in the "false" range | ||
| currentTimeForFalse = System.currentTimeMillis(); | ||
| } | ||
| ReflectionTestUtils.invokeMethod(healthCheck, "performHealthCheck"); | ||
| healthCheck.updateHealthStatus(); | ||
| assertFalse((Boolean) ReflectionTestUtils.getField(healthCheck, "isHealthy"), "Health should be false"); | ||
| } |
There was a problem hiding this comment.
The test relies on time-based conditions (lines 40-45 and 50-55), which can lead to flaky test results. Consider refactoring to remove the time dependency or use a mocking framework to simulate the behavior of performHealthCheck.
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (1)
- edb73c1: changes for unit tests
Files Processed (3)
- microservices-self-registration/contextservice/src/main/java/com/learning/contextservice/MyCustomHealthCheck.java (1 hunk)
- microservices-self-registration/contextservice/src/test/java/com/learning/contextservice/myCustomHealthCheckTest.java (1 hunk)
- microservices-self-registration/eurekaserver/pom.xml (1 hunk)
Actionable Comments (0)
Skipped Comments (1)
-
microservices-self-registration/contextservice/src/main/java/com/learning/contextservice/MyCustomHealthCheck.java [26-29]
possible issue: "Improve health check simulation."
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (1)
- 84b6676: changes for unit tests
Files Processed (1)
- microservices-self-registration/contextservice/src/test/java/com/learning/contextservice/myCustomHealthCheckTest.java (1 hunk)
Actionable Comments (0)
Skipped Comments (1)
-
microservices-self-registration/contextservice/src/test/java/com/learning/contextservice/myCustomHealthCheckTest.java [1-43]
enhancement: "Add negative test cases for health check."
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (1)
- fcf605d: changes to for code coverage improvement
Files Processed (5)
- microservices-self-registration/contextservice/src/main/java/com/learning/contextservice/MyCustomHealthCheck.java (1 hunk)
- microservices-self-registration/contextservice/src/main/java/com/learning/contextservice/client/GreetingServiceClient.java (1 hunk)
- microservices-self-registration/contextservice/src/test/java/com/learning/contextservice/ContextControllerTest.java (1 hunk)
- microservices-self-registration/contextservice/src/test/java/com/learning/contextservice/myCustomHealthCheckTest.java (1 hunk)
- microservices-self-registration/greetingservice/application.log.2025-04-11.0.gz (0 hunks)
Actionable Comments (0)
Skipped Comments (1)
-
microservices-self-registration/contextservice/src/main/java/com/learning/contextservice/MyCustomHealthCheck.java [26-29]
possible issue: "Improve health check simulation."
|
iluwatar
requested changes
Apr 12, 2025
There was a problem hiding this comment.
Additionally, please remove the log archives such as:
microservices-self-registration/application.log.2025-04-09.0.gz
microservices-self-registration/contextservice/application.log.2025-04-05.0.gz
microservices-self-registration/contextservice/application.log.2025-04-07.0.gz
microservices-self-registration/contextservice/application.log.2025-04-09.0.gz
We don't need those stored in the repository.
| <artifactId>spring-boot-starter-parent</artifactId> | ||
| <version>3.4.4</version> | ||
| <relativePath/> </parent> | ||
| <groupId>com.learning</groupId> |
| @Component("myCustomHealthCheck") | ||
| public class MyCustomHealthCheck implements HealthIndicator { | ||
|
|
||
| private static final Logger log = LoggerFactory.getLogger(MyCustomHealthCheck.class); |
There was a problem hiding this comment.
Use Lombok annotation @slf4j for logging
|
|
||
| boolean performHealthCheck() { | ||
| boolean current = System.currentTimeMillis() % 10000 < 5000; // Simulate fluctuating health | ||
| log.debug("Performing health check, current status: {}", current); |
There was a problem hiding this comment.
Remove debug-level logging not to spam the output
Comment on lines
+43
to
+62
| <properties> | ||
| <java.version>21</java.version> | ||
| <maven.compiler.source>${java.version}</maven.compiler.source> | ||
| <maven.compiler.target>${java.version}</maven.compiler.target> | ||
| </properties> | ||
|
|
||
| <build> | ||
| <pluginManagement> | ||
| <plugins> | ||
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-compiler-plugin</artifactId> | ||
| <version>3.8.1</version> <configuration> | ||
| <source>${maven.compiler.source}</source> | ||
| <target>${maven.compiler.target}</target> | ||
| </configuration> | ||
| </plugin> | ||
| </plugins> | ||
| </pluginManagement> | ||
| </build> |
There was a problem hiding this comment.
I think you can use the maven-compiler-plugin from the parent pom.xml, so all this can be left out. This helps in maintenance work.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Template
What does this PR do?
Implemented the Microservices Self-Registration pattern using Spring Boot (3.4.4) and Eureka. This PR includes the Eureka Server setup and two microservices (Greeting and Context) that register with Eureka and communicate using OpenFeign. Key Spring Cloud dependencies include Eureka Discovery Client, Eureka Server, and OpenFeign.