fix: capture when argument is not a string #1724
Merged
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
PR Summary
This PR improves error handling in the PostHog SDK by fixing cases where captureException() is called with a string argument, preventing undefined type and value properties when autocapture is disabled.
- Added new
ErrorConversionArgstype insrc/types.tsto replace tuple-basedErrorEventArgsfor better type safety - Modified
errorToPropertiesinsrc/extensions/exception-autocapture/error-conversion.tsto handle string inputs with proper fallback values - Added test coverage in
playwright/error-tracking.spec.tsspecifically for manual string exception capture scenarios - Added
isErrortype guard insrc/utils/type-utils.tsto properly check for Error instances - Updated error handling interface in
globals.tsto use structuredErrorConversionArgstype instead of tuples
8 file(s) reviewed, 4 comment(s)
Edit PR Review Bot Settings | Greptile
| page, | ||
| context | ||
| ) | ||
| test.describe('Exception autocapture enabled', () => { |
There was a problem hiding this comment.
logic: The describe block title 'Exception autocapture enabled' is incorrect since autocaptureExceptions is set to false in the config
Suggested change
| test.describe('Exception autocapture enabled', () => { | |
| test.describe('Exception autocapture disabled', () => { |
| expect(captures[2].properties.$exception_personURL).toBeUndefined() | ||
| expect(captures[2].properties.$exception_list[0].value).toEqual('I am a plain old string') | ||
| expect(captures[2].properties.$exception_list[0].type).toEqual('Error') | ||
| }) | ||
| }) | ||
|
|
||
| test.describe('Exception autocapture enabled', () => { |
There was a problem hiding this comment.
style: Duplicate describe block title 'Exception autocapture enabled' makes it unclear which tests are for which scenario
Comment on lines
15
to
18
| win.onerror = function (args: ErrorEventArgs): boolean { | ||
| const errorProperties = errorToProperties({ event: args[0], error: args[4] }) | ||
| captureFn(errorProperties) | ||
| return originalOnError?.(...args) ?? false | ||
| return originalOnError?.(args) ?? false |
There was a problem hiding this comment.
logic: The function signature changed from spread args to a single args parameter, but ErrorEventArgs is still treated as an array with indexed access. This could cause type safety issues.
Suggested change
| win.onerror = function (args: ErrorEventArgs): boolean { | |
| const errorProperties = errorToProperties({ event: args[0], error: args[4] }) | |
| captureFn(errorProperties) | |
| return originalOnError?.(...args) ?? false | |
| return originalOnError?.(args) ?? false | |
| win.onerror = function (message: string | Event, source?: string, lineno?: number, colno?: number, error?: Error): boolean { | |
| const errorProperties = errorToProperties({ event: message, error: error }) | |
| captureFn(errorProperties) | |
| return originalOnError?.(message, source, lineno, colno, error) ?? false |
Comment on lines
1841
to
1844
| ? { | ||
| ...assignableWindow.__PosthogExtensions__.parseErrorAsProperties( | ||
| [error.message, undefined, undefined, undefined, error], | ||
| isError(error) ? { error, event: error.message } : { event: error as Event | string }, | ||
| // create synthetic error to get stack in cases where user input does not contain one |
There was a problem hiding this comment.
style: Check if window.PosthogExtensions exists before using parseErrorAsProperties to prevent undefined errors
Suggested change
| ? { | |
| ...assignableWindow.__PosthogExtensions__.parseErrorAsProperties( | |
| [error.message, undefined, undefined, undefined, error], | |
| isError(error) ? { error, event: error.message } : { event: error as Event | string }, | |
| // create synthetic error to get stack in cases where user input does not contain one | |
| ? isFunction(assignableWindow.__PosthogExtensions__?.parseErrorAsProperties) | |
| ? { | |
| ...assignableWindow.__PosthogExtensions__.parseErrorAsProperties( | |
| isError(error) ? { error, event: error.message } : { event: error as Event | string }, | |
| // create synthetic error to get stack in cases where user input does not contain one |
|
Size Change: +873 B (+0.03%) Total Size: 3.3 MB
ℹ️ View Unchanged
|
oliverb123
approved these changes
Feb 10, 2025
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.
Changes
Because you could call
captureException()with a string it is possible that the type and value would be undefined if autocapture was disabled because of:Adds a fix to check for an error type and if not just use the provided value. This is best effort given we don't import the full
exception-conversionfile for this case