Commit c0cd4d5

Browse files
authored
Throw special error if rejected Promises are incorrectly instrumented (#36328)
When a rejected `Promise` is instrumented in userspace while setting the rejection reason in the wrong field (e.g. `error` instead of `reason`), React will throw undefined (because `usable.reason` doesn't exist). This makes it incredibly hard to find the actual rejection reason. React is now throwing a generic error if we couldn't find the rejection reason. That will produce a callstack pointing into the problematic Promise from where you can hopefully extract the real rejection reason (alongside fixing the bad instrumentation). We're doing this in prod since this is unlikely to surface in dev. We're only doing runtime type-checking for the rejected case. That should be hit rarely and therefore hopefully have negligible runtime impact.
1 parent cafd63b commit c0cd4d5

5 files changed

Lines changed: 185 additions & 2 deletions

File tree

‎packages/react-reconciler/src/ReactFiberThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,12 +192,30 @@ export function trackUsedThenable<T>(
192192
// a listener that will update its status and result when it resolves.
193193
switch(thenable.status){
194194
case'fulfilled': {
195+
// This could be a bad instrumentation that doesn't set .value.
196+
// We're not type-checking since this is a hot path where you can
197+
// track down easily when something becomes `undefined` unexpectedly.
195198
constfulfilledValue: T=thenable.value;
196199
returnfulfilledValue;
197200
}
198201
case'rejected': {
199202
const rejectedError =thenable.reason;
200203
checkIfUseWrappedInAsyncCatch(rejectedError);
204+
205+
// Rejected Promises are rarer so we're doing an extra type-check in
206+
// case of a bad instrumentation that doesn't set .reason
207+
// If we end up throwing `undefined` it becomes hard to track down
208+
// where that throw originated because no callstack would exist.
209+
// React would still have a Component stack but that could only be used
210+
// as an approximation.
211+
if(rejectedError===undefined&&!('reason'inthenable)){
212+
thrownewError(
213+
'A rejected Promise was passed to React without a `reason` property. '+
214+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
215+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
216+
);
217+
}
218+
201219
throwrejectedError;
202220
}
203221
default: {

‎packages/react-reconciler/src/__tests__/ReactUse-test.js‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,30 @@ describe('ReactUse', () => {
8181
});
8282
}
8383

84+
functionnormalizeCodeLocInfo(str){
85+
return(
86+
str&&
87+
str.replace(
88+
/^+(?:at|in)([\S]+)([^\n]*)(\n?)/gm,
89+
function(m,name,location,eol){
90+
if(location.indexOf(__filename)===-1){
91+
// ignore frames from library code
92+
return'';
93+
}
94+
return(
95+
' in '+
96+
name+
97+
(/:\d+:\d+/.test(m)
98+
? ' '+
99+
location.replace(__dirname,'~').replace(/:\d+:\d+/,':*:*')
100+
: '')+
101+
eol
102+
);
103+
},
104+
)
105+
);
106+
}
107+
84108
functionText({text}){
85109
Scheduler.log(text);
86110
returntext;
@@ -2189,4 +2213,108 @@ describe('ReactUse', () => {
21892213
expect(root).toMatchRenderedOutput('Updated');
21902214
},
21912215
);
2216+
2217+
it('throws a descriptive error when a rejected promise without a reason property is passed to use()',async()=>{
2218+
constbadThenable=Promise.resolve();
2219+
// Simulate bad instrumentation: status is 'rejected' but the reason is not
2220+
// in the `reason` property as intended.
2221+
badThenable.status='rejected';
2222+
badThenable.error=newError('Something went wrong');
2223+
2224+
functionChild(){
2225+
returnuse(badThenable);
2226+
}
2227+
2228+
functionApp({
2229+
// Intentionally destrucutring a prop here so that our production error
2230+
// stack trick is triggered at the beginning of the function
2231+
prop,
2232+
}){
2233+
return<Child/>;
2234+
}
2235+
2236+
constuncaughtErrors=[];
2237+
constroot=ReactNoop.createRoot({
2238+
onUncaughtError(error,errorInfo){
2239+
uncaughtErrors.push({
2240+
callStack: normalizeCodeLocInfo(error.stack),
2241+
ownerStack: React.captureOwnerStack
2242+
? normalizeCodeLocInfo(React.captureOwnerStack())
2243+
: null,
2244+
componentStack: normalizeCodeLocInfo(errorInfo.componentStack),
2245+
});
2246+
},
2247+
});
2248+
2249+
awaitact(()=>{
2250+
root.render(<App/>);
2251+
});
2252+
2253+
expect(uncaughtErrors).toEqual([
2254+
{
2255+
callStack:
2256+
'Error: A rejected Promise was passed to React without a `reason` property. '+
2257+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
2258+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`."+
2259+
'\n in Child (~/ReactUse-test.js:*:*)'+
2260+
'\n in Object.<anonymous> (~/ReactUse-test.js:*:*)',
2261+
componentStack:
2262+
'\n in Child (~/ReactUse-test.js:*:*)'+
2263+
'\n in App (~/ReactUse-test.js:*:*)',
2264+
ownerStack: __DEV__ ? '\n in App (~/ReactUse-test.js:*:*)' : null,
2265+
},
2266+
]);
2267+
});
2268+
2269+
it('throws a descriptive error when a rejected promise without a reason property is used as a child',async()=>{
2270+
constbadThenable=Promise.resolve();
2271+
// Simulate bad instrumentation: status is 'rejected' but the reason is not
2272+
// in the `reason` property as intended.
2273+
badThenable.status='rejected';
2274+
badThenable.error=newError('Something went wrong');
2275+
2276+
functionChild(){
2277+
return<div>{badThenable}</div>;
2278+
}
2279+
2280+
functionApp({
2281+
// Intentionally destrucutring a prop here so that our production error
2282+
// stack trick is triggered at the beginning of the function
2283+
prop,
2284+
}){
2285+
return<Child/>;
2286+
}
2287+
2288+
constuncaughtErrors=[];
2289+
constroot=ReactNoop.createRoot({
2290+
onUncaughtError(error,errorInfo){
2291+
uncaughtErrors.push({
2292+
callStack: normalizeCodeLocInfo(error.stack),
2293+
ownerStack: React.captureOwnerStack
2294+
? normalizeCodeLocInfo(React.captureOwnerStack())
2295+
: null,
2296+
componentStack: normalizeCodeLocInfo(errorInfo.componentStack),
2297+
});
2298+
},
2299+
});
2300+
2301+
awaitact(()=>{
2302+
root.render(<App/>);
2303+
});
2304+
2305+
expect(uncaughtErrors).toEqual([
2306+
{
2307+
callStack:
2308+
'Error: A rejected Promise was passed to React without a `reason` property. '+
2309+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
2310+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`."+
2311+
'\n in Object.<anonymous> (~/ReactUse-test.js:*:*)',
2312+
componentStack: '\n in App (~/ReactUse-test.js:*:*)',
2313+
ownerStack: __DEV__
2314+
? // TODO: Should start in Child since that's the owner.
2315+
'\n in App (~/ReactUse-test.js:*:*)'
2316+
: null,
2317+
},
2318+
]);
2319+
});
21922320
});

‎packages/react-server/src/ReactFizzThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,29 @@ export function trackUsedThenable<T>(
6969
// a listener that will update its status and result when it resolves.
7070
switch(thenable.status){
7171
case'fulfilled': {
72+
// This could be a bad instrumentation that doesn't set .value.
73+
// We're not type-checking since this is a hot path where you can
74+
// track down easily when something becomes `undefined` unexpectedly.
7275
constfulfilledValue: T=thenable.value;
7376
returnfulfilledValue;
7477
}
7578
case'rejected': {
7679
constrejectedError=thenable.reason;
80+
81+
// Rejected Promises are rarer so we're doing an extra type-check in
82+
// case of a bad instrumentation that doesn't set .reason
83+
// If we end up throwing `undefined` it becomes hard to track down
84+
// where that throw originated because no callstack would exist.
85+
// React would still have a Component stack but that could only be used
86+
// as an approximation.
87+
if(rejectedError===undefined&&!('reason'inthenable)){
88+
thrownewError(
89+
'A rejected Promise was passed to React without a `reason` property. '+
90+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
91+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
92+
);
93+
}
94+
7795
throwrejectedError;
7896
}
7997
default: {

‎packages/react-server/src/ReactFlightThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,29 @@ export function trackUsedThenable<T>(
7777
// a listener that will update its status and result when it resolves.
7878
switch(thenable.status){
7979
case'fulfilled': {
80+
// This could be a bad instrumentation that doesn't set .value.
81+
// We're not type-checking since this is a hot path where you can
82+
// track down easily when something becomes `undefined` unexpectedly.
8083
constfulfilledValue: T=thenable.value;
8184
returnfulfilledValue;
8285
}
8386
case'rejected': {
8487
constrejectedError=thenable.reason;
88+
89+
// Rejected Promises are rarer so we're doing an extra type-check in
90+
// case of a bad instrumentation that doesn't set .reason
91+
// If we end up throwing `undefined` it becomes hard to track down
92+
// where that throw originated because no callstack would exist.
93+
// React would still have a Component stack but that could only be used
94+
// as an approximation.
95+
if(rejectedError===undefined&&!('reason'inthenable)){
96+
thrownewError(
97+
'A rejected Promise was passed to React without a `reason` property. '+
98+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
99+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
100+
);
101+
}
102+
85103
throwrejectedError;
86104
}
87105
default: {

‎scripts/error-codes/codes.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -584,5 +584,6 @@
584584
"596": "Could not find the module \"%s\" in the React Client Manifest. This is probably a bug in the React Server Components bundler.",
585585
"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.",
586586
"598": "Maximum update depth exceeded. This could be an infinite loop. This can happen when a component repeatedly calls setState during render phase or inside useLayoutEffect, causing infinite render loop. React limits the number of nested updates to prevent infinite loops.",
587-
"599": "Expected an initialized chunk but got an initialized stream chunk instead. This payload may have been submitted by an older version of React."
588-
}
587+
"599": "Expected an initialized chunk but got an initialized stream chunk instead. This payload may have been submitted by an older version of React.",
588+
"600": "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'`."
589+
}

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Commit c0cd4d5

Browse files
authored
Throw special error if rejected Promises are incorrectly instrumented (#36328)
When a rejected `Promise` is instrumented in userspace while setting the rejection reason in the wrong field (e.g. `error` instead of `reason`), React will throw undefined (because `usable.reason` doesn't exist). This makes it incredibly hard to find the actual rejection reason. React is now throwing a generic error if we couldn't find the rejection reason. That will produce a callstack pointing into the problematic Promise from where you can hopefully extract the real rejection reason (alongside fixing the bad instrumentation). We're doing this in prod since this is unlikely to surface in dev. We're only doing runtime type-checking for the rejected case. That should be hit rarely and therefore hopefully have negligible runtime impact.
1 parent cafd63b commit c0cd4d5

5 files changed

Lines changed: 185 additions & 2 deletions

File tree

‎packages/react-reconciler/src/ReactFiberThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,12 +192,30 @@ export function trackUsedThenable<T>(
192192
// a listener that will update its status and result when it resolves.
193193
switch(thenable.status){
194194
case'fulfilled': {
195+
// This could be a bad instrumentation that doesn't set .value.
196+
// We're not type-checking since this is a hot path where you can
197+
// track down easily when something becomes `undefined` unexpectedly.
195198
constfulfilledValue: T=thenable.value;
196199
returnfulfilledValue;
197200
}
198201
case'rejected': {
199202
const rejectedError =thenable.reason;
200203
checkIfUseWrappedInAsyncCatch(rejectedError);
204+
205+
// Rejected Promises are rarer so we're doing an extra type-check in
206+
// case of a bad instrumentation that doesn't set .reason
207+
// If we end up throwing `undefined` it becomes hard to track down
208+
// where that throw originated because no callstack would exist.
209+
// React would still have a Component stack but that could only be used
210+
// as an approximation.
211+
if(rejectedError===undefined&&!('reason'inthenable)){
212+
thrownewError(
213+
'A rejected Promise was passed to React without a `reason` property. '+
214+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
215+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
216+
);
217+
}
218+
201219
throwrejectedError;
202220
}
203221
default: {

‎packages/react-reconciler/src/__tests__/ReactUse-test.js‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,30 @@ describe('ReactUse', () => {
8181
});
8282
}
8383

84+
functionnormalizeCodeLocInfo(str){
85+
return(
86+
str&&
87+
str.replace(
88+
/^+(?:at|in)([\S]+)([^\n]*)(\n?)/gm,
89+
function(m,name,location,eol){
90+
if(location.indexOf(__filename)===-1){
91+
// ignore frames from library code
92+
return'';
93+
}
94+
return(
95+
' in '+
96+
name+
97+
(/:\d+:\d+/.test(m)
98+
? ' '+
99+
location.replace(__dirname,'~').replace(/:\d+:\d+/,':*:*')
100+
: '')+
101+
eol
102+
);
103+
},
104+
)
105+
);
106+
}
107+
84108
functionText({text}){
85109
Scheduler.log(text);
86110
returntext;
@@ -2189,4 +2213,108 @@ describe('ReactUse', () => {
21892213
expect(root).toMatchRenderedOutput('Updated');
21902214
},
21912215
);
2216+
2217+
it('throws a descriptive error when a rejected promise without a reason property is passed to use()',async()=>{
2218+
constbadThenable=Promise.resolve();
2219+
// Simulate bad instrumentation: status is 'rejected' but the reason is not
2220+
// in the `reason` property as intended.
2221+
badThenable.status='rejected';
2222+
badThenable.error=newError('Something went wrong');
2223+
2224+
functionChild(){
2225+
returnuse(badThenable);
2226+
}
2227+
2228+
functionApp({
2229+
// Intentionally destrucutring a prop here so that our production error
2230+
// stack trick is triggered at the beginning of the function
2231+
prop,
2232+
}){
2233+
return<Child/>;
2234+
}
2235+
2236+
constuncaughtErrors=[];
2237+
constroot=ReactNoop.createRoot({
2238+
onUncaughtError(error,errorInfo){
2239+
uncaughtErrors.push({
2240+
callStack: normalizeCodeLocInfo(error.stack),
2241+
ownerStack: React.captureOwnerStack
2242+
? normalizeCodeLocInfo(React.captureOwnerStack())
2243+
: null,
2244+
componentStack: normalizeCodeLocInfo(errorInfo.componentStack),
2245+
});
2246+
},
2247+
});
2248+
2249+
awaitact(()=>{
2250+
root.render(<App/>);
2251+
});
2252+
2253+
expect(uncaughtErrors).toEqual([
2254+
{
2255+
callStack:
2256+
'Error: A rejected Promise was passed to React without a `reason` property. '+
2257+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
2258+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`."+
2259+
'\n in Child (~/ReactUse-test.js:*:*)'+
2260+
'\n in Object.<anonymous> (~/ReactUse-test.js:*:*)',
2261+
componentStack:
2262+
'\n in Child (~/ReactUse-test.js:*:*)'+
2263+
'\n in App (~/ReactUse-test.js:*:*)',
2264+
ownerStack: __DEV__ ? '\n in App (~/ReactUse-test.js:*:*)' : null,
2265+
},
2266+
]);
2267+
});
2268+
2269+
it('throws a descriptive error when a rejected promise without a reason property is used as a child',async()=>{
2270+
constbadThenable=Promise.resolve();
2271+
// Simulate bad instrumentation: status is 'rejected' but the reason is not
2272+
// in the `reason` property as intended.
2273+
badThenable.status='rejected';
2274+
badThenable.error=newError('Something went wrong');
2275+
2276+
functionChild(){
2277+
return<div>{badThenable}</div>;
2278+
}
2279+
2280+
functionApp({
2281+
// Intentionally destrucutring a prop here so that our production error
2282+
// stack trick is triggered at the beginning of the function
2283+
prop,
2284+
}){
2285+
return<Child/>;
2286+
}
2287+
2288+
constuncaughtErrors=[];
2289+
constroot=ReactNoop.createRoot({
2290+
onUncaughtError(error,errorInfo){
2291+
uncaughtErrors.push({
2292+
callStack: normalizeCodeLocInfo(error.stack),
2293+
ownerStack: React.captureOwnerStack
2294+
? normalizeCodeLocInfo(React.captureOwnerStack())
2295+
: null,
2296+
componentStack: normalizeCodeLocInfo(errorInfo.componentStack),
2297+
});
2298+
},
2299+
});
2300+
2301+
awaitact(()=>{
2302+
root.render(<App/>);
2303+
});
2304+
2305+
expect(uncaughtErrors).toEqual([
2306+
{
2307+
callStack:
2308+
'Error: A rejected Promise was passed to React without a `reason` property. '+
2309+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
2310+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`."+
2311+
'\n in Object.<anonymous> (~/ReactUse-test.js:*:*)',
2312+
componentStack: '\n in App (~/ReactUse-test.js:*:*)',
2313+
ownerStack: __DEV__
2314+
? // TODO: Should start in Child since that's the owner.
2315+
'\n in App (~/ReactUse-test.js:*:*)'
2316+
: null,
2317+
},
2318+
]);
2319+
});
21922320
});

‎packages/react-server/src/ReactFizzThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,29 @@ export function trackUsedThenable<T>(
6969
// a listener that will update its status and result when it resolves.
7070
switch(thenable.status){
7171
case'fulfilled': {
72+
// This could be a bad instrumentation that doesn't set .value.
73+
// We're not type-checking since this is a hot path where you can
74+
// track down easily when something becomes `undefined` unexpectedly.
7275
constfulfilledValue: T=thenable.value;
7376
returnfulfilledValue;
7477
}
7578
case'rejected': {
7679
constrejectedError=thenable.reason;
80+
81+
// Rejected Promises are rarer so we're doing an extra type-check in
82+
// case of a bad instrumentation that doesn't set .reason
83+
// If we end up throwing `undefined` it becomes hard to track down
84+
// where that throw originated because no callstack would exist.
85+
// React would still have a Component stack but that could only be used
86+
// as an approximation.
87+
if(rejectedError===undefined&&!('reason'inthenable)){
88+
thrownewError(
89+
'A rejected Promise was passed to React without a `reason` property. '+
90+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
91+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
92+
);
93+
}
94+
7795
throwrejectedError;
7896
}
7997
default: {

‎packages/react-server/src/ReactFlightThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,29 @@ export function trackUsedThenable<T>(
7777
// a listener that will update its status and result when it resolves.
7878
switch(thenable.status){
7979
case'fulfilled': {
80+
// This could be a bad instrumentation that doesn't set .value.
81+
// We're not type-checking since this is a hot path where you can
82+
// track down easily when something becomes `undefined` unexpectedly.
8083
constfulfilledValue: T=thenable.value;
8184
returnfulfilledValue;
8285
}
8386
case'rejected': {
8487
constrejectedError=thenable.reason;
88+
89+
// Rejected Promises are rarer so we're doing an extra type-check in
90+
// case of a bad instrumentation that doesn't set .reason
91+
// If we end up throwing `undefined` it becomes hard to track down
92+
// where that throw originated because no callstack would exist.
93+
// React would still have a Component stack but that could only be used
94+
// as an approximation.
95+
if(rejectedError===undefined&&!('reason'inthenable)){
96+
thrownewError(
97+
'A rejected Promise was passed to React without a `reason` property. '+
98+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
99+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
100+
);
101+
}
102+
85103
throwrejectedError;
86104
}
87105
default: {

‎scripts/error-codes/codes.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -584,5 +584,6 @@
584584
"596": "Could not find the module \"%s\" in the React Client Manifest. This is probably a bug in the React Server Components bundler.",
585585
"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.",
586586
"598": "Maximum update depth exceeded. This could be an infinite loop. This can happen when a component repeatedly calls setState during render phase or inside useLayoutEffect, causing infinite render loop. React limits the number of nested updates to prevent infinite loops.",
587-
"599": "Expected an initialized chunk but got an initialized stream chunk instead. This payload may have been submitted by an older version of React."
588-
}
587+
"599": "Expected an initialized chunk but got an initialized stream chunk instead. This payload may have been submitted by an older version of React.",
588+
"600": "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'`."
589+
}

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit c0cd4d5

Browse files
authored
Throw special error if rejected Promises are incorrectly instrumented (#36328)
When a rejected `Promise` is instrumented in userspace while setting the rejection reason in the wrong field (e.g. `error` instead of `reason`), React will throw undefined (because `usable.reason` doesn't exist). This makes it incredibly hard to find the actual rejection reason. React is now throwing a generic error if we couldn't find the rejection reason. That will produce a callstack pointing into the problematic Promise from where you can hopefully extract the real rejection reason (alongside fixing the bad instrumentation). We're doing this in prod since this is unlikely to surface in dev. We're only doing runtime type-checking for the rejected case. That should be hit rarely and therefore hopefully have negligible runtime impact.
1 parent cafd63b commit c0cd4d5

5 files changed

Lines changed: 185 additions & 2 deletions

File tree

‎packages/react-reconciler/src/ReactFiberThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,12 +192,30 @@ export function trackUsedThenable<T>(
192192
// a listener that will update its status and result when it resolves.
193193
switch(thenable.status){
194194
case'fulfilled': {
195+
// This could be a bad instrumentation that doesn't set .value.
196+
// We're not type-checking since this is a hot path where you can
197+
// track down easily when something becomes `undefined` unexpectedly.
195198
constfulfilledValue: T=thenable.value;
196199
returnfulfilledValue;
197200
}
198201
case'rejected': {
199202
const rejectedError =thenable.reason;
200203
checkIfUseWrappedInAsyncCatch(rejectedError);
204+
205+
// Rejected Promises are rarer so we're doing an extra type-check in
206+
// case of a bad instrumentation that doesn't set .reason
207+
// If we end up throwing `undefined` it becomes hard to track down
208+
// where that throw originated because no callstack would exist.
209+
// React would still have a Component stack but that could only be used
210+
// as an approximation.
211+
if(rejectedError===undefined&&!('reason'inthenable)){
212+
thrownewError(
213+
'A rejected Promise was passed to React without a `reason` property. '+
214+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
215+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
216+
);
217+
}
218+
201219
throwrejectedError;
202220
}
203221
default: {

‎packages/react-reconciler/src/__tests__/ReactUse-test.js‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,30 @@ describe('ReactUse', () => {
8181
});
8282
}
8383

84+
functionnormalizeCodeLocInfo(str){
85+
return(
86+
str&&
87+
str.replace(
88+
/^+(?:at|in)([\S]+)([^\n]*)(\n?)/gm,
89+
function(m,name,location,eol){
90+
if(location.indexOf(__filename)===-1){
91+
// ignore frames from library code
92+
return'';
93+
}
94+
return(
95+
' in '+
96+
name+
97+
(/:\d+:\d+/.test(m)
98+
? ' '+
99+
location.replace(__dirname,'~').replace(/:\d+:\d+/,':*:*')
100+
: '')+
101+
eol
102+
);
103+
},
104+
)
105+
);
106+
}
107+
84108
functionText({text}){
85109
Scheduler.log(text);
86110
returntext;
@@ -2189,4 +2213,108 @@ describe('ReactUse', () => {
21892213
expect(root).toMatchRenderedOutput('Updated');
21902214
},
21912215
);
2216+
2217+
it('throws a descriptive error when a rejected promise without a reason property is passed to use()',async()=>{
2218+
constbadThenable=Promise.resolve();
2219+
// Simulate bad instrumentation: status is 'rejected' but the reason is not
2220+
// in the `reason` property as intended.
2221+
badThenable.status='rejected';
2222+
badThenable.error=newError('Something went wrong');
2223+
2224+
functionChild(){
2225+
returnuse(badThenable);
2226+
}
2227+
2228+
functionApp({
2229+
// Intentionally destrucutring a prop here so that our production error
2230+
// stack trick is triggered at the beginning of the function
2231+
prop,
2232+
}){
2233+
return<Child/>;
2234+
}
2235+
2236+
constuncaughtErrors=[];
2237+
constroot=ReactNoop.createRoot({
2238+
onUncaughtError(error,errorInfo){
2239+
uncaughtErrors.push({
2240+
callStack: normalizeCodeLocInfo(error.stack),
2241+
ownerStack: React.captureOwnerStack
2242+
? normalizeCodeLocInfo(React.captureOwnerStack())
2243+
: null,
2244+
componentStack: normalizeCodeLocInfo(errorInfo.componentStack),
2245+
});
2246+
},
2247+
});
2248+
2249+
awaitact(()=>{
2250+
root.render(<App/>);
2251+
});
2252+
2253+
expect(uncaughtErrors).toEqual([
2254+
{
2255+
callStack:
2256+
'Error: A rejected Promise was passed to React without a `reason` property. '+
2257+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
2258+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`."+
2259+
'\n in Child (~/ReactUse-test.js:*:*)'+
2260+
'\n in Object.<anonymous> (~/ReactUse-test.js:*:*)',
2261+
componentStack:
2262+
'\n in Child (~/ReactUse-test.js:*:*)'+
2263+
'\n in App (~/ReactUse-test.js:*:*)',
2264+
ownerStack: __DEV__ ? '\n in App (~/ReactUse-test.js:*:*)' : null,
2265+
},
2266+
]);
2267+
});
2268+
2269+
it('throws a descriptive error when a rejected promise without a reason property is used as a child',async()=>{
2270+
constbadThenable=Promise.resolve();
2271+
// Simulate bad instrumentation: status is 'rejected' but the reason is not
2272+
// in the `reason` property as intended.
2273+
badThenable.status='rejected';
2274+
badThenable.error=newError('Something went wrong');
2275+
2276+
functionChild(){
2277+
return<div>{badThenable}</div>;
2278+
}
2279+
2280+
functionApp({
2281+
// Intentionally destrucutring a prop here so that our production error
2282+
// stack trick is triggered at the beginning of the function
2283+
prop,
2284+
}){
2285+
return<Child/>;
2286+
}
2287+
2288+
constuncaughtErrors=[];
2289+
constroot=ReactNoop.createRoot({
2290+
onUncaughtError(error,errorInfo){
2291+
uncaughtErrors.push({
2292+
callStack: normalizeCodeLocInfo(error.stack),
2293+
ownerStack: React.captureOwnerStack
2294+
? normalizeCodeLocInfo(React.captureOwnerStack())
2295+
: null,
2296+
componentStack: normalizeCodeLocInfo(errorInfo.componentStack),
2297+
});
2298+
},
2299+
});
2300+
2301+
awaitact(()=>{
2302+
root.render(<App/>);
2303+
});
2304+
2305+
expect(uncaughtErrors).toEqual([
2306+
{
2307+
callStack:
2308+
'Error: A rejected Promise was passed to React without a `reason` property. '+
2309+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
2310+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`."+
2311+
'\n in Object.<anonymous> (~/ReactUse-test.js:*:*)',
2312+
componentStack: '\n in App (~/ReactUse-test.js:*:*)',
2313+
ownerStack: __DEV__
2314+
? // TODO: Should start in Child since that's the owner.
2315+
'\n in App (~/ReactUse-test.js:*:*)'
2316+
: null,
2317+
},
2318+
]);
2319+
});
21922320
});

‎packages/react-server/src/ReactFizzThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,29 @@ export function trackUsedThenable<T>(
6969
// a listener that will update its status and result when it resolves.
7070
switch(thenable.status){
7171
case'fulfilled': {
72+
// This could be a bad instrumentation that doesn't set .value.
73+
// We're not type-checking since this is a hot path where you can
74+
// track down easily when something becomes `undefined` unexpectedly.
7275
constfulfilledValue: T=thenable.value;
7376
returnfulfilledValue;
7477
}
7578
case'rejected': {
7679
constrejectedError=thenable.reason;
80+
81+
// Rejected Promises are rarer so we're doing an extra type-check in
82+
// case of a bad instrumentation that doesn't set .reason
83+
// If we end up throwing `undefined` it becomes hard to track down
84+
// where that throw originated because no callstack would exist.
85+
// React would still have a Component stack but that could only be used
86+
// as an approximation.
87+
if(rejectedError===undefined&&!('reason'inthenable)){
88+
thrownewError(
89+
'A rejected Promise was passed to React without a `reason` property. '+
90+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
91+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
92+
);
93+
}
94+
7795
throwrejectedError;
7896
}
7997
default: {

‎packages/react-server/src/ReactFlightThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,29 @@ export function trackUsedThenable<T>(
7777
// a listener that will update its status and result when it resolves.
7878
switch(thenable.status){
7979
case'fulfilled': {
80+
// This could be a bad instrumentation that doesn't set .value.
81+
// We're not type-checking since this is a hot path where you can
82+
// track down easily when something becomes `undefined` unexpectedly.
8083
constfulfilledValue: T=thenable.value;
8184
returnfulfilledValue;
8285
}
8386
case'rejected': {
8487
constrejectedError=thenable.reason;
88+
89+
// Rejected Promises are rarer so we're doing an extra type-check in
90+
// case of a bad instrumentation that doesn't set .reason
91+
// If we end up throwing `undefined` it becomes hard to track down
92+
// where that throw originated because no callstack would exist.
93+
// React would still have a Component stack but that could only be used
94+
// as an approximation.
95+
if(rejectedError===undefined&&!('reason'inthenable)){
96+
thrownewError(
97+
'A rejected Promise was passed to React without a `reason` property. '+
98+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
99+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
100+
);
101+
}
102+
85103
throwrejectedError;
86104
}
87105
default: {

‎scripts/error-codes/codes.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -584,5 +584,6 @@
584584
"596": "Could not find the module \"%s\" in the React Client Manifest. This is probably a bug in the React Server Components bundler.",
585585
"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.",
586586
"598": "Maximum update depth exceeded. This could be an infinite loop. This can happen when a component repeatedly calls setState during render phase or inside useLayoutEffect, causing infinite render loop. React limits the number of nested updates to prevent infinite loops.",
587-
"599": "Expected an initialized chunk but got an initialized stream chunk instead. This payload may have been submitted by an older version of React."
588-
}
587+
"599": "Expected an initialized chunk but got an initialized stream chunk instead. This payload may have been submitted by an older version of React.",
588+
"600": "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'`."
589+
}

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit c0cd4d5

Browse files
authored
Throw special error if rejected Promises are incorrectly instrumented (#36328)
When a rejected `Promise` is instrumented in userspace while setting the rejection reason in the wrong field (e.g. `error` instead of `reason`), React will throw undefined (because `usable.reason` doesn't exist). This makes it incredibly hard to find the actual rejection reason. React is now throwing a generic error if we couldn't find the rejection reason. That will produce a callstack pointing into the problematic Promise from where you can hopefully extract the real rejection reason (alongside fixing the bad instrumentation). We're doing this in prod since this is unlikely to surface in dev. We're only doing runtime type-checking for the rejected case. That should be hit rarely and therefore hopefully have negligible runtime impact.
1 parent cafd63b commit c0cd4d5

5 files changed

Lines changed: 185 additions & 2 deletions

File tree

‎packages/react-reconciler/src/ReactFiberThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,12 +192,30 @@ export function trackUsedThenable<T>(
192192
// a listener that will update its status and result when it resolves.
193193
switch(thenable.status){
194194
case'fulfilled': {
195+
// This could be a bad instrumentation that doesn't set .value.
196+
// We're not type-checking since this is a hot path where you can
197+
// track down easily when something becomes `undefined` unexpectedly.
195198
constfulfilledValue: T=thenable.value;
196199
returnfulfilledValue;
197200
}
198201
case'rejected': {
199202
const rejectedError =thenable.reason;
200203
checkIfUseWrappedInAsyncCatch(rejectedError);
204+
205+
// Rejected Promises are rarer so we're doing an extra type-check in
206+
// case of a bad instrumentation that doesn't set .reason
207+
// If we end up throwing `undefined` it becomes hard to track down
208+
// where that throw originated because no callstack would exist.
209+
// React would still have a Component stack but that could only be used
210+
// as an approximation.
211+
if(rejectedError===undefined&&!('reason'inthenable)){
212+
thrownewError(
213+
'A rejected Promise was passed to React without a `reason` property. '+
214+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
215+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
216+
);
217+
}
218+
201219
throwrejectedError;
202220
}
203221
default: {

‎packages/react-reconciler/src/__tests__/ReactUse-test.js‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,30 @@ describe('ReactUse', () => {
8181
});
8282
}
8383

84+
functionnormalizeCodeLocInfo(str){
85+
return(
86+
str&&
87+
str.replace(
88+
/^+(?:at|in)([\S]+)([^\n]*)(\n?)/gm,
89+
function(m,name,location,eol){
90+
if(location.indexOf(__filename)===-1){
91+
// ignore frames from library code
92+
return'';
93+
}
94+
return(
95+
' in '+
96+
name+
97+
(/:\d+:\d+/.test(m)
98+
? ' '+
99+
location.replace(__dirname,'~').replace(/:\d+:\d+/,':*:*')
100+
: '')+
101+
eol
102+
);
103+
},
104+
)
105+
);
106+
}
107+
84108
functionText({text}){
85109
Scheduler.log(text);
86110
returntext;
@@ -2189,4 +2213,108 @@ describe('ReactUse', () => {
21892213
expect(root).toMatchRenderedOutput('Updated');
21902214
},
21912215
);
2216+
2217+
it('throws a descriptive error when a rejected promise without a reason property is passed to use()',async()=>{
2218+
constbadThenable=Promise.resolve();
2219+
// Simulate bad instrumentation: status is 'rejected' but the reason is not
2220+
// in the `reason` property as intended.
2221+
badThenable.status='rejected';
2222+
badThenable.error=newError('Something went wrong');
2223+
2224+
functionChild(){
2225+
returnuse(badThenable);
2226+
}
2227+
2228+
functionApp({
2229+
// Intentionally destrucutring a prop here so that our production error
2230+
// stack trick is triggered at the beginning of the function
2231+
prop,
2232+
}){
2233+
return<Child/>;
2234+
}
2235+
2236+
constuncaughtErrors=[];
2237+
constroot=ReactNoop.createRoot({
2238+
onUncaughtError(error,errorInfo){
2239+
uncaughtErrors.push({
2240+
callStack: normalizeCodeLocInfo(error.stack),
2241+
ownerStack: React.captureOwnerStack
2242+
? normalizeCodeLocInfo(React.captureOwnerStack())
2243+
: null,
2244+
componentStack: normalizeCodeLocInfo(errorInfo.componentStack),
2245+
});
2246+
},
2247+
});
2248+
2249+
awaitact(()=>{
2250+
root.render(<App/>);
2251+
});
2252+
2253+
expect(uncaughtErrors).toEqual([
2254+
{
2255+
callStack:
2256+
'Error: A rejected Promise was passed to React without a `reason` property. '+
2257+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
2258+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`."+
2259+
'\n in Child (~/ReactUse-test.js:*:*)'+
2260+
'\n in Object.<anonymous> (~/ReactUse-test.js:*:*)',
2261+
componentStack:
2262+
'\n in Child (~/ReactUse-test.js:*:*)'+
2263+
'\n in App (~/ReactUse-test.js:*:*)',
2264+
ownerStack: __DEV__ ? '\n in App (~/ReactUse-test.js:*:*)' : null,
2265+
},
2266+
]);
2267+
});
2268+
2269+
it('throws a descriptive error when a rejected promise without a reason property is used as a child',async()=>{
2270+
constbadThenable=Promise.resolve();
2271+
// Simulate bad instrumentation: status is 'rejected' but the reason is not
2272+
// in the `reason` property as intended.
2273+
badThenable.status='rejected';
2274+
badThenable.error=newError('Something went wrong');
2275+
2276+
functionChild(){
2277+
return<div>{badThenable}</div>;
2278+
}
2279+
2280+
functionApp({
2281+
// Intentionally destrucutring a prop here so that our production error
2282+
// stack trick is triggered at the beginning of the function
2283+
prop,
2284+
}){
2285+
return<Child/>;
2286+
}
2287+
2288+
constuncaughtErrors=[];
2289+
constroot=ReactNoop.createRoot({
2290+
onUncaughtError(error,errorInfo){
2291+
uncaughtErrors.push({
2292+
callStack: normalizeCodeLocInfo(error.stack),
2293+
ownerStack: React.captureOwnerStack
2294+
? normalizeCodeLocInfo(React.captureOwnerStack())
2295+
: null,
2296+
componentStack: normalizeCodeLocInfo(errorInfo.componentStack),
2297+
});
2298+
},
2299+
});
2300+
2301+
awaitact(()=>{
2302+
root.render(<App/>);
2303+
});
2304+
2305+
expect(uncaughtErrors).toEqual([
2306+
{
2307+
callStack:
2308+
'Error: A rejected Promise was passed to React without a `reason` property. '+
2309+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
2310+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`."+
2311+
'\n in Object.<anonymous> (~/ReactUse-test.js:*:*)',
2312+
componentStack: '\n in App (~/ReactUse-test.js:*:*)',
2313+
ownerStack: __DEV__
2314+
? // TODO: Should start in Child since that's the owner.
2315+
'\n in App (~/ReactUse-test.js:*:*)'
2316+
: null,
2317+
},
2318+
]);
2319+
});
21922320
});

‎packages/react-server/src/ReactFizzThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,29 @@ export function trackUsedThenable<T>(
6969
// a listener that will update its status and result when it resolves.
7070
switch(thenable.status){
7171
case'fulfilled': {
72+
// This could be a bad instrumentation that doesn't set .value.
73+
// We're not type-checking since this is a hot path where you can
74+
// track down easily when something becomes `undefined` unexpectedly.
7275
constfulfilledValue: T=thenable.value;
7376
returnfulfilledValue;
7477
}
7578
case'rejected': {
7679
constrejectedError=thenable.reason;
80+
81+
// Rejected Promises are rarer so we're doing an extra type-check in
82+
// case of a bad instrumentation that doesn't set .reason
83+
// If we end up throwing `undefined` it becomes hard to track down
84+
// where that throw originated because no callstack would exist.
85+
// React would still have a Component stack but that could only be used
86+
// as an approximation.
87+
if(rejectedError===undefined&&!('reason'inthenable)){
88+
thrownewError(
89+
'A rejected Promise was passed to React without a `reason` property. '+
90+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
91+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
92+
);
93+
}
94+
7795
throwrejectedError;
7896
}
7997
default: {

‎packages/react-server/src/ReactFlightThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,29 @@ export function trackUsedThenable<T>(
7777
// a listener that will update its status and result when it resolves.
7878
switch(thenable.status){
7979
case'fulfilled': {
80+
// This could be a bad instrumentation that doesn't set .value.
81+
// We're not type-checking since this is a hot path where you can
82+
// track down easily when something becomes `undefined` unexpectedly.
8083
constfulfilledValue: T=thenable.value;
8184
returnfulfilledValue;
8285
}
8386
case'rejected': {
8487
constrejectedError=thenable.reason;
88+
89+
// Rejected Promises are rarer so we're doing an extra type-check in
90+
// case of a bad instrumentation that doesn't set .reason
91+
// If we end up throwing `undefined` it becomes hard to track down
92+
// where that throw originated because no callstack would exist.
93+
// React would still have a Component stack but that could only be used
94+
// as an approximation.
95+
if(rejectedError===undefined&&!('reason'inthenable)){
96+
thrownewError(
97+
'A rejected Promise was passed to React without a `reason` property. '+
98+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
99+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
100+
);
101+
}
102+
85103
throwrejectedError;
86104
}
87105
default: {

‎scripts/error-codes/codes.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -584,5 +584,6 @@
584584
"596": "Could not find the module \"%s\" in the React Client Manifest. This is probably a bug in the React Server Components bundler.",
585585
"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.",
586586
"598": "Maximum update depth exceeded. This could be an infinite loop. This can happen when a component repeatedly calls setState during render phase or inside useLayoutEffect, causing infinite render loop. React limits the number of nested updates to prevent infinite loops.",
587-
"599": "Expected an initialized chunk but got an initialized stream chunk instead. This payload may have been submitted by an older version of React."
588-
}
587+
"599": "Expected an initialized chunk but got an initialized stream chunk instead. This payload may have been submitted by an older version of React.",
588+
"600": "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'`."
589+
}

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Commit c0cd4d5

Browse files
authored
Throw special error if rejected Promises are incorrectly instrumented (#36328)
When a rejected `Promise` is instrumented in userspace while setting the rejection reason in the wrong field (e.g. `error` instead of `reason`), React will throw undefined (because `usable.reason` doesn't exist). This makes it incredibly hard to find the actual rejection reason. React is now throwing a generic error if we couldn't find the rejection reason. That will produce a callstack pointing into the problematic Promise from where you can hopefully extract the real rejection reason (alongside fixing the bad instrumentation). We're doing this in prod since this is unlikely to surface in dev. We're only doing runtime type-checking for the rejected case. That should be hit rarely and therefore hopefully have negligible runtime impact.
1 parent cafd63b commit c0cd4d5

5 files changed

Lines changed: 185 additions & 2 deletions

File tree

‎packages/react-reconciler/src/ReactFiberThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,12 +192,30 @@ export function trackUsedThenable<T>(
192192
// a listener that will update its status and result when it resolves.
193193
switch(thenable.status){
194194
case'fulfilled': {
195+
// This could be a bad instrumentation that doesn't set .value.
196+
// We're not type-checking since this is a hot path where you can
197+
// track down easily when something becomes `undefined` unexpectedly.
195198
constfulfilledValue: T=thenable.value;
196199
returnfulfilledValue;
197200
}
198201
case'rejected': {
199202
const rejectedError =thenable.reason;
200203
checkIfUseWrappedInAsyncCatch(rejectedError);
204+
205+
// Rejected Promises are rarer so we're doing an extra type-check in
206+
// case of a bad instrumentation that doesn't set .reason
207+
// If we end up throwing `undefined` it becomes hard to track down
208+
// where that throw originated because no callstack would exist.
209+
// React would still have a Component stack but that could only be used
210+
// as an approximation.
211+
if(rejectedError===undefined&&!('reason'inthenable)){
212+
thrownewError(
213+
'A rejected Promise was passed to React without a `reason` property. '+
214+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
215+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
216+
);
217+
}
218+
201219
throwrejectedError;
202220
}
203221
default: {

‎packages/react-reconciler/src/__tests__/ReactUse-test.js‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,30 @@ describe('ReactUse', () => {
8181
});
8282
}
8383

84+
functionnormalizeCodeLocInfo(str){
85+
return(
86+
str&&
87+
str.replace(
88+
/^+(?:at|in)([\S]+)([^\n]*)(\n?)/gm,
89+
function(m,name,location,eol){
90+
if(location.indexOf(__filename)===-1){
91+
// ignore frames from library code
92+
return'';
93+
}
94+
return(
95+
' in '+
96+
name+
97+
(/:\d+:\d+/.test(m)
98+
? ' '+
99+
location.replace(__dirname,'~').replace(/:\d+:\d+/,':*:*')
100+
: '')+
101+
eol
102+
);
103+
},
104+
)
105+
);
106+
}
107+
84108
functionText({text}){
85109
Scheduler.log(text);
86110
returntext;
@@ -2189,4 +2213,108 @@ describe('ReactUse', () => {
21892213
expect(root).toMatchRenderedOutput('Updated');
21902214
},
21912215
);
2216+
2217+
it('throws a descriptive error when a rejected promise without a reason property is passed to use()',async()=>{
2218+
constbadThenable=Promise.resolve();
2219+
// Simulate bad instrumentation: status is 'rejected' but the reason is not
2220+
// in the `reason` property as intended.
2221+
badThenable.status='rejected';
2222+
badThenable.error=newError('Something went wrong');
2223+
2224+
functionChild(){
2225+
returnuse(badThenable);
2226+
}
2227+
2228+
functionApp({
2229+
// Intentionally destrucutring a prop here so that our production error
2230+
// stack trick is triggered at the beginning of the function
2231+
prop,
2232+
}){
2233+
return<Child/>;
2234+
}
2235+
2236+
constuncaughtErrors=[];
2237+
constroot=ReactNoop.createRoot({
2238+
onUncaughtError(error,errorInfo){
2239+
uncaughtErrors.push({
2240+
callStack: normalizeCodeLocInfo(error.stack),
2241+
ownerStack: React.captureOwnerStack
2242+
? normalizeCodeLocInfo(React.captureOwnerStack())
2243+
: null,
2244+
componentStack: normalizeCodeLocInfo(errorInfo.componentStack),
2245+
});
2246+
},
2247+
});
2248+
2249+
awaitact(()=>{
2250+
root.render(<App/>);
2251+
});
2252+
2253+
expect(uncaughtErrors).toEqual([
2254+
{
2255+
callStack:
2256+
'Error: A rejected Promise was passed to React without a `reason` property. '+
2257+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
2258+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`."+
2259+
'\n in Child (~/ReactUse-test.js:*:*)'+
2260+
'\n in Object.<anonymous> (~/ReactUse-test.js:*:*)',
2261+
componentStack:
2262+
'\n in Child (~/ReactUse-test.js:*:*)'+
2263+
'\n in App (~/ReactUse-test.js:*:*)',
2264+
ownerStack: __DEV__ ? '\n in App (~/ReactUse-test.js:*:*)' : null,
2265+
},
2266+
]);
2267+
});
2268+
2269+
it('throws a descriptive error when a rejected promise without a reason property is used as a child',async()=>{
2270+
constbadThenable=Promise.resolve();
2271+
// Simulate bad instrumentation: status is 'rejected' but the reason is not
2272+
// in the `reason` property as intended.
2273+
badThenable.status='rejected';
2274+
badThenable.error=newError('Something went wrong');
2275+
2276+
functionChild(){
2277+
return<div>{badThenable}</div>;
2278+
}
2279+
2280+
functionApp({
2281+
// Intentionally destrucutring a prop here so that our production error
2282+
// stack trick is triggered at the beginning of the function
2283+
prop,
2284+
}){
2285+
return<Child/>;
2286+
}
2287+
2288+
constuncaughtErrors=[];
2289+
constroot=ReactNoop.createRoot({
2290+
onUncaughtError(error,errorInfo){
2291+
uncaughtErrors.push({
2292+
callStack: normalizeCodeLocInfo(error.stack),
2293+
ownerStack: React.captureOwnerStack
2294+
? normalizeCodeLocInfo(React.captureOwnerStack())
2295+
: null,
2296+
componentStack: normalizeCodeLocInfo(errorInfo.componentStack),
2297+
});
2298+
},
2299+
});
2300+
2301+
awaitact(()=>{
2302+
root.render(<App/>);
2303+
});
2304+
2305+
expect(uncaughtErrors).toEqual([
2306+
{
2307+
callStack:
2308+
'Error: A rejected Promise was passed to React without a `reason` property. '+
2309+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
2310+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`."+
2311+
'\n in Object.<anonymous> (~/ReactUse-test.js:*:*)',
2312+
componentStack: '\n in App (~/ReactUse-test.js:*:*)',
2313+
ownerStack: __DEV__
2314+
? // TODO: Should start in Child since that's the owner.
2315+
'\n in App (~/ReactUse-test.js:*:*)'
2316+
: null,
2317+
},
2318+
]);
2319+
});
21922320
});

‎packages/react-server/src/ReactFizzThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,29 @@ export function trackUsedThenable<T>(
6969
// a listener that will update its status and result when it resolves.
7070
switch(thenable.status){
7171
case'fulfilled': {
72+
// This could be a bad instrumentation that doesn't set .value.
73+
// We're not type-checking since this is a hot path where you can
74+
// track down easily when something becomes `undefined` unexpectedly.
7275
constfulfilledValue: T=thenable.value;
7376
returnfulfilledValue;
7477
}
7578
case'rejected': {
7679
constrejectedError=thenable.reason;
80+
81+
// Rejected Promises are rarer so we're doing an extra type-check in
82+
// case of a bad instrumentation that doesn't set .reason
83+
// If we end up throwing `undefined` it becomes hard to track down
84+
// where that throw originated because no callstack would exist.
85+
// React would still have a Component stack but that could only be used
86+
// as an approximation.
87+
if(rejectedError===undefined&&!('reason'inthenable)){
88+
thrownewError(
89+
'A rejected Promise was passed to React without a `reason` property. '+
90+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
91+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
92+
);
93+
}
94+
7795
throwrejectedError;
7896
}
7997
default: {

‎packages/react-server/src/ReactFlightThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,29 @@ export function trackUsedThenable<T>(
7777
// a listener that will update its status and result when it resolves.
7878
switch(thenable.status){
7979
case'fulfilled': {
80+
// This could be a bad instrumentation that doesn't set .value.
81+
// We're not type-checking since this is a hot path where you can
82+
// track down easily when something becomes `undefined` unexpectedly.
8083
constfulfilledValue: T=thenable.value;
8184
returnfulfilledValue;
8285
}
8386
case'rejected': {
8487
constrejectedError=thenable.reason;
88+
89+
// Rejected Promises are rarer so we're doing an extra type-check in
90+
// case of a bad instrumentation that doesn't set .reason
91+
// If we end up throwing `undefined` it becomes hard to track down
92+
// where that throw originated because no callstack would exist.
93+
// React would still have a Component stack but that could only be used
94+
// as an approximation.
95+
if(rejectedError===undefined&&!('reason'inthenable)){
96+
thrownewError(
97+
'A rejected Promise was passed to React without a `reason` property. '+
98+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
99+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
100+
);
101+
}
102+
85103
throwrejectedError;
86104
}
87105
default: {

‎scripts/error-codes/codes.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -584,5 +584,6 @@
584584
"596": "Could not find the module \"%s\" in the React Client Manifest. This is probably a bug in the React Server Components bundler.",
585585
"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.",
586586
"598": "Maximum update depth exceeded. This could be an infinite loop. This can happen when a component repeatedly calls setState during render phase or inside useLayoutEffect, causing infinite render loop. React limits the number of nested updates to prevent infinite loops.",
587-
"599": "Expected an initialized chunk but got an initialized stream chunk instead. This payload may have been submitted by an older version of React."
588-
}
587+
"599": "Expected an initialized chunk but got an initialized stream chunk instead. This payload may have been submitted by an older version of React.",
588+
"600": "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'`."
589+
}

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit c0cd4d5

Browse files
authored
Throw special error if rejected Promises are incorrectly instrumented (#36328)
When a rejected `Promise` is instrumented in userspace while setting the rejection reason in the wrong field (e.g. `error` instead of `reason`), React will throw undefined (because `usable.reason` doesn't exist). This makes it incredibly hard to find the actual rejection reason. React is now throwing a generic error if we couldn't find the rejection reason. That will produce a callstack pointing into the problematic Promise from where you can hopefully extract the real rejection reason (alongside fixing the bad instrumentation). We're doing this in prod since this is unlikely to surface in dev. We're only doing runtime type-checking for the rejected case. That should be hit rarely and therefore hopefully have negligible runtime impact.
1 parent cafd63b commit c0cd4d5

5 files changed

Lines changed: 185 additions & 2 deletions

File tree

‎packages/react-reconciler/src/ReactFiberThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,12 +192,30 @@ export function trackUsedThenable<T>(
192192
// a listener that will update its status and result when it resolves.
193193
switch(thenable.status){
194194
case'fulfilled': {
195+
// This could be a bad instrumentation that doesn't set .value.
196+
// We're not type-checking since this is a hot path where you can
197+
// track down easily when something becomes `undefined` unexpectedly.
195198
constfulfilledValue: T=thenable.value;
196199
returnfulfilledValue;
197200
}
198201
case'rejected': {
199202
const rejectedError =thenable.reason;
200203
checkIfUseWrappedInAsyncCatch(rejectedError);
204+
205+
// Rejected Promises are rarer so we're doing an extra type-check in
206+
// case of a bad instrumentation that doesn't set .reason
207+
// If we end up throwing `undefined` it becomes hard to track down
208+
// where that throw originated because no callstack would exist.
209+
// React would still have a Component stack but that could only be used
210+
// as an approximation.
211+
if(rejectedError===undefined&&!('reason'inthenable)){
212+
thrownewError(
213+
'A rejected Promise was passed to React without a `reason` property. '+
214+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
215+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
216+
);
217+
}
218+
201219
throwrejectedError;
202220
}
203221
default: {

‎packages/react-reconciler/src/__tests__/ReactUse-test.js‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,30 @@ describe('ReactUse', () => {
8181
});
8282
}
8383

84+
functionnormalizeCodeLocInfo(str){
85+
return(
86+
str&&
87+
str.replace(
88+
/^+(?:at|in)([\S]+)([^\n]*)(\n?)/gm,
89+
function(m,name,location,eol){
90+
if(location.indexOf(__filename)===-1){
91+
// ignore frames from library code
92+
return'';
93+
}
94+
return(
95+
' in '+
96+
name+
97+
(/:\d+:\d+/.test(m)
98+
? ' '+
99+
location.replace(__dirname,'~').replace(/:\d+:\d+/,':*:*')
100+
: '')+
101+
eol
102+
);
103+
},
104+
)
105+
);
106+
}
107+
84108
functionText({text}){
85109
Scheduler.log(text);
86110
returntext;
@@ -2189,4 +2213,108 @@ describe('ReactUse', () => {
21892213
expect(root).toMatchRenderedOutput('Updated');
21902214
},
21912215
);
2216+
2217+
it('throws a descriptive error when a rejected promise without a reason property is passed to use()',async()=>{
2218+
constbadThenable=Promise.resolve();
2219+
// Simulate bad instrumentation: status is 'rejected' but the reason is not
2220+
// in the `reason` property as intended.
2221+
badThenable.status='rejected';
2222+
badThenable.error=newError('Something went wrong');
2223+
2224+
functionChild(){
2225+
returnuse(badThenable);
2226+
}
2227+
2228+
functionApp({
2229+
// Intentionally destrucutring a prop here so that our production error
2230+
// stack trick is triggered at the beginning of the function
2231+
prop,
2232+
}){
2233+
return<Child/>;
2234+
}
2235+
2236+
constuncaughtErrors=[];
2237+
constroot=ReactNoop.createRoot({
2238+
onUncaughtError(error,errorInfo){
2239+
uncaughtErrors.push({
2240+
callStack: normalizeCodeLocInfo(error.stack),
2241+
ownerStack: React.captureOwnerStack
2242+
? normalizeCodeLocInfo(React.captureOwnerStack())
2243+
: null,
2244+
componentStack: normalizeCodeLocInfo(errorInfo.componentStack),
2245+
});
2246+
},
2247+
});
2248+
2249+
awaitact(()=>{
2250+
root.render(<App/>);
2251+
});
2252+
2253+
expect(uncaughtErrors).toEqual([
2254+
{
2255+
callStack:
2256+
'Error: A rejected Promise was passed to React without a `reason` property. '+
2257+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
2258+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`."+
2259+
'\n in Child (~/ReactUse-test.js:*:*)'+
2260+
'\n in Object.<anonymous> (~/ReactUse-test.js:*:*)',
2261+
componentStack:
2262+
'\n in Child (~/ReactUse-test.js:*:*)'+
2263+
'\n in App (~/ReactUse-test.js:*:*)',
2264+
ownerStack: __DEV__ ? '\n in App (~/ReactUse-test.js:*:*)' : null,
2265+
},
2266+
]);
2267+
});
2268+
2269+
it('throws a descriptive error when a rejected promise without a reason property is used as a child',async()=>{
2270+
constbadThenable=Promise.resolve();
2271+
// Simulate bad instrumentation: status is 'rejected' but the reason is not
2272+
// in the `reason` property as intended.
2273+
badThenable.status='rejected';
2274+
badThenable.error=newError('Something went wrong');
2275+
2276+
functionChild(){
2277+
return<div>{badThenable}</div>;
2278+
}
2279+
2280+
functionApp({
2281+
// Intentionally destrucutring a prop here so that our production error
2282+
// stack trick is triggered at the beginning of the function
2283+
prop,
2284+
}){
2285+
return<Child/>;
2286+
}
2287+
2288+
constuncaughtErrors=[];
2289+
constroot=ReactNoop.createRoot({
2290+
onUncaughtError(error,errorInfo){
2291+
uncaughtErrors.push({
2292+
callStack: normalizeCodeLocInfo(error.stack),
2293+
ownerStack: React.captureOwnerStack
2294+
? normalizeCodeLocInfo(React.captureOwnerStack())
2295+
: null,
2296+
componentStack: normalizeCodeLocInfo(errorInfo.componentStack),
2297+
});
2298+
},
2299+
});
2300+
2301+
awaitact(()=>{
2302+
root.render(<App/>);
2303+
});
2304+
2305+
expect(uncaughtErrors).toEqual([
2306+
{
2307+
callStack:
2308+
'Error: A rejected Promise was passed to React without a `reason` property. '+
2309+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
2310+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`."+
2311+
'\n in Object.<anonymous> (~/ReactUse-test.js:*:*)',
2312+
componentStack: '\n in App (~/ReactUse-test.js:*:*)',
2313+
ownerStack: __DEV__
2314+
? // TODO: Should start in Child since that's the owner.
2315+
'\n in App (~/ReactUse-test.js:*:*)'
2316+
: null,
2317+
},
2318+
]);
2319+
});
21922320
});

‎packages/react-server/src/ReactFizzThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,29 @@ export function trackUsedThenable<T>(
6969
// a listener that will update its status and result when it resolves.
7070
switch(thenable.status){
7171
case'fulfilled': {
72+
// This could be a bad instrumentation that doesn't set .value.
73+
// We're not type-checking since this is a hot path where you can
74+
// track down easily when something becomes `undefined` unexpectedly.
7275
constfulfilledValue: T=thenable.value;
7376
returnfulfilledValue;
7477
}
7578
case'rejected': {
7679
constrejectedError=thenable.reason;
80+
81+
// Rejected Promises are rarer so we're doing an extra type-check in
82+
// case of a bad instrumentation that doesn't set .reason
83+
// If we end up throwing `undefined` it becomes hard to track down
84+
// where that throw originated because no callstack would exist.
85+
// React would still have a Component stack but that could only be used
86+
// as an approximation.
87+
if(rejectedError===undefined&&!('reason'inthenable)){
88+
thrownewError(
89+
'A rejected Promise was passed to React without a `reason` property. '+
90+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
91+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
92+
);
93+
}
94+
7795
throwrejectedError;
7896
}
7997
default: {

‎packages/react-server/src/ReactFlightThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,29 @@ export function trackUsedThenable<T>(
7777
// a listener that will update its status and result when it resolves.
7878
switch(thenable.status){
7979
case'fulfilled': {
80+
// This could be a bad instrumentation that doesn't set .value.
81+
// We're not type-checking since this is a hot path where you can
82+
// track down easily when something becomes `undefined` unexpectedly.
8083
constfulfilledValue: T=thenable.value;
8184
returnfulfilledValue;
8285
}
8386
case'rejected': {
8487
constrejectedError=thenable.reason;
88+
89+
// Rejected Promises are rarer so we're doing an extra type-check in
90+
// case of a bad instrumentation that doesn't set .reason
91+
// If we end up throwing `undefined` it becomes hard to track down
92+
// where that throw originated because no callstack would exist.
93+
// React would still have a Component stack but that could only be used
94+
// as an approximation.
95+
if(rejectedError===undefined&&!('reason'inthenable)){
96+
thrownewError(
97+
'A rejected Promise was passed to React without a `reason` property. '+
98+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
99+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
100+
);
101+
}
102+
85103
throwrejectedError;
86104
}
87105
default: {

‎scripts/error-codes/codes.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -584,5 +584,6 @@
584584
"596": "Could not find the module \"%s\" in the React Client Manifest. This is probably a bug in the React Server Components bundler.",
585585
"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.",
586586
"598": "Maximum update depth exceeded. This could be an infinite loop. This can happen when a component repeatedly calls setState during render phase or inside useLayoutEffect, causing infinite render loop. React limits the number of nested updates to prevent infinite loops.",
587-
"599": "Expected an initialized chunk but got an initialized stream chunk instead. This payload may have been submitted by an older version of React."
588-
}
587+
"599": "Expected an initialized chunk but got an initialized stream chunk instead. This payload may have been submitted by an older version of React.",
588+
"600": "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'`."
589+
}

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit c0cd4d5

Browse files
authored
Throw special error if rejected Promises are incorrectly instrumented (#36328)
When a rejected `Promise` is instrumented in userspace while setting the rejection reason in the wrong field (e.g. `error` instead of `reason`), React will throw undefined (because `usable.reason` doesn't exist). This makes it incredibly hard to find the actual rejection reason. React is now throwing a generic error if we couldn't find the rejection reason. That will produce a callstack pointing into the problematic Promise from where you can hopefully extract the real rejection reason (alongside fixing the bad instrumentation). We're doing this in prod since this is unlikely to surface in dev. We're only doing runtime type-checking for the rejected case. That should be hit rarely and therefore hopefully have negligible runtime impact.
1 parent cafd63b commit c0cd4d5

5 files changed

Lines changed: 185 additions & 2 deletions

File tree

‎packages/react-reconciler/src/ReactFiberThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,12 +192,30 @@ export function trackUsedThenable<T>(
192192
// a listener that will update its status and result when it resolves.
193193
switch(thenable.status){
194194
case'fulfilled': {
195+
// This could be a bad instrumentation that doesn't set .value.
196+
// We're not type-checking since this is a hot path where you can
197+
// track down easily when something becomes `undefined` unexpectedly.
195198
constfulfilledValue: T=thenable.value;
196199
returnfulfilledValue;
197200
}
198201
case'rejected': {
199202
const rejectedError =thenable.reason;
200203
checkIfUseWrappedInAsyncCatch(rejectedError);
204+
205+
// Rejected Promises are rarer so we're doing an extra type-check in
206+
// case of a bad instrumentation that doesn't set .reason
207+
// If we end up throwing `undefined` it becomes hard to track down
208+
// where that throw originated because no callstack would exist.
209+
// React would still have a Component stack but that could only be used
210+
// as an approximation.
211+
if(rejectedError===undefined&&!('reason'inthenable)){
212+
thrownewError(
213+
'A rejected Promise was passed to React without a `reason` property. '+
214+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
215+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
216+
);
217+
}
218+
201219
throwrejectedError;
202220
}
203221
default: {

‎packages/react-reconciler/src/__tests__/ReactUse-test.js‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,30 @@ describe('ReactUse', () => {
8181
});
8282
}
8383

84+
functionnormalizeCodeLocInfo(str){
85+
return(
86+
str&&
87+
str.replace(
88+
/^+(?:at|in)([\S]+)([^\n]*)(\n?)/gm,
89+
function(m,name,location,eol){
90+
if(location.indexOf(__filename)===-1){
91+
// ignore frames from library code
92+
return'';
93+
}
94+
return(
95+
' in '+
96+
name+
97+
(/:\d+:\d+/.test(m)
98+
? ' '+
99+
location.replace(__dirname,'~').replace(/:\d+:\d+/,':*:*')
100+
: '')+
101+
eol
102+
);
103+
},
104+
)
105+
);
106+
}
107+
84108
functionText({text}){
85109
Scheduler.log(text);
86110
returntext;
@@ -2189,4 +2213,108 @@ describe('ReactUse', () => {
21892213
expect(root).toMatchRenderedOutput('Updated');
21902214
},
21912215
);
2216+
2217+
it('throws a descriptive error when a rejected promise without a reason property is passed to use()',async()=>{
2218+
constbadThenable=Promise.resolve();
2219+
// Simulate bad instrumentation: status is 'rejected' but the reason is not
2220+
// in the `reason` property as intended.
2221+
badThenable.status='rejected';
2222+
badThenable.error=newError('Something went wrong');
2223+
2224+
functionChild(){
2225+
returnuse(badThenable);
2226+
}
2227+
2228+
functionApp({
2229+
// Intentionally destrucutring a prop here so that our production error
2230+
// stack trick is triggered at the beginning of the function
2231+
prop,
2232+
}){
2233+
return<Child/>;
2234+
}
2235+
2236+
constuncaughtErrors=[];
2237+
constroot=ReactNoop.createRoot({
2238+
onUncaughtError(error,errorInfo){
2239+
uncaughtErrors.push({
2240+
callStack: normalizeCodeLocInfo(error.stack),
2241+
ownerStack: React.captureOwnerStack
2242+
? normalizeCodeLocInfo(React.captureOwnerStack())
2243+
: null,
2244+
componentStack: normalizeCodeLocInfo(errorInfo.componentStack),
2245+
});
2246+
},
2247+
});
2248+
2249+
awaitact(()=>{
2250+
root.render(<App/>);
2251+
});
2252+
2253+
expect(uncaughtErrors).toEqual([
2254+
{
2255+
callStack:
2256+
'Error: A rejected Promise was passed to React without a `reason` property. '+
2257+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
2258+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`."+
2259+
'\n in Child (~/ReactUse-test.js:*:*)'+
2260+
'\n in Object.<anonymous> (~/ReactUse-test.js:*:*)',
2261+
componentStack:
2262+
'\n in Child (~/ReactUse-test.js:*:*)'+
2263+
'\n in App (~/ReactUse-test.js:*:*)',
2264+
ownerStack: __DEV__ ? '\n in App (~/ReactUse-test.js:*:*)' : null,
2265+
},
2266+
]);
2267+
});
2268+
2269+
it('throws a descriptive error when a rejected promise without a reason property is used as a child',async()=>{
2270+
constbadThenable=Promise.resolve();
2271+
// Simulate bad instrumentation: status is 'rejected' but the reason is not
2272+
// in the `reason` property as intended.
2273+
badThenable.status='rejected';
2274+
badThenable.error=newError('Something went wrong');
2275+
2276+
functionChild(){
2277+
return<div>{badThenable}</div>;
2278+
}
2279+
2280+
functionApp({
2281+
// Intentionally destrucutring a prop here so that our production error
2282+
// stack trick is triggered at the beginning of the function
2283+
prop,
2284+
}){
2285+
return<Child/>;
2286+
}
2287+
2288+
constuncaughtErrors=[];
2289+
constroot=ReactNoop.createRoot({
2290+
onUncaughtError(error,errorInfo){
2291+
uncaughtErrors.push({
2292+
callStack: normalizeCodeLocInfo(error.stack),
2293+
ownerStack: React.captureOwnerStack
2294+
? normalizeCodeLocInfo(React.captureOwnerStack())
2295+
: null,
2296+
componentStack: normalizeCodeLocInfo(errorInfo.componentStack),
2297+
});
2298+
},
2299+
});
2300+
2301+
awaitact(()=>{
2302+
root.render(<App/>);
2303+
});
2304+
2305+
expect(uncaughtErrors).toEqual([
2306+
{
2307+
callStack:
2308+
'Error: A rejected Promise was passed to React without a `reason` property. '+
2309+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
2310+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`."+
2311+
'\n in Object.<anonymous> (~/ReactUse-test.js:*:*)',
2312+
componentStack: '\n in App (~/ReactUse-test.js:*:*)',
2313+
ownerStack: __DEV__
2314+
? // TODO: Should start in Child since that's the owner.
2315+
'\n in App (~/ReactUse-test.js:*:*)'
2316+
: null,
2317+
},
2318+
]);
2319+
});
21922320
});

‎packages/react-server/src/ReactFizzThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,29 @@ export function trackUsedThenable<T>(
6969
// a listener that will update its status and result when it resolves.
7070
switch(thenable.status){
7171
case'fulfilled': {
72+
// This could be a bad instrumentation that doesn't set .value.
73+
// We're not type-checking since this is a hot path where you can
74+
// track down easily when something becomes `undefined` unexpectedly.
7275
constfulfilledValue: T=thenable.value;
7376
returnfulfilledValue;
7477
}
7578
case'rejected': {
7679
constrejectedError=thenable.reason;
80+
81+
// Rejected Promises are rarer so we're doing an extra type-check in
82+
// case of a bad instrumentation that doesn't set .reason
83+
// If we end up throwing `undefined` it becomes hard to track down
84+
// where that throw originated because no callstack would exist.
85+
// React would still have a Component stack but that could only be used
86+
// as an approximation.
87+
if(rejectedError===undefined&&!('reason'inthenable)){
88+
thrownewError(
89+
'A rejected Promise was passed to React without a `reason` property. '+
90+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
91+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
92+
);
93+
}
94+
7795
throwrejectedError;
7896
}
7997
default: {

‎packages/react-server/src/ReactFlightThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,29 @@ export function trackUsedThenable<T>(
7777
// a listener that will update its status and result when it resolves.
7878
switch(thenable.status){
7979
case'fulfilled': {
80+
// This could be a bad instrumentation that doesn't set .value.
81+
// We're not type-checking since this is a hot path where you can
82+
// track down easily when something becomes `undefined` unexpectedly.
8083
constfulfilledValue: T=thenable.value;
8184
returnfulfilledValue;
8285
}
8386
case'rejected': {
8487
constrejectedError=thenable.reason;
88+
89+
// Rejected Promises are rarer so we're doing an extra type-check in
90+
// case of a bad instrumentation that doesn't set .reason
91+
// If we end up throwing `undefined` it becomes hard to track down
92+
// where that throw originated because no callstack would exist.
93+
// React would still have a Component stack but that could only be used
94+
// as an approximation.
95+
if(rejectedError===undefined&&!('reason'inthenable)){
96+
thrownewError(
97+
'A rejected Promise was passed to React without a `reason` property. '+
98+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
99+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
100+
);
101+
}
102+
85103
throwrejectedError;
86104
}
87105
default: {

‎scripts/error-codes/codes.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -584,5 +584,6 @@
584584
"596": "Could not find the module \"%s\" in the React Client Manifest. This is probably a bug in the React Server Components bundler.",
585585
"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.",
586586
"598": "Maximum update depth exceeded. This could be an infinite loop. This can happen when a component repeatedly calls setState during render phase or inside useLayoutEffect, causing infinite render loop. React limits the number of nested updates to prevent infinite loops.",
587-
"599": "Expected an initialized chunk but got an initialized stream chunk instead. This payload may have been submitted by an older version of React."
588-
}
587+
"599": "Expected an initialized chunk but got an initialized stream chunk instead. This payload may have been submitted by an older version of React.",
588+
"600": "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'`."
589+
}

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Commit c0cd4d5

Browse files
authored
Throw special error if rejected Promises are incorrectly instrumented (#36328)
When a rejected `Promise` is instrumented in userspace while setting the rejection reason in the wrong field (e.g. `error` instead of `reason`), React will throw undefined (because `usable.reason` doesn't exist). This makes it incredibly hard to find the actual rejection reason. React is now throwing a generic error if we couldn't find the rejection reason. That will produce a callstack pointing into the problematic Promise from where you can hopefully extract the real rejection reason (alongside fixing the bad instrumentation). We're doing this in prod since this is unlikely to surface in dev. We're only doing runtime type-checking for the rejected case. That should be hit rarely and therefore hopefully have negligible runtime impact.
1 parent cafd63b commit c0cd4d5

5 files changed

Lines changed: 185 additions & 2 deletions

File tree

‎packages/react-reconciler/src/ReactFiberThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,12 +192,30 @@ export function trackUsedThenable<T>(
192192
// a listener that will update its status and result when it resolves.
193193
switch(thenable.status){
194194
case'fulfilled': {
195+
// This could be a bad instrumentation that doesn't set .value.
196+
// We're not type-checking since this is a hot path where you can
197+
// track down easily when something becomes `undefined` unexpectedly.
195198
constfulfilledValue: T=thenable.value;
196199
returnfulfilledValue;
197200
}
198201
case'rejected': {
199202
const rejectedError =thenable.reason;
200203
checkIfUseWrappedInAsyncCatch(rejectedError);
204+
205+
// Rejected Promises are rarer so we're doing an extra type-check in
206+
// case of a bad instrumentation that doesn't set .reason
207+
// If we end up throwing `undefined` it becomes hard to track down
208+
// where that throw originated because no callstack would exist.
209+
// React would still have a Component stack but that could only be used
210+
// as an approximation.
211+
if(rejectedError===undefined&&!('reason'inthenable)){
212+
thrownewError(
213+
'A rejected Promise was passed to React without a `reason` property. '+
214+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
215+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
216+
);
217+
}
218+
201219
throwrejectedError;
202220
}
203221
default: {

‎packages/react-reconciler/src/__tests__/ReactUse-test.js‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,30 @@ describe('ReactUse', () => {
8181
});
8282
}
8383

84+
functionnormalizeCodeLocInfo(str){
85+
return(
86+
str&&
87+
str.replace(
88+
/^+(?:at|in)([\S]+)([^\n]*)(\n?)/gm,
89+
function(m,name,location,eol){
90+
if(location.indexOf(__filename)===-1){
91+
// ignore frames from library code
92+
return'';
93+
}
94+
return(
95+
' in '+
96+
name+
97+
(/:\d+:\d+/.test(m)
98+
? ' '+
99+
location.replace(__dirname,'~').replace(/:\d+:\d+/,':*:*')
100+
: '')+
101+
eol
102+
);
103+
},
104+
)
105+
);
106+
}
107+
84108
functionText({text}){
85109
Scheduler.log(text);
86110
returntext;
@@ -2189,4 +2213,108 @@ describe('ReactUse', () => {
21892213
expect(root).toMatchRenderedOutput('Updated');
21902214
},
21912215
);
2216+
2217+
it('throws a descriptive error when a rejected promise without a reason property is passed to use()',async()=>{
2218+
constbadThenable=Promise.resolve();
2219+
// Simulate bad instrumentation: status is 'rejected' but the reason is not
2220+
// in the `reason` property as intended.
2221+
badThenable.status='rejected';
2222+
badThenable.error=newError('Something went wrong');
2223+
2224+
functionChild(){
2225+
returnuse(badThenable);
2226+
}
2227+
2228+
functionApp({
2229+
// Intentionally destrucutring a prop here so that our production error
2230+
// stack trick is triggered at the beginning of the function
2231+
prop,
2232+
}){
2233+
return<Child/>;
2234+
}
2235+
2236+
constuncaughtErrors=[];
2237+
constroot=ReactNoop.createRoot({
2238+
onUncaughtError(error,errorInfo){
2239+
uncaughtErrors.push({
2240+
callStack: normalizeCodeLocInfo(error.stack),
2241+
ownerStack: React.captureOwnerStack
2242+
? normalizeCodeLocInfo(React.captureOwnerStack())
2243+
: null,
2244+
componentStack: normalizeCodeLocInfo(errorInfo.componentStack),
2245+
});
2246+
},
2247+
});
2248+
2249+
awaitact(()=>{
2250+
root.render(<App/>);
2251+
});
2252+
2253+
expect(uncaughtErrors).toEqual([
2254+
{
2255+
callStack:
2256+
'Error: A rejected Promise was passed to React without a `reason` property. '+
2257+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
2258+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`."+
2259+
'\n in Child (~/ReactUse-test.js:*:*)'+
2260+
'\n in Object.<anonymous> (~/ReactUse-test.js:*:*)',
2261+
componentStack:
2262+
'\n in Child (~/ReactUse-test.js:*:*)'+
2263+
'\n in App (~/ReactUse-test.js:*:*)',
2264+
ownerStack: __DEV__ ? '\n in App (~/ReactUse-test.js:*:*)' : null,
2265+
},
2266+
]);
2267+
});
2268+
2269+
it('throws a descriptive error when a rejected promise without a reason property is used as a child',async()=>{
2270+
constbadThenable=Promise.resolve();
2271+
// Simulate bad instrumentation: status is 'rejected' but the reason is not
2272+
// in the `reason` property as intended.
2273+
badThenable.status='rejected';
2274+
badThenable.error=newError('Something went wrong');
2275+
2276+
functionChild(){
2277+
return<div>{badThenable}</div>;
2278+
}
2279+
2280+
functionApp({
2281+
// Intentionally destrucutring a prop here so that our production error
2282+
// stack trick is triggered at the beginning of the function
2283+
prop,
2284+
}){
2285+
return<Child/>;
2286+
}
2287+
2288+
constuncaughtErrors=[];
2289+
constroot=ReactNoop.createRoot({
2290+
onUncaughtError(error,errorInfo){
2291+
uncaughtErrors.push({
2292+
callStack: normalizeCodeLocInfo(error.stack),
2293+
ownerStack: React.captureOwnerStack
2294+
? normalizeCodeLocInfo(React.captureOwnerStack())
2295+
: null,
2296+
componentStack: normalizeCodeLocInfo(errorInfo.componentStack),
2297+
});
2298+
},
2299+
});
2300+
2301+
awaitact(()=>{
2302+
root.render(<App/>);
2303+
});
2304+
2305+
expect(uncaughtErrors).toEqual([
2306+
{
2307+
callStack:
2308+
'Error: A rejected Promise was passed to React without a `reason` property. '+
2309+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
2310+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`."+
2311+
'\n in Object.<anonymous> (~/ReactUse-test.js:*:*)',
2312+
componentStack: '\n in App (~/ReactUse-test.js:*:*)',
2313+
ownerStack: __DEV__
2314+
? // TODO: Should start in Child since that's the owner.
2315+
'\n in App (~/ReactUse-test.js:*:*)'
2316+
: null,
2317+
},
2318+
]);
2319+
});
21922320
});

‎packages/react-server/src/ReactFizzThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,29 @@ export function trackUsedThenable<T>(
6969
// a listener that will update its status and result when it resolves.
7070
switch(thenable.status){
7171
case'fulfilled': {
72+
// This could be a bad instrumentation that doesn't set .value.
73+
// We're not type-checking since this is a hot path where you can
74+
// track down easily when something becomes `undefined` unexpectedly.
7275
constfulfilledValue: T=thenable.value;
7376
returnfulfilledValue;
7477
}
7578
case'rejected': {
7679
constrejectedError=thenable.reason;
80+
81+
// Rejected Promises are rarer so we're doing an extra type-check in
82+
// case of a bad instrumentation that doesn't set .reason
83+
// If we end up throwing `undefined` it becomes hard to track down
84+
// where that throw originated because no callstack would exist.
85+
// React would still have a Component stack but that could only be used
86+
// as an approximation.
87+
if(rejectedError===undefined&&!('reason'inthenable)){
88+
thrownewError(
89+
'A rejected Promise was passed to React without a `reason` property. '+
90+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
91+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
92+
);
93+
}
94+
7795
throwrejectedError;
7896
}
7997
default: {

‎packages/react-server/src/ReactFlightThenable.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,29 @@ export function trackUsedThenable<T>(
7777
// a listener that will update its status and result when it resolves.
7878
switch(thenable.status){
7979
case'fulfilled': {
80+
// This could be a bad instrumentation that doesn't set .value.
81+
// We're not type-checking since this is a hot path where you can
82+
// track down easily when something becomes `undefined` unexpectedly.
8083
constfulfilledValue: T=thenable.value;
8184
returnfulfilledValue;
8285
}
8386
case'rejected': {
8487
constrejectedError=thenable.reason;
88+
89+
// Rejected Promises are rarer so we're doing an extra type-check in
90+
// case of a bad instrumentation that doesn't set .reason
91+
// If we end up throwing `undefined` it becomes hard to track down
92+
// where that throw originated because no callstack would exist.
93+
// React would still have a Component stack but that could only be used
94+
// as an approximation.
95+
if(rejectedError===undefined&&!('reason'inthenable)){
96+
thrownewError(
97+
'A rejected Promise was passed to React without a `reason` property. '+
98+
'React threw a generic error from where the Promise was used to assist in identifying the problematic Promise. '+
99+
"Make sure that instrumented Promises correctly set the `reason` property when setting `status` to `'rejected'`.",
100+
);
101+
}
102+
85103
throwrejectedError;
86104
}
87105
default: {

‎scripts/error-codes/codes.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -584,5 +584,6 @@
584584
"596": "Could not find the module \"%s\" in the React Client Manifest. This is probably a bug in the React Server Components bundler.",
585585
"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.",
586586
"598": "Maximum update depth exceeded. This could be an infinite loop. This can happen when a component repeatedly calls setState during render phase or inside useLayoutEffect, causing infinite render loop. React limits the number of nested updates to prevent infinite loops.",
587-
"599": "Expected an initialized chunk but got an initialized stream chunk instead. This payload may have been submitted by an older version of React."
588-
}
587+
"599": "Expected an initialized chunk but got an initialized stream chunk instead. This payload may have been submitted by an older version of React.",
588+
"600": "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'`."
589+
}

0 commit comments

Comments
 (0)