Skip to content

Symbolicate unhandled promise rejections #40914

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.

Sign up for GitHub

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

Closed
wants to merge 12 commits into from
Closed

Symbolicate unhandled promise rejections #40914

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
8d1ce80
Symbolicate unhandled promise rejections and try to log them
ospfranco Oct 13, 2023
cb897d0
Linting
ospfranco Oct 13, 2023
c488217
change paths for devtools
ospfranco Oct 13, 2023
516deee
change paths for devtools
ospfranco Oct 13, 2023
ff6be9c
Fix flow errors
ospfranco Oct 13, 2023
c460d5f
Allow passing stack into addLog
ospfranco Oct 13, 2023
a54fd6b
Do not symbolicate stack on promiseRejectionTrackingOptions but let l…
ospfranco Oct 13, 2023
2a8a491
remove unused codeFrame
ospfranco Oct 13, 2023
352ab9f
Revert outdated change to rejectionTrackingOptions type
ospfranco Oct 13, 2023
07a48c2
Parse error stack on LogBoxData
ospfranco Oct 16, 2023
1443452
re-insert blank line
ospfranco Oct 16, 2023
e5eed45
PR comments
ospfranco Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/react-native/Libraries/LogBox/Data/LogBoxData.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ export type LogData = $ReadOnly<{|
message: Message,
category: Category,
componentStack: ComponentStack,
codeFrame?: string,
|}>;

export type Observer = (
Expand Down Expand Up @@ -208,6 +209,7 @@ export function addLog(log: LogData): void {
stack,
category: log.category,
componentStack: log.componentStack,
codeFrame: log.codeFrame,
}),
);
} catch (error) {
Expand Down
35 changes: 33 additions & 2 deletions packages/react-native/Libraries/promiseRejectionTrackingOptions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@

import typeof {enable} from 'promise/setimmediate/rejection-tracking';

let rejectionTrackingOptions: $NonMaybeType<Parameters<enable>[0]> = {
type ExtractOptionsType = <P>(((options?: ?P) => void)) => P;

let rejectionTrackingOptions: $Call<ExtractOptionsType, enable> = {
allRejections: true,
onUnhandled: (id, rejection = {}) => {
onUnhandled: async (id, rejection = {}) => {
let message: string;
let stack: ?string;

Expand All @@ -22,6 +24,35 @@ let rejectionTrackingOptions: $NonMaybeType<Parameters<enable>[0]> = {
// $FlowFixMe[method-unbinding] added when improving typing for this parameters
message = Error.prototype.toString.call(rejection);
const error: Error = (rejection: $FlowFixMe);

// Print pretty unhandled rejections while on DEV
if (__DEV__) {
const parseErrorStack = require('react-native/Libraries/Core/Devtools/parseErrorStack');
const symbolicateStackTrace = require('react-native/Libraries/Core/Devtools/symbolicateStackTrace');
const LogBox = require('react-native/Libraries/LogBox/LogBox').default;

stack = parseErrorStack(error.stack);
stack = await symbolicateStackTrace(stack);
if (stack) {
const warning =
`Possible Unhandled Promise Rejection (id: ${id}):\n` +
`${message ?? ''}\n` +
`at File: ${stack.codeFrame.fileName}, row: ${stack.codeFrame.location.row}, column: ${stack.codeFrame.location.column}`;

console.log(stack.codeFrame.content)

LogBox.addLog({
level: 'warn',
message: {content: warning, substitutions: []},
isComponentError: false,
codeFrame: stack.codeFrame,
stack: error.stack,
Copy link

Choose a reason for hiding this comment

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

Can't we just pass the symbolicated stack variable here instead of the original obfuscated error.stack?

Copy link
Member

Choose a reason for hiding this comment

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

Logbox already supports doing the symbolication, can we leverage the logic there?

Copy link

Choose a reason for hiding this comment

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

Can you provide more context on how to do that? I can see that he already provided it with the error.stack but still the correct first frame wasn't shown

Copy link
Member

Choose a reason for hiding this comment

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

You may need to use LogBox.addException for this, and update parseLogBoxException to treat these as non-fatal

Copy link

Choose a reason for hiding this comment

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

@ospfranco can you please give this a try?

Copy link
Contributor Author

@ospfranco ospfranco Oct 13, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Nope, doesn't seem to be working, didn't change the level yet, but stack parsing doesn't seem to work.

category: `${stack.codeFrame.fileName}-${stack.codeFrame.location.row}-${stack.codeFrame.location.column}`,
});
return;
}
}

stack = error.stack;
} else {
try {
Expand Down