fix(core): Explicitly flush log buffer in client.close()#19371
Open
fix(core): Explicitly flush log buffer in client.close()#19371
client.close()#19371Conversation
Contributor
Codecov Results 📊Generated by Codecov Action |
Contributor
size-limit report 📦
|
Contributor
node-overhead report 🧳Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Adds an explicit
_INTERNAL_flushLogsBuffer(this)call at the start of the base Client.close() method, before flush(timeout) is called.Previously, the log buffer flush during
close()relied on an indirect event chain:close() → flush() → emit('flush') → setupWeightBasedFlushing handler → _INTERNAL_flushLogsBuffer. While this works, it's fragile and could break if someone refactors the event mechanism. The explicit call ensures logs are always flushed on close regardless of the event wiring.The call is placed before flush() so the log envelope is queued to the transport before transport.flush(timeout) drains all pending sends. _INTERNAL_flushLogsBuffer safely handles empty buffers (returns early), so there's no overhead when logs are disabled or the buffer is empty.
All platform SDKs (NodeClient, LightNodeClient, DenoClient, BrowserClient, CloudflareClient) ultimately call super.close() which reaches this base implementation, so all runtimes benefit automatically.
closes #19347