Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Expose reportRuntimeError #4709

Merged
merged 2 commits into from
Nov 1, 2018
Merged

Expose reportRuntimeError #4709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
202dc5d
factor out crashWithFrames and expose reportRuntimeError
hipstersmoothie Jun 30, 2018
563ee7c
address code review and move error call to handleRuntimeError
hipstersmoothie Jul 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 38 additions & 20 deletions packages/react-error-overlay/src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@
*/

/* @flow */
import { listenToRuntimeErrors } from './listenToRuntimeErrors';
import {
listenToRuntimeErrors,
crashWithFrames,
} from './listenToRuntimeErrors';
import { iframeStyle } from './styles';
import { applyStyles } from './utils/dom/css';

Expand Down Expand Up @@ -47,6 +50,14 @@ export function reportBuildError(error: string) {
update();
}

export function reportRuntimeError(
error: Error,
options?: RuntimeReportingOption = {}
) {
currentRuntimeErrorOptions = options;
crashWithFrames(handleRuntimeError(options))(error);
}

export function dismissBuildError() {
currentBuildError = null;
update();
Expand All @@ -64,28 +75,35 @@ export function startReportingRuntimeErrors(options: RuntimeReportingOptions) {
);
}
currentRuntimeErrorOptions = options;
stopListeningToRuntimeErrors = listenToRuntimeErrors(errorRecord => {
try {
if (typeof options.onError === 'function') {
options.onError.call(null);
}
} finally {
handleRuntimeError(errorRecord);
}
}, options.filename);
stopListeningToRuntimeErrors = listenToRuntimeErrors(
handleRuntimeError(options),
options.filename
);
}

function handleRuntimeError(errorRecord) {
if (
currentRuntimeErrorRecords.some(({ error }) => error === errorRecord.error)
) {
// Deduplicate identical errors.
// This fixes https://github.com/facebook/create-react-app/issues/3011.
return;
const handleRuntimeError = (options: RuntimeReportingOptions) => (
errorRecord: ErrorRecord
) => {
try {
if (typeof options.onError === 'function') {
options.onError.call(null);
}
} finally {
if (
currentRuntimeErrorRecords.some(
({ error }) => error === errorRecord.error
)
) {
// Deduplicate identical errors.
// This fixes https://github.com/facebook/create-react-app/issues/3011.
return;
}
currentRuntimeErrorRecords = currentRuntimeErrorRecords.concat([
errorRecord,
]);
update();
}
currentRuntimeErrorRecords = currentRuntimeErrorRecords.concat([errorRecord]);
update();
}
};

export function dismissRuntimeErrors() {
currentRuntimeErrorRecords = [];
Expand Down
46 changes: 26 additions & 20 deletions packages/react-error-overlay/src/listenToRuntimeErrors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,34 +37,40 @@ export type ErrorRecord = {|
stackFrames: StackFrame[],
|};

export const crashWithFrames = (crash: ErrorRecord => void) => (
error: Error,
unhandledRejection = false
) => {
getStackFrames(error, unhandledRejection, CONTEXT_SIZE)
.then(stackFrames => {
if (stackFrames == null) {
return;
}
crash({
error,
unhandledRejection,
contextSize: CONTEXT_SIZE,
stackFrames,
});
})
.catch(e => {
console.log('Could not get the stack frames of error:', e);
});
};

export function listenToRuntimeErrors(
crash: ErrorRecord => void,
filename: string = '/static/js/bundle.js'
) {
function crashWithFrames(error: Error, unhandledRejection = false) {
getStackFrames(error, unhandledRejection, CONTEXT_SIZE)
.then(stackFrames => {
if (stackFrames == null) {
return;
}
crash({
error,
unhandledRejection,
contextSize: CONTEXT_SIZE,
stackFrames,
});
})
.catch(e => {
console.log('Could not get the stack frames of error:', e);
});
}
registerError(window, error => crashWithFrames(error, false));
registerPromise(window, error => crashWithFrames(error, true));
const crashWithFramesRunTime = crashWithFrames(crash);

registerError(window, error => crashWithFramesRunTime(error, false));
registerPromise(window, error => crashWithFramesRunTime(error, true));
registerStackTraceLimit();
registerReactStack();
permanentRegisterConsole('error', (warning, stack) => {
const data = massageWarning(warning, stack);
crashWithFrames(
crashWithFramesRunTime(
// $FlowFixMe
{
message: data.message,
Expand Down