-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
feat(consola): Enhance Consola integration to extract objects as searchable attributes #18602
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
s1gr1d
wants to merge
4
commits into
develop
Choose a base branch
from
sig/consola-objects
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
50 changes: 50 additions & 0 deletions
50
dev-packages/node-integration-tests/suites/consola/subject-object-context.ts
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| import * as Sentry from '@sentry/node'; | ||
| import { loggingTransport } from '@sentry-internal/node-integration-tests'; | ||
| import { consola } from 'consola'; | ||
|
|
||
| Sentry.init({ | ||
| dsn: 'https://[email protected]/1337', | ||
| release: '1.0.0', | ||
| environment: 'test', | ||
| enableLogs: true, | ||
| transport: loggingTransport, | ||
| }); | ||
|
|
||
| async function run(): Promise<void> { | ||
| consola.level = 5; | ||
|
|
||
| const sentryReporter = Sentry.createConsolaReporter(); | ||
| consola.addReporter(sentryReporter); | ||
|
|
||
| // Object context extraction - objects should become searchable attributes | ||
| consola.info('User logged in', { userId: 123, sessionId: 'abc-123' }); | ||
|
|
||
| // Multiple objects - properties should be merged | ||
| consola.warn('Payment processed', { orderId: 456 }, { amount: 99.99, currency: 'USD' }); | ||
|
|
||
| // Mixed primitives and objects | ||
| consola.error('Error occurred', 'in payment module', { errorCode: 'E001', retryable: true }); | ||
|
|
||
| // Arrays (should be stored as context attributes) | ||
| consola.debug('Processing items', [1, 2, 3, 4, 5]); | ||
|
|
||
| // Nested objects | ||
| consola.info('Complex data', { user: { id: 789, name: 'Jane' }, metadata: { source: 'api' } }); | ||
|
|
||
| // Deep nesting to test normalizeDepth (should be normalized at depth 3 - default) | ||
| consola.info('Deep object', { | ||
| level1: { | ||
| level2: { | ||
| level3: { | ||
| level4: { level5: 'should be normalized' }, | ||
| }, | ||
| }, | ||
| }, | ||
| simpleKey: 'simple value', | ||
| }); | ||
|
|
||
| await Sentry.flush(); | ||
| } | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/no-floating-promises | ||
| void run(); |
39 changes: 39 additions & 0 deletions
39
dev-packages/node-integration-tests/suites/consola/subject-special-objects.ts
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| import * as Sentry from '@sentry/node'; | ||
| import { loggingTransport } from '@sentry-internal/node-integration-tests'; | ||
| import { consola } from 'consola'; | ||
|
|
||
| Sentry.init({ | ||
| dsn: 'https://[email protected]/1337', | ||
| release: '1.0.0', | ||
| environment: 'test', | ||
| enableLogs: true, | ||
| transport: loggingTransport, | ||
| }); | ||
|
|
||
| async function run(): Promise<void> { | ||
| consola.level = 5; | ||
|
|
||
| const sentryReporter = Sentry.createConsolaReporter(); | ||
| consola.addReporter(sentryReporter); | ||
|
|
||
| // Test Date objects are preserved | ||
| consola.info('Current time:', new Date('2023-01-01T00:00:00.000Z')); | ||
|
|
||
| // Test Error objects are preserved | ||
| consola.error('Error occurred:', new Error('Test error')); | ||
|
|
||
| // Test RegExp objects are preserved | ||
| consola.info('Pattern:', /test/gi); | ||
|
|
||
| // Test Map and Set objects are preserved | ||
| consola.info('Collections:', new Map([['key', 'value']]), new Set([1, 2, 3])); | ||
|
|
||
| // Test mixed: plain object + special object | ||
| consola.info('Mixed data', { userId: 123 }, new Date('2023-06-15T12:00:00.000Z')); | ||
|
|
||
| await Sentry.flush(); | ||
| } | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/no-floating-promises | ||
| void run(); | ||
|
|
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Test missing assertion for array attribute extraction (Bugbot Rules)
Per the review rules: "Check that tests actually test the newly added behaviour. When checking on sent payloads by the SDK, ensure that the newly added data is asserted thoroughly." The test subject at
subject-args.tsline 24 includes an array[1, 2, 3]in the args, which per the new feature should be stored asconsola.args.0. However, the test's expected attributes at lines 285-295 only assertkey: 'value'but not theconsola.args.0attribute for the array, leaving the array extraction behavior unverified in this test case.