Scribd
Upload
26 views

Logger

This document defines types for logging events from React DevTools and functions for registering log functions and logging events. It includes types for different event types and functions for conditionally logging events based on a feature flag.

Uploaded by

mahoraga
Copyright
© © All Rights Reserved
Available Formats
Download as TXT, PDF, TXT or read online on Scribd
26 views

Logger

This document defines types for logging events from React DevTools and functions for registering log functions and logging events. It includes types for different event types and functions for conditionally logging events based on a feature flag.

Uploaded by

mahoraga
Copyright
© © All Rights Reserved
Available Formats
Download as TXT, PDF, TXT or read online on Scribd
You are on page 1/ 2

/**

* Copyright (c) Meta Platforms, Inc. and affiliates.


*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict-local
*/

import {enableLogger} from 'react-devtools-feature-flags';

export type LoggerEvent =


| {
+event_name: 'loaded-dev-tools',
}
| {
+event_name: 'error',
+error_message: string | null,
+error_stack: string | null,
+error_component_stack: string | null,
}
| {
+event_name: 'selected-components-tab',
}
| {
+event_name: 'selected-profiler-tab',
}
| {
+event_name: 'load-hook-names',
+event_status: 'success' | 'error' | 'timeout' | 'unknown',
+duration_ms: number,
+inspected_element_display_name: string | null,
+inspected_element_number_of_hooks: number | null,
}
| {
+event_name: 'select-element',
+metadata: {
+source: string,
},
}
| {
+event_name: 'inspect-element-button-clicked',
}
| {
+event_name: 'profiling-start',
+metadata: {
+current_tab: string,
},
}
| {
+event_name: 'profiler-tab-changed',
+metadata: {
+tabId: string,
},
}
| {
+event_name: 'settings-changed',
+metadata: {
+key: string,
+value: any,
...
},
};

export type LogFunction = LoggerEvent => void | Promise<void>;

let logFunctions: Array<LogFunction> = [];


export const logEvent: LogFunction =
enableLogger === true
? function logEvent(event: LoggerEvent): void {
logFunctions.forEach(log => {
log(event);
});
}
: function logEvent() {};

export const registerEventLogger: (logFunction: LogFunction) => () => void =


enableLogger === true
? function registerEventLogger(logFunction: LogFunction): () => void {
if (enableLogger) {
logFunctions.push(logFunction);
return function unregisterEventLogger() {
logFunctions = logFunctions.filter(log => log !== logFunction);
};
}
return () => {};
}
: function registerEventLogger(logFunction: LogFunction) {
return () => {};
};

You might also like