Set Eureka InstanceInfo to endpoint attribute #6069
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
eureka/src/main/java/com/linecorp/armeria/client/eureka/EurekaEndpointGroup.java
Outdated
Show resolved
Hide resolved
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
eureka/src/main/java/com/linecorp/armeria/common/eureka/InstanceInfo.java
Outdated
Show resolved
Hide resolved
eureka/src/main/java/com/linecorp/armeria/common/eureka/InstanceInfo.java
Outdated
Show resolved
Hide resolved
Ivan-Montes
force-pushed
the
feature/set-eureka-instanceinfo-to-endpoint-attr
branch
3 times, most recently
from
3dc8d19 to
9a88c9d
Compare
I’ve made the requested changes. Please have a look when you get a chance! Thanks @minwoox |
minwoox
approved these changes
Feb 4, 2025
jrhee17
approved these changes
Feb 10, 2025
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
1575885 to
ee0f298
Compare
ikhoon
reviewed
Feb 24, 2025
| * @return The {@link InstanceInfo} associated with the specified {@link Endpoint}. | ||
| */ | ||
| @Nullable | ||
| public static InstanceInfo instanceInfo(Endpoint endpoint) { |
There was a problem hiding this comment.
Suggested change
| public static InstanceInfo instanceInfo(Endpoint endpoint) { | |
| public static InstanceInfo from(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 setInstanceInfo(Endpoint endpoint, InstanceInfo instanceInfo) { |
There was a problem hiding this comment.
Should we move this method to internal API? Generally, I don't think, users need this API. This setter may be only used in EurekaEndpointGroup.
There was a problem hiding this comment.
The original issue was to retrieve metadata from an Endpoint. Also, I think there's no reason to hide this API from public. If you don't want to put this API on InstanceInfo, we might consider adding InstanceInfoUtil.
There was a problem hiding this comment.
Understood. Let’s proceed that way.
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: