File size: 14,733 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 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 | 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<IndexWidget>();
function InstantSearchMock({ children, ...props }: InstantSearchProps) {
return (
<InstantSearch {...props}>
<IndexContext.Consumer>
{(value) => {
// @ts-ignore `React.RefObject` is typed as immutable
indexContextRef.current = value!;
return (
<IndexContext.Provider value={value}>
{children}
</IndexContext.Provider>
);
}}
</IndexContext.Consumer>
</InstantSearch>
);
}
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(
<InstantSearch indexName="indexName" searchClient={searchClient}>
<DynamicWidgets>
<Pagination />
</DynamicWidgets>
</InstantSearch>
);
}).toThrowErrorMatchingInlineSnapshot(
`"[InstantSearch] <DynamicWidgets> 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(
<InstantSearch indexName="indexName" searchClient={searchClient}>
<DynamicWidgets>Hello</DynamicWidgets>
</InstantSearch>
);
}).toThrowErrorMatchingInlineSnapshot(
`"[InstantSearch] <DynamicWidgets> 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(
<InstantSearchMock indexName="indexName" searchClient={searchClient}>
<DynamicWidgets transformItems={() => ['brand']}>
<RefinementList attribute="brand" />
<HierarchicalMenu
attributes={[
'hierarchicalCategories.lvl0',
'hierarchicalCategories.lvl1',
]}
/>
</DynamicWidgets>
</InstantSearchMock>
);
await waitFor(() => {
expect(searchClient.search).toHaveBeenCalledTimes(1);
});
expect(container).toMatchInlineSnapshot(`
<div>
RefinementList(brand)
</div>
`);
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(
<InstantSearchMock indexName="indexName" searchClient={searchClient}>
<DynamicWidgets transformItems={() => ['brand']}>
<div className="ais-Panel">
<div className="ais-Panel-body">
<RefinementList attribute="brand" />
</div>
</div>
</DynamicWidgets>
</InstantSearchMock>
);
await waitFor(() => {
expect(searchClient.search).toHaveBeenCalledTimes(1);
});
expect(container).toMatchInlineSnapshot(`
<div>
<div
class="ais-Panel"
>
<div
class="ais-Panel-body"
>
RefinementList(brand)
</div>
</div>
</div>
`);
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 (
<div className="ais-Panel">
<div className="ais-Panel-body">{children}</div>
</div>
);
}
expect(() => {
render(
<InstantSearch indexName="indexName" searchClient={searchClient}>
<DynamicWidgets transformItems={() => ['brand']}>
<MyComponent>
<RefinementList attribute="brand" />
<Menu attribute="categories" />
</MyComponent>
</DynamicWidgets>
</InstantSearch>
);
}).toThrowErrorMatchingInlineSnapshot(`
"[InstantSearch] <DynamicWidgets> only supports a single component in nested components. Make sure to not render multiple children in a parent component.
Example of an unsupported scenario:
\`\`\`
<DynamicWidgets>
<MyComponent>
<RefinementList attribute=\\"brand\\" />
<Menu attribute=\\"categories\\" />
</MyComponent>
</DynamicWidgets>
\`\`\`
"
`);
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 <RefinementList attribute="brand" />;
}
expect(() => {
render(
<InstantSearch indexName="indexName" searchClient={searchClient}>
<DynamicWidgets>
<WrappedRefinementList />
</DynamicWidgets>
</InstantSearch>
);
}).toThrowErrorMatchingInlineSnapshot(
`"[InstantSearch] <DynamicWidgets> 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(
<InstantSearchMock indexName="indexName" searchClient={searchClient}>
<DynamicWidgets
transformItems={() => [
'brand',
'categories',
'hierarchicalCategories.lvl0',
]}
>
<RefinementList attribute="brand" />
</DynamicWidgets>
</InstantSearchMock>
);
await waitFor(() => {
expect(searchClient.search).toHaveBeenCalledTimes(1);
});
expect(container).toMatchInlineSnapshot(`
<div>
RefinementList(brand)
</div>
`);
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(
<InstantSearchMock indexName="indexName" searchClient={searchClient}>
<DynamicWidgets
fallbackComponent={Menu}
transformItems={() => [
'brand',
'categories',
'hierarchicalCategories.lvl0',
]}
>
<RefinementList attribute="brand" />
</DynamicWidgets>
</InstantSearchMock>
);
await waitFor(() => {
expect(searchClient.search).toHaveBeenCalledTimes(1);
});
expect(container).toMatchInlineSnapshot(`
<div>
RefinementList(brand)
Menu(categories)
Menu(hierarchicalCategories.lvl0)
</div>
`);
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(
<InstantSearch indexName="indexName" searchClient={searchClient}>
<DynamicWidgets
fallbackComponent={({ attribute }) => <Menu attribute={attribute} />}
transformItems={() => [
'brand',
'categories',
'hierarchicalCategories.lvl0',
]}
>
<RefinementList attribute="brand" />
</DynamicWidgets>
</InstantSearch>
);
await waitFor(() => {
expect(searchClient.search).toHaveBeenCalledTimes(1);
});
expect(container).toMatchInlineSnapshot(`
<div>
RefinementList(brand)
Menu(categories)
Menu(hierarchicalCategories.lvl0)
</div>
`);
});
test('renders dynamic widgets in an Index', async () => {
const searchClient = createSearchClient({});
const { InstantSearchMock, indexContextRef } = createInstantSearchMock();
const { container } = render(
<InstantSearchMock indexName="indexName" searchClient={searchClient}>
<Index indexName="subIndexName">
<DynamicWidgets transformItems={() => ['brand']}>
<RefinementList attribute="brand" />
</DynamicWidgets>
</Index>
</InstantSearchMock>
);
await waitFor(() => {
expect(searchClient.search).toHaveBeenCalledTimes(1);
});
expect(container).toMatchInlineSnapshot(`
<div>
RefinementList(brand)
</div>
`);
const index = indexContextRef
.current!.getWidgets()
.find<IndexWidget>(
(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 (
<InstantSearchMock indexName="indexName" searchClient={searchClient}>
<DynamicWidgets transformItems={() => attributes}>
<RefinementList attribute="brand" />
<Menu attribute="categories" />
</DynamicWidgets>
</InstantSearchMock>
);
}
// @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(<App attributes={['brand']} />);
await waitFor(() => {
expect(searchClient.search).toHaveBeenCalledTimes(1);
});
expect(container).toMatchInlineSnapshot(`
<div>
RefinementList(brand)
</div>
`);
expect(indexContextRef.current!.getWidgets()).toEqual([
expect.objectContaining({ $$type: 'ais.refinementList' }),
expect.objectContaining({ $$type: 'ais.dynamicWidgets' }),
]);
act(() => {
rerender(<App attributes={['brand', 'categories']} />);
});
await waitFor(() => {
expect(searchClient.search).toHaveBeenCalledTimes(3);
});
expect(container).toMatchInlineSnapshot(`
<div>
RefinementList(brand)
Menu(categories)
</div>
`);
expect(indexContextRef.current!.getWidgets()).toEqual([
expect.objectContaining({ $$type: 'ais.refinementList' }),
expect.objectContaining({ $$type: 'ais.dynamicWidgets' }),
expect.objectContaining({ $$type: 'ais.menu' }),
]);
act(() => {
rerender(<App attributes={['brand']} />);
});
await waitFor(() => {
expect(searchClient.search).toHaveBeenCalledTimes(5);
});
expect(container).toMatchInlineSnapshot(`
<div>
RefinementList(brand)
</div>
`);
expect(indexContextRef.current!.getWidgets()).toEqual([
expect.objectContaining({ $$type: 'ais.refinementList' }),
expect.objectContaining({ $$type: 'ais.dynamicWidgets' }),
]);
consoleError.mockRestore();
});
});
|