[react devtools][easy] Change variable names, etc. (#25211)
* Change variable names, put stuff in constants, etc. in preparation for next diff
Robert Balicki committed
Sep 9, 2022 at 11:09 UTC
540ba5b4039cf3489a3a7d5da90211c1dc00eb39
6 files changed
+39
-79
packages/react-devtools-shared/src/__tests__/setupTests.js
+2
-4
@@ -52,8 +52,7 @@ env.beforeEach(() => {
52
const {installHook} = require('react-devtools-shared/src/hook');
53
const {
54
getDefaultComponentFilters,
55
- saveComponentFilters,
56
- setShowInlineWarningsAndErrors,
55
+ setSavedComponentFilters,
56
} = require('react-devtools-shared/src/utils');
57
58
// Fake timers let us flush Bridge operations between setup and assertions.
@@ -118,11 +117,10 @@ env.beforeEach(() => {
117
};
118
119
// Initialize filters to a known good state.
121
- saveComponentFilters(getDefaultComponentFilters());
120
+ setSavedComponentFilters(getDefaultComponentFilters());
121
global.__REACT_DEVTOOLS_COMPONENT_FILTERS__ = getDefaultComponentFilters();
122
123
// Also initialize inline warnings so that we can test them.
125
- setShowInlineWarningsAndErrors(true);
124
global.__REACT_DEVTOOLS_SHOW_INLINE_WARNINGS_AND_ERRORS__ = true;
125
126
installHook(global);
packages/react-devtools-shared/src/constants.js
+3
-1
@@ -30,7 +30,7 @@ export const PROFILING_FLAG_TIMELINE_SUPPORT = 0b10;
30
31
export const LOCAL_STORAGE_DEFAULT_TAB_KEY = 'React::DevTools::defaultTab';
32
33
-export const LOCAL_STORAGE_FILTER_PREFERENCES_KEY =
33
+export const LOCAL_STORAGE_COMPONENT_FILTER_PREFERENCES_KEY =
34
'React::DevTools::componentFilters';
35
36
export const SESSION_STORAGE_LAST_SELECTION_KEY =
@@ -51,6 +51,8 @@ export const SESSION_STORAGE_RELOAD_AND_PROFILE_KEY =
51
export const LOCAL_STORAGE_SHOULD_BREAK_ON_CONSOLE_ERRORS =
52
'React::DevTools::breakOnConsoleErrors';
53
54
+export const LOCAL_STORAGE_BROWSER_THEME = 'React::DevTools::theme';
55
+
56
export const LOCAL_STORAGE_SHOULD_APPEND_COMPONENT_STACK_KEY =
57
'React::DevTools::appendComponentStack';
58
packages/react-devtools-shared/src/devtools/store.js
+3
-3
@@ -23,7 +23,7 @@ import {
23
import {ElementTypeRoot} from '../types';
24
import {
25
getSavedComponentFilters,
26
- saveComponentFilters,
26
+ setSavedComponentFilters,
27
separateDisplayNameAndHOCs,
28
shallowDiffers,
29
utfDecodeString,
@@ -365,7 +365,7 @@ export default class Store extends EventEmitter<{|
365
this._componentFilters = value;
366
367
// Update persisted filter preferences stored in localStorage.
368
- saveComponentFilters(value);
368
+ setSavedComponentFilters(value);
369
370
// Notify the renderer that filter preferences have changed.
371
// This is an expensive operation; it unmounts and remounts the entire tree,
@@ -1332,7 +1332,7 @@ export default class Store extends EventEmitter<{|
1332
) => {
1333
this._componentFilters = componentFilters;
1334
1335
- saveComponentFilters(componentFilters);
1335
+ setSavedComponentFilters(componentFilters);
1336
};
1337
1338
onBridgeShutdown = () => {
packages/react-devtools-shared/src/devtools/views/Settings/DebuggingSettings.js
+2
-2
@@ -22,7 +22,7 @@ export default function DebuggingSettings(_: {||}) {
22
setBreakOnConsoleErrors,
23
setShowInlineWarningsAndErrors,
24
showInlineWarningsAndErrors,
25
- sethideConsoleLogsInStrictMode,
25
+ setHideConsoleLogsInStrictMode,
26
} = useContext(SettingsContext);
27
28
return (
@@ -72,7 +72,7 @@ export default function DebuggingSettings(_: {||}) {
72
type="checkbox"
73
checked={hideConsoleLogsInStrictMode}
74
onChange={({currentTarget}) =>
75
- sethideConsoleLogsInStrictMode(currentTarget.checked)
75
+ setHideConsoleLogsInStrictMode(currentTarget.checked)
76
}
77
/>{' '}
78
Hide logs during second render in Strict Mode
packages/react-devtools-shared/src/devtools/views/Settings/SettingsContext.js
+6
-5
@@ -18,6 +18,7 @@ import {
18
import {
19
COMFORTABLE_LINE_HEIGHT,
20
COMPACT_LINE_HEIGHT,
21
+ LOCAL_STORAGE_BROWSER_THEME,
22
LOCAL_STORAGE_PARSE_HOOK_NAMES_KEY,
23
LOCAL_STORAGE_SHOULD_BREAK_ON_CONSOLE_ERRORS,
24
LOCAL_STORAGE_SHOULD_APPEND_COMPONENT_STACK_KEY,
@@ -52,7 +53,7 @@ type Context = {|
53
setParseHookNames: (value: boolean) => void,
54
55
hideConsoleLogsInStrictMode: boolean,
55
- sethideConsoleLogsInStrictMode: (value: boolean) => void,
56
+ setHideConsoleLogsInStrictMode: (value: boolean) => void,
57
58
showInlineWarningsAndErrors: boolean,
59
setShowInlineWarningsAndErrors: (value: boolean) => void,
@@ -110,7 +111,7 @@ function SettingsContextController({
111
'compact',
112
);
113
const [theme, setTheme] = useLocalStorageWithLog<Theme>(
113
- 'React::DevTools::theme',
114
+ LOCAL_STORAGE_BROWSER_THEME,
115
'auto',
116
);
117
const [
@@ -133,7 +134,7 @@ function SettingsContextController({
134
);
135
const [
136
hideConsoleLogsInStrictMode,
136
- sethideConsoleLogsInStrictMode,
137
+ setHideConsoleLogsInStrictMode,
138
] = useLocalStorageWithLog<boolean>(
139
LOCAL_STORAGE_HIDE_CONSOLE_LOGS_IN_STRICT_MODE,
140
false,
@@ -240,7 +241,7 @@ function SettingsContextController({
241
setTraceUpdatesEnabled,
242
setShowInlineWarningsAndErrors,
243
showInlineWarningsAndErrors,
243
- sethideConsoleLogsInStrictMode,
244
+ setHideConsoleLogsInStrictMode,
245
hideConsoleLogsInStrictMode,
246
theme,
247
browserTheme,
@@ -259,7 +260,7 @@ function SettingsContextController({
260
setTraceUpdatesEnabled,
261
setShowInlineWarningsAndErrors,
262
showInlineWarningsAndErrors,
262
- sethideConsoleLogsInStrictMode,
263
+ setHideConsoleLogsInStrictMode,
264
hideConsoleLogsInStrictMode,
265
theme,
266
browserTheme,
packages/react-devtools-shared/src/utils.js
+23
-64
@@ -34,16 +34,14 @@ import {
34
TREE_OPERATION_SET_SUBTREE_MODE,
35
TREE_OPERATION_UPDATE_ERRORS_OR_WARNINGS,
36
TREE_OPERATION_UPDATE_TREE_BASE_DURATION,
37
-} from './constants';
38
-import {ElementTypeRoot} from 'react-devtools-shared/src/types';
39
-import {
40
- LOCAL_STORAGE_FILTER_PREFERENCES_KEY,
37
+ LOCAL_STORAGE_COMPONENT_FILTER_PREFERENCES_KEY,
38
LOCAL_STORAGE_OPEN_IN_EDITOR_URL,
39
LOCAL_STORAGE_SHOULD_BREAK_ON_CONSOLE_ERRORS,
40
LOCAL_STORAGE_SHOULD_APPEND_COMPONENT_STACK_KEY,
41
LOCAL_STORAGE_SHOW_INLINE_WARNINGS_AND_ERRORS_KEY,
42
LOCAL_STORAGE_HIDE_CONSOLE_LOGS_IN_STRICT_MODE,
43
} from './constants';
44
+import {ElementTypeRoot} from 'react-devtools-shared/src/types';
45
import {ComponentFilterElementType, ElementTypeHostComponent} from './types';
46
import {
47
ElementTypeClass,
@@ -324,7 +322,9 @@ export function getDefaultComponentFilters(): Array<ComponentFilter> {
322
323
export function getSavedComponentFilters(): Array<ComponentFilter> {
324
try {
327
- const raw = localStorageGetItem(LOCAL_STORAGE_FILTER_PREFERENCES_KEY);
325
+ const raw = localStorageGetItem(
326
+ LOCAL_STORAGE_COMPONENT_FILTER_PREFERENCES_KEY,
327
+ );
328
if (raw != null) {
329
return JSON.parse(raw);
330
}
@@ -332,89 +332,48 @@ export function getSavedComponentFilters(): Array<ComponentFilter> {
332
return getDefaultComponentFilters();
333
}
334
335
-export function saveComponentFilters(
335
+export function setSavedComponentFilters(
336
componentFilters: Array<ComponentFilter>,
337
): void {
338
localStorageSetItem(
339
- LOCAL_STORAGE_FILTER_PREFERENCES_KEY,
339
+ LOCAL_STORAGE_COMPONENT_FILTER_PREFERENCES_KEY,
340
JSON.stringify(componentFilters),
341
);
342
}
343
344
-export function getAppendComponentStack(): boolean {
345
- try {
346
- const raw = localStorageGetItem(
347
- LOCAL_STORAGE_SHOULD_APPEND_COMPONENT_STACK_KEY,
348
- );
349
- if (raw != null) {
350
- return JSON.parse(raw);
351
- }
352
- } catch (error) {}
353
- return true;
344
+function parseBool(s: ?string): ?boolean {
345
+ if (s === 'true') {
346
+ return true;
347
+ }
348
+ if (s === 'false') {
349
+ return false;
350
+ }
351
}
352
356
-export function setAppendComponentStack(value: boolean): void {
357
- localStorageSetItem(
353
+export function getAppendComponentStack(): boolean {
354
+ const raw = localStorageGetItem(
355
LOCAL_STORAGE_SHOULD_APPEND_COMPONENT_STACK_KEY,
359
- JSON.stringify(value),
356
);
357
+ return parseBool(raw) ?? true;
358
}
359
360
export function getBreakOnConsoleErrors(): boolean {
364
- try {
365
- const raw = localStorageGetItem(
366
- LOCAL_STORAGE_SHOULD_BREAK_ON_CONSOLE_ERRORS,
367
- );
368
- if (raw != null) {
369
- return JSON.parse(raw);
370
- }
371
- } catch (error) {}
372
- return false;
373
-}
374
-
375
-export function setBreakOnConsoleErrors(value: boolean): void {
376
- localStorageSetItem(
377
- LOCAL_STORAGE_SHOULD_BREAK_ON_CONSOLE_ERRORS,
378
- JSON.stringify(value),
379
- );
361
+ const raw = localStorageGetItem(LOCAL_STORAGE_SHOULD_BREAK_ON_CONSOLE_ERRORS);
362
+ return parseBool(raw) ?? false;
363
}
364
365
export function getHideConsoleLogsInStrictMode(): boolean {
383
- try {
384
- const raw = localStorageGetItem(
385
- LOCAL_STORAGE_HIDE_CONSOLE_LOGS_IN_STRICT_MODE,
386
- );
387
- if (raw != null) {
388
- return JSON.parse(raw);
389
- }
390
- } catch (error) {}
391
- return false;
392
-}
393
-
394
-export function sethideConsoleLogsInStrictMode(value: boolean): void {
395
- localStorageSetItem(
366
+ const raw = localStorageGetItem(
367
LOCAL_STORAGE_HIDE_CONSOLE_LOGS_IN_STRICT_MODE,
397
- JSON.stringify(value),
368
);
369
+ return parseBool(raw) ?? false;
370
}
371
372
export function getShowInlineWarningsAndErrors(): boolean {
402
- try {
403
- const raw = localStorageGetItem(
404
- LOCAL_STORAGE_SHOW_INLINE_WARNINGS_AND_ERRORS_KEY,
405
- );
406
- if (raw != null) {
407
- return JSON.parse(raw);
408
- }
409
- } catch (error) {}
410
- return true;
411
-}
412
-
413
-export function setShowInlineWarningsAndErrors(value: boolean): void {
414
- localStorageSetItem(
373
+ const raw = localStorageGetItem(
374
LOCAL_STORAGE_SHOW_INLINE_WARNINGS_AND_ERRORS_KEY,
416
- JSON.stringify(value),
375
);
376
+ return parseBool(raw) ?? true;
377
}
378
379
export function getDefaultOpenInEditorURL(): string {