123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141 |
- /**
- * 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.
- *
- * @format
- * @flow strict-local
- */
- 'use strict';
- const RCTDeviceEventEmitter = require('../EventEmitter/RCTDeviceEventEmitter');
- import type EmitterSubscription from '../vendor/emitter/EmitterSubscription';
- import NativeBugReporting from './NativeBugReporting';
- import NativeRedBox from '../NativeModules/specs/NativeRedBox';
- type ExtraData = {[key: string]: string, ...};
- type SourceCallback = () => string;
- type DebugData = {
- extras: ExtraData,
- files: ExtraData,
- ...
- };
- function defaultExtras() {
- BugReporting.addFileSource('react_hierarchy.txt', () =>
- require('./dumpReactTree')(),
- );
- }
- /**
- * A simple class for collecting bug report data. Components can add sources that will be queried when a bug report
- * is created via `collectExtraData`. For example, a list component might add a source that provides the list of rows
- * that are currently visible on screen. Components should also remember to call `remove()` on the object that is
- * returned by `addSource` when they are unmounted.
- */
- class BugReporting {
- static _extraSources: Map<string, SourceCallback> = new Map();
- static _fileSources: Map<string, SourceCallback> = new Map();
- static _subscription: ?EmitterSubscription = null;
- static _redboxSubscription: ?EmitterSubscription = null;
- static _maybeInit() {
- if (!BugReporting._subscription) {
- BugReporting._subscription = RCTDeviceEventEmitter.addListener(
- 'collectBugExtraData',
- BugReporting.collectExtraData,
- null,
- );
- defaultExtras();
- }
- if (!BugReporting._redboxSubscription) {
- BugReporting._redboxSubscription = RCTDeviceEventEmitter.addListener(
- 'collectRedBoxExtraData',
- BugReporting.collectExtraData,
- null,
- );
- }
- }
- /**
- * Maps a string key to a simple callback that should return a string payload to be attached
- * to a bug report. Source callbacks are called when `collectExtraData` is called.
- *
- * Returns an object to remove the source when the component unmounts.
- *
- * Conflicts trample with a warning.
- */
- static addSource(
- key: string,
- callback: SourceCallback,
- ): {remove: () => void, ...} {
- return this._addSource(key, callback, BugReporting._extraSources);
- }
- /**
- * Maps a string key to a simple callback that should return a string payload to be attached
- * to a bug report. Source callbacks are called when `collectExtraData` is called.
- *
- * Returns an object to remove the source when the component unmounts.
- *
- * Conflicts trample with a warning.
- */
- static addFileSource(
- key: string,
- callback: SourceCallback,
- ): {remove: () => void, ...} {
- return this._addSource(key, callback, BugReporting._fileSources);
- }
- static _addSource(
- key: string,
- callback: SourceCallback,
- source: Map<string, SourceCallback>,
- ): {remove: () => void, ...} {
- BugReporting._maybeInit();
- if (source.has(key)) {
- console.warn(
- `BugReporting.add* called multiple times for same key '${key}'`,
- );
- }
- source.set(key, callback);
- return {
- remove: () => {
- source.delete(key);
- },
- };
- }
- /**
- * This can be called from a native bug reporting flow, or from JS code.
- *
- * If available, this will call `NativeModules.BugReporting.setExtraData(extraData)`
- * after collecting `extraData`.
- */
- static collectExtraData(): DebugData {
- const extraData: ExtraData = {};
- for (const [key, callback] of BugReporting._extraSources) {
- extraData[key] = callback();
- }
- const fileData: ExtraData = {};
- for (const [key, callback] of BugReporting._fileSources) {
- fileData[key] = callback();
- }
- if (NativeBugReporting != null && NativeBugReporting.setExtraData != null) {
- NativeBugReporting.setExtraData(extraData, fileData);
- }
- if (NativeRedBox != null && NativeRedBox.setExtraData != null) {
- NativeRedBox.setExtraData(extraData, 'From BugReporting.js');
- }
- return {extras: extraData, files: fileData};
- }
- }
- module.exports = BugReporting;
|