Skip to content

Commit 2ba3065

Browse files
authored
[Flight] Add support for transporting Error.cause (#35810)
1 parent 38cd020 commit 2ba3065

4 files changed

Lines changed: 185 additions & 18 deletions

File tree

‎packages/react-client/src/ReactFlightClient.js‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
*/
99

1010
importtype{
11+
JSONValue,
1112
Thenable,
1213
ReactDebugInfo,
1314
ReactDebugInfoEntry,
@@ -132,14 +133,6 @@ interface FlightStreamController {
132133

133134
typeUninitializedModel=string;
134135

135-
exporttypeJSONValue=
136-
|number
137-
|null
138-
|boolean
139-
|string
140-
|{+[key: string]: JSONValue}
141-
|$ReadOnlyArray<JSONValue>;
142-
143136
typeProfilingResult={
144137
track: number,
145138
endTime: number,
@@ -3527,6 +3520,18 @@ function resolveErrorDev(
35273520
}
35283521

35293522
leterror;
3523+
consterrorOptions=
3524+
'cause'inerrorInfo
3525+
? {
3526+
cause: reviveModel(
3527+
response,
3528+
// $FlowFixMe[incompatible-cast] -- Flow thinks `cause` in `cause?: JSONValue` can be undefined after `in` check.
3529+
(errorInfo.cause: JSONValue),
3530+
errorInfo,
3531+
'cause',
3532+
),
3533+
}
3534+
: undefined;
35303535
constcallStack=buildFakeCallStack(
35313536
response,
35323537
stack,
@@ -3537,6 +3542,7 @@ function resolveErrorDev(
35373542
null,
35383543
message||
35393544
'An error occurred in the Server Components render but no message was provided',
3545+
errorOptions,
35403546
),
35413547
);
35423548

‎packages/react-client/src/__tests__/ReactFlight-test.js‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -707,6 +707,139 @@ describe('ReactFlight', () => {
707707
}
708708
});
709709

710+
it('can transport Error.cause',async()=>{
711+
functionrenderError(error){
712+
if(!(errorinstanceofError)){
713+
return`${JSON.stringify(error)}`;
714+
}
715+
return`
716+
is error: ${errorinstanceofError}
717+
name: ${error.name}
718+
message: ${error.message}
719+
stack: ${normalizeCodeLocInfo(error.stack).split('\n').slice(0,2).join('\n')}
720+
environmentName: ${error.environmentName}
721+
cause: ${'cause'inerror ? renderError(error.cause) : 'no cause'}`;
722+
}
723+
functionComponentClient({error}){
724+
returnrenderError(error);
725+
}
726+
constComponent=clientReference(ComponentClient);
727+
728+
functionServerComponent(){
729+
constcause=newTypeError('root cause',{
730+
cause: {type: 'object cause'},
731+
});
732+
consterror=newError('hello',{cause});
733+
return<Componenterror={error}/>;
734+
}
735+
736+
consttransport=ReactNoopFlightServer.render(<ServerComponent/>,{
737+
onError(x){
738+
if(__DEV__){
739+
return'a dev digest';
740+
}
741+
return`digest("${x.message}")`;
742+
},
743+
});
744+
745+
awaitact(()=>{
746+
ReactNoop.render(ReactNoopFlightClient.read(transport));
747+
});
748+
749+
if(__DEV__){
750+
expect(ReactNoop).toMatchRenderedOutput(`
751+
is error: true
752+
name: Error
753+
message: hello
754+
stack: Error: hello
755+
in ServerComponent (at **)
756+
environmentName: Server
757+
cause:
758+
is error: true
759+
name: TypeError
760+
message: root cause
761+
stack: TypeError: root cause
762+
in ServerComponent (at **)
763+
environmentName: Server
764+
cause: {"type":"object cause"}`);
765+
}else{
766+
expect(ReactNoop).toMatchRenderedOutput(`
767+
is error: true
768+
name: Error
769+
message: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
770+
stack: Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
771+
environmentName: undefined
772+
cause: no cause`);
773+
}
774+
});
775+
776+
it('includes Error.cause in thrown errors',async()=>{
777+
functionrenderError(error){
778+
if(!(errorinstanceofError)){
779+
return`${JSON.stringify(error)}`;
780+
}
781+
return`
782+
is error: true
783+
name: ${error.name}
784+
message: ${error.message}
785+
stack: ${normalizeCodeLocInfo(error.stack).split('\n').slice(0,2).join('\n')}
786+
environmentName: ${error.environmentName}
787+
cause: ${'cause'inerror ? renderError(error.cause) : 'no cause'}`;
788+
}
789+
790+
functionServerComponent(){
791+
constcause=newTypeError('root cause',{
792+
cause: {type: 'object cause'},
793+
});
794+
consterror=newError('hello',{cause});
795+
throwerror;
796+
}
797+
798+
consttransport=ReactNoopFlightServer.render(<ServerComponent/>,{
799+
onError(x){
800+
if(__DEV__){
801+
return'a dev digest';
802+
}
803+
return`digest("${x.message}")`;
804+
},
805+
});
806+
807+
leterror;
808+
try{
809+
awaitact(()=>{
810+
ReactNoop.render(ReactNoopFlightClient.read(transport));
811+
});
812+
}catch(x){
813+
error=x;
814+
}
815+
816+
if(__DEV__){
817+
expect(renderError(error)).toEqual(`
818+
is error: true
819+
name: Error
820+
message: hello
821+
stack: Error: hello
822+
in ServerComponent (at **)
823+
environmentName: Server
824+
cause:
825+
is error: true
826+
name: TypeError
827+
message: root cause
828+
stack: TypeError: root cause
829+
in ServerComponent (at **)
830+
environmentName: Server
831+
cause: {"type":"object cause"}`);
832+
}else{
833+
expect(renderError(error)).toEqual(`
834+
is error: true
835+
name: Error
836+
message: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
837+
stack: Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
838+
environmentName: undefined
839+
cause: no cause`);
840+
}
841+
});
842+
710843
it('can transport cyclic objects',async()=>{
711844
functionComponentClient({prop}){
712845
expect(prop.obj.obj.obj).toBe(prop.obj.obj);

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

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -467,14 +467,6 @@ function getCurrentStackInDEV(): string {
467467

468468
constObjectPrototype=Object.prototype;
469469

470-
typeJSONValue=
471-
|string
472-
|boolean
473-
|number
474-
|null
475-
|{+[key: string]: JSONValue}
476-
| $ReadOnlyArray<JSONValue>;
477-
478470
conststringify=JSON.stringify;
479471

480472
typeReactJSONValue=
@@ -498,6 +490,7 @@ export type ReactClientValue =
498490
| React$Element<string>
499491
| React$Element<ClientReference<any>&any>
500492
|ReactComponentInfo
493+
|ReactErrorInfo
501494
|string
502495
|boolean
503496
|number
@@ -4171,6 +4164,11 @@ function serializeErrorValue(request: Request, error: Error): string {
41714164
stack=[];
41724165
}
41734166
consterrorInfo: ReactErrorInfoDev={name,message,stack,env};
4167+
if('cause'inerror){
4168+
constcause: ReactClientValue=(error.cause: any);
4169+
constcauseId=outlineModel(request,cause);
4170+
errorInfo.cause=serializeByValueID(causeId);
4171+
}
41744172
constid=outlineModel(request,errorInfo);
41754173
return'$Z'+id.toString(16);
41764174
}else{
@@ -4181,7 +4179,11 @@ function serializeErrorValue(request: Request, error: Error): string {
41814179
}
41824180
}
41834181

4184-
function serializeDebugErrorValue(request: Request, error: Error): string {
4182+
functionserializeDebugErrorValue(
4183+
request: Request,
4184+
counter: {objectLimit: number},
4185+
error: Error,
4186+
): string{
41854187
if(__DEV__){
41864188
let name: string='Error';
41874189
let message: string;
@@ -4203,6 +4205,12 @@ function serializeDebugErrorValue(request: Request, error: Error): string {
42034205
stack=[];
42044206
}
42054207
consterrorInfo: ReactErrorInfoDev={name, message, stack, env};
4208+
if('cause'inerror){
4209+
counter.objectLimit--;
4210+
constcause: ReactClientValue=(error.cause: any);
4211+
constcauseId=outlineDebugModel(request,counter,cause);
4212+
errorInfo.cause=serializeByValueID(causeId);
4213+
}
42064214
constid=outlineDebugModel(
42074215
request,
42084216
{objectLimit: stack.length*2+1},
@@ -4231,6 +4239,7 @@ function emitErrorChunk(
42314239
letmessage: string;
42324240
letstack: ReactStackTrace;
42334241
letenv=(0,request.environmentName)();
4242+
letcauseReference: null|string=null;
42344243
try{
42354244
if(errorinstanceofError){
42364245
name=error.name;
@@ -4243,6 +4252,13 @@ function emitErrorChunk(
42434252
// Keep the environment name.
42444253
env=errorEnv;
42454254
}
4255+
if('cause'inerror){
4256+
constcause: ReactClientValue=(error.cause: any);
4257+
constcauseId=debug
4258+
? outlineDebugModel(request,{objectLimit: 5},cause)
4259+
: outlineModel(request,cause);
4260+
causeReference=serializeByValueID(causeId);
4261+
}
42464262
}elseif(typeoferror==='object'&&error!==null){
42474263
message=describeObjectForErrorMessage(error);
42484264
stack=[];
@@ -4258,6 +4274,9 @@ function emitErrorChunk(
42584274
constownerRef=
42594275
owner==null ? null : outlineComponentInfo(request,owner);
42604276
errorInfo={digest, name, message, stack, env,owner: ownerRef};
4277+
if(causeReference!==null){
4278+
(errorInfo: ReactErrorInfoDev).cause=causeReference;
4279+
}
42614280
}else{
42624281
errorInfo ={digest};
42634282
}
@@ -4969,7 +4988,7 @@ function renderDebugModel(
49694988
returnserializeDebugFormData(request,value);
49704989
}
49714990
if (value instanceof Error) {
4972-
returnserializeDebugErrorValue(request,value);
4991+
returnserializeDebugErrorValue(request,counter,value);
49734992
}
49744993
if (value instanceof ArrayBuffer) {
49754994
returnserializeDebugTypedArray(request,'A',newUint8Array(value));

‎packages/shared/ReactTypes.js‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,13 +228,22 @@ export type ReactErrorInfoProd = {
228228
+digest: string,
229229
};
230230

231+
export type JSONValue =
232+
| string
233+
| boolean
234+
| number
235+
| null
236+
| {+[key: string]: JSONValue}
237+
| $ReadOnlyArray<JSONValue>;
238+
231239
export type ReactErrorInfoDev = {
232240
+digest?: string,
233241
+name: string,
234242
+message: string,
235243
+stack: ReactStackTrace,
236244
+env: string,
237245
+owner?: null|string,
246+
cause?: JSONValue,
238247
};
239248

240249
export type ReactErrorInfo = ReactErrorInfoProd | ReactErrorInfoDev;

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[Flight] Add support for transporting `Error.cause` (#35810) · react/react@2ba3065 · GitHub
Skip to content

Commit 2ba3065

Browse files
authored
[Flight] Add support for transporting Error.cause (#35810)
1 parent 38cd020 commit 2ba3065

4 files changed

Lines changed: 185 additions & 18 deletions

File tree

‎packages/react-client/src/ReactFlightClient.js‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
*/
99

1010
importtype{
11+
JSONValue,
1112
Thenable,
1213
ReactDebugInfo,
1314
ReactDebugInfoEntry,
@@ -132,14 +133,6 @@ interface FlightStreamController {
132133

133134
typeUninitializedModel=string;
134135

135-
exporttypeJSONValue=
136-
|number
137-
|null
138-
|boolean
139-
|string
140-
|{+[key: string]: JSONValue}
141-
|$ReadOnlyArray<JSONValue>;
142-
143136
typeProfilingResult={
144137
track: number,
145138
endTime: number,
@@ -3527,6 +3520,18 @@ function resolveErrorDev(
35273520
}
35283521

35293522
leterror;
3523+
consterrorOptions=
3524+
'cause'inerrorInfo
3525+
? {
3526+
cause: reviveModel(
3527+
response,
3528+
// $FlowFixMe[incompatible-cast] -- Flow thinks `cause` in `cause?: JSONValue` can be undefined after `in` check.
3529+
(errorInfo.cause: JSONValue),
3530+
errorInfo,
3531+
'cause',
3532+
),
3533+
}
3534+
: undefined;
35303535
constcallStack=buildFakeCallStack(
35313536
response,
35323537
stack,
@@ -3537,6 +3542,7 @@ function resolveErrorDev(
35373542
null,
35383543
message||
35393544
'An error occurred in the Server Components render but no message was provided',
3545+
errorOptions,
35403546
),
35413547
);
35423548

‎packages/react-client/src/__tests__/ReactFlight-test.js‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -707,6 +707,139 @@ describe('ReactFlight', () => {
707707
}
708708
});
709709

710+
it('can transport Error.cause',async()=>{
711+
functionrenderError(error){
712+
if(!(errorinstanceofError)){
713+
return`${JSON.stringify(error)}`;
714+
}
715+
return`
716+
is error: ${errorinstanceofError}
717+
name: ${error.name}
718+
message: ${error.message}
719+
stack: ${normalizeCodeLocInfo(error.stack).split('\n').slice(0,2).join('\n')}
720+
environmentName: ${error.environmentName}
721+
cause: ${'cause'inerror ? renderError(error.cause) : 'no cause'}`;
722+
}
723+
functionComponentClient({error}){
724+
returnrenderError(error);
725+
}
726+
constComponent=clientReference(ComponentClient);
727+
728+
functionServerComponent(){
729+
constcause=newTypeError('root cause',{
730+
cause: {type: 'object cause'},
731+
});
732+
consterror=newError('hello',{cause});
733+
return<Componenterror={error}/>;
734+
}
735+
736+
consttransport=ReactNoopFlightServer.render(<ServerComponent/>,{
737+
onError(x){
738+
if(__DEV__){
739+
return'a dev digest';
740+
}
741+
return`digest("${x.message}")`;
742+
},
743+
});
744+
745+
awaitact(()=>{
746+
ReactNoop.render(ReactNoopFlightClient.read(transport));
747+
});
748+
749+
if(__DEV__){
750+
expect(ReactNoop).toMatchRenderedOutput(`
751+
is error: true
752+
name: Error
753+
message: hello
754+
stack: Error: hello
755+
in ServerComponent (at **)
756+
environmentName: Server
757+
cause:
758+
is error: true
759+
name: TypeError
760+
message: root cause
761+
stack: TypeError: root cause
762+
in ServerComponent (at **)
763+
environmentName: Server
764+
cause: {"type":"object cause"}`);
765+
}else{
766+
expect(ReactNoop).toMatchRenderedOutput(`
767+
is error: true
768+
name: Error
769+
message: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
770+
stack: Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
771+
environmentName: undefined
772+
cause: no cause`);
773+
}
774+
});
775+
776+
it('includes Error.cause in thrown errors',async()=>{
777+
functionrenderError(error){
778+
if(!(errorinstanceofError)){
779+
return`${JSON.stringify(error)}`;
780+
}
781+
return`
782+
is error: true
783+
name: ${error.name}
784+
message: ${error.message}
785+
stack: ${normalizeCodeLocInfo(error.stack).split('\n').slice(0,2).join('\n')}
786+
environmentName: ${error.environmentName}
787+
cause: ${'cause'inerror ? renderError(error.cause) : 'no cause'}`;
788+
}
789+
790+
functionServerComponent(){
791+
constcause=newTypeError('root cause',{
792+
cause: {type: 'object cause'},
793+
});
794+
consterror=newError('hello',{cause});
795+
throwerror;
796+
}
797+
798+
consttransport=ReactNoopFlightServer.render(<ServerComponent/>,{
799+
onError(x){
800+
if(__DEV__){
801+
return'a dev digest';
802+
}
803+
return`digest("${x.message}")`;
804+
},
805+
});
806+
807+
leterror;
808+
try{
809+
awaitact(()=>{
810+
ReactNoop.render(ReactNoopFlightClient.read(transport));
811+
});
812+
}catch(x){
813+
error=x;
814+
}
815+
816+
if(__DEV__){
817+
expect(renderError(error)).toEqual(`
818+
is error: true
819+
name: Error
820+
message: hello
821+
stack: Error: hello
822+
in ServerComponent (at **)
823+
environmentName: Server
824+
cause:
825+
is error: true
826+
name: TypeError
827+
message: root cause
828+
stack: TypeError: root cause
829+
in ServerComponent (at **)
830+
environmentName: Server
831+
cause: {"type":"object cause"}`);
832+
}else{
833+
expect(renderError(error)).toEqual(`
834+
is error: true
835+
name: Error
836+
message: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
837+
stack: Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
838+
environmentName: undefined
839+
cause: no cause`);
840+
}
841+
});
842+
710843
it('can transport cyclic objects',async()=>{
711844
functionComponentClient({prop}){
712845
expect(prop.obj.obj.obj).toBe(prop.obj.obj);

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

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -467,14 +467,6 @@ function getCurrentStackInDEV(): string {
467467

468468
constObjectPrototype=Object.prototype;
469469

470-
typeJSONValue=
471-
|string
472-
|boolean
473-
|number
474-
|null
475-
|{+[key: string]: JSONValue}
476-
| $ReadOnlyArray<JSONValue>;
477-
478470
conststringify=JSON.stringify;
479471

480472
typeReactJSONValue=
@@ -498,6 +490,7 @@ export type ReactClientValue =
498490
| React$Element<string>
499491
| React$Element<ClientReference<any>&any>
500492
|ReactComponentInfo
493+
|ReactErrorInfo
501494
|string
502495
|boolean
503496
|number
@@ -4171,6 +4164,11 @@ function serializeErrorValue(request: Request, error: Error): string {
41714164
stack=[];
41724165
}
41734166
consterrorInfo: ReactErrorInfoDev={name,message,stack,env};
4167+
if('cause'inerror){
4168+
constcause: ReactClientValue=(error.cause: any);
4169+
constcauseId=outlineModel(request,cause);
4170+
errorInfo.cause=serializeByValueID(causeId);
4171+
}
41744172
constid=outlineModel(request,errorInfo);
41754173
return'$Z'+id.toString(16);
41764174
}else{
@@ -4181,7 +4179,11 @@ function serializeErrorValue(request: Request, error: Error): string {
41814179
}
41824180
}
41834181

4184-
function serializeDebugErrorValue(request: Request, error: Error): string {
4182+
functionserializeDebugErrorValue(
4183+
request: Request,
4184+
counter: {objectLimit: number},
4185+
error: Error,
4186+
): string{
41854187
if(__DEV__){
41864188
let name: string='Error';
41874189
let message: string;
@@ -4203,6 +4205,12 @@ function serializeDebugErrorValue(request: Request, error: Error): string {
42034205
stack=[];
42044206
}
42054207
consterrorInfo: ReactErrorInfoDev={name, message, stack, env};
4208+
if('cause'inerror){
4209+
counter.objectLimit--;
4210+
constcause: ReactClientValue=(error.cause: any);
4211+
constcauseId=outlineDebugModel(request,counter,cause);
4212+
errorInfo.cause=serializeByValueID(causeId);
4213+
}
42064214
constid=outlineDebugModel(
42074215
request,
42084216
{objectLimit: stack.length*2+1},
@@ -4231,6 +4239,7 @@ function emitErrorChunk(
42314239
letmessage: string;
42324240
letstack: ReactStackTrace;
42334241
letenv=(0,request.environmentName)();
4242+
letcauseReference: null|string=null;
42344243
try{
42354244
if(errorinstanceofError){
42364245
name=error.name;
@@ -4243,6 +4252,13 @@ function emitErrorChunk(
42434252
// Keep the environment name.
42444253
env=errorEnv;
42454254
}
4255+
if('cause'inerror){
4256+
constcause: ReactClientValue=(error.cause: any);
4257+
constcauseId=debug
4258+
? outlineDebugModel(request,{objectLimit: 5},cause)
4259+
: outlineModel(request,cause);
4260+
causeReference=serializeByValueID(causeId);
4261+
}
42464262
}elseif(typeoferror==='object'&&error!==null){
42474263
message=describeObjectForErrorMessage(error);
42484264
stack=[];
@@ -4258,6 +4274,9 @@ function emitErrorChunk(
42584274
constownerRef=
42594275
owner==null ? null : outlineComponentInfo(request,owner);
42604276
errorInfo={digest, name, message, stack, env,owner: ownerRef};
4277+
if(causeReference!==null){
4278+
(errorInfo: ReactErrorInfoDev).cause=causeReference;
4279+
}
42614280
}else{
42624281
errorInfo ={digest};
42634282
}
@@ -4969,7 +4988,7 @@ function renderDebugModel(
49694988
returnserializeDebugFormData(request,value);
49704989
}
49714990
if (value instanceof Error) {
4972-
returnserializeDebugErrorValue(request,value);
4991+
returnserializeDebugErrorValue(request,counter,value);
49734992
}
49744993
if (value instanceof ArrayBuffer) {
49754994
returnserializeDebugTypedArray(request,'A',newUint8Array(value));

‎packages/shared/ReactTypes.js‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,13 +228,22 @@ export type ReactErrorInfoProd = {
228228
+digest: string,
229229
};
230230

231+
export type JSONValue =
232+
| string
233+
| boolean
234+
| number
235+
| null
236+
| {+[key: string]: JSONValue}
237+
| $ReadOnlyArray<JSONValue>;
238+
231239
export type ReactErrorInfoDev = {
232240
+digest?: string,
233241
+name: string,
234242
+message: string,
235243
+stack: ReactStackTrace,
236244
+env: string,
237245
+owner?: null|string,
246+
cause?: JSONValue,
238247
};
239248

240249
export type ReactErrorInfo = ReactErrorInfoProd | ReactErrorInfoDev;

0 commit comments

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

Commit 2ba3065

Browse files
authored
[Flight] Add support for transporting Error.cause (#35810)
1 parent 38cd020 commit 2ba3065

4 files changed

Lines changed: 185 additions & 18 deletions

File tree

‎packages/react-client/src/ReactFlightClient.js‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
*/
99

1010
importtype{
11+
JSONValue,
1112
Thenable,
1213
ReactDebugInfo,
1314
ReactDebugInfoEntry,
@@ -132,14 +133,6 @@ interface FlightStreamController {
132133

133134
typeUninitializedModel=string;
134135

135-
exporttypeJSONValue=
136-
|number
137-
|null
138-
|boolean
139-
|string
140-
|{+[key: string]: JSONValue}
141-
|$ReadOnlyArray<JSONValue>;
142-
143136
typeProfilingResult={
144137
track: number,
145138
endTime: number,
@@ -3527,6 +3520,18 @@ function resolveErrorDev(
35273520
}
35283521

35293522
leterror;
3523+
consterrorOptions=
3524+
'cause'inerrorInfo
3525+
? {
3526+
cause: reviveModel(
3527+
response,
3528+
// $FlowFixMe[incompatible-cast] -- Flow thinks `cause` in `cause?: JSONValue` can be undefined after `in` check.
3529+
(errorInfo.cause: JSONValue),
3530+
errorInfo,
3531+
'cause',
3532+
),
3533+
}
3534+
: undefined;
35303535
constcallStack=buildFakeCallStack(
35313536
response,
35323537
stack,
@@ -3537,6 +3542,7 @@ function resolveErrorDev(
35373542
null,
35383543
message||
35393544
'An error occurred in the Server Components render but no message was provided',
3545+
errorOptions,
35403546
),
35413547
);
35423548

‎packages/react-client/src/__tests__/ReactFlight-test.js‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -707,6 +707,139 @@ describe('ReactFlight', () => {
707707
}
708708
});
709709

710+
it('can transport Error.cause',async()=>{
711+
functionrenderError(error){
712+
if(!(errorinstanceofError)){
713+
return`${JSON.stringify(error)}`;
714+
}
715+
return`
716+
is error: ${errorinstanceofError}
717+
name: ${error.name}
718+
message: ${error.message}
719+
stack: ${normalizeCodeLocInfo(error.stack).split('\n').slice(0,2).join('\n')}
720+
environmentName: ${error.environmentName}
721+
cause: ${'cause'inerror ? renderError(error.cause) : 'no cause'}`;
722+
}
723+
functionComponentClient({error}){
724+
returnrenderError(error);
725+
}
726+
constComponent=clientReference(ComponentClient);
727+
728+
functionServerComponent(){
729+
constcause=newTypeError('root cause',{
730+
cause: {type: 'object cause'},
731+
});
732+
consterror=newError('hello',{cause});
733+
return<Componenterror={error}/>;
734+
}
735+
736+
consttransport=ReactNoopFlightServer.render(<ServerComponent/>,{
737+
onError(x){
738+
if(__DEV__){
739+
return'a dev digest';
740+
}
741+
return`digest("${x.message}")`;
742+
},
743+
});
744+
745+
awaitact(()=>{
746+
ReactNoop.render(ReactNoopFlightClient.read(transport));
747+
});
748+
749+
if(__DEV__){
750+
expect(ReactNoop).toMatchRenderedOutput(`
751+
is error: true
752+
name: Error
753+
message: hello
754+
stack: Error: hello
755+
in ServerComponent (at **)
756+
environmentName: Server
757+
cause:
758+
is error: true
759+
name: TypeError
760+
message: root cause
761+
stack: TypeError: root cause
762+
in ServerComponent (at **)
763+
environmentName: Server
764+
cause: {"type":"object cause"}`);
765+
}else{
766+
expect(ReactNoop).toMatchRenderedOutput(`
767+
is error: true
768+
name: Error
769+
message: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
770+
stack: Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
771+
environmentName: undefined
772+
cause: no cause`);
773+
}
774+
});
775+
776+
it('includes Error.cause in thrown errors',async()=>{
777+
functionrenderError(error){
778+
if(!(errorinstanceofError)){
779+
return`${JSON.stringify(error)}`;
780+
}
781+
return`
782+
is error: true
783+
name: ${error.name}
784+
message: ${error.message}
785+
stack: ${normalizeCodeLocInfo(error.stack).split('\n').slice(0,2).join('\n')}
786+
environmentName: ${error.environmentName}
787+
cause: ${'cause'inerror ? renderError(error.cause) : 'no cause'}`;
788+
}
789+
790+
functionServerComponent(){
791+
constcause=newTypeError('root cause',{
792+
cause: {type: 'object cause'},
793+
});
794+
consterror=newError('hello',{cause});
795+
throwerror;
796+
}
797+
798+
consttransport=ReactNoopFlightServer.render(<ServerComponent/>,{
799+
onError(x){
800+
if(__DEV__){
801+
return'a dev digest';
802+
}
803+
return`digest("${x.message}")`;
804+
},
805+
});
806+
807+
leterror;
808+
try{
809+
awaitact(()=>{
810+
ReactNoop.render(ReactNoopFlightClient.read(transport));
811+
});
812+
}catch(x){
813+
error=x;
814+
}
815+
816+
if(__DEV__){
817+
expect(renderError(error)).toEqual(`
818+
is error: true
819+
name: Error
820+
message: hello
821+
stack: Error: hello
822+
in ServerComponent (at **)
823+
environmentName: Server
824+
cause:
825+
is error: true
826+
name: TypeError
827+
message: root cause
828+
stack: TypeError: root cause
829+
in ServerComponent (at **)
830+
environmentName: Server
831+
cause: {"type":"object cause"}`);
832+
}else{
833+
expect(renderError(error)).toEqual(`
834+
is error: true
835+
name: Error
836+
message: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
837+
stack: Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
838+
environmentName: undefined
839+
cause: no cause`);
840+
}
841+
});
842+
710843
it('can transport cyclic objects',async()=>{
711844
functionComponentClient({prop}){
712845
expect(prop.obj.obj.obj).toBe(prop.obj.obj);

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

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -467,14 +467,6 @@ function getCurrentStackInDEV(): string {
467467

468468
constObjectPrototype=Object.prototype;
469469

470-
typeJSONValue=
471-
|string
472-
|boolean
473-
|number
474-
|null
475-
|{+[key: string]: JSONValue}
476-
| $ReadOnlyArray<JSONValue>;
477-
478470
conststringify=JSON.stringify;
479471

480472
typeReactJSONValue=
@@ -498,6 +490,7 @@ export type ReactClientValue =
498490
| React$Element<string>
499491
| React$Element<ClientReference<any>&any>
500492
|ReactComponentInfo
493+
|ReactErrorInfo
501494
|string
502495
|boolean
503496
|number
@@ -4171,6 +4164,11 @@ function serializeErrorValue(request: Request, error: Error): string {
41714164
stack=[];
41724165
}
41734166
consterrorInfo: ReactErrorInfoDev={name,message,stack,env};
4167+
if('cause'inerror){
4168+
constcause: ReactClientValue=(error.cause: any);
4169+
constcauseId=outlineModel(request,cause);
4170+
errorInfo.cause=serializeByValueID(causeId);
4171+
}
41744172
constid=outlineModel(request,errorInfo);
41754173
return'$Z'+id.toString(16);
41764174
}else{
@@ -4181,7 +4179,11 @@ function serializeErrorValue(request: Request, error: Error): string {
41814179
}
41824180
}
41834181

4184-
function serializeDebugErrorValue(request: Request, error: Error): string {
4182+
functionserializeDebugErrorValue(
4183+
request: Request,
4184+
counter: {objectLimit: number},
4185+
error: Error,
4186+
): string{
41854187
if(__DEV__){
41864188
let name: string='Error';
41874189
let message: string;
@@ -4203,6 +4205,12 @@ function serializeDebugErrorValue(request: Request, error: Error): string {
42034205
stack=[];
42044206
}
42054207
consterrorInfo: ReactErrorInfoDev={name, message, stack, env};
4208+
if('cause'inerror){
4209+
counter.objectLimit--;
4210+
constcause: ReactClientValue=(error.cause: any);
4211+
constcauseId=outlineDebugModel(request,counter,cause);
4212+
errorInfo.cause=serializeByValueID(causeId);
4213+
}
42064214
constid=outlineDebugModel(
42074215
request,
42084216
{objectLimit: stack.length*2+1},
@@ -4231,6 +4239,7 @@ function emitErrorChunk(
42314239
letmessage: string;
42324240
letstack: ReactStackTrace;
42334241
letenv=(0,request.environmentName)();
4242+
letcauseReference: null|string=null;
42344243
try{
42354244
if(errorinstanceofError){
42364245
name=error.name;
@@ -4243,6 +4252,13 @@ function emitErrorChunk(
42434252
// Keep the environment name.
42444253
env=errorEnv;
42454254
}
4255+
if('cause'inerror){
4256+
constcause: ReactClientValue=(error.cause: any);
4257+
constcauseId=debug
4258+
? outlineDebugModel(request,{objectLimit: 5},cause)
4259+
: outlineModel(request,cause);
4260+
causeReference=serializeByValueID(causeId);
4261+
}
42464262
}elseif(typeoferror==='object'&&error!==null){
42474263
message=describeObjectForErrorMessage(error);
42484264
stack=[];
@@ -4258,6 +4274,9 @@ function emitErrorChunk(
42584274
constownerRef=
42594275
owner==null ? null : outlineComponentInfo(request,owner);
42604276
errorInfo={digest, name, message, stack, env,owner: ownerRef};
4277+
if(causeReference!==null){
4278+
(errorInfo: ReactErrorInfoDev).cause=causeReference;
4279+
}
42614280
}else{
42624281
errorInfo ={digest};
42634282
}
@@ -4969,7 +4988,7 @@ function renderDebugModel(
49694988
returnserializeDebugFormData(request,value);
49704989
}
49714990
if (value instanceof Error) {
4972-
returnserializeDebugErrorValue(request,value);
4991+
returnserializeDebugErrorValue(request,counter,value);
49734992
}
49744993
if (value instanceof ArrayBuffer) {
49754994
returnserializeDebugTypedArray(request,'A',newUint8Array(value));

‎packages/shared/ReactTypes.js‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,13 +228,22 @@ export type ReactErrorInfoProd = {
228228
+digest: string,
229229
};
230230

231+
export type JSONValue =
232+
| string
233+
| boolean
234+
| number
235+
| null
236+
| {+[key: string]: JSONValue}
237+
| $ReadOnlyArray<JSONValue>;
238+
231239
export type ReactErrorInfoDev = {
232240
+digest?: string,
233241
+name: string,
234242
+message: string,
235243
+stack: ReactStackTrace,
236244
+env: string,
237245
+owner?: null|string,
246+
cause?: JSONValue,
238247
};
239248

240249
export type ReactErrorInfo = ReactErrorInfoProd | ReactErrorInfoDev;

0 commit comments

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

Commit 2ba3065

Browse files
authored
[Flight] Add support for transporting Error.cause (#35810)
1 parent 38cd020 commit 2ba3065

4 files changed

Lines changed: 185 additions & 18 deletions

File tree

‎packages/react-client/src/ReactFlightClient.js‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
*/
99

1010
importtype{
11+
JSONValue,
1112
Thenable,
1213
ReactDebugInfo,
1314
ReactDebugInfoEntry,
@@ -132,14 +133,6 @@ interface FlightStreamController {
132133

133134
typeUninitializedModel=string;
134135

135-
exporttypeJSONValue=
136-
|number
137-
|null
138-
|boolean
139-
|string
140-
|{+[key: string]: JSONValue}
141-
|$ReadOnlyArray<JSONValue>;
142-
143136
typeProfilingResult={
144137
track: number,
145138
endTime: number,
@@ -3527,6 +3520,18 @@ function resolveErrorDev(
35273520
}
35283521

35293522
leterror;
3523+
consterrorOptions=
3524+
'cause'inerrorInfo
3525+
? {
3526+
cause: reviveModel(
3527+
response,
3528+
// $FlowFixMe[incompatible-cast] -- Flow thinks `cause` in `cause?: JSONValue` can be undefined after `in` check.
3529+
(errorInfo.cause: JSONValue),
3530+
errorInfo,
3531+
'cause',
3532+
),
3533+
}
3534+
: undefined;
35303535
constcallStack=buildFakeCallStack(
35313536
response,
35323537
stack,
@@ -3537,6 +3542,7 @@ function resolveErrorDev(
35373542
null,
35383543
message||
35393544
'An error occurred in the Server Components render but no message was provided',
3545+
errorOptions,
35403546
),
35413547
);
35423548

‎packages/react-client/src/__tests__/ReactFlight-test.js‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -707,6 +707,139 @@ describe('ReactFlight', () => {
707707
}
708708
});
709709

710+
it('can transport Error.cause',async()=>{
711+
functionrenderError(error){
712+
if(!(errorinstanceofError)){
713+
return`${JSON.stringify(error)}`;
714+
}
715+
return`
716+
is error: ${errorinstanceofError}
717+
name: ${error.name}
718+
message: ${error.message}
719+
stack: ${normalizeCodeLocInfo(error.stack).split('\n').slice(0,2).join('\n')}
720+
environmentName: ${error.environmentName}
721+
cause: ${'cause'inerror ? renderError(error.cause) : 'no cause'}`;
722+
}
723+
functionComponentClient({error}){
724+
returnrenderError(error);
725+
}
726+
constComponent=clientReference(ComponentClient);
727+
728+
functionServerComponent(){
729+
constcause=newTypeError('root cause',{
730+
cause: {type: 'object cause'},
731+
});
732+
consterror=newError('hello',{cause});
733+
return<Componenterror={error}/>;
734+
}
735+
736+
consttransport=ReactNoopFlightServer.render(<ServerComponent/>,{
737+
onError(x){
738+
if(__DEV__){
739+
return'a dev digest';
740+
}
741+
return`digest("${x.message}")`;
742+
},
743+
});
744+
745+
awaitact(()=>{
746+
ReactNoop.render(ReactNoopFlightClient.read(transport));
747+
});
748+
749+
if(__DEV__){
750+
expect(ReactNoop).toMatchRenderedOutput(`
751+
is error: true
752+
name: Error
753+
message: hello
754+
stack: Error: hello
755+
in ServerComponent (at **)
756+
environmentName: Server
757+
cause:
758+
is error: true
759+
name: TypeError
760+
message: root cause
761+
stack: TypeError: root cause
762+
in ServerComponent (at **)
763+
environmentName: Server
764+
cause: {"type":"object cause"}`);
765+
}else{
766+
expect(ReactNoop).toMatchRenderedOutput(`
767+
is error: true
768+
name: Error
769+
message: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
770+
stack: Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
771+
environmentName: undefined
772+
cause: no cause`);
773+
}
774+
});
775+
776+
it('includes Error.cause in thrown errors',async()=>{
777+
functionrenderError(error){
778+
if(!(errorinstanceofError)){
779+
return`${JSON.stringify(error)}`;
780+
}
781+
return`
782+
is error: true
783+
name: ${error.name}
784+
message: ${error.message}
785+
stack: ${normalizeCodeLocInfo(error.stack).split('\n').slice(0,2).join('\n')}
786+
environmentName: ${error.environmentName}
787+
cause: ${'cause'inerror ? renderError(error.cause) : 'no cause'}`;
788+
}
789+
790+
functionServerComponent(){
791+
constcause=newTypeError('root cause',{
792+
cause: {type: 'object cause'},
793+
});
794+
consterror=newError('hello',{cause});
795+
throwerror;
796+
}
797+
798+
consttransport=ReactNoopFlightServer.render(<ServerComponent/>,{
799+
onError(x){
800+
if(__DEV__){
801+
return'a dev digest';
802+
}
803+
return`digest("${x.message}")`;
804+
},
805+
});
806+
807+
leterror;
808+
try{
809+
awaitact(()=>{
810+
ReactNoop.render(ReactNoopFlightClient.read(transport));
811+
});
812+
}catch(x){
813+
error=x;
814+
}
815+
816+
if(__DEV__){
817+
expect(renderError(error)).toEqual(`
818+
is error: true
819+
name: Error
820+
message: hello
821+
stack: Error: hello
822+
in ServerComponent (at **)
823+
environmentName: Server
824+
cause:
825+
is error: true
826+
name: TypeError
827+
message: root cause
828+
stack: TypeError: root cause
829+
in ServerComponent (at **)
830+
environmentName: Server
831+
cause: {"type":"object cause"}`);
832+
}else{
833+
expect(renderError(error)).toEqual(`
834+
is error: true
835+
name: Error
836+
message: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
837+
stack: Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
838+
environmentName: undefined
839+
cause: no cause`);
840+
}
841+
});
842+
710843
it('can transport cyclic objects',async()=>{
711844
functionComponentClient({prop}){
712845
expect(prop.obj.obj.obj).toBe(prop.obj.obj);

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

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -467,14 +467,6 @@ function getCurrentStackInDEV(): string {
467467

468468
constObjectPrototype=Object.prototype;
469469

470-
typeJSONValue=
471-
|string
472-
|boolean
473-
|number
474-
|null
475-
|{+[key: string]: JSONValue}
476-
| $ReadOnlyArray<JSONValue>;
477-
478470
conststringify=JSON.stringify;
479471

480472
typeReactJSONValue=
@@ -498,6 +490,7 @@ export type ReactClientValue =
498490
| React$Element<string>
499491
| React$Element<ClientReference<any>&any>
500492
|ReactComponentInfo
493+
|ReactErrorInfo
501494
|string
502495
|boolean
503496
|number
@@ -4171,6 +4164,11 @@ function serializeErrorValue(request: Request, error: Error): string {
41714164
stack=[];
41724165
}
41734166
consterrorInfo: ReactErrorInfoDev={name,message,stack,env};
4167+
if('cause'inerror){
4168+
constcause: ReactClientValue=(error.cause: any);
4169+
constcauseId=outlineModel(request,cause);
4170+
errorInfo.cause=serializeByValueID(causeId);
4171+
}
41744172
constid=outlineModel(request,errorInfo);
41754173
return'$Z'+id.toString(16);
41764174
}else{
@@ -4181,7 +4179,11 @@ function serializeErrorValue(request: Request, error: Error): string {
41814179
}
41824180
}
41834181

4184-
function serializeDebugErrorValue(request: Request, error: Error): string {
4182+
functionserializeDebugErrorValue(
4183+
request: Request,
4184+
counter: {objectLimit: number},
4185+
error: Error,
4186+
): string{
41854187
if(__DEV__){
41864188
let name: string='Error';
41874189
let message: string;
@@ -4203,6 +4205,12 @@ function serializeDebugErrorValue(request: Request, error: Error): string {
42034205
stack=[];
42044206
}
42054207
consterrorInfo: ReactErrorInfoDev={name, message, stack, env};
4208+
if('cause'inerror){
4209+
counter.objectLimit--;
4210+
constcause: ReactClientValue=(error.cause: any);
4211+
constcauseId=outlineDebugModel(request,counter,cause);
4212+
errorInfo.cause=serializeByValueID(causeId);
4213+
}
42064214
constid=outlineDebugModel(
42074215
request,
42084216
{objectLimit: stack.length*2+1},
@@ -4231,6 +4239,7 @@ function emitErrorChunk(
42314239
letmessage: string;
42324240
letstack: ReactStackTrace;
42334241
letenv=(0,request.environmentName)();
4242+
letcauseReference: null|string=null;
42344243
try{
42354244
if(errorinstanceofError){
42364245
name=error.name;
@@ -4243,6 +4252,13 @@ function emitErrorChunk(
42434252
// Keep the environment name.
42444253
env=errorEnv;
42454254
}
4255+
if('cause'inerror){
4256+
constcause: ReactClientValue=(error.cause: any);
4257+
constcauseId=debug
4258+
? outlineDebugModel(request,{objectLimit: 5},cause)
4259+
: outlineModel(request,cause);
4260+
causeReference=serializeByValueID(causeId);
4261+
}
42464262
}elseif(typeoferror==='object'&&error!==null){
42474263
message=describeObjectForErrorMessage(error);
42484264
stack=[];
@@ -4258,6 +4274,9 @@ function emitErrorChunk(
42584274
constownerRef=
42594275
owner==null ? null : outlineComponentInfo(request,owner);
42604276
errorInfo={digest, name, message, stack, env,owner: ownerRef};
4277+
if(causeReference!==null){
4278+
(errorInfo: ReactErrorInfoDev).cause=causeReference;
4279+
}
42614280
}else{
42624281
errorInfo ={digest};
42634282
}
@@ -4969,7 +4988,7 @@ function renderDebugModel(
49694988
returnserializeDebugFormData(request,value);
49704989
}
49714990
if (value instanceof Error) {
4972-
returnserializeDebugErrorValue(request,value);
4991+
returnserializeDebugErrorValue(request,counter,value);
49734992
}
49744993
if (value instanceof ArrayBuffer) {
49754994
returnserializeDebugTypedArray(request,'A',newUint8Array(value));

‎packages/shared/ReactTypes.js‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,13 +228,22 @@ export type ReactErrorInfoProd = {
228228
+digest: string,
229229
};
230230

231+
export type JSONValue =
232+
| string
233+
| boolean
234+
| number
235+
| null
236+
| {+[key: string]: JSONValue}
237+
| $ReadOnlyArray<JSONValue>;
238+
231239
export type ReactErrorInfoDev = {
232240
+digest?: string,
233241
+name: string,
234242
+message: string,
235243
+stack: ReactStackTrace,
236244
+env: string,
237245
+owner?: null|string,
246+
cause?: JSONValue,
238247
};
239248

240249
export type ReactErrorInfo = ReactErrorInfoProd | ReactErrorInfoDev;

0 commit comments

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

Commit 2ba3065

Browse files
authored
[Flight] Add support for transporting Error.cause (#35810)
1 parent 38cd020 commit 2ba3065

4 files changed

Lines changed: 185 additions & 18 deletions

File tree

‎packages/react-client/src/ReactFlightClient.js‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
*/
99

1010
importtype{
11+
JSONValue,
1112
Thenable,
1213
ReactDebugInfo,
1314
ReactDebugInfoEntry,
@@ -132,14 +133,6 @@ interface FlightStreamController {
132133

133134
typeUninitializedModel=string;
134135

135-
exporttypeJSONValue=
136-
|number
137-
|null
138-
|boolean
139-
|string
140-
|{+[key: string]: JSONValue}
141-
|$ReadOnlyArray<JSONValue>;
142-
143136
typeProfilingResult={
144137
track: number,
145138
endTime: number,
@@ -3527,6 +3520,18 @@ function resolveErrorDev(
35273520
}
35283521

35293522
leterror;
3523+
consterrorOptions=
3524+
'cause'inerrorInfo
3525+
? {
3526+
cause: reviveModel(
3527+
response,
3528+
// $FlowFixMe[incompatible-cast] -- Flow thinks `cause` in `cause?: JSONValue` can be undefined after `in` check.
3529+
(errorInfo.cause: JSONValue),
3530+
errorInfo,
3531+
'cause',
3532+
),
3533+
}
3534+
: undefined;
35303535
constcallStack=buildFakeCallStack(
35313536
response,
35323537
stack,
@@ -3537,6 +3542,7 @@ function resolveErrorDev(
35373542
null,
35383543
message||
35393544
'An error occurred in the Server Components render but no message was provided',
3545+
errorOptions,
35403546
),
35413547
);
35423548

‎packages/react-client/src/__tests__/ReactFlight-test.js‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -707,6 +707,139 @@ describe('ReactFlight', () => {
707707
}
708708
});
709709

710+
it('can transport Error.cause',async()=>{
711+
functionrenderError(error){
712+
if(!(errorinstanceofError)){
713+
return`${JSON.stringify(error)}`;
714+
}
715+
return`
716+
is error: ${errorinstanceofError}
717+
name: ${error.name}
718+
message: ${error.message}
719+
stack: ${normalizeCodeLocInfo(error.stack).split('\n').slice(0,2).join('\n')}
720+
environmentName: ${error.environmentName}
721+
cause: ${'cause'inerror ? renderError(error.cause) : 'no cause'}`;
722+
}
723+
functionComponentClient({error}){
724+
returnrenderError(error);
725+
}
726+
constComponent=clientReference(ComponentClient);
727+
728+
functionServerComponent(){
729+
constcause=newTypeError('root cause',{
730+
cause: {type: 'object cause'},
731+
});
732+
consterror=newError('hello',{cause});
733+
return<Componenterror={error}/>;
734+
}
735+
736+
consttransport=ReactNoopFlightServer.render(<ServerComponent/>,{
737+
onError(x){
738+
if(__DEV__){
739+
return'a dev digest';
740+
}
741+
return`digest("${x.message}")`;
742+
},
743+
});
744+
745+
awaitact(()=>{
746+
ReactNoop.render(ReactNoopFlightClient.read(transport));
747+
});
748+
749+
if(__DEV__){
750+
expect(ReactNoop).toMatchRenderedOutput(`
751+
is error: true
752+
name: Error
753+
message: hello
754+
stack: Error: hello
755+
in ServerComponent (at **)
756+
environmentName: Server
757+
cause:
758+
is error: true
759+
name: TypeError
760+
message: root cause
761+
stack: TypeError: root cause
762+
in ServerComponent (at **)
763+
environmentName: Server
764+
cause: {"type":"object cause"}`);
765+
}else{
766+
expect(ReactNoop).toMatchRenderedOutput(`
767+
is error: true
768+
name: Error
769+
message: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
770+
stack: Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
771+
environmentName: undefined
772+
cause: no cause`);
773+
}
774+
});
775+
776+
it('includes Error.cause in thrown errors',async()=>{
777+
functionrenderError(error){
778+
if(!(errorinstanceofError)){
779+
return`${JSON.stringify(error)}`;
780+
}
781+
return`
782+
is error: true
783+
name: ${error.name}
784+
message: ${error.message}
785+
stack: ${normalizeCodeLocInfo(error.stack).split('\n').slice(0,2).join('\n')}
786+
environmentName: ${error.environmentName}
787+
cause: ${'cause'inerror ? renderError(error.cause) : 'no cause'}`;
788+
}
789+
790+
functionServerComponent(){
791+
constcause=newTypeError('root cause',{
792+
cause: {type: 'object cause'},
793+
});
794+
consterror=newError('hello',{cause});
795+
throwerror;
796+
}
797+
798+
consttransport=ReactNoopFlightServer.render(<ServerComponent/>,{
799+
onError(x){
800+
if(__DEV__){
801+
return'a dev digest';
802+
}
803+
return`digest("${x.message}")`;
804+
},
805+
});
806+
807+
leterror;
808+
try{
809+
awaitact(()=>{
810+
ReactNoop.render(ReactNoopFlightClient.read(transport));
811+
});
812+
}catch(x){
813+
error=x;
814+
}
815+
816+
if(__DEV__){
817+
expect(renderError(error)).toEqual(`
818+
is error: true
819+
name: Error
820+
message: hello
821+
stack: Error: hello
822+
in ServerComponent (at **)
823+
environmentName: Server
824+
cause:
825+
is error: true
826+
name: TypeError
827+
message: root cause
828+
stack: TypeError: root cause
829+
in ServerComponent (at **)
830+
environmentName: Server
831+
cause: {"type":"object cause"}`);
832+
}else{
833+
expect(renderError(error)).toEqual(`
834+
is error: true
835+
name: Error
836+
message: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
837+
stack: Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
838+
environmentName: undefined
839+
cause: no cause`);
840+
}
841+
});
842+
710843
it('can transport cyclic objects',async()=>{
711844
functionComponentClient({prop}){
712845
expect(prop.obj.obj.obj).toBe(prop.obj.obj);

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

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -467,14 +467,6 @@ function getCurrentStackInDEV(): string {
467467

468468
constObjectPrototype=Object.prototype;
469469

470-
typeJSONValue=
471-
|string
472-
|boolean
473-
|number
474-
|null
475-
|{+[key: string]: JSONValue}
476-
| $ReadOnlyArray<JSONValue>;
477-
478470
conststringify=JSON.stringify;
479471

480472
typeReactJSONValue=
@@ -498,6 +490,7 @@ export type ReactClientValue =
498490
| React$Element<string>
499491
| React$Element<ClientReference<any>&any>
500492
|ReactComponentInfo
493+
|ReactErrorInfo
501494
|string
502495
|boolean
503496
|number
@@ -4171,6 +4164,11 @@ function serializeErrorValue(request: Request, error: Error): string {
41714164
stack=[];
41724165
}
41734166
consterrorInfo: ReactErrorInfoDev={name,message,stack,env};
4167+
if('cause'inerror){
4168+
constcause: ReactClientValue=(error.cause: any);
4169+
constcauseId=outlineModel(request,cause);
4170+
errorInfo.cause=serializeByValueID(causeId);
4171+
}
41744172
constid=outlineModel(request,errorInfo);
41754173
return'$Z'+id.toString(16);
41764174
}else{
@@ -4181,7 +4179,11 @@ function serializeErrorValue(request: Request, error: Error): string {
41814179
}
41824180
}
41834181

4184-
function serializeDebugErrorValue(request: Request, error: Error): string {
4182+
functionserializeDebugErrorValue(
4183+
request: Request,
4184+
counter: {objectLimit: number},
4185+
error: Error,
4186+
): string{
41854187
if(__DEV__){
41864188
let name: string='Error';
41874189
let message: string;
@@ -4203,6 +4205,12 @@ function serializeDebugErrorValue(request: Request, error: Error): string {
42034205
stack=[];
42044206
}
42054207
consterrorInfo: ReactErrorInfoDev={name, message, stack, env};
4208+
if('cause'inerror){
4209+
counter.objectLimit--;
4210+
constcause: ReactClientValue=(error.cause: any);
4211+
constcauseId=outlineDebugModel(request,counter,cause);
4212+
errorInfo.cause=serializeByValueID(causeId);
4213+
}
42064214
constid=outlineDebugModel(
42074215
request,
42084216
{objectLimit: stack.length*2+1},
@@ -4231,6 +4239,7 @@ function emitErrorChunk(
42314239
letmessage: string;
42324240
letstack: ReactStackTrace;
42334241
letenv=(0,request.environmentName)();
4242+
letcauseReference: null|string=null;
42344243
try{
42354244
if(errorinstanceofError){
42364245
name=error.name;
@@ -4243,6 +4252,13 @@ function emitErrorChunk(
42434252
// Keep the environment name.
42444253
env=errorEnv;
42454254
}
4255+
if('cause'inerror){
4256+
constcause: ReactClientValue=(error.cause: any);
4257+
constcauseId=debug
4258+
? outlineDebugModel(request,{objectLimit: 5},cause)
4259+
: outlineModel(request,cause);
4260+
causeReference=serializeByValueID(causeId);
4261+
}
42464262
}elseif(typeoferror==='object'&&error!==null){
42474263
message=describeObjectForErrorMessage(error);
42484264
stack=[];
@@ -4258,6 +4274,9 @@ function emitErrorChunk(
42584274
constownerRef=
42594275
owner==null ? null : outlineComponentInfo(request,owner);
42604276
errorInfo={digest, name, message, stack, env,owner: ownerRef};
4277+
if(causeReference!==null){
4278+
(errorInfo: ReactErrorInfoDev).cause=causeReference;
4279+
}
42614280
}else{
42624281
errorInfo ={digest};
42634282
}
@@ -4969,7 +4988,7 @@ function renderDebugModel(
49694988
returnserializeDebugFormData(request,value);
49704989
}
49714990
if (value instanceof Error) {
4972-
returnserializeDebugErrorValue(request,value);
4991+
returnserializeDebugErrorValue(request,counter,value);
49734992
}
49744993
if (value instanceof ArrayBuffer) {
49754994
returnserializeDebugTypedArray(request,'A',newUint8Array(value));

‎packages/shared/ReactTypes.js‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,13 +228,22 @@ export type ReactErrorInfoProd = {
228228
+digest: string,
229229
};
230230

231+
export type JSONValue =
232+
| string
233+
| boolean
234+
| number
235+
| null
236+
| {+[key: string]: JSONValue}
237+
| $ReadOnlyArray<JSONValue>;
238+
231239
export type ReactErrorInfoDev = {
232240
+digest?: string,
233241
+name: string,
234242
+message: string,
235243
+stack: ReactStackTrace,
236244
+env: string,
237245
+owner?: null|string,
246+
cause?: JSONValue,
238247
};
239248

240249
export type ReactErrorInfo = ReactErrorInfoProd | ReactErrorInfoDev;

0 commit comments

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

Commit 2ba3065

Browse files
authored
[Flight] Add support for transporting Error.cause (#35810)
1 parent 38cd020 commit 2ba3065

4 files changed

Lines changed: 185 additions & 18 deletions

File tree

‎packages/react-client/src/ReactFlightClient.js‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
*/
99

1010
importtype{
11+
JSONValue,
1112
Thenable,
1213
ReactDebugInfo,
1314
ReactDebugInfoEntry,
@@ -132,14 +133,6 @@ interface FlightStreamController {
132133

133134
typeUninitializedModel=string;
134135

135-
exporttypeJSONValue=
136-
|number
137-
|null
138-
|boolean
139-
|string
140-
|{+[key: string]: JSONValue}
141-
|$ReadOnlyArray<JSONValue>;
142-
143136
typeProfilingResult={
144137
track: number,
145138
endTime: number,
@@ -3527,6 +3520,18 @@ function resolveErrorDev(
35273520
}
35283521

35293522
leterror;
3523+
consterrorOptions=
3524+
'cause'inerrorInfo
3525+
? {
3526+
cause: reviveModel(
3527+
response,
3528+
// $FlowFixMe[incompatible-cast] -- Flow thinks `cause` in `cause?: JSONValue` can be undefined after `in` check.
3529+
(errorInfo.cause: JSONValue),
3530+
errorInfo,
3531+
'cause',
3532+
),
3533+
}
3534+
: undefined;
35303535
constcallStack=buildFakeCallStack(
35313536
response,
35323537
stack,
@@ -3537,6 +3542,7 @@ function resolveErrorDev(
35373542
null,
35383543
message||
35393544
'An error occurred in the Server Components render but no message was provided',
3545+
errorOptions,
35403546
),
35413547
);
35423548

‎packages/react-client/src/__tests__/ReactFlight-test.js‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -707,6 +707,139 @@ describe('ReactFlight', () => {
707707
}
708708
});
709709

710+
it('can transport Error.cause',async()=>{
711+
functionrenderError(error){
712+
if(!(errorinstanceofError)){
713+
return`${JSON.stringify(error)}`;
714+
}
715+
return`
716+
is error: ${errorinstanceofError}
717+
name: ${error.name}
718+
message: ${error.message}
719+
stack: ${normalizeCodeLocInfo(error.stack).split('\n').slice(0,2).join('\n')}
720+
environmentName: ${error.environmentName}
721+
cause: ${'cause'inerror ? renderError(error.cause) : 'no cause'}`;
722+
}
723+
functionComponentClient({error}){
724+
returnrenderError(error);
725+
}
726+
constComponent=clientReference(ComponentClient);
727+
728+
functionServerComponent(){
729+
constcause=newTypeError('root cause',{
730+
cause: {type: 'object cause'},
731+
});
732+
consterror=newError('hello',{cause});
733+
return<Componenterror={error}/>;
734+
}
735+
736+
consttransport=ReactNoopFlightServer.render(<ServerComponent/>,{
737+
onError(x){
738+
if(__DEV__){
739+
return'a dev digest';
740+
}
741+
return`digest("${x.message}")`;
742+
},
743+
});
744+
745+
awaitact(()=>{
746+
ReactNoop.render(ReactNoopFlightClient.read(transport));
747+
});
748+
749+
if(__DEV__){
750+
expect(ReactNoop).toMatchRenderedOutput(`
751+
is error: true
752+
name: Error
753+
message: hello
754+
stack: Error: hello
755+
in ServerComponent (at **)
756+
environmentName: Server
757+
cause:
758+
is error: true
759+
name: TypeError
760+
message: root cause
761+
stack: TypeError: root cause
762+
in ServerComponent (at **)
763+
environmentName: Server
764+
cause: {"type":"object cause"}`);
765+
}else{
766+
expect(ReactNoop).toMatchRenderedOutput(`
767+
is error: true
768+
name: Error
769+
message: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
770+
stack: Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
771+
environmentName: undefined
772+
cause: no cause`);
773+
}
774+
});
775+
776+
it('includes Error.cause in thrown errors',async()=>{
777+
functionrenderError(error){
778+
if(!(errorinstanceofError)){
779+
return`${JSON.stringify(error)}`;
780+
}
781+
return`
782+
is error: true
783+
name: ${error.name}
784+
message: ${error.message}
785+
stack: ${normalizeCodeLocInfo(error.stack).split('\n').slice(0,2).join('\n')}
786+
environmentName: ${error.environmentName}
787+
cause: ${'cause'inerror ? renderError(error.cause) : 'no cause'}`;
788+
}
789+
790+
functionServerComponent(){
791+
constcause=newTypeError('root cause',{
792+
cause: {type: 'object cause'},
793+
});
794+
consterror=newError('hello',{cause});
795+
throwerror;
796+
}
797+
798+
consttransport=ReactNoopFlightServer.render(<ServerComponent/>,{
799+
onError(x){
800+
if(__DEV__){
801+
return'a dev digest';
802+
}
803+
return`digest("${x.message}")`;
804+
},
805+
});
806+
807+
leterror;
808+
try{
809+
awaitact(()=>{
810+
ReactNoop.render(ReactNoopFlightClient.read(transport));
811+
});
812+
}catch(x){
813+
error=x;
814+
}
815+
816+
if(__DEV__){
817+
expect(renderError(error)).toEqual(`
818+
is error: true
819+
name: Error
820+
message: hello
821+
stack: Error: hello
822+
in ServerComponent (at **)
823+
environmentName: Server
824+
cause:
825+
is error: true
826+
name: TypeError
827+
message: root cause
828+
stack: TypeError: root cause
829+
in ServerComponent (at **)
830+
environmentName: Server
831+
cause: {"type":"object cause"}`);
832+
}else{
833+
expect(renderError(error)).toEqual(`
834+
is error: true
835+
name: Error
836+
message: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
837+
stack: Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
838+
environmentName: undefined
839+
cause: no cause`);
840+
}
841+
});
842+
710843
it('can transport cyclic objects',async()=>{
711844
functionComponentClient({prop}){
712845
expect(prop.obj.obj.obj).toBe(prop.obj.obj);

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

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -467,14 +467,6 @@ function getCurrentStackInDEV(): string {
467467

468468
constObjectPrototype=Object.prototype;
469469

470-
typeJSONValue=
471-
|string
472-
|boolean
473-
|number
474-
|null
475-
|{+[key: string]: JSONValue}
476-
| $ReadOnlyArray<JSONValue>;
477-
478470
conststringify=JSON.stringify;
479471

480472
typeReactJSONValue=
@@ -498,6 +490,7 @@ export type ReactClientValue =
498490
| React$Element<string>
499491
| React$Element<ClientReference<any>&any>
500492
|ReactComponentInfo
493+
|ReactErrorInfo
501494
|string
502495
|boolean
503496
|number
@@ -4171,6 +4164,11 @@ function serializeErrorValue(request: Request, error: Error): string {
41714164
stack=[];
41724165
}
41734166
consterrorInfo: ReactErrorInfoDev={name,message,stack,env};
4167+
if('cause'inerror){
4168+
constcause: ReactClientValue=(error.cause: any);
4169+
constcauseId=outlineModel(request,cause);
4170+
errorInfo.cause=serializeByValueID(causeId);
4171+
}
41744172
constid=outlineModel(request,errorInfo);
41754173
return'$Z'+id.toString(16);
41764174
}else{
@@ -4181,7 +4179,11 @@ function serializeErrorValue(request: Request, error: Error): string {
41814179
}
41824180
}
41834181

4184-
function serializeDebugErrorValue(request: Request, error: Error): string {
4182+
functionserializeDebugErrorValue(
4183+
request: Request,
4184+
counter: {objectLimit: number},
4185+
error: Error,
4186+
): string{
41854187
if(__DEV__){
41864188
let name: string='Error';
41874189
let message: string;
@@ -4203,6 +4205,12 @@ function serializeDebugErrorValue(request: Request, error: Error): string {
42034205
stack=[];
42044206
}
42054207
consterrorInfo: ReactErrorInfoDev={name, message, stack, env};
4208+
if('cause'inerror){
4209+
counter.objectLimit--;
4210+
constcause: ReactClientValue=(error.cause: any);
4211+
constcauseId=outlineDebugModel(request,counter,cause);
4212+
errorInfo.cause=serializeByValueID(causeId);
4213+
}
42064214
constid=outlineDebugModel(
42074215
request,
42084216
{objectLimit: stack.length*2+1},
@@ -4231,6 +4239,7 @@ function emitErrorChunk(
42314239
letmessage: string;
42324240
letstack: ReactStackTrace;
42334241
letenv=(0,request.environmentName)();
4242+
letcauseReference: null|string=null;
42344243
try{
42354244
if(errorinstanceofError){
42364245
name=error.name;
@@ -4243,6 +4252,13 @@ function emitErrorChunk(
42434252
// Keep the environment name.
42444253
env=errorEnv;
42454254
}
4255+
if('cause'inerror){
4256+
constcause: ReactClientValue=(error.cause: any);
4257+
constcauseId=debug
4258+
? outlineDebugModel(request,{objectLimit: 5},cause)
4259+
: outlineModel(request,cause);
4260+
causeReference=serializeByValueID(causeId);
4261+
}
42464262
}elseif(typeoferror==='object'&&error!==null){
42474263
message=describeObjectForErrorMessage(error);
42484264
stack=[];
@@ -4258,6 +4274,9 @@ function emitErrorChunk(
42584274
constownerRef=
42594275
owner==null ? null : outlineComponentInfo(request,owner);
42604276
errorInfo={digest, name, message, stack, env,owner: ownerRef};
4277+
if(causeReference!==null){
4278+
(errorInfo: ReactErrorInfoDev).cause=causeReference;
4279+
}
42614280
}else{
42624281
errorInfo ={digest};
42634282
}
@@ -4969,7 +4988,7 @@ function renderDebugModel(
49694988
returnserializeDebugFormData(request,value);
49704989
}
49714990
if (value instanceof Error) {
4972-
returnserializeDebugErrorValue(request,value);
4991+
returnserializeDebugErrorValue(request,counter,value);
49734992
}
49744993
if (value instanceof ArrayBuffer) {
49754994
returnserializeDebugTypedArray(request,'A',newUint8Array(value));

‎packages/shared/ReactTypes.js‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,13 +228,22 @@ export type ReactErrorInfoProd = {
228228
+digest: string,
229229
};
230230

231+
export type JSONValue =
232+
| string
233+
| boolean
234+
| number
235+
| null
236+
| {+[key: string]: JSONValue}
237+
| $ReadOnlyArray<JSONValue>;
238+
231239
export type ReactErrorInfoDev = {
232240
+digest?: string,
233241
+name: string,
234242
+message: string,
235243
+stack: ReactStackTrace,
236244
+env: string,
237245
+owner?: null|string,
246+
cause?: JSONValue,
238247
};
239248

240249
export type ReactErrorInfo = ReactErrorInfoProd | ReactErrorInfoDev;

0 commit comments

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

Commit 2ba3065

Browse files
authored
[Flight] Add support for transporting Error.cause (#35810)
1 parent 38cd020 commit 2ba3065

4 files changed

Lines changed: 185 additions & 18 deletions

File tree

‎packages/react-client/src/ReactFlightClient.js‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
*/
99

1010
importtype{
11+
JSONValue,
1112
Thenable,
1213
ReactDebugInfo,
1314
ReactDebugInfoEntry,
@@ -132,14 +133,6 @@ interface FlightStreamController {
132133

133134
typeUninitializedModel=string;
134135

135-
exporttypeJSONValue=
136-
|number
137-
|null
138-
|boolean
139-
|string
140-
|{+[key: string]: JSONValue}
141-
|$ReadOnlyArray<JSONValue>;
142-
143136
typeProfilingResult={
144137
track: number,
145138
endTime: number,
@@ -3527,6 +3520,18 @@ function resolveErrorDev(
35273520
}
35283521

35293522
leterror;
3523+
consterrorOptions=
3524+
'cause'inerrorInfo
3525+
? {
3526+
cause: reviveModel(
3527+
response,
3528+
// $FlowFixMe[incompatible-cast] -- Flow thinks `cause` in `cause?: JSONValue` can be undefined after `in` check.
3529+
(errorInfo.cause: JSONValue),
3530+
errorInfo,
3531+
'cause',
3532+
),
3533+
}
3534+
: undefined;
35303535
constcallStack=buildFakeCallStack(
35313536
response,
35323537
stack,
@@ -3537,6 +3542,7 @@ function resolveErrorDev(
35373542
null,
35383543
message||
35393544
'An error occurred in the Server Components render but no message was provided',
3545+
errorOptions,
35403546
),
35413547
);
35423548

‎packages/react-client/src/__tests__/ReactFlight-test.js‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -707,6 +707,139 @@ describe('ReactFlight', () => {
707707
}
708708
});
709709

710+
it('can transport Error.cause',async()=>{
711+
functionrenderError(error){
712+
if(!(errorinstanceofError)){
713+
return`${JSON.stringify(error)}`;
714+
}
715+
return`
716+
is error: ${errorinstanceofError}
717+
name: ${error.name}
718+
message: ${error.message}
719+
stack: ${normalizeCodeLocInfo(error.stack).split('\n').slice(0,2).join('\n')}
720+
environmentName: ${error.environmentName}
721+
cause: ${'cause'inerror ? renderError(error.cause) : 'no cause'}`;
722+
}
723+
functionComponentClient({error}){
724+
returnrenderError(error);
725+
}
726+
constComponent=clientReference(ComponentClient);
727+
728+
functionServerComponent(){
729+
constcause=newTypeError('root cause',{
730+
cause: {type: 'object cause'},
731+
});
732+
consterror=newError('hello',{cause});
733+
return<Componenterror={error}/>;
734+
}
735+
736+
consttransport=ReactNoopFlightServer.render(<ServerComponent/>,{
737+
onError(x){
738+
if(__DEV__){
739+
return'a dev digest';
740+
}
741+
return`digest("${x.message}")`;
742+
},
743+
});
744+
745+
awaitact(()=>{
746+
ReactNoop.render(ReactNoopFlightClient.read(transport));
747+
});
748+
749+
if(__DEV__){
750+
expect(ReactNoop).toMatchRenderedOutput(`
751+
is error: true
752+
name: Error
753+
message: hello
754+
stack: Error: hello
755+
in ServerComponent (at **)
756+
environmentName: Server
757+
cause:
758+
is error: true
759+
name: TypeError
760+
message: root cause
761+
stack: TypeError: root cause
762+
in ServerComponent (at **)
763+
environmentName: Server
764+
cause: {"type":"object cause"}`);
765+
}else{
766+
expect(ReactNoop).toMatchRenderedOutput(`
767+
is error: true
768+
name: Error
769+
message: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
770+
stack: Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
771+
environmentName: undefined
772+
cause: no cause`);
773+
}
774+
});
775+
776+
it('includes Error.cause in thrown errors',async()=>{
777+
functionrenderError(error){
778+
if(!(errorinstanceofError)){
779+
return`${JSON.stringify(error)}`;
780+
}
781+
return`
782+
is error: true
783+
name: ${error.name}
784+
message: ${error.message}
785+
stack: ${normalizeCodeLocInfo(error.stack).split('\n').slice(0,2).join('\n')}
786+
environmentName: ${error.environmentName}
787+
cause: ${'cause'inerror ? renderError(error.cause) : 'no cause'}`;
788+
}
789+
790+
functionServerComponent(){
791+
constcause=newTypeError('root cause',{
792+
cause: {type: 'object cause'},
793+
});
794+
consterror=newError('hello',{cause});
795+
throwerror;
796+
}
797+
798+
consttransport=ReactNoopFlightServer.render(<ServerComponent/>,{
799+
onError(x){
800+
if(__DEV__){
801+
return'a dev digest';
802+
}
803+
return`digest("${x.message}")`;
804+
},
805+
});
806+
807+
leterror;
808+
try{
809+
awaitact(()=>{
810+
ReactNoop.render(ReactNoopFlightClient.read(transport));
811+
});
812+
}catch(x){
813+
error=x;
814+
}
815+
816+
if(__DEV__){
817+
expect(renderError(error)).toEqual(`
818+
is error: true
819+
name: Error
820+
message: hello
821+
stack: Error: hello
822+
in ServerComponent (at **)
823+
environmentName: Server
824+
cause:
825+
is error: true
826+
name: TypeError
827+
message: root cause
828+
stack: TypeError: root cause
829+
in ServerComponent (at **)
830+
environmentName: Server
831+
cause: {"type":"object cause"}`);
832+
}else{
833+
expect(renderError(error)).toEqual(`
834+
is error: true
835+
name: Error
836+
message: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
837+
stack: Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
838+
environmentName: undefined
839+
cause: no cause`);
840+
}
841+
});
842+
710843
it('can transport cyclic objects',async()=>{
711844
functionComponentClient({prop}){
712845
expect(prop.obj.obj.obj).toBe(prop.obj.obj);

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

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -467,14 +467,6 @@ function getCurrentStackInDEV(): string {
467467

468468
constObjectPrototype=Object.prototype;
469469

470-
typeJSONValue=
471-
|string
472-
|boolean
473-
|number
474-
|null
475-
|{+[key: string]: JSONValue}
476-
| $ReadOnlyArray<JSONValue>;
477-
478470
conststringify=JSON.stringify;
479471

480472
typeReactJSONValue=
@@ -498,6 +490,7 @@ export type ReactClientValue =
498490
| React$Element<string>
499491
| React$Element<ClientReference<any>&any>
500492
|ReactComponentInfo
493+
|ReactErrorInfo
501494
|string
502495
|boolean
503496
|number
@@ -4171,6 +4164,11 @@ function serializeErrorValue(request: Request, error: Error): string {
41714164
stack=[];
41724165
}
41734166
consterrorInfo: ReactErrorInfoDev={name,message,stack,env};
4167+
if('cause'inerror){
4168+
constcause: ReactClientValue=(error.cause: any);
4169+
constcauseId=outlineModel(request,cause);
4170+
errorInfo.cause=serializeByValueID(causeId);
4171+
}
41744172
constid=outlineModel(request,errorInfo);
41754173
return'$Z'+id.toString(16);
41764174
}else{
@@ -4181,7 +4179,11 @@ function serializeErrorValue(request: Request, error: Error): string {
41814179
}
41824180
}
41834181

4184-
function serializeDebugErrorValue(request: Request, error: Error): string {
4182+
functionserializeDebugErrorValue(
4183+
request: Request,
4184+
counter: {objectLimit: number},
4185+
error: Error,
4186+
): string{
41854187
if(__DEV__){
41864188
let name: string='Error';
41874189
let message: string;
@@ -4203,6 +4205,12 @@ function serializeDebugErrorValue(request: Request, error: Error): string {
42034205
stack=[];
42044206
}
42054207
consterrorInfo: ReactErrorInfoDev={name, message, stack, env};
4208+
if('cause'inerror){
4209+
counter.objectLimit--;
4210+
constcause: ReactClientValue=(error.cause: any);
4211+
constcauseId=outlineDebugModel(request,counter,cause);
4212+
errorInfo.cause=serializeByValueID(causeId);
4213+
}
42064214
constid=outlineDebugModel(
42074215
request,
42084216
{objectLimit: stack.length*2+1},
@@ -4231,6 +4239,7 @@ function emitErrorChunk(
42314239
letmessage: string;
42324240
letstack: ReactStackTrace;
42334241
letenv=(0,request.environmentName)();
4242+
letcauseReference: null|string=null;
42344243
try{
42354244
if(errorinstanceofError){
42364245
name=error.name;
@@ -4243,6 +4252,13 @@ function emitErrorChunk(
42434252
// Keep the environment name.
42444253
env=errorEnv;
42454254
}
4255+
if('cause'inerror){
4256+
constcause: ReactClientValue=(error.cause: any);
4257+
constcauseId=debug
4258+
? outlineDebugModel(request,{objectLimit: 5},cause)
4259+
: outlineModel(request,cause);
4260+
causeReference=serializeByValueID(causeId);
4261+
}
42464262
}elseif(typeoferror==='object'&&error!==null){
42474263
message=describeObjectForErrorMessage(error);
42484264
stack=[];
@@ -4258,6 +4274,9 @@ function emitErrorChunk(
42584274
constownerRef=
42594275
owner==null ? null : outlineComponentInfo(request,owner);
42604276
errorInfo={digest, name, message, stack, env,owner: ownerRef};
4277+
if(causeReference!==null){
4278+
(errorInfo: ReactErrorInfoDev).cause=causeReference;
4279+
}
42614280
}else{
42624281
errorInfo ={digest};
42634282
}
@@ -4969,7 +4988,7 @@ function renderDebugModel(
49694988
returnserializeDebugFormData(request,value);
49704989
}
49714990
if (value instanceof Error) {
4972-
returnserializeDebugErrorValue(request,value);
4991+
returnserializeDebugErrorValue(request,counter,value);
49734992
}
49744993
if (value instanceof ArrayBuffer) {
49754994
returnserializeDebugTypedArray(request,'A',newUint8Array(value));

‎packages/shared/ReactTypes.js‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,13 +228,22 @@ export type ReactErrorInfoProd = {
228228
+digest: string,
229229
};
230230

231+
export type JSONValue =
232+
| string
233+
| boolean
234+
| number
235+
| null
236+
| {+[key: string]: JSONValue}
237+
| $ReadOnlyArray<JSONValue>;
238+
231239
export type ReactErrorInfoDev = {
232240
+digest?: string,
233241
+name: string,
234242
+message: string,
235243
+stack: ReactStackTrace,
236244
+env: string,
237245
+owner?: null|string,
246+
cause?: JSONValue,
238247
};
239248

240249
export type ReactErrorInfo = ReactErrorInfoProd | ReactErrorInfoDev;

0 commit comments

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

Commit 2ba3065

Browse files
authored
[Flight] Add support for transporting Error.cause (#35810)
1 parent 38cd020 commit 2ba3065

4 files changed

Lines changed: 185 additions & 18 deletions

File tree

‎packages/react-client/src/ReactFlightClient.js‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
*/
99

1010
importtype{
11+
JSONValue,
1112
Thenable,
1213
ReactDebugInfo,
1314
ReactDebugInfoEntry,
@@ -132,14 +133,6 @@ interface FlightStreamController {
132133

133134
typeUninitializedModel=string;
134135

135-
exporttypeJSONValue=
136-
|number
137-
|null
138-
|boolean
139-
|string
140-
|{+[key: string]: JSONValue}
141-
|$ReadOnlyArray<JSONValue>;
142-
143136
typeProfilingResult={
144137
track: number,
145138
endTime: number,
@@ -3527,6 +3520,18 @@ function resolveErrorDev(
35273520
}
35283521

35293522
leterror;
3523+
consterrorOptions=
3524+
'cause'inerrorInfo
3525+
? {
3526+
cause: reviveModel(
3527+
response,
3528+
// $FlowFixMe[incompatible-cast] -- Flow thinks `cause` in `cause?: JSONValue` can be undefined after `in` check.
3529+
(errorInfo.cause: JSONValue),
3530+
errorInfo,
3531+
'cause',
3532+
),
3533+
}
3534+
: undefined;
35303535
constcallStack=buildFakeCallStack(
35313536
response,
35323537
stack,
@@ -3537,6 +3542,7 @@ function resolveErrorDev(
35373542
null,
35383543
message||
35393544
'An error occurred in the Server Components render but no message was provided',
3545+
errorOptions,
35403546
),
35413547
);
35423548

‎packages/react-client/src/__tests__/ReactFlight-test.js‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -707,6 +707,139 @@ describe('ReactFlight', () => {
707707
}
708708
});
709709

710+
it('can transport Error.cause',async()=>{
711+
functionrenderError(error){
712+
if(!(errorinstanceofError)){
713+
return`${JSON.stringify(error)}`;
714+
}
715+
return`
716+
is error: ${errorinstanceofError}
717+
name: ${error.name}
718+
message: ${error.message}
719+
stack: ${normalizeCodeLocInfo(error.stack).split('\n').slice(0,2).join('\n')}
720+
environmentName: ${error.environmentName}
721+
cause: ${'cause'inerror ? renderError(error.cause) : 'no cause'}`;
722+
}
723+
functionComponentClient({error}){
724+
returnrenderError(error);
725+
}
726+
constComponent=clientReference(ComponentClient);
727+
728+
functionServerComponent(){
729+
constcause=newTypeError('root cause',{
730+
cause: {type: 'object cause'},
731+
});
732+
consterror=newError('hello',{cause});
733+
return<Componenterror={error}/>;
734+
}
735+
736+
consttransport=ReactNoopFlightServer.render(<ServerComponent/>,{
737+
onError(x){
738+
if(__DEV__){
739+
return'a dev digest';
740+
}
741+
return`digest("${x.message}")`;
742+
},
743+
});
744+
745+
awaitact(()=>{
746+
ReactNoop.render(ReactNoopFlightClient.read(transport));
747+
});
748+
749+
if(__DEV__){
750+
expect(ReactNoop).toMatchRenderedOutput(`
751+
is error: true
752+
name: Error
753+
message: hello
754+
stack: Error: hello
755+
in ServerComponent (at **)
756+
environmentName: Server
757+
cause:
758+
is error: true
759+
name: TypeError
760+
message: root cause
761+
stack: TypeError: root cause
762+
in ServerComponent (at **)
763+
environmentName: Server
764+
cause: {"type":"object cause"}`);
765+
}else{
766+
expect(ReactNoop).toMatchRenderedOutput(`
767+
is error: true
768+
name: Error
769+
message: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
770+
stack: Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
771+
environmentName: undefined
772+
cause: no cause`);
773+
}
774+
});
775+
776+
it('includes Error.cause in thrown errors',async()=>{
777+
functionrenderError(error){
778+
if(!(errorinstanceofError)){
779+
return`${JSON.stringify(error)}`;
780+
}
781+
return`
782+
is error: true
783+
name: ${error.name}
784+
message: ${error.message}
785+
stack: ${normalizeCodeLocInfo(error.stack).split('\n').slice(0,2).join('\n')}
786+
environmentName: ${error.environmentName}
787+
cause: ${'cause'inerror ? renderError(error.cause) : 'no cause'}`;
788+
}
789+
790+
functionServerComponent(){
791+
constcause=newTypeError('root cause',{
792+
cause: {type: 'object cause'},
793+
});
794+
consterror=newError('hello',{cause});
795+
throwerror;
796+
}
797+
798+
consttransport=ReactNoopFlightServer.render(<ServerComponent/>,{
799+
onError(x){
800+
if(__DEV__){
801+
return'a dev digest';
802+
}
803+
return`digest("${x.message}")`;
804+
},
805+
});
806+
807+
leterror;
808+
try{
809+
awaitact(()=>{
810+
ReactNoop.render(ReactNoopFlightClient.read(transport));
811+
});
812+
}catch(x){
813+
error=x;
814+
}
815+
816+
if(__DEV__){
817+
expect(renderError(error)).toEqual(`
818+
is error: true
819+
name: Error
820+
message: hello
821+
stack: Error: hello
822+
in ServerComponent (at **)
823+
environmentName: Server
824+
cause:
825+
is error: true
826+
name: TypeError
827+
message: root cause
828+
stack: TypeError: root cause
829+
in ServerComponent (at **)
830+
environmentName: Server
831+
cause: {"type":"object cause"}`);
832+
}else{
833+
expect(renderError(error)).toEqual(`
834+
is error: true
835+
name: Error
836+
message: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
837+
stack: Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.
838+
environmentName: undefined
839+
cause: no cause`);
840+
}
841+
});
842+
710843
it('can transport cyclic objects',async()=>{
711844
functionComponentClient({prop}){
712845
expect(prop.obj.obj.obj).toBe(prop.obj.obj);

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

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -467,14 +467,6 @@ function getCurrentStackInDEV(): string {
467467

468468
constObjectPrototype=Object.prototype;
469469

470-
typeJSONValue=
471-
|string
472-
|boolean
473-
|number
474-
|null
475-
|{+[key: string]: JSONValue}
476-
| $ReadOnlyArray<JSONValue>;
477-
478470
conststringify=JSON.stringify;
479471

480472
typeReactJSONValue=
@@ -498,6 +490,7 @@ export type ReactClientValue =
498490
| React$Element<string>
499491
| React$Element<ClientReference<any>&any>
500492
|ReactComponentInfo
493+
|ReactErrorInfo
501494
|string
502495
|boolean
503496
|number
@@ -4171,6 +4164,11 @@ function serializeErrorValue(request: Request, error: Error): string {
41714164
stack=[];
41724165
}
41734166
consterrorInfo: ReactErrorInfoDev={name,message,stack,env};
4167+
if('cause'inerror){
4168+
constcause: ReactClientValue=(error.cause: any);
4169+
constcauseId=outlineModel(request,cause);
4170+
errorInfo.cause=serializeByValueID(causeId);
4171+
}
41744172
constid=outlineModel(request,errorInfo);
41754173
return'$Z'+id.toString(16);
41764174
}else{
@@ -4181,7 +4179,11 @@ function serializeErrorValue(request: Request, error: Error): string {
41814179
}
41824180
}
41834181

4184-
function serializeDebugErrorValue(request: Request, error: Error): string {
4182+
functionserializeDebugErrorValue(
4183+
request: Request,
4184+
counter: {objectLimit: number},
4185+
error: Error,
4186+
): string{
41854187
if(__DEV__){
41864188
let name: string='Error';
41874189
let message: string;
@@ -4203,6 +4205,12 @@ function serializeDebugErrorValue(request: Request, error: Error): string {
42034205
stack=[];
42044206
}
42054207
consterrorInfo: ReactErrorInfoDev={name, message, stack, env};
4208+
if('cause'inerror){
4209+
counter.objectLimit--;
4210+
constcause: ReactClientValue=(error.cause: any);
4211+
constcauseId=outlineDebugModel(request,counter,cause);
4212+
errorInfo.cause=serializeByValueID(causeId);
4213+
}
42064214
constid=outlineDebugModel(
42074215
request,
42084216
{objectLimit: stack.length*2+1},
@@ -4231,6 +4239,7 @@ function emitErrorChunk(
42314239
letmessage: string;
42324240
letstack: ReactStackTrace;
42334241
letenv=(0,request.environmentName)();
4242+
letcauseReference: null|string=null;
42344243
try{
42354244
if(errorinstanceofError){
42364245
name=error.name;
@@ -4243,6 +4252,13 @@ function emitErrorChunk(
42434252
// Keep the environment name.
42444253
env=errorEnv;
42454254
}
4255+
if('cause'inerror){
4256+
constcause: ReactClientValue=(error.cause: any);
4257+
constcauseId=debug
4258+
? outlineDebugModel(request,{objectLimit: 5},cause)
4259+
: outlineModel(request,cause);
4260+
causeReference=serializeByValueID(causeId);
4261+
}
42464262
}elseif(typeoferror==='object'&&error!==null){
42474263
message=describeObjectForErrorMessage(error);
42484264
stack=[];
@@ -4258,6 +4274,9 @@ function emitErrorChunk(
42584274
constownerRef=
42594275
owner==null ? null : outlineComponentInfo(request,owner);
42604276
errorInfo={digest, name, message, stack, env,owner: ownerRef};
4277+
if(causeReference!==null){
4278+
(errorInfo: ReactErrorInfoDev).cause=causeReference;
4279+
}
42614280
}else{
42624281
errorInfo ={digest};
42634282
}
@@ -4969,7 +4988,7 @@ function renderDebugModel(
49694988
returnserializeDebugFormData(request,value);
49704989
}
49714990
if (value instanceof Error) {
4972-
returnserializeDebugErrorValue(request,value);
4991+
returnserializeDebugErrorValue(request,counter,value);
49734992
}
49744993
if (value instanceof ArrayBuffer) {
49754994
returnserializeDebugTypedArray(request,'A',newUint8Array(value));

‎packages/shared/ReactTypes.js‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,13 +228,22 @@ export type ReactErrorInfoProd = {
228228
+digest: string,
229229
};
230230

231+
export type JSONValue =
232+
| string
233+
| boolean
234+
| number
235+
| null
236+
| {+[key: string]: JSONValue}
237+
| $ReadOnlyArray<JSONValue>;
238+
231239
export type ReactErrorInfoDev = {
232240
+digest?: string,
233241
+name: string,
234242
+message: string,
235243
+stack: ReactStackTrace,
236244
+env: string,
237245
+owner?: null|string,
246+
cause?: JSONValue,
238247
};
239248

240249
export type ReactErrorInfo = ReactErrorInfoProd | ReactErrorInfoDev;

0 commit comments

Comments
 (0)