/** * @jest-environment node */ import React, { version as ReactVersion } from 'react'; import { renderToString } from 'react-dom/server'; import { InstantSearch, InstantSearchSSRProvider, Index, DynamicWidgets, version, useSearchBox, } from 'react-instantsearch-hooks'; import { Hits, RefinementList } from 'react-instantsearch-hooks-web'; import { createMultiSearchResponse, createSearchClient, createSingleSearchResponse, } from '../../../../test/mock'; import { getServerState } from '../getServerState'; import type { InstantSearchServerState, InstantSearchProps, } from 'react-instantsearch-hooks'; function SearchBox() { const { query } = useSearchBox(); return (
); } function Hit({ hit }) { return <>{hit.objectID}; } type CreateTestEnvironmentProps = { searchClient: InstantSearchProps['searchClient']; initialUiState?: InstantSearchProps['initialUiState']; }; function createTestEnvironment({ searchClient, initialUiState = { instant_search: { query: 'iphone', refinementList: { brand: ['Apple'], }, }, instant_search_price_asc: { query: 'iphone', refinementList: { brand: ['Apple'], }, }, }, }: CreateTestEnvironmentProps) { function Search({ children }: { children?: React.ReactNode }) { return ( {children}

instant_search

instant_search_price_asc

instant_search_rating_desc

instant_search_price_desc

); } function App({ serverState, children, }: { serverState?: InstantSearchServerState; children?: React.ReactNode; }) { return ( {children} ); } return { App, }; } describe('getServerState', () => { test('throws without component', async () => { function App() { return null; } await expect( getServerState() ).rejects.toThrowErrorMatchingInlineSnapshot( `"Unable to retrieve InstantSearch's server state in \`getServerState()\`. Did you mount the component?"` ); }); test('throws when the search client errors', async () => { const searchClient = createSearchClient({ search: () => { throw new Error('Search client error'); }, }); const { App } = createTestEnvironment({ searchClient }); await expect(getServerState()).rejects.toThrow( /Search client error/ ); }); test('adds the server user agents', async () => { const searchClient = createSearchClient({}); const { App } = createTestEnvironment({ searchClient }); await getServerState(); expect(searchClient.addAlgoliaAgent).toHaveBeenCalledWith( `react (${ReactVersion})` ); expect(searchClient.addAlgoliaAgent).toHaveBeenCalledWith( `react-instantsearch (${version})` ); expect(searchClient.addAlgoliaAgent).toHaveBeenCalledWith( `react-instantsearch-hooks (${version})` ); expect(searchClient.addAlgoliaAgent).toHaveBeenCalledWith( `react-instantsearch-server (${version})` ); }); test('calls search with widgets search parameters', async () => { const searchClient = createSearchClient({}); const { App } = createTestEnvironment({ searchClient }); await getServerState(); expect(searchClient.search).toHaveBeenCalledTimes(1); expect(searchClient.search).toHaveBeenCalledWith([ { indexName: 'instant_search', params: { facetFilters: [['brand:Apple']], facets: ['brand'], highlightPostTag: '__/ais-highlight__', highlightPreTag: '__ais-highlight__', maxValuesPerFacet: 10, query: 'iphone', tagFilters: '', }, }, { indexName: 'instant_search', params: { analytics: false, clickAnalytics: false, facets: 'brand', highlightPostTag: '__/ais-highlight__', highlightPreTag: '__ais-highlight__', hitsPerPage: 0, maxValuesPerFacet: 10, query: 'iphone', page: 0, }, }, { indexName: 'instant_search_price_asc', params: { facetFilters: [['brand:Apple']], facets: ['brand'], highlightPostTag: '__/ais-highlight__', highlightPreTag: '__ais-highlight__', maxValuesPerFacet: 10, query: 'iphone', tagFilters: '', }, }, { indexName: 'instant_search_price_asc', params: { analytics: false, clickAnalytics: false, facets: 'brand', highlightPostTag: '__/ais-highlight__', highlightPreTag: '__ais-highlight__', hitsPerPage: 0, maxValuesPerFacet: 10, page: 0, query: 'iphone', }, }, { indexName: 'instant_search_rating_desc', params: { facetFilters: [['brand:Apple']], facets: ['brand'], highlightPostTag: '__/ais-highlight__', highlightPreTag: '__ais-highlight__', maxValuesPerFacet: 10, query: 'iphone', tagFilters: '', }, }, { indexName: 'instant_search_rating_desc', params: { analytics: false, clickAnalytics: false, facets: 'brand', highlightPostTag: '__/ais-highlight__', highlightPreTag: '__ais-highlight__', hitsPerPage: 0, maxValuesPerFacet: 10, page: 0, query: 'iphone', }, }, { indexName: 'instant_search_price_desc', params: { facetFilters: [['brand:Apple']], facets: ['brand'], highlightPostTag: '__/ais-highlight__', highlightPreTag: '__ais-highlight__', maxValuesPerFacet: 10, query: 'iphone', tagFilters: '', }, }, { indexName: 'instant_search_price_desc', params: { analytics: false, clickAnalytics: false, facets: 'brand', highlightPostTag: '__/ais-highlight__', highlightPreTag: '__ais-highlight__', hitsPerPage: 0, maxValuesPerFacet: 10, page: 0, query: 'iphone', }, }, ]); }); test('returns initialResults', async () => { const searchClient = createSearchClient({}); const { App } = createTestEnvironment({ searchClient }); const serverState = await getServerState(); expect(Object.keys(serverState.initialResults)).toHaveLength(4); expect(serverState.initialResults).toMatchSnapshot(); }); test('searches twice (cached) with dynamic widgets', async () => { const searchClient = createSearchClient({}); const { App } = createTestEnvironment({ searchClient, initialUiState: {} }); await getServerState( ); expect(searchClient.search).toHaveBeenCalledTimes(2); // both calls are the same, so they're cached expect((searchClient.search as jest.Mock).mock.calls[0][0]).toEqual( (searchClient.search as jest.Mock).mock.calls[1][0] ); }); test('searches twice (cached) with dynamic widgets inside index', async () => { const searchClient = createSearchClient({}); const { App } = createTestEnvironment({ searchClient, initialUiState: {} }); await getServerState( ); expect(searchClient.search).toHaveBeenCalledTimes(2); // both calls are the same, so they're cached expect((searchClient.search as jest.Mock).mock.calls[0][0]).toEqual( (searchClient.search as jest.Mock).mock.calls[1][0] ); }); test('searches twice with dynamic widgets and a refinement', async () => { const searchClient = createSearchClient({}); const { App } = createTestEnvironment({ searchClient, initialUiState: { instant_search: { refinementList: { categories: ['refined!'], }, }, }, }); await getServerState( ); expect(searchClient.search).toHaveBeenCalledTimes(2); // first query doesn't have the fallback widget mounted yet expect((searchClient.search as jest.Mock).mock.calls[0][0][0]).toEqual({ indexName: 'instant_search', params: { facets: ['*'], highlightPostTag: '__/ais-highlight__', highlightPreTag: '__ais-highlight__', maxValuesPerFacet: 20, query: '', tagFilters: '', }, }); // second query does have the fallback widget mounted, and thus also the refinement expect((searchClient.search as jest.Mock).mock.calls[1][0][0]).toEqual({ indexName: 'instant_search', params: { facetFilters: [['categories:refined!']], facets: ['*'], highlightPostTag: '__/ais-highlight__', highlightPreTag: '__ais-highlight__', maxValuesPerFacet: 20, query: '', tagFilters: '', }, }); }); test('returns HTML from server state', async () => { const searchClient = createSearchClient({ search: jest.fn((requests) => Promise.resolve( createMultiSearchResponse( ...requests.map(() => createSingleSearchResponse({ hits: [{ objectID: '1' }, { objectID: '2' }], }) ) ) ) ), }); const { App } = createTestEnvironment({ searchClient }); const serverState = await getServerState(); const html = renderToString(); expect(html).toMatchInlineSnapshot(`

instant_search

  1. 1
  2. 2

instant_search_price_asc

  1. 1
  2. 2

instant_search_rating_desc

  1. 1
  2. 2

instant_search_price_desc

  1. 1
  2. 2
`); }); });