Skip to content

[FXIED] LibEvent: natsConnection_Close() not closing the TCP connection#882

Merged
kozlovic merged 1 commit into
mainfrom
fix_879
Jul 12, 2025
Merged

[FXIED] LibEvent: natsConnection_Close() not closing the TCP connection#882
kozlovic merged 1 commit into
mainfrom
fix_879

Conversation

@kozlovic

@kozlovic kozlovic commented Jul 3, 2025

Copy link
Copy Markdown
Member

This was likely introduced in PR #815 when delaying the close of the socket based on the event loop adapter invoking a NATS C callback to indicate that it is safe to do so. The libuv adapter is doing the right thing, however the libevent was not since it was creating a one-time event based on EV_TIMEOUT passing the socket to close, however, in that mode the socket from the callback is always set to -1. We have to pass the socket to close though the nle object.

I also made the natsLibevent_Detach() function schedule an event to ensure that a _freeCb is now invoked after execution of the _closeCb.

Resolves #879

Signed-off-by: Ivan Kozlovic ivan@synadia.com

This was likely introduced in PR #815 when delaying the close of the
socket based on the event loop adapter invoking a NATS C callback
to indicate that it is safe to do so. The `libuv` adapter is doing
the right thing, however the `libevent` was not since it was creating
a one-time event based on `EV_TIMEOUT` passing the socket to close,
however, in that mode the socket from the callback is always set
to `-1`. We have to pass the socket to close though the `nle` object.

I also made the `natsLibevent_Detach()` function schedule an event
to ensure that a `_freeCb` is now invoked *after* execution of the
`_closeCb`.

Resolves #879

Signed-off-by: Ivan Kozlovic <ivan@synadia.com>
@kozlovic
kozlovic requested a review from levb July 3, 2025 23:01
@codecov

codecov Bot commented Jul 3, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.09%. Comparing base (1553d4a) to head (9605fd0).
Report is 68 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #882      +/-   ##
==========================================
+ Coverage   68.71%   70.09%   +1.38%     
==========================================
  Files          39       47       +8     
  Lines       15207    15555     +348     
  Branches     3143     3202      +59     
==========================================
+ Hits        10449    10903     +454     
+ Misses       1700     1577     -123     
- Partials     3058     3075      +17     

☔ 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.

@kozlovic
kozlovic requested review from derekcollison and removed request for levb July 12, 2025 01:18

@derekcollison derekcollison left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kozlovic
kozlovic merged commit de58a3f into main Jul 12, 2025
32 of 33 checks passed
@kozlovic
kozlovic deleted the fix_879 branch July 12, 2025 18:23
github-actions Bot pushed a commit that referenced this pull request Jul 12, 2025
kozlovic added a commit that referenced this pull request Sep 26, 2025
Release notes will be:

This release contains some breaking changes. See the "Changed" section below.

* Build
  * Disable NATS Streaming by default by @mtmk in #770
  * TLS
    * Require OpenSSL 1.1.1+ to compile. Removed the `NATS_BUILD_TLS_USE_OPENSSL_1_1_API` CMake variable by @kozlovic in #905
    * The option `natsOptions_SetSSLVerificationCallback` signature was changed to replace the use of `SSL_verify_cb` (which required OpenSSL dependency in the `nats.h` file), to the new callback `natsSSLVerifyCb`. See documentation of `natsSSLVerifyCb` to see the cast needed to compile with this new header file by @kozlovic in #908
* Modification of a `natsOptions` object if it has TLS/SSL configuration and is actively used by connections will now return a `NATS_ILLEGAL_STATE` by @kozlovic in #912

* Options
  * Ability to load the trusted CA certificates from a directory using the new option `natsOptions_LoadCATrustedCertificatesPath` by @kerbert101 in #862
  * Ability to connect via HTTP proxy for instance by adding a proxy connection handler using the new option `natsOptions_SetProxyConnHandler` by @wolfkor in #871 and @kozlovic in #897
  * Ability to load the certificate chain and key from a file on every connection attempt using the new option `natsOptions_LoadCertificatesChainDynamic` by @Matus-p in #901
  * Ability to perform concurrent TLS handshakes that may improve time it takes for concurrent connections to be established using the new option `natsOptions_AllowConcurrentTLSHandshakes ` by @kozlovic in #914. Issue was reported by @yanyongcheng in #899
* JetStream
  * Per-message TTL support (a NATS Server v2.11 feature) by @levb in #863
  * Pull consumer priority groups (a NATS Server v2.11 feature) by @levb in #869
* ObjectStore support by @kozlovic in #902. Thanks to @jfflynn41 and @alex1891 for the feedback in #876

* JetStream
  * Handling of publish asynchronous timeouts by @kozlovic in #886. Issue reported by @yanyongcheng in #880
* Timer insertion by @kozlovic in #883. Issue reported by @yanyongcheng in #881

* EventLoop:
  * Handling of possible failure on initial attach by @kozlovic in #918
  * LibEvent: `natsConnection_Close()` not closing the TCP connection by @kozlovic in #882. Issue was reported by @yanyongcheng in #879
  * Libuv: Possible crash if connection is destroyed while receiving data by @kozlovic in #889. Issue was reported by @yanyongcheng in #888
* KeyValue
  * Keys, History or watcher's next may incorrectly return `NATS_TIMEOUT` by @kozlovic in #917/ Issue was reported by @ArashPartow in #916
* MicroServices:
  * Wrong marshaling of `average_processing_time` by @kozlovic in #892. Issue was reported by @Archie3d in #890
  * Statistics error was always incremented by @kozlovic in #894. Issue was reported by @Archie3d in #893
* TLS
  * Unknown type name `SSL_verify_cb` by @kozlovic in #878. Issue was reported by @philipfoulkes in #877
  * Initialization and cleanup code related to OpenSSL was removed since it was deprecated for versions post OpenSSL 1.1. A cleanup function pertinent to 1.1+ code was possibly causing a problem. By @kozlovic in #905. Issue was reported by @vdeters in #904
  * Possible hang during handshake by @kozlovic in #907. Issue was reported by @etrochim in #906
  * Protect calls to `SSL_read` and `SSL_write` with a mutex. Since the same `SSL` object is shared between different threads, the OpenSSL library requires a mutex to be used by @kozlovic in #913
* Memory allocation check by @wooffie in #868
* Add missing status text string by @oldnick85 in #872 and @kozlovic in #874 (the issue was not present in any published release and was introduced in #869)
* Parsing of message headers with `NULL` or all-whitespace values by @habbbe in #873
* Removed some unused code related to handling of responses and added custom inbox with very long prefix test by @kozlovic in #885. Issue was reported by @yanyongcheng in #884
* Connection drain could cause missed reply and/or a 100ms delay by @kozlovic in #915. Issue was reported by @T-Maxxx in #911

* Build
  * Deprecated Ubuntu 20.04 in GitHub actions by @levb in #864
  * Removed the older compiler jobs by @levb in #865
  * Fixed Windows build to use the NATS Server main branch by @levb in #866

* @kerbert101 made their first contribution in #862
* @habbbe made their first contribution in #873
* @wolfkor made their first contribution in #871
* @Matus-p made their first contribution in #901

Signed-off-by: Ivan Kozlovic <ivan@synadia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

When using the Libevent library, natsConnection_Destroy() does not actually close the TCP connection

2 participants