Add Nacos Support #5409

KonaEspresso94 · 2024-01-25T16:19:04Z

Motivation:

Nacos is a service discovery application extensively used. By providing native support for Nacos, it will be beneficial to Armeria users.

#5360 #5365

Modification:

Add a nacos module.
Add NacosClient.
Its internal implementation includes LoginClient for obtaining an accessToken through basic Nacos authentication, QueryInstancesClient for querying service instances, and RegisterInstanceClient for handling the registration and deregistration of instances.
Implement NacosEndpointGroup and NacosUpdatingListener.
Configure unit tests using Testcontainers and the Nacos image to facilitate actual call testing.

Result:

Closes #5365

Nacos discovery and instance registration functionalities are now integrated into Armeria.

In writing this code, I was strongly influenced by the implementation on the consul and eureka modules.
I appreciate your review and feedback. Thank you.

CLAassistant · 2024-01-25T16:19:10Z

All committers have signed the CLA.

github-actions · 2024-01-26T06:38:13Z

🔍 Build Scan® (commit: `73c1699`)

Job name	Status	Build Scan®
build-ubicloud-standard-8-jdk-8	✅	https://ge.armeria.dev/s/oqess4dtfftrq
build-ubicloud-standard-8-jdk-21-snapshot-blockhound	✅	https://ge.armeria.dev/s/vizmb5qc26pgg
build-ubicloud-standard-8-jdk-17-min-java-17-coverage	❌ (failure)	https://ge.armeria.dev/s/6weimqw2fhdr6
build-ubicloud-standard-8-jdk-17-min-java-11	✅	https://ge.armeria.dev/s/3totpwrdj6wso
build-ubicloud-standard-8-jdk-17-leak	✅	https://ge.armeria.dev/s/cd4rggnfvatgw
build-ubicloud-standard-8-jdk-11	✅	https://ge.armeria.dev/s/bl3zdxk32yvty
build-macos-12-jdk-21	✅	https://ge.armeria.dev/s/vbkwlk2lqrtcy

…stead of QueryParams, making it easier to append additional parameters (e.g., accessToken).

ikhoon

The overall direction looks great.

nacos/src/main/java/com/linecorp/armeria/internal/nacos/LoginClient.java

ikhoon · 2024-02-07T08:47:13Z

nacos/src/main/java/com/linecorp/armeria/internal/nacos/LoginClient.java

+
+    private static final String NACOS_ACCESS_TOKEN_CACHE_KEY = "NACOS_ACCESS_TOKEN_CACHE_KEY";
+    private final AsyncLoadingCache<String, LoginResult> tokenCache = Caffeine.newBuilder()
+            .maximumSize(1)


Optional) It seems overkill to use Caffeine only for 1 element.
What do you think of creating a function that triggers loginInternal() if access tokens are expired while invoking login()?

If you find it more difficult than Caffeine approach, I'm okay to keep this as is.

nacos/src/main/java/com/linecorp/armeria/internal/nacos/QueryInstancesClient.java

… immutable.

Hide login-related context from other clients as much as possible.

…peatedly produced.

…sarily repeatedly produced.

…ll immutable parameters to properties.

…ilder instead"

…ntation.

KonaEspresso94 · 2024-02-11T11:13:03Z

@ikhoon

Thank you for your review comments. I've applied your suggestions into the code.

LoginClient now implements SimpleDecoratingHttpClient. Contexts related to 'nacos basic authentication' have been hidden as much as possible from other clients.
Caching access token by own implementation instead of Caffeine cache.
Changed the query string that was being created each time in LoginClient and QueryInstanceClient to be reused efficiently.
NacosUpdatingListener and RegisterInstanceClient are not guaranteed to always have the same endpoint used as parameter. Eventually, we will need to create a StringBuilder or QueryParamsBuilder. However, I have minimized the parameter of the API by turning immutable parameters into properties, such as in the above two clients.
Fixed some missing final.

