/
KeyValue.js
459 lines (425 loc) · 12.3 KB
/
KeyValue.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
/**
* 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
*/
import * as React from 'react';
import {
unstable_useTransition as useTransition,
useContext,
useRef,
useState,
} from 'react';
import EditableName from './EditableName';
import EditableValue from './EditableValue';
import NewArrayValue from './NewArrayValue';
import NewKeyValue from './NewKeyValue';
import LoadingAnimation from './LoadingAnimation';
import ExpandCollapseToggle from './ExpandCollapseToggle';
import {alphaSortEntries, getMetaValueLabel} from '../utils';
import {meta} from '../../../hydration';
import useContextMenu from '../../ContextMenu/useContextMenu';
import Store from '../../store';
import {parseHookPathForEdit} from './utils';
import styles from './KeyValue.css';
import Button from 'react-devtools-shared/src/devtools/views/Button';
import ButtonIcon from 'react-devtools-shared/src/devtools/views/ButtonIcon';
import {InspectedElementContext} from './InspectedElementContext';
import type {InspectedElement} from './types';
import type {Element} from 'react-devtools-shared/src/devtools/views/Components/types';
import type {Element as ReactElement} from 'react';
import type {FrontendBridge} from 'react-devtools-shared/src/bridge';
type Type = 'props' | 'state' | 'context' | 'hooks';
type KeyValueProps = {|
alphaSort: boolean,
bridge: FrontendBridge,
canDeletePaths: boolean,
canEditValues: boolean,
canRenamePaths: boolean,
canRenamePathsAtDepth?: (depth: number) => boolean,
depth: number,
element: Element,
hidden: boolean,
hookID?: ?number,
inspectedElement: InspectedElement,
isDirectChildOfAnArray?: boolean,
name: string,
path: Array<any>,
pathRoot: Type,
store: Store,
value: any,
|};
export default function KeyValue({
alphaSort,
bridge,
canDeletePaths,
canEditValues,
canRenamePaths,
canRenamePathsAtDepth,
depth,
element,
inspectedElement,
isDirectChildOfAnArray,
hidden,
hookID,
name,
path,
pathRoot,
store,
value,
}: KeyValueProps) {
const {id} = inspectedElement;
const [isOpen, setIsOpen] = useState<boolean>(false);
const contextMenuTriggerRef = useRef(null);
const {inspectPaths} = useContext(InspectedElementContext);
let isInspectable = false;
let isReadOnly = false;
if (value !== null && typeof value === 'object') {
isInspectable = value[meta.inspectable] && value[meta.size] !== 0;
isReadOnly = value[meta.readonly];
}
const [isInspectPathsPending, startInspectPathsTransition] = useTransition();
const toggleIsOpen = () => {
if (isOpen) {
setIsOpen(false);
} else {
setIsOpen(true);
if (isInspectable) {
startInspectPathsTransition(() => {
inspectPaths([pathRoot, ...path]);
});
}
}
};
useContextMenu({
data: {
path: [pathRoot, ...path],
type:
value !== null &&
typeof value === 'object' &&
hasOwnProperty.call(value, meta.type)
? value[meta.type]
: typeof value,
},
id: 'InspectedElement',
ref: contextMenuTriggerRef,
});
const dataType = typeof value;
const isSimpleType =
dataType === 'number' ||
dataType === 'string' ||
dataType === 'boolean' ||
value == null;
const style = {
paddingLeft: `${(depth - 1) * 0.75}rem`,
};
const overrideValue = (newPath, newValue) => {
if (hookID != null) {
newPath = parseHookPathForEdit(newPath);
}
const rendererID = store.getRendererIDForElement(id);
if (rendererID !== null) {
bridge.send('overrideValueAtPath', {
hookID,
id,
path: newPath,
rendererID,
type: pathRoot,
value: newValue,
});
}
};
const deletePath = pathToDelete => {
if (hookID != null) {
pathToDelete = parseHookPathForEdit(pathToDelete);
}
const rendererID = store.getRendererIDForElement(id);
if (rendererID !== null) {
bridge.send('deletePath', {
hookID,
id,
path: pathToDelete,
rendererID,
type: pathRoot,
});
}
};
const renamePath = (oldPath, newPath) => {
if (newPath[newPath.length - 1] === '') {
// Deleting the key suggests an intent to delete the whole path.
if (canDeletePaths) {
deletePath(oldPath);
}
} else {
if (hookID != null) {
oldPath = parseHookPathForEdit(oldPath);
newPath = parseHookPathForEdit(newPath);
}
const rendererID = store.getRendererIDForElement(id);
if (rendererID !== null) {
bridge.send('renamePath', {
hookID,
id,
newPath,
oldPath,
rendererID,
type: pathRoot,
});
}
}
};
// TRICKY This is a bit of a hack to account for context and hooks.
// In these cases, paths can be renamed but only at certain depths.
// The special "value" wrapper for context shouldn't be editable.
// Only certain types of hooks should be editable.
let canRenameTheCurrentPath = canRenamePaths;
if (canRenameTheCurrentPath && typeof canRenamePathsAtDepth === 'function') {
canRenameTheCurrentPath = canRenamePathsAtDepth(depth);
}
let renderedName;
if (isDirectChildOfAnArray) {
if (canDeletePaths) {
renderedName = (
<DeleteToggle name={name} deletePath={deletePath} path={path} />
);
} else {
renderedName = <span className={styles.Name}>{name}</span>;
}
} else if (canRenameTheCurrentPath) {
renderedName = (
<EditableName
allowEmpty={canDeletePaths}
className={styles.EditableName}
initialValue={name}
overrideName={renamePath}
path={path}
/>
);
} else {
renderedName = <span className={styles.Name}>{name}</span>;
}
let children = null;
if (isSimpleType) {
let displayValue = value;
if (dataType === 'string') {
displayValue = `"${value}"`;
} else if (dataType === 'boolean') {
displayValue = value ? 'true' : 'false';
} else if (value === null) {
displayValue = 'null';
} else if (value === undefined) {
displayValue = 'undefined';
}
children = (
<div
key="root"
className={styles.Item}
hidden={hidden}
ref={contextMenuTriggerRef}
style={style}>
<div className={styles.ExpandCollapseToggleSpacer} />
{renderedName}
<div className={styles.AfterName}>:</div>
{canEditValues ? (
<EditableValue
overrideValue={overrideValue}
path={path}
value={value}
/>
) : (
<span className={styles.Value}>{displayValue}</span>
)}
</div>
);
} else if (
hasOwnProperty.call(value, meta.type) &&
!hasOwnProperty.call(value, meta.unserializable)
) {
children = (
<div
key="root"
className={styles.Item}
hidden={hidden}
ref={contextMenuTriggerRef}
style={style}>
{isInspectable ? (
<ExpandCollapseToggle isOpen={isOpen} setIsOpen={toggleIsOpen} />
) : (
<div className={styles.ExpandCollapseToggleSpacer} />
)}
{renderedName}
<div className={styles.AfterName}>:</div>
<span
className={styles.Value}
onClick={isInspectable ? toggleIsOpen : undefined}>
{getMetaValueLabel(value)}
</span>
</div>
);
if (isInspectPathsPending) {
children = (
<>
{children}
<div className={styles.Item} style={style}>
<div className={styles.ExpandCollapseToggleSpacer} />
<LoadingAnimation />
</div>
</>
);
}
} else {
if (Array.isArray(value)) {
const hasChildren = value.length > 0 || canEditValues;
const displayName = getMetaValueLabel(value);
children = value.map((innerValue, index) => (
<KeyValue
key={index}
alphaSort={alphaSort}
bridge={bridge}
canDeletePaths={canDeletePaths && !isReadOnly}
canEditValues={canEditValues && !isReadOnly}
canRenamePaths={canRenamePaths && !isReadOnly}
canRenamePathsAtDepth={canRenamePathsAtDepth}
depth={depth + 1}
element={element}
hookID={hookID}
inspectedElement={inspectedElement}
isDirectChildOfAnArray={true}
hidden={hidden || !isOpen}
name={index}
path={path.concat(index)}
pathRoot={pathRoot}
store={store}
value={value[index]}
/>
));
if (canEditValues && !isReadOnly) {
children.push(
<NewArrayValue
key="NewKeyValue"
bridge={bridge}
depth={depth + 1}
hidden={hidden || !isOpen}
hookID={hookID}
index={value.length}
element={element}
inspectedElement={inspectedElement}
path={path}
store={store}
type={pathRoot}
/>,
);
}
children.unshift(
<div
key={`${depth}-root`}
className={styles.Item}
hidden={hidden}
ref={contextMenuTriggerRef}
style={style}>
{hasChildren ? (
<ExpandCollapseToggle isOpen={isOpen} setIsOpen={setIsOpen} />
) : (
<div className={styles.ExpandCollapseToggleSpacer} />
)}
{renderedName}
<div className={styles.AfterName}>:</div>
<span
className={styles.Value}
onClick={hasChildren ? toggleIsOpen : undefined}>
{displayName}
</span>
</div>,
);
} else {
// TRICKY
// It's important to use Object.entries() rather than Object.keys()
// because of the hidden meta Symbols used for hydration and unserializable values.
const entries = Object.entries(value);
if (alphaSort) {
entries.sort(alphaSortEntries);
}
const hasChildren = entries.length > 0 || canEditValues;
const displayName = getMetaValueLabel(value);
children = entries.map<ReactElement<any>>(([key, keyValue]) => (
<KeyValue
key={key}
alphaSort={alphaSort}
bridge={bridge}
canDeletePaths={canDeletePaths && !isReadOnly}
canEditValues={canEditValues && !isReadOnly}
canRenamePaths={canRenamePaths && !isReadOnly}
canRenamePathsAtDepth={canRenamePathsAtDepth}
depth={depth + 1}
element={element}
hookID={hookID}
inspectedElement={inspectedElement}
hidden={hidden || !isOpen}
name={key}
path={path.concat(key)}
pathRoot={pathRoot}
store={store}
value={keyValue}
/>
));
if (canEditValues && !isReadOnly) {
children.push(
<NewKeyValue
key="NewKeyValue"
bridge={bridge}
depth={depth + 1}
element={element}
hidden={hidden || !isOpen}
hookID={hookID}
inspectedElement={inspectedElement}
path={path}
store={store}
type={pathRoot}
/>,
);
}
children.unshift(
<div
key={`${depth}-root`}
className={styles.Item}
hidden={hidden}
ref={contextMenuTriggerRef}
style={style}>
{hasChildren ? (
<ExpandCollapseToggle isOpen={isOpen} setIsOpen={setIsOpen} />
) : (
<div className={styles.ExpandCollapseToggleSpacer} />
)}
{renderedName}
<div className={styles.AfterName}>:</div>
<span
className={styles.Value}
onClick={hasChildren ? toggleIsOpen : undefined}>
{displayName}
</span>
</div>,
);
}
}
return children;
}
function DeleteToggle({deletePath, name, path}) {
const handleClick = event => {
event.stopPropagation();
deletePath(path);
};
return (
<>
<Button
className={styles.DeleteArrayItemButton}
onClick={handleClick}
title="Delete entry">
<ButtonIcon type="delete" />
</Button>
<span className={styles.Name}>{name}</span>
</>
);
}