fix(v9/core): Ensure logs past MAX_LOG_BUFFER_SIZE are not swallowed
#18213
+8
−3
Conversation
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
Comment on lines
245
to
254
| // Add one more to trigger flush | ||
| _INTERNAL_captureLog({ level: 'info', message: 'trigger flush' }, client, undefined); | ||
|
|
||
| expect(_INTERNAL_getLogBuffer(client)).toEqual([]); | ||
| // After flushing the 100 logs, the new log starts a fresh buffer with 1 item | ||
| const buffer = _INTERNAL_getLogBuffer(client); | ||
| expect(buffer).toHaveLength(1); | ||
| expect(buffer?.[0]?.body).toBe('trigger flush'); | ||
| }); | ||
|
|
||
| it('does not flush logs buffer when it is empty', () => { |
There was a problem hiding this comment.
Bug: New logs are silently discarded when the log buffer reaches its maximum size and triggers a flush.
Severity: CRITICAL | Confidence: 1.00
🔍 Detailed Analysis
When the log buffer reaches MAX_LOG_BUFFER_SIZE and a new log is added, the system incorrectly flushes the old buffer before the new log is fully processed. Specifically, _INTERNAL_flushLogsBuffer is called with the logBuffer (100 items) before the serializedLog is properly accounted for. Subsequently, _getBufferMap().set(client, []) clears the buffer, overwriting the newly updated buffer that contained the 101st log. This results in the most recent log being silently discarded.
💡 Suggested Fix
Modify the logic to either check the new buffer size before flushing or ensure the new log is preserved after the buffer is cleared by the flush operation.
🤖 Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: packages/core/test/lib/logs/exports.test.ts#L245-L254
Potential issue: When the log buffer reaches `MAX_LOG_BUFFER_SIZE` and a new log is
added, the system incorrectly flushes the old buffer before the new log is fully
processed. Specifically, `_INTERNAL_flushLogsBuffer` is called with the `logBuffer` (100
items) before the `serializedLog` is properly accounted for. Subsequently,
`_getBufferMap().set(client, [])` clears the buffer, overwriting the newly updated
buffer that contained the 101st log. This results in the most recent log being silently
discarded.
Did we get this right? 👍 / 👎 to inform future reviews.
Reference_id: 2693436
Member
Author
There was a problem hiding this comment.
Indeed, that's what this PR fixes with ba24997.
Contributor
size-limit report 📦
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Looks like we swallowed the log that triggers a flush when
MAX_LOG_BUFFER_SIZEis surpassed.Test demonstrating issue: e3a8e2f
Fix: ba24997
v10 equivalent: #18207