Skip to content
This repository has been archived by the owner on Dec 30, 2022. It is now read-only.

feat(hooks-server): support import from React 18 #3464

Merged
merged 9 commits into from
May 12, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions packages/react-instantsearch-hooks-server/rollup.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,15 @@ const plugins = [

const createConfiguration = ({ name, minify = false } = {}) => ({
input: 'src/index.ts',
external: ['react', 'react-dom', 'react-instantsearch-hooks'],
external: ['react', 'react-instantsearch-hooks'],
inlineDynamicImports: true,
output: {
file: `dist/umd/ReactInstantSearch${name}${minify ? '.min' : ''}.js`,
name: `ReactInstantSearch${name}`,
format: 'umd',
globals: {
react: 'React',
'react-dom': 'ReactDOM',
Haroenv marked this conversation as resolved.
Show resolved Hide resolved
'react-dom/server.js': 'ReactDOMServer',
'react-instantsearch-hooks': 'ReactInstantSearchHooks',
},
banner: createBanner(name),
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
/**
* @jest-environment node
*/

import React from 'react';
import {
InstantSearch,
InstantSearchSSRProvider,
Index,
useHits,
useRefinementList,
useSearchBox,
} from 'react-instantsearch-hooks';

import { createSearchClient } from '../../../../test/mock';
import { getServerState } from '../getServerState';

import type {
InstantSearchServerState,
InstantSearchProps,
UseRefinementListProps,
} from 'react-instantsearch-hooks';

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 (
<InstantSearch
searchClient={searchClient}
indexName="instant_search"
initialUiState={initialUiState}
>
{children}
<RefinementList attribute="brand" />
<SearchBox />
<Hits />

<Index indexName="instant_search_price_asc">
<Hits />

<Index indexName="instant_search_rating_desc">
<Hits />
</Index>
</Index>

<Index indexName="instant_search_price_desc">
<Hits />
</Index>
</InstantSearch>
);
}

function App({
serverState,
children,
}: {
serverState?: InstantSearchServerState;
children?: React.ReactNode;
}) {
return (
<InstantSearchSSRProvider {...serverState}>
<Search>{children}</Search>
</InstantSearchSSRProvider>
);
}

return {
App,
};
}

// Neither of the modules exist
jest.mock(
'react-dom/server.js',
() => {
throw new Error('simulate the module not existing');
},
{ virtual: true }
);

jest.mock(
'react-dom/server',
() => {
throw new Error('simulate the module not existing');
},
{ virtual: true }
);

describe('ReactDOMServer imports', () => {
test('throws when no ReactDOMServer is present', async () => {
const searchClient = createSearchClient({});
const { App } = createTestEnvironment({ searchClient });

await expect(
getServerState(<App />)
).rejects.toThrowErrorMatchingInlineSnapshot(
`"Could not import ReactDOMServer."`
);
});
});

function SearchBox() {
useSearchBox();
return null;
}

function Hits() {
useHits();
return null;
}

function RefinementList(props: UseRefinementListProps) {
useRefinementList(props);
return null;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
/**
* @jest-environment node
*/

import React from 'react';
import {
InstantSearch,
InstantSearchSSRProvider,
Index,
useHits,
useRefinementList,
useSearchBox,
} from 'react-instantsearch-hooks';

import { createSearchClient } from '../../../../test/mock';
import { getServerState } from '../getServerState';

import type {
InstantSearchServerState,
InstantSearchProps,
UseRefinementListProps,
} from 'react-instantsearch-hooks';

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 (
<InstantSearch
searchClient={searchClient}
indexName="instant_search"
initialUiState={initialUiState}
>
{children}
<RefinementList attribute="brand" />
<SearchBox />
<Hits />

<Index indexName="instant_search_price_asc">
<Hits />

<Index indexName="instant_search_rating_desc">
<Hits />
</Index>
</Index>

<Index indexName="instant_search_price_desc">
<Hits />
</Index>
</InstantSearch>
);
}

function App({
serverState,
children,
}: {
serverState?: InstantSearchServerState;
children?: React.ReactNode;
}) {
return (
<InstantSearchSSRProvider {...serverState}>
<Search>{children}</Search>
</InstantSearchSSRProvider>
);
}

return {
App,
};
}

// Only the module with extension exists
jest.mock(
'react-dom/server.js',
() => {
return jest.requireActual('react-dom/server');
},
{ virtual: true }
);

jest.mock(
'react-dom/server',
() => {
throw new Error('simulate the module not existing');
},
{ virtual: true }
);

describe('ReactDOMServer imports', () => {
test('works when the import with an extension exists', async () => {
const searchClient = createSearchClient({});
const { App } = createTestEnvironment({ searchClient });

const serverState = await getServerState(<App />);

expect(serverState.initialResults).toEqual(expect.any(Object));
});
});

function SearchBox() {
useSearchBox();
return null;
}

function Hits() {
useHits();
return null;
}

function RefinementList(props: UseRefinementListProps) {
useRefinementList(props);
return null;
}
Loading