Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

React DevTools: Show symbols used as keys in state #19786

Merged
merged 9 commits into from
Sep 14, 2020
Merged

React DevTools: Show symbols used as keys in state #19786

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
5134885
Support Symbol as key
omarsy Sep 7, 2020
ef7cdf5
correct lint error
omarsy Sep 8, 2020
71ab637
add symbole test
omarsy Sep 8, 2020
7caa608
correct lint
omarsy Sep 8, 2020
f51b99a
create getAllEnumerableKeys method
omarsy Sep 8, 2020
de1bfae
Add all symbol enumerable
omarsy Sep 11, 2020
db09127
fix lint error
omarsy Sep 11, 2020
dbf29c3
fix flow issue
omarsy Sep 11, 2020
6b06f41
Minor tweaks to DevTools test data
Sep 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions fixtures/devtools/standalone/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,57 @@ <h1>List</h1>
return <ChildComponent customObject={new Custom()} />;
}

const baseInheritedKeys = Object.create(Object.prototype, {
value1: {
value: 1,
writable: true,
enumerable: true,
configurable: true,
},
[Symbol('value1')]: {
value: 1,
writable: true,
enumerable: true,
configurable: true,
},
});

const inheritedKeys = Object.create(baseInheritedKeys, {
value2: {
value: 2,
writable: true,
enumerable: true,
configurable: true,
},
value3: {
value: 3,
writable: true,
enumerable: false,
configurable: true,
},
3: {
value: 3,
writable: true,
enumerable: true,
configurable: true,
},
[Symbol('value2')]: {
value: 2,
writable: true,
enumerable: false,
configurable: true,
},
[Symbol('value3')]: {
value: 3,
writable: true,
enumerable: true,
configurable: true,
},
});
function InheritedKeys() {
return <ChildComponent inheritedKeys={inheritedKeys} />;
}

