Add logic to remove duplicates from the bound port list to prevent internal services from being bound to the server twice.

[tomatophobia]

Motivation:

• When the internal-services.port and management.server.port are set to the same, the internal services are bound twice.

Modifications:

• Add code to remove duplicates from the list of bound ports to prevent duplicate binding of internal services.

Result:

• Closes Internal services are bound twice to the server #4796.
• Even if internal-services.port and management.server.port are set to the same value, internal services are bound to the port only once.

[ikhoon]

Thanks for fixing the bug, @tomatophobia! ❤️

[ikhoon]

Could you check the failures of lint and flaky-tests?

[jrhee17]

Thanks @tomatophobia ! Happy with the changes once @ikhoon 's comment is addressed 🙇 👍 🙇

[tomatophobia]

Test code permalink.

@DynamicPropertySource
static void registerPortProperties(DynamicPropertyRegistry registry) {
    final int port = PortUtil.unusedTcpPort();
    registry.add("armeria.internal-services.port", () -> port);
    registry.add("management.server.port", () -> port);
}

@Test
void exposeActuatorServiceHasSingleCustomPrefixAtInternalPort() throws Exception {
    ...
}

Thank you for review! 🙇‍♂️ I have found the cause of the flaky test failure, but it seems to contradict the assumptions of this PR. As mentioned in the comment of issue #5022, I proceeded with the assumption that it was a mistake for the user to set armeria.internal-services.port and management.server.port to the same value.

However, the above test intentionally tests the scenario where they are the same. So, I'm wondering if I can simply delete it or if I need to reconsider a solution. (I should have noticed it right after submitting the PR, and I apologize for the delay. 😭)

[minwoox]

I'm wondering if I can simply delete it

Yes, I think we can simply remove the test. 😉

Could you also fix this line? 😉

armeria/spring/boot3-actuator-autoconfigure/src/main/java/com/linecorp/armeria/spring/actuate/ArmeriaSpringActuatorAutoConfiguration.java

Line 258 in d482f0c

(!internalServicePort.equals(managementPort) ||

[minwoox]

Had a chat with @jrhee17 and we realized that this will break the current behavior if a user uses the same ports with WebFlux.
(Currently, users cannot use the same port when they use embedded tomcat so we should fix it though.)

So how about just deduping instead of raising an exception as the original issue suggested?

[tomatophobia]

I have removed the previously written code. Following the revised direction, I added conditions to prevent the use of duplicate ports.

[tomatophobia]

I have modified the code using the dedupPorts method to remove duplicates.

[minwoox]

Awesome! Thanks a lot! 👍 👍 👍

[ikhoon]

@tomatophobia Would you update the PR title and description to reflect the final change?

[ikhoon]

Thanks, @tomatophobia! 🙇

[trustin]

Thanks, @tomatophobia! 👍

[codecov]

Codecov Report

Patch coverage: 90.47% and project coverage change: -0.01% ⚠️

Comparison is base (3d169b6) 74.18% compared to head (6d763f9) 74.18%.
Report is 4 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #5022      +/-   ##
============================================
- Coverage     74.18%   74.18%   -0.01%     
- Complexity    19464    19469       +5     
============================================
  Files          1672     1672              
  Lines         71749    71768      +19     
  Branches       9189     9197       +8     
============================================
+ Hits          53230    53243      +13     
- Misses        14191    14196       +5     
- Partials       4328     4329       +1     

Files Changed	Coverage Δ
...eria/internal/spring/ArmeriaConfigurationUtil.java	77.99% <90.47%> (+1.14%)	⬆️

... and 11 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.