Forward `autocompleter` prop from `CompareFilter` to `Search` (https://github.com/woocommerce/woocommerce-admin/pull/6911)

- Forward `autocompleter` prop from `CompareFilter` to `Search`.
	Allow, to use the `custom` type of search, 
	previously it was complaining about lack of `autocompleter`,
	even though it was provided.

- Move `path` in Storybooks example to a parameter, to allow setting it in unit tests.
- Add few tests for FilterPicker. 
	- it renders the basic storybook example without throwing an error
	- it forwards `autocompleter` & `type` props

Fixes: woocommerce/woocommerce-admin#6890
This commit is contained in:
Tomek Wytrębowicz 2021-05-13 17:20:07 +02:00 committed by GitHub
parent bdd91b3337
commit 7cc1d724de
5 changed files with 82 additions and 5 deletions

View File

@ -1,5 +1,6 @@
# Unreleased # Unreleased
- Fix `autocompleter` for custom Search in `CompareFilter` #6911
- SelectControl: automatically scroll to selected options when list is displayed. #6906 - SelectControl: automatically scroll to selected options when list is displayed. #6906
- SelectControl: no longer auto selects on rendering list. #6906 - SelectControl: no longer auto selects on rendering list. #6906
- Make `Search` accept synchronous `autocompleter.options`. #6884 - Make `Search` accept synchronous `autocompleter.options`. #6884

View File

@ -91,7 +91,7 @@ export class CompareFilter extends Component {
} }
render() { render() {
const { labels, type } = this.props; const { labels, type, autocompleter } = this.props;
const { selected } = this.state; const { selected } = this.state;
return ( return (
<Card className="woocommerce-filters__compare"> <Card className="woocommerce-filters__compare">
@ -100,6 +100,7 @@ export class CompareFilter extends Component {
</CardHeader> </CardHeader>
<CardBody> <CardBody>
<Search <Search
autocompleter={ autocompleter }
type={ type } type={ type }
selected={ selected } selected={ selected }
placeholder={ labels.placeholder } placeholder={ labels.placeholder }
@ -165,6 +166,10 @@ CompareFilter.propTypes = {
* Which type of autocompleter should be used in the Search * Which type of autocompleter should be used in the Search
*/ */
type: PropTypes.string.isRequired, type: PropTypes.string.isRequired,
/**
* The custom autocompleter to be forwarded to the `Search` component.
*/
autocompleter: PropTypes.object,
}; };
CompareFilter.defaultProps = { CompareFilter.defaultProps = {

View File

@ -3,7 +3,6 @@
*/ */
import { CompareFilter } from '@woocommerce/components'; import { CompareFilter } from '@woocommerce/components';
const path = new URL( document.location ).searchParams.get( 'path' );
const query = {}; const query = {};
const compareFilter = { const compareFilter = {
type: 'products', type: 'products',
@ -19,9 +18,9 @@ const compareFilter = {
}, },
}; };
export const Basic = () => ( export const Basic = ( {
<CompareFilter path={ path } query={ query } { ...compareFilter } /> path = new URL( document.location ).searchParams.get( 'path' ),
); } ) => <CompareFilter path={ path } query={ query } { ...compareFilter } />;
export default { export default {
title: 'WooCommerce Admin/components/CompareFilter', title: 'WooCommerce Admin/components/CompareFilter',

View File

@ -0,0 +1,70 @@
/**
* External dependencies
*/
import { render } from '@testing-library/react';
/**
* Internal dependencies
*/
import { Basic } from '../stories/index';
import { CompareFilter } from '../index';
import Search from '../../search';
import productAutocompleter from '../../search/autocompleters/product';
// Due to Jest implementation we cannot mock it only for specific tests.
// If your test requires non-mocked Search, move them to another test file.
jest.mock( '../../search' );
Search.mockName( 'Search' );
describe( 'CompareFilter', () => {
let props;
beforeEach( () => {
props = {
path: '/foo/bar',
type: 'products',
param: 'product',
getLabels() {
return Promise.resolve( [] );
},
labels: {
helpText: 'Select at least two to compare',
placeholder: 'Search for things to compare',
title: 'Compare Things',
update: 'Compare',
},
};
} );
it( 'should render the example from the storybook', () => {
const path = '/story/woocommerce-admin-components-comparefilter--basic';
expect( function () {
render( <Basic path={ path } /> );
} ).not.toThrow();
} );
it( 'should forward the `type` prop the Search component', () => {
props.type = 'custom';
render( <CompareFilter { ...props } /> );
// Check that Search component received the prop, without checking its behavior/internals/implementation details.
expect( Search ).toHaveBeenLastCalledWith(
expect.objectContaining( {
type: 'custom',
} ),
expect.anything()
);
} );
it( 'should forward the `autocompleter` prop the Search component', () => {
props.autocompleter = productAutocompleter;
render( <CompareFilter { ...props } /> );
// Check that Search component received the prop, without checking its behavior/internals/implementation details.
expect( Search ).toHaveBeenLastCalledWith(
expect.objectContaining( {
autocompleter: productAutocompleter,
} ),
expect.anything()
);
} );
} );

View File

@ -74,6 +74,8 @@ Release and roadmap notes are available on the [WooCommerce Developers Blog](htt
== Changelog == == Changelog ==
== Unreleased == == Unreleased ==
- Fix: Autocompleter for custom Search in CompareFilter #6911
- Enhancement: Adding Slotfills for remote payments and SettingsForm component. #6932 - Enhancement: Adding Slotfills for remote payments and SettingsForm component. #6932
- Fix: Make `Search` accept synchronous `autocompleter.options`. #6884 - Fix: Make `Search` accept synchronous `autocompleter.options`. #6884
- Add: Consume remote payment methods on frontend #6867 - Add: Consume remote payment methods on frontend #6867