import { act, render, waitFor } from '@testing-library/react'; import React, { createRef } from 'react'; import { createSearchClient } from '../../../../../test/mock'; import { useHierarchicalMenu } from '../../connectors/useHierarchicalMenu'; import { useMenu } from '../../connectors/useMenu'; import { usePagination } from '../../connectors/usePagination'; import { useRefinementList } from '../../connectors/useRefinementList'; import { IndexContext } from '../../lib/IndexContext'; import { DynamicWidgets } from '../DynamicWidgets'; import { Index } from '../Index'; import { InstantSearch } from '../InstantSearch'; import type { UseHierarchicalMenuProps } from '../../connectors/useHierarchicalMenu'; import type { UseMenuProps } from '../../connectors/useMenu'; import type { UsePaginationProps } from '../../connectors/usePagination'; import type { UseRefinementListProps } from '../../connectors/useRefinementList'; import type { InstantSearchProps } from '../InstantSearch'; import type { IndexWidget } from 'instantsearch.js/es/widgets/index/index'; function Pagination(props: UsePaginationProps) { usePagination(props); return 'Pagination' as unknown as JSX.Element; } function RefinementList(props: UseRefinementListProps) { useRefinementList(props); return `RefinementList(${props.attribute})` as unknown as JSX.Element; } function Menu(props: UseMenuProps) { useMenu(props); return `Menu(${props.attribute})` as unknown as JSX.Element; } function HierarchicalMenu(props: UseHierarchicalMenuProps) { useHierarchicalMenu(props); return `HierarchicalMenu(${props.attributes[0]})` as unknown as JSX.Element; } function createInstantSearchMock() { const indexContextRef = createRef(); function InstantSearchMock({ children, ...props }: InstantSearchProps) { return ( {(value) => { // @ts-ignore `React.RefObject` is typed as immutable indexContextRef.current = value!; return ( {children} ); }} ); } return { InstantSearchMock, indexContextRef, }; } describe('DynamicWidgets', () => { test('throws with components that are non-attribute widgets', () => { const consoleError = jest.spyOn(console, 'error'); consoleError.mockImplementation(() => {}); const searchClient = createSearchClient({}); expect(() => { render( ); }).toThrowErrorMatchingInlineSnapshot( `"[InstantSearch] only supports InstantSearch widgets with an \`attribute\` or \`attributes\` prop."` ); consoleError.mockRestore(); }); test('throws with string components', () => { const consoleError = jest.spyOn(console, 'error'); consoleError.mockImplementation(() => {}); const searchClient = createSearchClient({}); expect(() => { render( Hello ); }).toThrowErrorMatchingInlineSnapshot( `"[InstantSearch] only supports InstantSearch widgets with an \`attribute\` or \`attributes\` prop."` ); consoleError.mockRestore(); }); test('renders only the result of transformItems', async () => { const searchClient = createSearchClient({}); const { InstantSearchMock, indexContextRef } = createInstantSearchMock(); const { container } = render( ['brand']}> ); await waitFor(() => { expect(searchClient.search).toHaveBeenCalledTimes(1); }); expect(container).toMatchInlineSnapshot(`
RefinementList(brand)
`); expect(indexContextRef.current!.getWidgets()).toEqual([ expect.objectContaining({ $$type: 'ais.refinementList' }), expect.objectContaining({ $$type: 'ais.dynamicWidgets' }), ]); }); test('renders widgets in components', async () => { const searchClient = createSearchClient({}); const { InstantSearchMock, indexContextRef } = createInstantSearchMock(); const { container } = render( ['brand']}>
); await waitFor(() => { expect(searchClient.search).toHaveBeenCalledTimes(1); }); expect(container).toMatchInlineSnapshot(`
RefinementList(brand)
`); expect(indexContextRef.current!.getWidgets()).toEqual([ expect.objectContaining({ $$type: 'ais.refinementList' }), expect.objectContaining({ $$type: 'ais.dynamicWidgets' }), ]); }); test('throws when a nested component contains multiple children', () => { const consoleError = jest.spyOn(console, 'error'); consoleError.mockImplementation(() => {}); const searchClient = createSearchClient({}); function MyComponent({ children }) { return (
{children}
); } expect(() => { render( ['brand']}> ); }).toThrowErrorMatchingInlineSnapshot(` "[InstantSearch] only supports a single component in nested components. Make sure to not render multiple children in a parent component. Example of an unsupported scenario: \`\`\` \`\`\` " `); consoleError.mockRestore(); }); // Ideally we should be able to render the widgets wrapped in components, but // we didn't implement this behavior for simplicity. test('does not render no-attribute widgets that are not direct children', () => { const consoleError = jest.spyOn(console, 'error'); consoleError.mockImplementation(() => {}); const searchClient = createSearchClient({}); function WrappedRefinementList() { return ; } expect(() => { render( ); }).toThrowErrorMatchingInlineSnapshot( `"[InstantSearch] only supports InstantSearch widgets with an \`attribute\` or \`attributes\` prop."` ); consoleError.mockRestore(); }); test('does not render attributes without widget by default', async () => { const searchClient = createSearchClient({}); const { InstantSearchMock, indexContextRef } = createInstantSearchMock(); const { container } = render( [ 'brand', 'categories', 'hierarchicalCategories.lvl0', ]} > ); await waitFor(() => { expect(searchClient.search).toHaveBeenCalledTimes(1); }); expect(container).toMatchInlineSnapshot(`
RefinementList(brand)
`); expect(indexContextRef.current!.getWidgets()).toEqual([ expect.objectContaining({ $$type: 'ais.refinementList' }), expect.objectContaining({ $$type: 'ais.dynamicWidgets' }), ]); }); test('renders attributes without widget with fallbackComponent', async () => { const searchClient = createSearchClient({}); const { InstantSearchMock, indexContextRef } = createInstantSearchMock(); const { container } = render( [ 'brand', 'categories', 'hierarchicalCategories.lvl0', ]} > ); await waitFor(() => { expect(searchClient.search).toHaveBeenCalledTimes(1); }); expect(container).toMatchInlineSnapshot(`
RefinementList(brand) Menu(categories) Menu(hierarchicalCategories.lvl0)
`); expect(indexContextRef.current!.getWidgets()).toEqual([ expect.objectContaining({ $$type: 'ais.refinementList' }), expect.objectContaining({ $$type: 'ais.menu' }), expect.objectContaining({ $$type: 'ais.menu' }), expect.objectContaining({ $$type: 'ais.dynamicWidgets' }), ]); }); test('renders attributes without widget with fallbackComponent (function form)', async () => { const searchClient = createSearchClient({}); const { container } = render( } transformItems={() => [ 'brand', 'categories', 'hierarchicalCategories.lvl0', ]} > ); await waitFor(() => { expect(searchClient.search).toHaveBeenCalledTimes(1); }); expect(container).toMatchInlineSnapshot(`
RefinementList(brand) Menu(categories) Menu(hierarchicalCategories.lvl0)
`); }); test('renders dynamic widgets in an Index', async () => { const searchClient = createSearchClient({}); const { InstantSearchMock, indexContextRef } = createInstantSearchMock(); const { container } = render( ['brand']}> ); await waitFor(() => { expect(searchClient.search).toHaveBeenCalledTimes(1); }); expect(container).toMatchInlineSnapshot(`
RefinementList(brand)
`); const index = indexContextRef .current!.getWidgets() .find( (widget): widget is IndexWidget => widget.$$type === 'ais.index' )!; expect(indexContextRef.current!.getWidgets()).toEqual([ expect.objectContaining({ $$type: 'ais.index' }), ]); expect(index.getWidgets()).toEqual([ expect.objectContaining({ $$type: 'ais.refinementList' }), expect.objectContaining({ $$type: 'ais.dynamicWidgets' }), ]); }); test('dynamically updates widgets when attributes change', async () => { const searchClient = createSearchClient({}); const { InstantSearchMock, indexContextRef } = createInstantSearchMock(); function App({ attributes }: { attributes: string[] }) { return ( attributes}> ); } // @TODO: we swallow React act errors in this test because we're unable to // satisfy them (?) const consoleError = jest.spyOn(console, 'error'); consoleError.mockImplementation(() => {}); const { container, rerender } = render(); await waitFor(() => { expect(searchClient.search).toHaveBeenCalledTimes(1); }); expect(container).toMatchInlineSnapshot(`
RefinementList(brand)
`); expect(indexContextRef.current!.getWidgets()).toEqual([ expect.objectContaining({ $$type: 'ais.refinementList' }), expect.objectContaining({ $$type: 'ais.dynamicWidgets' }), ]); act(() => { rerender(); }); await waitFor(() => { expect(searchClient.search).toHaveBeenCalledTimes(3); }); expect(container).toMatchInlineSnapshot(`
RefinementList(brand) Menu(categories)
`); expect(indexContextRef.current!.getWidgets()).toEqual([ expect.objectContaining({ $$type: 'ais.refinementList' }), expect.objectContaining({ $$type: 'ais.dynamicWidgets' }), expect.objectContaining({ $$type: 'ais.menu' }), ]); act(() => { rerender(); }); await waitFor(() => { expect(searchClient.search).toHaveBeenCalledTimes(5); }); expect(container).toMatchInlineSnapshot(`
RefinementList(brand)
`); expect(indexContextRef.current!.getWidgets()).toEqual([ expect.objectContaining({ $$type: 'ais.refinementList' }), expect.objectContaining({ $$type: 'ais.dynamicWidgets' }), ]); consoleError.mockRestore(); }); });