Skip to content

Throw special error if rejected Promises are incorrectly instrumented #36328

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

Draft
eps1lon wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Throw special error if rejected Promises are incorrectly instrumented #36328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 18 additions & 0 deletions packages/react-reconciler/src/ReactFiberThenable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,12 +192,30 @@ export function trackUsedThenable<T>(
// a listener that will update its status and result when it resolves.
switch (thenable.status) {
case 'fulfilled': {
// This could be a bad instrumentation that doesn't set .value.
// We're not type-checking since this is a hot path where you can
// track down easily when something becomes `undefined` unexpectedly.
const fulfilledValue: T = thenable.value;
return fulfilledValue;
}
case 'rejected': {
const rejectedError = thenable.reason;
checkIfUseWrappedInAsyncCatch(rejectedError);

// Rejected Promises are rarer so we're doing an extra type-check in
// case of a bad instrumentation that doesn't set .reason
// If we end up throwing `undefined` it becomes hard to track down
// where that throw originated because no callstack would exist.
// React would still have a Component stack but that could only be used
// as an approximation.
if (rejectedError === undefined && !('reason' in thenable)) {
throw new Error(
'A rejected Promise was passed to React without a `reason` property. ' +
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. ' +
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
);
}

throw rejectedError;
}
default: {
Expand Down
128 changes: 128 additions & 0 deletions packages/react-reconciler/src/__tests__/ReactUse-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,30 @@ describe('ReactUse', () => {
});
}

function normalizeCodeLocInfo(str) {
return (
str &&
str.replace(
/^ +(?:at|in) ([\S]+)([^\n]*)(\n?)/gm,
function (m, name, location, eol) {
if (location.indexOf(__filename) === -1) {
// ignore frames from library code
return '';
}
return (
' in ' +
name +
(/:\d+:\d+/.test(m)
? ' ' +
location.replace(__dirname, '~').replace(/:\d+:\d+/, ':*:*')
: '') +
eol
);
},
)
);
}

function Text({text}) {
Scheduler.log(text);
return text;
Expand Down Expand Up @@ -2189,4 +2213,108 @@ describe('ReactUse', () => {
expect(root).toMatchRenderedOutput('Updated');
},
);

it('throws a descriptive error when a rejected promise without a reason property is passed to use()', async () => {
const badThenable = Promise.resolve();
// Simulate bad instrumentation: status is 'rejected' but the reason is not
// in the `reason` property as intended.
badThenable.status = 'rejected';
badThenable.error = new Error('Something went wrong');

function Child() {
return use(badThenable);
}

function App({
// Intentionally destrucutring a prop here so that our production error
// stack trick is triggered at the beginning of the function
prop,
}) {
return <Child />;
}

const uncaughtErrors = [];
const root = ReactNoop.createRoot({
onUncaughtError(error, errorInfo) {
uncaughtErrors.push({
callStack: normalizeCodeLocInfo(error.stack),
ownerStack: React.captureOwnerStack
? normalizeCodeLocInfo(React.captureOwnerStack())
: null,
componentStack: normalizeCodeLocInfo(errorInfo.componentStack),
});
},
});

await act(() => {
root.render(<App />);
});

expect(uncaughtErrors).toEqual([
{
callStack:
'Error: A rejected Promise was passed to React without a `reason` property. ' +
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. ' +
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`." +
'\n in Child (~/ReactUse-test.js:*:*)' +
'\n in Object.<anonymous> (~/ReactUse-test.js:*:*)',
componentStack:
'\n in Child (~/ReactUse-test.js:*:*)' +
'\n in App (~/ReactUse-test.js:*:*)',
ownerStack: __DEV__ ? '\n in App (~/ReactUse-test.js:*:*)' : null,
},
]);
});

it('throws a descriptive error when a rejected promise without a reason property is used as a child', async () => {
const badThenable = Promise.resolve();
// Simulate bad instrumentation: status is 'rejected' but the reason is not
// in the `reason` property as intended.
badThenable.status = 'rejected';
badThenable.error = new Error('Something went wrong');

function Child() {
return <div>{badThenable}</div>;
}

function App({
// Intentionally destrucutring a prop here so that our production error
// stack trick is triggered at the beginning of the function
prop,
}) {
return <Child />;
}

const uncaughtErrors = [];
const root = ReactNoop.createRoot({
onUncaughtError(error, errorInfo) {
uncaughtErrors.push({
callStack: normalizeCodeLocInfo(error.stack),
ownerStack: React.captureOwnerStack
? normalizeCodeLocInfo(React.captureOwnerStack())
: null,
componentStack: normalizeCodeLocInfo(errorInfo.componentStack),
});
},
});

await act(() => {
root.render(<App />);
});

expect(uncaughtErrors).toEqual([
{
callStack:
'Error: A rejected Promise was passed to React without a `reason` property. ' +
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. ' +
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`." +
'\n in Object.<anonymous> (~/ReactUse-test.js:*:*)',
componentStack: '\n in App (~/ReactUse-test.js:*:*)',
ownerStack: __DEV__
? // TODO: Should start in Child since that's the owner.
'\n in App (~/ReactUse-test.js:*:*)'
: null,
},
]);
});
});
18 changes: 18 additions & 0 deletions packages/react-server/src/ReactFizzThenable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,29 @@ export function trackUsedThenable<T>(
// a listener that will update its status and result when it resolves.
switch (thenable.status) {
case 'fulfilled': {
// This could be a bad instrumentation that doesn't set .value.
// We're not type-checking since this is a hot path where you can
// track down easily when something becomes `undefined` unexpectedly.
const fulfilledValue: T = thenable.value;
return fulfilledValue;
}
case 'rejected': {
const rejectedError = thenable.reason;

// Rejected Promises are rarer so we're doing an extra type-check in
// case of a bad instrumentation that doesn't set .reason
// If we end up throwing `undefined` it becomes hard to track down
// where that throw originated because no callstack would exist.
// React would still have a Component stack but that could only be used
// as an approximation.
if (rejectedError === undefined && !('reason' in thenable)) {
throw new Error(
'A rejected Promise was passed to React without a `reason` property. ' +
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. ' +
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
);
}

throw rejectedError;
}
default: {
Expand Down
18 changes: 18 additions & 0 deletions packages/react-server/src/ReactFlightThenable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,29 @@ export function trackUsedThenable<T>(
// a listener that will update its status and result when it resolves.
switch (thenable.status) {
case 'fulfilled': {
// This could be a bad instrumentation that doesn't set .value.
// We're not type-checking since this is a hot path where you can
// track down easily when something becomes `undefined` unexpectedly.
const fulfilledValue: T = thenable.value;
return fulfilledValue;
}
case 'rejected': {
const rejectedError = thenable.reason;

// Rejected Promises are rarer so we're doing an extra type-check in
// case of a bad instrumentation that doesn't set .reason
// If we end up throwing `undefined` it becomes hard to track down
// where that throw originated because no callstack would exist.
// React would still have a Component stack but that could only be used
// as an approximation.
if (rejectedError === undefined && !('reason' in thenable)) {
throw new Error(
'A rejected Promise was passed to React without a `reason` property. ' +
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. ' +
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
);
}

throw rejectedError;
}
default: {
Expand Down
5 changes: 3 additions & 2 deletions scripts/error-codes/codes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -582,5 +582,6 @@
"594": "Cannot read Symbol exports. Only named exports are supported on a client module imported on the server.",
"595": "Attempted to call %s() from the server but %s is on the client. It's not possible to invoke a client function from the server, it can only be rendered as a Component or passed to props of a Client Component.",
"596": "Could not find the module \"%s\" in the React Client Manifest. This is probably a bug in the React Server Components bundler.",
"597": "The module \"%s\" is marked as an async ESM module but was loaded as a CJS proxy. This is probably a bug in the React Server Components bundler."
}
"597": "The module \"%s\" is marked as an async ESM module but was loaded as a CJS proxy. This is probably a bug in the React Server Components bundler.",
"598": "A rejected Promise was passed to React without a `reason` property. React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`."
}
Loading