The implementation to replace the Caffein, I made it as simple as possible. So now the login api can be called concurrently. Considering the usability of NacosUpdatingListener and NacosEndpointGroup, I think it's unlikely that concurrent calls will actually happen, and if they do, it won't be an issue. But I'm not sure. I'd be interested in your thoughts.

Thank you!

nacos/src/main/java/com/linecorp/armeria/internal/nacos/LoginClient.java

trustin · 2024-05-08T05:40:24Z

@KonaEspresso94 Gentle ping - looking forward to having this feature merged 🙇

…r. + Properly pass the builder to the next chains in a builder-like manner (even if it's a mutable single object).

…negative test to registryFetchIntervalMillis

…nal module to hide them.

ikhoon

Thanks, @KonaEspresso94. 🚀🙇‍♂️
Left a minor suggestion.

ikhoon · 2024-07-25T10:16:58Z

nacos/src/main/java/com/linecorp/armeria/server/nacos/NacosUpdatingListenerBuilder.java

+        nacosClientBuilder.authorization(username, password);
+        return this;
+    }
+


There is useHealthyEndpoints() method on the client side.
Should we also support health status when registering an instance?
https://nacos.io/en-us/docs/open-api.html#2.1

ikhoon · 2024-07-25T10:18:35Z

nacos/src/main/java/com/linecorp/armeria/internal/nacos/LoginClient.java

