Set Eureka InstanceInfo to endpoint attribute #6069
+229
−27
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
Ivan-Montes
requested review from
ikhoon,
jrhee17,
minwoox and
trustin
as code owners
|
|
minwoox
reviewed
Jan 14, 2025
| @@ -399,6 +400,24 @@ public List<Endpoint> apply(byte[] content) { | |||
| } | |||
| } | |||
|
|
|||
| private static final class EurekaInstanceInfoUtil { | |||
There was a problem hiding this comment.
Let's:
- Remove this class because users cannot access this class to retrieve
InstanceInfo - Move
com.linecorp.armeria.internal.common.eureka.InstanceInfotocom.linecorp.armeria.common.eureka.InstanceInfo - Move the methods to the
InstanceInfoclass - Add a test to verify that users can retrieve the
InstanceInfo
There was a problem hiding this comment.
Okay, thanks for the steps. I will work on it.
There was a problem hiding this comment.
I would like your opinion on my approach for resolving some exceptions in the CI workflow and to know whether the potential modifications align with the project.
Motivation:
Since it is ensured that the public API does not expose the shaded classes, after moving com.linecorp.armeria.internal.common.eureka.InstanceInfo to com.linecorp.armeria.common.eureka.InstanceInfo, the same exception occurs with the following jobs:
- build-ubicloud-standard-16-jdk-*
- build-macos-latest-jdk-21
- build-windows-latest-jdk-21
Execution failed for task ':javadoc:checkJavadoc'.
> java.lang.Exception: Disallowed class(es) in the public API:
- InstanceInfo -> com.linecorp.armeria.internal.common.eureka.DataCenterInfo
- InstanceInfo -> com.linecorp.armeria.internal.common.eureka.LeaseInfo
Modifications:
- Move
com.linecorp.armeria.internal.common.eureka.DataCenterInfotocom.linecorp.armeria.common.eureka.DataCenterInfo. - Move
com.linecorp.armeria.internal.common.eureka.LeaseInfotocom.linecorp.armeria.common.eureka.LeaseInfo. - Make public
com.linecorp.armeria.internal.common.eureka.DataCenterInfoSerializer
Thanks
There was a problem hiding this comment.
Yeah, we also need to move those classes. 😉
Ivan-Montes
force-pushed
the
feature/set-eureka-instanceinfo-to-endpoint-attr
branch
2 times, most recently
from
d205a96 to
258fd3f
Compare
minwoox
reviewed
Jan 21, 2025
| * @return The {@link InstanceInfo} associated with the specified {@link Endpoint}. | ||
| */ | ||
| @Nullable | ||
| public static InstanceInfo get(Endpoint endpoint) { |
There was a problem hiding this comment.
How about
Suggested change
| public static InstanceInfo get(Endpoint endpoint) { | |
| public static InstanceInfo instanceInfo(Endpoint endpoint) { |
| * @param endpoint The {@link Endpoint} to which the {@link InstanceInfo} will be set as an attribute. | ||
| * @return The same {@link Endpoint} passed as a parameter. | ||
| */ | ||
| public static Endpoint with(Endpoint endpoint, InstanceInfo instanceInfo) { |
There was a problem hiding this comment.
Suggested change
| public static Endpoint with(Endpoint endpoint, InstanceInfo instanceInfo) { | |
| public static Endpoint setInstanceInfo(Endpoint endpoint, InstanceInfo instanceInfo) { |
Ivan-Montes
force-pushed
the
feature/set-eureka-instanceinfo-to-endpoint-attr
branch
from
a945657 to
9d91394
Compare
Related: line#6056 Motivation: Users might want to use the metadata from the Eureka `InstanceInfo` but currently, there's no way to retrieve it. Modifications: - Add a helper class to hide the implementation detail. - Set the `InstanceInfo` to the `Endpoint` as an attribute. Result: - Closes line#6056 - Now users can retrieve it.
Related: line#6056 Motivation: Users might want to use the metadata from the Eureka `InstanceInfo` but currently, there's no way to retrieve it. Modifications: - Remove helper class because users cannot access this class to retrieve `InstanceInfo`. - Move `com.linecorp.armeria.internal.common.eureka.InstanceInfo` to `com.linecorp.armeria.common.eureka.InstanceInfo`. - Move the methods to the `InstanceInfo` class. - Add a test to verify that users can retrieve the `InstanceInfo`. Result: - Closes line#6056 - Now users can retrieve it.
Motivation: Since it is ensured that the public API does not expose the shaded classes, after moving `com.linecorp.armeria.internal.common.eureka.InstanceInfo` to `com.linecorp.armeria.common.eureka.InstanceInfo`, the same exception occurs with the following jobs: - build-ubicloud-standard-16-jdk-* - build-macos-latest-jdk-21 - build-windows-latest-jdk-21 ``` Execution failed for task ':javadoc:checkJavadoc'. > java.lang.Exception: Disallowed class(es) in the public API: - InstanceInfo -> com.linecorp.armeria.internal.common.eureka.DataCenterInfo - InstanceInfo -> com.linecorp.armeria.internal.common.eureka.LeaseInfo ``` Modifications: - Move `com.linecorp.armeria.internal.common.eureka.DataCenterInfo` to `com.linecorp.armeria.common.eureka.DataCenterInfo`. - Move `com.linecorp.armeria.internal.common.eureka.LeaseInfo` to `com.linecorp.armeria.common.eureka.LeaseInfo`. - Make public `com.linecorp.armeria.internal.common.eureka.DataCenterInfoSerializer` Result: DataCenterInfo and LeaseInfo classes are now allowed
Ivan-Montes
force-pushed
the
feature/set-eureka-instanceinfo-to-endpoint-attr
branch
from
9d91394 to
3dc8d19
Compare
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.
Related: #6056
Motivation:
Users might want to use the metadata from the Eureka
InstanceInfobut currently, there's no way to retrieve it.Modifications:
InstanceInfoto theEndpointas an attribute.Result: