File size: 5,710 Bytes
1e92f2d | 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 | import { render, waitFor } from '@testing-library/react';
import React, { StrictMode } from 'react';
import { createSearchClient } from '../../../../../test/mock';
import { createInstantSearchSpy } from '../../../../../test/utils';
import { Configure } from '../../components/Configure';
import { IndexContext } from '../../lib/IndexContext';
import { noop } from '../../lib/noop';
import { Index } from '../Index';
import { InstantSearch } from '../InstantSearch';
import { InstantSearchSSRProvider } from '../InstantSearchSSRProvider';
import type { IndexWidget } from 'instantsearch.js/es/widgets/index/index';
describe('Index', () => {
test('throws when used outside of <InstantSearch>', () => {
// Hide the errors from the test logs.
jest.spyOn(console, 'error').mockImplementation(noop);
expect(() => {
render(<Index indexName="childIndex">Children</Index>);
}).toThrowErrorMatchingInlineSnapshot(
`"[InstantSearch] The <Index> component must be used within <InstantSearch>."`
);
jest.spyOn(console, 'error').mockRestore();
});
test('renders children', () => {
const searchClient = createSearchClient({});
const { container } = render(
<StrictMode>
<InstantSearch indexName="indexName" searchClient={searchClient}>
<Index indexName="childIndex">Children</Index>
</InstantSearch>
</StrictMode>
);
expect(container).toMatchInlineSnapshot(`
<div>
Children
</div>
`);
});
test('provides the parent index', () => {
const searchClient = createSearchClient({});
let indexContext: IndexWidget | null = null;
render(
<StrictMode>
<InstantSearch indexName="indexName" searchClient={searchClient}>
<Index indexName="childIndex">
<IndexContext.Consumer>
{(context) => {
indexContext = context;
return null;
}}
</IndexContext.Consumer>
</Index>
</InstantSearch>
</StrictMode>
);
expect(indexContext).toEqual(
expect.objectContaining({
$$type: 'ais.index',
addWidgets: expect.any(Function),
removeWidgets: expect.any(Function),
})
);
expect(indexContext!.getIndexName()).toEqual('childIndex');
});
test('provides the nested parent index', () => {
const searchClient = createSearchClient({});
let indexContext: IndexWidget | null = null;
render(
<StrictMode>
<InstantSearch indexName="indexName" searchClient={searchClient}>
<Index indexName="childIndex">
<Index indexName="subchildIndex">
<IndexContext.Consumer>
{(context) => {
indexContext = context;
return null;
}}
</IndexContext.Consumer>
</Index>
</Index>
</InstantSearch>
</StrictMode>
);
expect(indexContext).toEqual(
expect.objectContaining({
$$type: 'ais.index',
addWidgets: expect.any(Function),
removeWidgets: expect.any(Function),
})
);
expect(indexContext!.getIndexName()).toEqual('subchildIndex');
});
test('adds the index only once on CSR', async () => {
const searchClient = createSearchClient({});
const { InstantSearchSpy, indexContext } = createInstantSearchSpy();
const { unmount } = render(
<StrictMode>
<InstantSearchSpy searchClient={searchClient} indexName="indexName">
<Index indexName="indexName2">
<Configure />
</Index>
</InstantSearchSpy>
</StrictMode>
);
expect(indexContext.current!.addWidgets).toHaveBeenCalledTimes(1);
expect(indexContext.current!.addWidgets).toHaveBeenLastCalledWith([
expect.objectContaining({ $$type: 'ais.index' }),
]);
unmount();
await waitFor(() => {
expect(indexContext.current!.removeWidgets).toHaveBeenCalledTimes(1);
expect(indexContext.current!.removeWidgets).toHaveBeenCalledWith([
expect.objectContaining({ $$type: 'ais.index' }),
]);
});
});
test('adds the index only once on SSR', async () => {
const searchClient = createSearchClient({});
const { InstantSearchSpy, indexContext } = createInstantSearchSpy();
const initialResults = {
indexName: {
state: {},
results: [
{
exhaustiveFacetsCount: true,
exhaustiveNbHits: true,
hits: [{ objectID: '1' }, { objectID: '2' }, { objectID: '3' }],
hitsPerPage: 20,
index: 'indexName',
nbHits: 0,
nbPages: 0,
page: 0,
params: '',
processingTimeMS: 0,
query: '',
},
],
},
};
// @TODO: this test doesn't work in Strict Mode
const { unmount } = render(
<InstantSearchSSRProvider initialResults={initialResults}>
<InstantSearchSpy searchClient={searchClient} indexName="indexName">
<Index indexName="indexName2">
<Configure />
</Index>
</InstantSearchSpy>
</InstantSearchSSRProvider>
);
expect(indexContext.current!.addWidgets).toHaveBeenCalledTimes(1);
expect(indexContext.current!.addWidgets).toHaveBeenLastCalledWith([
expect.objectContaining({ $$type: 'ais.index' }),
]);
unmount();
await waitFor(() => {
expect(indexContext.current!.removeWidgets).toHaveBeenCalledTimes(1);
expect(indexContext.current!.removeWidgets).toHaveBeenCalledWith([
expect.objectContaining({ $$type: 'ais.index' }),
]);
});
});
});
|