+        public String toString() {
+            return MoreObjects.toStringHelper(this)
+                              .omitNullValues()
+                              .add("accessToken", accessToken)


Changed to use AuthToken because sensitive information should be excluded from serialization.

nacos/src/main/java/com/linecorp/armeria/server/nacos/NacosUpdatingListener.java

minwoox

@KonaEspresso94 Sorry about the late review. Thanks a lot! 👍 👍 👍

KonaEspresso94 added 3 commits January 26, 2024 00:43

Add NacosClient and NacosEndpointGroup

785b353

Add NacosUpdatingListener

a76d4fc

Test codes

4caabaf

KonaEspresso94 requested review from ikhoon, jrhee17, minwoox and trustin as code owners January 25, 2024 16:19

ikhoon added the new feature label Jan 26, 2024

KonaEspresso94 and others added 2 commits January 27, 2024 16:59

Modified NacosClientUtil::queryParams to return QueryParamsBuilder in…

3af6f6c

…stead of QueryParams, making it easier to append additional parameters (e.g., accessToken).

Merge branch 'main' into nacos-support

d4332aa

ikhoon reviewed Feb 7, 2024

View reviewed changes

KonaEspresso94 marked this pull request as draft February 9, 2024 13:58

KonaEspresso94 added 7 commits February 10, 2024 20:17

Make properties of the classes that define data rendering private and…

9530372

… immutable.

Make LoginClient an implementation of SimpleDecoratingHttpClient.

ffc64d7

Hide login-related context from other clients as much as possible.

LoginClient : Cache and reuse QueryStrings that were unnecessarily re…

68e1137

…peatedly produced.

QueryInstancesClient : Cache and reuse request path that were unneces…

0f71869

…sarily repeatedly produced.

Reduce the parameters of the RegisterInstanceClient APIS, by moving a…

46abd6d

…ll immutable parameters to properties.

Revert "Modified NacosClientUtil::queryParams to return QueryParamsBu…

adb40fc

…ilder instead"

To reuse access-token, instead of the Caffeine cache, use own impleme…

0120fd7

…ntation.

KonaEspresso94 force-pushed the nacos-support branch from a5e4a8c to 0120fd7 Compare February 11, 2024 06:52

KonaEspresso94 requested a review from ikhoon February 11, 2024 11:13

KonaEspresso94 marked this pull request as ready for review February 11, 2024 11:13

Merge branch 'main' into nacos-support

12b2214

ikhoon reviewed Mar 15, 2024

View reviewed changes

nacos/src/main/java/com/linecorp/armeria/internal/nacos/LoginClient.java Outdated Show resolved Hide resolved

github-actions bot added the Stale label Apr 15, 2024

Merge branch 'main' into nacos-support

23d8913

RetryingClientDecorator should be outside the authentication decorato…

2ffafe0

…r. + Properly pass the builder to the next chains in a builder-like manner (even if it's a mutable single object).

KonaEspresso94 force-pushed the nacos-support branch from 9189264 to 2ffafe0 Compare July 21, 2024 07:17

KonaEspresso94 added 9 commits July 21, 2024 17:38

Null check for Response.

8c003bc

Add missing ctx.updateRequest(newReq);

dc532a0

Remove verbose javadocs @params.

02c412c

Lint Style

dff6e08

Use Exceptions.throwUnsafely(e)

ce4fe89

Delegate registryFetchInterval's registryFetchInterval non zero, non …

2841315

…negative test to registryFetchIntervalMillis

Move DEFAULT_NACOS_API_VERSION and NACOS_API_VERSION_PATTERN to inter…

73a2e0f

…nal module to hide them.

Allows the user to directly control the path of the Nacos URI.

83fdffa

Lint Code

268023f

KonaEspresso94 requested review from ikhoon and minwoox July 21, 2024 10:02

KonaEspresso94 and others added 3 commits July 21, 2024 19:04

Lint Code

e287a3e

Merge branch 'main' into nacos-support

d7c9dfc

clean up

a34068d

ikhoon approved these changes Jul 25, 2024

View reviewed changes

ikhoon modified the milestones: 1.30.0, 1.31.0 Aug 2, 2024

ikhoon added 3 commits August 2, 2024 15:49

Merge branch 'main' into pr-5409-KonaEspresso94-nacos-support

c690614

Apply AsyncLoader

aae35fb

remove this

e8ce9c5

github-actions bot added the Stale label Sep 3, 2024

Merge branch 'main' into nacos-support

7f323be

jrhee17 reviewed Nov 7, 2024

View reviewed changes

nacos/src/main/java/com/linecorp/armeria/server/nacos/NacosUpdatingListener.java Outdated Show resolved Hide resolved

Fix

73c1699

minwoox force-pushed the nacos-support branch from 088b518 to 73c1699 Compare November 7, 2024 05:36

minwoox approved these changes Nov 7, 2024

View reviewed changes

ikhoon removed the Stale label Nov 7, 2024

ikhoon merged commit 0b36df3 into line:main Nov 7, 2024
12 of 14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Nacos Support #5409

Add Nacos Support #5409

KonaEspresso94 commented Jan 25, 2024 •

edited

Loading

CLAassistant commented Jan 25, 2024 •

edited

Loading

github-actions bot commented Jan 26, 2024 •

edited

Loading

ikhoon left a comment

ikhoon Feb 7, 2024

KonaEspresso94 commented Feb 11, 2024

trustin commented May 8, 2024

ikhoon left a comment

ikhoon Jul 25, 2024

ikhoon Jul 25, 2024 •

edited

Loading

minwoox left a comment

Add Nacos Support #5409

Add Nacos Support #5409

Conversation

KonaEspresso94 commented Jan 25, 2024 • edited Loading

CLAassistant commented Jan 25, 2024 • edited Loading

github-actions bot commented Jan 26, 2024 • edited Loading

🔍 Build Scan® (commit: 73c1699)

ikhoon left a comment

Choose a reason for hiding this comment

ikhoon Feb 7, 2024

Choose a reason for hiding this comment

KonaEspresso94 commented Feb 11, 2024

trustin commented May 8, 2024

ikhoon left a comment

Choose a reason for hiding this comment

ikhoon Jul 25, 2024

Choose a reason for hiding this comment

ikhoon Jul 25, 2024 • edited Loading

Choose a reason for hiding this comment

minwoox left a comment

Choose a reason for hiding this comment

KonaEspresso94 commented Jan 25, 2024 •

edited

Loading

CLAassistant commented Jan 25, 2024 •

edited

Loading

github-actions bot commented Jan 26, 2024 •

edited

Loading

🔍 Build Scan® (commit: `73c1699`)

ikhoon Jul 25, 2024 •

edited

Loading