234 строки
6.5 KiB
JavaScript
234 строки
6.5 KiB
JavaScript
/**
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*
|
|
* @flow
|
|
* @format
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
const React = require('react');
|
|
|
|
import type {Registry, IgnorePattern} from './Data/YellowBoxRegistry';
|
|
import YellowBoxWarning from './Data/YellowBoxWarning';
|
|
|
|
import * as LogBoxData from '../LogBox/Data/LogBoxData';
|
|
import NativeLogBox from '../NativeModules/specs/NativeLogBox';
|
|
|
|
type Props = $ReadOnly<{||}>;
|
|
type State = {|
|
|
registry: ?Registry,
|
|
|};
|
|
|
|
let YellowBox;
|
|
|
|
/**
|
|
* YellowBox displays warnings at the bottom of the screen.
|
|
*
|
|
* Warnings help guard against subtle yet significant issues that can impact the
|
|
* quality of the app. This "in your face" style of warning allows developers to
|
|
* notice and correct these issues as quickly as possible.
|
|
*
|
|
* YellowBox is only enabled in `__DEV__`. Set the following flag to disable it:
|
|
*
|
|
* console.disableYellowBox = true;
|
|
*
|
|
* Ignore specific warnings by calling:
|
|
*
|
|
* YellowBox.ignoreWarnings(['Warning: ...']);
|
|
*
|
|
* Strings supplied to `YellowBox.ignoreWarnings` only need to be a substring of
|
|
* the ignored warning messages.
|
|
*/
|
|
if (__DEV__) {
|
|
const Platform = require('../Utilities/Platform');
|
|
const RCTLog = require('../Utilities/RCTLog');
|
|
const YellowBoxContainer = require('./YellowBoxContainer').default;
|
|
const LogBox = require('../LogBox/LogBox');
|
|
const YellowBoxRegistry = require('./Data/YellowBoxRegistry');
|
|
const LogBoxNotificationContainer = require('../LogBox/LogBoxNotificationContainer')
|
|
.default;
|
|
|
|
// YellowBox needs to insert itself early,
|
|
// in order to access the component stacks appended by React DevTools.
|
|
const {error, warn} = console;
|
|
let errorImpl = error;
|
|
let warnImpl = warn;
|
|
let _isLogBoxEnabled = false;
|
|
let _isInstalled = false;
|
|
(console: any).error = function(...args) {
|
|
errorImpl(...args);
|
|
};
|
|
(console: any).warn = function(...args) {
|
|
warnImpl(...args);
|
|
};
|
|
|
|
// eslint-disable-next-line no-shadow
|
|
YellowBox = class YellowBox extends React.Component<Props, State> {
|
|
static ignoreWarnings(patterns: $ReadOnlyArray<IgnorePattern>): void {
|
|
LogBoxData.addIgnorePatterns(patterns);
|
|
YellowBoxRegistry.addIgnorePatterns(patterns);
|
|
}
|
|
|
|
static install(): void {
|
|
_isInstalled = true;
|
|
if (_isLogBoxEnabled) {
|
|
LogBox.install();
|
|
return;
|
|
}
|
|
errorImpl = function(...args) {
|
|
registerError(...args);
|
|
};
|
|
|
|
warnImpl = function(...args) {
|
|
registerWarning(...args);
|
|
};
|
|
|
|
if ((console: any).disableYellowBox === true) {
|
|
YellowBoxRegistry.setDisabled(true);
|
|
}
|
|
(Object.defineProperty: any)(console, 'disableYellowBox', {
|
|
configurable: true,
|
|
get: () => YellowBoxRegistry.isDisabled(),
|
|
set: value => YellowBoxRegistry.setDisabled(value),
|
|
});
|
|
|
|
if (Platform.isTesting) {
|
|
(console: any).disableYellowBox = true;
|
|
}
|
|
|
|
RCTLog.setWarningHandler((...args) => {
|
|
registerWarning(...args);
|
|
});
|
|
}
|
|
|
|
static uninstall(): void {
|
|
if (_isLogBoxEnabled) {
|
|
LogBox.uninstall();
|
|
return;
|
|
}
|
|
_isInstalled = false;
|
|
errorImpl = error;
|
|
warnImpl = warn;
|
|
delete (console: any).disableYellowBox;
|
|
}
|
|
|
|
static __unstable_enableLogBox(): void {
|
|
if (NativeLogBox == null) {
|
|
// The native module is required to enable LogBox.
|
|
return;
|
|
}
|
|
|
|
if (_isInstalled) {
|
|
throw new Error(
|
|
'LogBox must be enabled before AppContainer is required so that it can properly wrap the console methods.\n\nPlease enable LogBox earlier in your app.\n\n',
|
|
);
|
|
}
|
|
_isLogBoxEnabled = true;
|
|
|
|
// TODO: Temporary hack to prevent cycles with the ExceptionManager.
|
|
global.__unstable_isLogBoxEnabled = true;
|
|
}
|
|
|
|
static __unstable_isLogBoxEnabled(): boolean {
|
|
return !!_isLogBoxEnabled;
|
|
}
|
|
|
|
render(): React.Node {
|
|
if (_isLogBoxEnabled) {
|
|
return <LogBoxNotificationContainer />;
|
|
}
|
|
|
|
// TODO: Ignore warnings that fire when rendering `YellowBox` itself.
|
|
return <YellowBoxContainer />;
|
|
}
|
|
};
|
|
|
|
const registerWarning = (...args): void => {
|
|
if (typeof args[0] === 'string' && args[0].startsWith('(ADVICE)')) {
|
|
return;
|
|
}
|
|
|
|
const {category, message, stack} = YellowBoxWarning.parse({
|
|
args,
|
|
});
|
|
|
|
if (!YellowBoxRegistry.isWarningIgnored(message)) {
|
|
YellowBoxRegistry.add({category, message, stack});
|
|
warn.call(console, ...args);
|
|
}
|
|
};
|
|
|
|
const registerError = (...args): void => {
|
|
// Only show YellowBox for the `warning` module, otherwise pass through and skip.
|
|
if (typeof args[0] !== 'string' || !args[0].startsWith('Warning: ')) {
|
|
error.call(console, ...args);
|
|
return;
|
|
}
|
|
|
|
const format = args[0].replace('Warning: ', '');
|
|
const filterResult = LogBoxData.checkWarningFilter(format);
|
|
if (filterResult.suppressCompletely) {
|
|
return;
|
|
}
|
|
|
|
args[0] = filterResult.finalFormat;
|
|
const {category, message, stack} = YellowBoxWarning.parse({
|
|
args,
|
|
});
|
|
|
|
if (YellowBoxRegistry.isWarningIgnored(message)) {
|
|
return;
|
|
}
|
|
|
|
if (filterResult.forceDialogImmediately === true) {
|
|
// This will pop a redbox. Do not downgrade. These are real bugs with same severity as throws.
|
|
error.call(console, message.content);
|
|
} else {
|
|
// Unfortunately, we need to add the Warning: prefix back so we don't show a redbox later.
|
|
args[0] = `Warning: ${filterResult.finalFormat}`;
|
|
|
|
// Note: YellowBox has no concept of "soft errors" so we're showing YellowBox for those.
|
|
YellowBoxRegistry.add({category, message, stack});
|
|
error.call(console, ...args);
|
|
}
|
|
};
|
|
} else {
|
|
YellowBox = class extends React.Component<Props, State> {
|
|
static ignoreWarnings(patterns: $ReadOnlyArray<IgnorePattern>): void {
|
|
// Do nothing.
|
|
}
|
|
|
|
static install(): void {
|
|
// Do nothing.
|
|
}
|
|
|
|
static uninstall(): void {
|
|
// Do nothing.
|
|
}
|
|
|
|
static __unstable_enableLogBox(): void {
|
|
// Do nothing.
|
|
}
|
|
static __unstable_isLogBoxEnabled(): boolean {
|
|
return false;
|
|
}
|
|
|
|
render(): React.Node {
|
|
return null;
|
|
}
|
|
};
|
|
}
|
|
|
|
module.exports = (YellowBox: Class<React.Component<Props, State>> & {
|
|
ignoreWarnings($ReadOnlyArray<IgnorePattern>): void,
|
|
install(): void,
|
|
uninstall(): void,
|
|
__unstable_enableLogBox(): void,
|
|
__unstable_isLogBoxEnabled(): boolean,
|
|
...
|
|
});
|