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

Ignore symbols and functions in select tag #13389

Merged
merged 4 commits into from
Aug 14, 2018
Merged

Ignore symbols and functions in select tag #13389

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1d2755a
wip: ignore symbols and functions in select tag
raunofreiberg Aug 14, 2018
a6041eb
fix: Use ToStringValue as a maybe type
raunofreiberg Aug 14, 2018
81ff1c9
refactor: remove unnecessary test
raunofreiberg Aug 14, 2018
48dcdef
refactor: remove implicit return from tests
raunofreiberg Aug 14, 2018
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
264 changes: 264 additions & 0 deletions packages/react-dom/src/__tests__/ReactDOMSelect-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -808,4 +808,268 @@ describe('ReactDOMSelect', () => {
expect(node.options[1].selected).toBe(false); // b
expect(node.options[2].selected).toBe(false); // c
});

describe('When given a Symbol value', () => {
it('treats initial Symbol value as an empty string', () => {
let node;

expect(
() =>
(node = ReactTestUtils.renderIntoDocument(
<select onChange={noop} value={Symbol('foobar')}>
<option value={Symbol('foobar')}>A Symbol!</option>
<option value="monkey">A monkey!</option>
<option value="giraffe">A giraffe!</option>
</select>,
)),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Style nit: but I think the implicit return with an assignment distracts from the test. Could you remove them, like:

expect(() => {
  node = ReactTestUtils.renderIntoDocument(
    <select onChange={noop} value={Symbol('foobar')}>
      <option value={Symbol('foobar')}>A Symbol!</option>
      <option value="monkey">A monkey!</option>
      <option value="giraffe">A giraffe!</option>
    </select>
  )
}).toWarnDev('Invalid value for prop `value`');

).toWarnDev('Invalid value for prop `value`');

expect(node.value).toBe('');
});

it('treats updated Symbol value as an empty string', () => {
let node;

expect(
() =>
(node = ReactTestUtils.renderIntoDocument(
<select onChange={noop} value="monkey">
<option value={Symbol('foobar')}>A Symbol!</option>
<option value="monkey">A monkey!</option>
<option value="giraffe">A giraffe!</option>
</select>,
)),
).toWarnDev('Invalid value for prop `value`');

expect(node.value).toBe('monkey');

node = ReactTestUtils.renderIntoDocument(
<select onChange={noop} value={Symbol('foobar')}>
<option value={Symbol('foobar')}>A Symbol!</option>
<option value="monkey">A monkey!</option>
<option value="giraffe">A giraffe!</option>
</select>,
);

expect(node.value).toBe('');
});

it('treats initial Symbol defaultValue as an empty string', () => {
let node;

expect(
() =>
(node = ReactTestUtils.renderIntoDocument(
<select defaultValue={Symbol('foobar')}>
<option value={Symbol('foobar')}>A Symbol!</option>
<option value="monkey">A monkey!</option>
<option value="giraffe">A giraffe!</option>
</select>,
)),
).toWarnDev('Invalid value for prop `value`');

expect(node.value).toBe('');
});

it('treats updated Symbol defaultValue as an empty string', () => {
let node;

expect(
() =>
(node = ReactTestUtils.renderIntoDocument(
<select defaultValue="monkey">
<option value={Symbol('foobar')}>A Symbol!</option>
<option value="monkey">A monkey!</option>
<option value="giraffe">A giraffe!</option>
</select>,
)),
).toWarnDev('Invalid value for prop `value`');

expect(node.value).toBe('monkey');

node = ReactTestUtils.renderIntoDocument(
<select defaultValue={Symbol('foobar')}>
<option value={Symbol('foobar')}>A Symbol!</option>
<option value="monkey">A monkey!</option>
<option value="giraffe">A giraffe!</option>
</select>,
);

expect(node.value).toBe('');
});
});