const object = {
string: "abc",
longString: "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKJLMNOPQRSTUVWXYZ1234567890",
Expand Down Expand Up @@ -294,6 +345,7 @@ <h1>List</h1>
<ObjectProps />
<UnserializableProps />
<CustomObject />
<InheritedKeys />
</Fragment>
);
}
Expand Down
22 changes: 22 additions & 0 deletions ...es/react-devtools-shared/src/__tests__/__snapshots__/inspectedElementContext-test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -541,6 +541,9 @@ exports[`InspectedElementContext should support complex data types: 1: Inspected
"object_of_objects": {
"inner": {}
},
"object_with_symbol": {
"Symbol(name)": "hello"
},
"proxy": {},
"react_element": {},
"regexp": {},
Expand Down Expand Up @@ -612,6 +615,25 @@ exports[`InspectedElementContext should support objects with overridden hasOwnPr
}
`;

exports[`InspectedElementContext should support objects with with inherited keys: 1: Inspected element 2 1`] = `
{
"id": 2,
"owners": null,
"context": null,
"hooks": null,
"props": {
"object": {
"3": 3,
"value2": 2,
"Symbol(value3)": 3,
"value1": 1,
"Symbol(value1)": 1
}
},
"state": null
}
`;

exports[`InspectedElementContext should support simple data types: 1: Initial inspection 1`] = `
{
"id": 2,
Expand Down
99 changes: 99 additions & 0 deletions packages/react-devtools-shared/src/__tests__/inspectedElementContext-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,6 +532,9 @@ describe('InspectedElementContext', () => {
const objectOfObjects = {
inner: {string: 'abc', number: 123, boolean: true},
};
const objectWithSymbol = {
[Symbol('name')]: 'hello',
};
const typedArray = Int8Array.from([100, -100, 0]);
const arrayBuffer = typedArray.buffer;
const dataView = new DataView(arrayBuffer);
Expand Down Expand Up @@ -575,6 +578,7 @@ describe('InspectedElementContext', () => {
map={mapShallow}
map_of_maps={mapOfMaps}
object_of_objects={objectOfObjects}
object_with_symbol={objectWithSymbol}
proxy={proxyInstance}
react_element={<span />}
regexp={/abc/giu}
Expand Down Expand Up @@ -628,6 +632,7 @@ describe('InspectedElementContext', () => {
map,
map_of_maps,
object_of_objects,
object_with_symbol,
proxy,
react_element,
regexp,
Expand Down Expand Up @@ -732,6 +737,8 @@ describe('InspectedElementContext', () => {
);
expect(object_of_objects.inner[meta.preview_short]).toBe('{…}');

expect(object_with_symbol['Symbol(name)']).toBe('hello');
bvaughn marked this conversation as resolved.
Show resolved Hide resolved

expect(proxy[meta.inspectable]).toBe(false);
expect(proxy[meta.name]).toBe('function');
expect(proxy[meta.type]).toBe('function');
Expand Down Expand Up @@ -934,6 +941,98 @@ describe('InspectedElementContext', () => {
done();
});

it('should support objects with with inherited keys', async done => {
const Example = () => null;

const base = Object.create(Object.prototype, {
value1: {
value: 1,
writable: true,
enumerable: true,
configurable: true,
},
[Symbol('value1')]: {
value: 1,
writable: true,
enumerable: true,
configurable: true,
},
});

const object = Object.create(base, {
value2: {
value: 2,
writable: true,
enumerable: true,
configurable: true,
},
value3: {
value: 3,
writable: true,
enumerable: false,
configurable: true,
},
3: {
value: 3,
writable: true,
enumerable: true,
configurable: true,
},
[Symbol('value2')]: {
value: 2,
writable: true,
enumerable: false,
configurable: true,
},
[Symbol('value3')]: {
value: 3,
writable: true,
enumerable: true,
configurable: true,
},
});
const container = document.createElement('div');
await utils.actAsync(() =>
ReactDOM.render(<Example object={object} />, container),
);

const id = ((store.getElementIDAtIndex(0): any): number);

let inspectedElement = null;

function Suspender({target}) {
const {getInspectedElement} = React.useContext(InspectedElementContext);
inspectedElement = getInspectedElement(id);
return null;
}

await utils.actAsync(
() =>
TestRenderer.create(
<Contexts
defaultSelectedElementID={id}
defaultSelectedElementIndex={0}>
<React.Suspense fallback={null}>
<Suspender target={id} />
</React.Suspense>
</Contexts>,
),
false,
);

expect(inspectedElement).not.toBeNull();
expect(inspectedElement).toMatchSnapshot(`1: Inspected element ${id}`);
expect(inspectedElement.props.object).toEqual({
'3': 3,
'Symbol(value1)': 1,
'Symbol(value3)': 3,
value1: 1,
value2: 2,
});

done();
});

it('should not dehydrate nested values until explicitly requested', async done => {
const Example = () => {
const [state] = React.useState({
Expand Down
23 changes: 23 additions & 0 deletions ...ages/react-devtools-shared/src/__tests__/legacy/__snapshots__/inspectElement-test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,29 @@ Object {
}
`;

exports[`InspectedElementContext should support objects with with inherited keys: 1: Initial inspection 1`] = `
Object {
"id": 2,
"type": "full-data",
"value": {
"id": 2,
"owners": null,
"context": {},
"hooks": null,
"props": {
"data": {
"3": 3,
"value2": 2,
"Symbol(value3)": 3,
"value1": 1,
"Symbol(value1)": 1
}
},
"state": null
},
}
`;

exports[`InspectedElementContext should support simple data types: 1: Initial inspection 1`] = `
Object {
"id": 2,
Expand Down
62 changes: 62 additions & 0 deletions packages/react-devtools-shared/src/__tests__/legacy/inspectElement-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -432,6 +432,68 @@ describe('InspectedElementContext', () => {
done();
});

it('should support objects with with inherited keys', async done => {
const Example = () => null;

const base = Object.create(Object.prototype, {
value1: {
value: 1,
writable: true,
enumerable: true,
configurable: true,
},
[Symbol('value1')]: {
value: 1,
writable: true,
enumerable: true,
configurable: true,
},
});

const object = Object.create(base, {
value2: {
value: 2,
writable: true,
enumerable: true,
configurable: true,
},
value3: {
value: 3,
writable: true,
enumerable: false,
configurable: true,
},
3: {
value: 3,
writable: true,
enumerable: true,
configurable: true,
},
[Symbol('value2')]: {
value: 2,
writable: true,
enumerable: false,
configurable: true,
},
[Symbol('value3')]: {
value: 3,
writable: true,
enumerable: true,
configurable: true,
},
});
act(() =>
ReactDOM.render(<Example data={object} />, document.createElement('div')),
);

const id = ((store.getElementIDAtIndex(0): any): number);
const inspectedElement = await read(id);

expect(inspectedElement).toMatchSnapshot('1: Initial inspection');

done();
});

it('should not dehydrate nested values until explicitly requested', async done => {
const Example = () => null;

Expand Down
8 changes: 5 additions & 3 deletions packages/react-devtools-shared/src/hydration.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import {
getDataType,
getDisplayNameForReactElement,
getAllEnumerableKeys,
getInObject,
formatDataForPreview,
setInObject,
Expand Down Expand Up @@ -291,16 +292,17 @@ export function dehydrate(
return createDehydrated(type, true, data, cleaned, path);
} else {
const object = {};
for (const name in data) {
getAllEnumerableKeys(data).forEach(key => {
const name = key.toString();
object[name] = dehydrate(
data[name],
data[key],
cleaned,
unserializable,
path.concat([name]),
isPathAllowed,
isPathAllowedCheck ? 1 : level + 1,
);
}
});
return object;
}

Expand Down
Loading