[3.3] Enable server socket reuseAddress option before binding by zrlw · Pull Request #15239 · apache/dubbo

zrlw · 2025-03-14T08:26:50Z

What is the purpose of the change?

try to fix #15238
sometimes the port got from NetUtils#getAvailablePort could not be bound directly because the port status is still TIME-WAIT as getAvailablePort closed it without setting SO_REUSEADDR option.

Checklist

Make sure there is a GitHub_issue field for the change.
Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
Write necessary unit-test to verify your logic correction. If the new feature or significant change is committed, please remember to add sample in dubbo samples project.
Make sure gitHub actions can pass. Why the workflow is failing and how to fix it?

codecov-commenter · 2025-03-14T08:44:10Z

Codecov Report

Attention: Patch coverage is 72.22222% with 5 lines in your changes missing coverage. Please review.

Project coverage is 60.78%. Comparing base (d3b1e1f) to head (cba2c7b).
Report is 139 commits behind head on 3.3.

Files with missing lines	Patch %	Lines
...n/java/org/apache/dubbo/common/utils/NetUtils.java	73.33%	2 Missing and 2 partials ⚠️
...ng/transport/netty/NettyPortUnificationServer.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##                3.3   #15239      +/-   ##
============================================
- Coverage     60.79%   60.78%   -0.01%     
- Complexity    10892    10894       +2     
============================================
  Files          1885     1885              
  Lines         86082    86102      +20     
  Branches      12895    12898       +3     
============================================
+ Hits          52331    52341      +10     
- Misses        28303    28316      +13     
+ Partials       5448     5445       -3

Flag	Coverage Δ
integration-tests	`33.09% <50.00%> (-0.06%)`	⬇️
samples-tests	`29.23% <33.33%> (+0.04%)`	⬆️
unit-tests	`58.92% <72.22%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

oxsean · 2025-03-14T13:40:49Z

Is it possible to add some tests?

zrlw · 2025-03-16T08:49:31Z

Is it possible to add some tests?

the results of these codes vary with os and jdk version,

ServerSocket serverSocket = new ServerSocket(port);
assertFalse(serverSocket.getReuseAddress());

passed if running on win10 + compiled by jdk8,
failed if running on linux + compiled by jdk17 as serverSocket.getReuseAddress() returns true.
i doubt there should have unified solution.

zrlw · 2025-03-17T02:10:49Z

see SO_REUSEADDR at java.net.StandardSocketOptions,

Re-use address.
An implementation allows this socket option to be set before the socket is bound or connected. Changing the value of this socket option after the socket is bound has no effect. The default value of this socket option is system dependent.

since the default value of SO_REUSEADDR is always true on some system, I didn't think of how to write appropriate testing case.

    @Test
    void testRepeatedStatusChecking() {
        int port = NetUtils.getAvailablePort();
        for (int i = 0; i < 1000; i++) {
            assertFalse(NetUtils.isPortInUsed(port));
        }
    }

zrlw · 2025-03-17T02:50:17Z

Enabling SO_REUSEADDR prior to binding the socket using bind(SocketAddress) allows the socket to be bound even though a previous connection is in a timeout state.

AlbumenJ · 2025-03-18T01:45:00Z

dubbo-common/src/main/java/org/apache/dubbo/common/utils/NetUtils.java

-            try (ServerSocket ignored = new ServerSocket(i)) {
+            try (ServerSocket serverSocket = new ServerSocket()) {
+                // SO_REUSEADDR should be enabled before bind.
+                serverSocket.setReuseAddress(true);


Are there any systems which cannot support such configuration or will throw exception here?

if an error occurs, or the socket is closed, SocketException will be thrown here.

i see. Embedded, real time system, or old Unix ( before 1980?) might not support SO_REUSEADDR. added condition check before setting it.

AlbumenJ · 2025-03-19T01:34:07Z

dubbo-common/src/main/java/org/apache/dubbo/common/utils/NetUtils.java

+        try (ServerSocket serverSocket = new ServerSocket()) {
+            serverSocket.setReuseAddress(true);
+            reuseAddressSupported = true;
+        } catch (IOException e) {


Suggested change

} catch (IOException e) {

} catch (Throwable ignore) {

zrlw · 2025-05-07T03:07:48Z

@AlbumenJ PTAL

zrlw force-pushed the 3.3-feature-setReuseAddressOption branch from fd08802 to c0ce2a7 Compare March 17, 2025 01:38

zrlw changed the title ~~[3.3] Set socket reuse address option to true~~ [3.3] Enable server socket ReuseAddress option before binding Mar 17, 2025

zrlw force-pushed the 3.3-feature-setReuseAddressOption branch from c0ce2a7 to d4b785c Compare March 17, 2025 01:43

zrlw changed the title ~~[3.3] Enable server socket ReuseAddress option before binding~~ [3.3] Enable server socket reuseAddress option before binding Mar 17, 2025

AlbumenJ reviewed Mar 18, 2025

View reviewed changes

AlbumenJ requested changes Mar 19, 2025

View reviewed changes

zrlw force-pushed the 3.3-feature-setReuseAddressOption branch from 8b08a99 to e15ba4d Compare March 19, 2025 02:06

Set reuseAddress option if system supports it

cba2c7b

zrlw force-pushed the 3.3-feature-setReuseAddressOption branch from e15ba4d to cba2c7b Compare March 19, 2025 04:14

AlbumenJ merged commit 02c9cca into apache:3.3 May 8, 2025
19 checks passed

zrlw deleted the 3.3-feature-setReuseAddressOption branch June 5, 2025 07:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[3.3] Enable server socket reuseAddress option before binding#15239

[3.3] Enable server socket reuseAddress option before binding#15239
AlbumenJ merged 1 commit intoapache:3.3from
zrlw:3.3-feature-setReuseAddressOption

zrlw commented Mar 14, 2025 •

edited

Loading

Uh oh!

codecov-commenter commented Mar 14, 2025 •

edited

Loading

Uh oh!

oxsean commented Mar 14, 2025

Uh oh!

zrlw commented Mar 16, 2025 •

edited

Loading

Uh oh!

zrlw commented Mar 17, 2025

Uh oh!

zrlw commented Mar 17, 2025

Uh oh!

AlbumenJ Mar 18, 2025

Uh oh!

zrlw Mar 18, 2025

Uh oh!

zrlw Mar 18, 2025 •

edited

Loading

Uh oh!

AlbumenJ Mar 19, 2025

Uh oh!

zrlw Mar 19, 2025

Uh oh!

zrlw commented May 7, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

zrlw commented Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is the purpose of the change?

Checklist

Uh oh!

codecov-commenter commented Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

oxsean commented Mar 14, 2025

Uh oh!

zrlw commented Mar 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zrlw commented Mar 17, 2025

Uh oh!

zrlw commented Mar 17, 2025

Uh oh!

AlbumenJ Mar 18, 2025

Choose a reason for hiding this comment

Uh oh!

zrlw Mar 18, 2025

Choose a reason for hiding this comment

Uh oh!

zrlw Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AlbumenJ Mar 19, 2025

Choose a reason for hiding this comment

Uh oh!

zrlw Mar 19, 2025

Choose a reason for hiding this comment

Uh oh!

zrlw commented May 7, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

zrlw commented Mar 14, 2025 •

edited

Loading

codecov-commenter commented Mar 14, 2025 •

edited

Loading

zrlw commented Mar 16, 2025 •

edited

Loading

zrlw Mar 18, 2025 •

edited

Loading