describe('When given a function value', () => {
let setUntrackedValue;
function dispatchEventOnNode(node, type) {
node.dispatchEvent(new Event(type, {bubbles: true, cancelable: true}));
}

beforeEach(() => {
setUntrackedValue = Object.getOwnPropertyDescriptor(
HTMLSelectElement.prototype,
'value',
).set;
});

it('treats initial function value as an empty string', () => {
let node;

expect(
() =>
(node = ReactTestUtils.renderIntoDocument(
<select onChange={noop} value={() => {}}>
<option value={() => {}}>A function!</option>
<option value="monkey">A monkey!</option>
<option value="giraffe">A giraffe!</option>
</select>,
)),
).toWarnDev('Invalid value for prop `value`');

expect(node.value).toBe('');
});

it('treats initial function defaultValue as an empty string', () => {
let node;

expect(
() =>
(node = ReactTestUtils.renderIntoDocument(
<select defaultValue={() => {}}>
<option value={() => {}}>A function!</option>
<option value="monkey">A monkey!</option>
<option value="giraffe">A giraffe!</option>
</select>,
)),
).toWarnDev('Invalid value for prop `value`');

expect(node.value).toBe('');
});

it('treats updated function value as an empty string', () => {
let node;

expect(
() =>
(node = ReactTestUtils.renderIntoDocument(
<select onChange={noop} value="monkey">
<option value={() => {}}>A function!</option>
<option value="monkey">A monkey!</option>
<option value="giraffe">A giraffe!</option>
</select>,
)),
).toWarnDev('Invalid value for prop `value`');

expect(node.value).toBe('monkey');

node = ReactTestUtils.renderIntoDocument(
<select onChange={noop} value={() => {}}>
<option value={() => {}}>A function!</option>
<option value="monkey">A monkey!</option>
<option value="giraffe">A giraffe!</option>
</select>,
);

expect(node.value).toBe('');
});

it('treats updated function defaultValue as an empty string', () => {
let node;

expect(
() =>
(node = ReactTestUtils.renderIntoDocument(
<select defaultValue="monkey">
<option value={() => {}}>A function!</option>
<option value="monkey">A monkey!</option>
<option value="giraffe">A giraffe!</option>
</select>,
)),
).toWarnDev('Invalid value for prop `value`');

expect(node.value).toBe('monkey');

node = ReactTestUtils.renderIntoDocument(
<select defaultValue={() => {}}>
<option value={() => {}}>A function!</option>
<option value="monkey">A monkey!</option>
<option value="giraffe">A giraffe!</option>
</select>,
);

expect(node.value).toBe('');
});

it('treats controlled function value as an empty string', () => {
let selectNode;

class Form extends React.Component {
state = {
value: 'giraffe',
};

handleChange = e => this.setState({value: e.target.value});

render() {
return (
<select
onChange={this.handleChange}
value={this.state.value}
ref={x => (selectNode = x)}>
<option value={() => {}}>A Function!</option>
<option value="monkey">A monkey!</option>
<option value="giraffe">A giraffe!</option>
</select>
);
}
}

expect(() => ReactTestUtils.renderIntoDocument(<Form />)).toWarnDev(
'Invalid value for prop `value`',
);

expect(selectNode.value).toBe('giraffe');

setUntrackedValue.call(selectNode, () => {});
dispatchEventOnNode(selectNode, 'change');

expect(selectNode.value).toBe('');
});

it('treats controlled function value as an empty string', () => {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seemed to be a additional case that I found failing before this PR. I don't know if this is the best way to test it, though.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, this case is probably fine as is, since the browser defaults to using the element's children as a value if the attribute value is not provided.

<select id="test">
  <option>hi</option>
</select>

console.log(document.getElementById('test').value) // 'hi'

let selectNode;

class Form extends React.Component {
state = {
value: 'giraffe',
};

handleChange = e => this.setState({value: e.target.value});

render() {
return (
<select
onChange={this.handleChange}
value={this.state.value}
ref={x => (selectNode = x)}>
<option value={() => {}}>A Function!</option>
<option value="monkey">A monkey!</option>
<option value="giraffe">A giraffe!</option>
</select>
);
}
}

expect(() => ReactTestUtils.renderIntoDocument(<Form />)).toWarnDev(
'Invalid value for prop `value`',
);

expect(selectNode.value).toBe('giraffe');

setUntrackedValue.call(selectNode, () => {});
dispatchEventOnNode(selectNode, 'change');

expect(selectNode.value).toBe('');
});
});
});
3 changes: 2 additions & 1 deletion packages/react-dom/src/client/ReactDOMFiberOption.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import React from 'react';
import warning from 'shared/warning';
import {validateDOMNesting, updatedAncestorInfo} from './validateDOMNesting';
import {getToStringValue, toString} from './ToStringValue';

let didWarnSelectedSetOnOption = false;

Expand Down Expand Up @@ -73,7 +74,7 @@ export function validateProps(element: Element, props: Object) {
export function postMountWrapper(element: Element, props: Object) {
// value="" should make a value attribute (#6219)
if (props.value != null) {
element.setAttribute('value', props.value);
element.setAttribute('value', toString(getToStringValue(props.value)));
}
}

Expand Down
6 changes: 4 additions & 2 deletions packages/react-dom/src/client/ReactDOMFiberSelect.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import {getCurrentFiberOwnerNameInDevOrNull} from 'react-reconciler/src/ReactCur
import warning from 'shared/warning';

import ReactControlledValuePropTypes from '../shared/ReactControlledValuePropTypes';
import {getToStringValue, toString} from './ToStringValue';
import type {ToStringValue} from './ToStringValue';

let didWarnValueDefaultValue;

Expand All @@ -21,7 +23,7 @@ if (__DEV__) {

type SelectWithWrapperState = HTMLSelectElement & {
_wrapperState: {
initialValue: ?string,
initialValue: ToStringValue | void,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since ToStringValue is an opaque type I wasn't sure what to do here.

wasMultiple: boolean,
},
};
Expand Down Expand Up @@ -98,7 +100,7 @@ function updateOptions(
} else {
// Do not set `select.value` as exact behavior isn't consistent across all
// browsers for all cases.
let selectedValue = '' + (propValue: string);
let selectedValue = toString(getToStringValue((propValue: any)));
let defaultSelected = null;
for (let i = 0; i < options.length; i++) {
if (options[i].value === selectedValue) {
Expand Down