Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(core): introduce getWidgetRenderState (2/n) #4457

Merged
merged 6 commits into from
Aug 3, 2020
Merged

feat(core): introduce getWidgetRenderState (2/n) #4457

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
78705f3
feat(widgets): introduce `getWidgetRenderState`
francoischalifour Jul 24, 2020
e16eda5
fix(types): remove `results` `undefined` type
francoischalifour Jul 30, 2020
7ebd868
fix(index): recompute only new added widgets render state
francoischalifour Jul 30, 2020
b84947b
docs(index): explain why `getWidgetRenderState` is called in a separa…
francoischalifour Jul 30, 2020
1dde226
chore: increase bundlesize
francoischalifour Jul 30, 2020
a8d42cd
refactor(index): reorder params
francoischalifour Jul 30, 2020
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
272 changes: 179 additions & 93 deletions src/connectors/search-box/__tests__/connectSearchBox-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ import algoliasearchHelper, {
SearchParameters,
} from 'algoliasearch-helper';
import connectSearchBox from '../connectSearchBox';
import {
createInitOptions,
createRenderOptions,
} from '../../../../test/mock/createWidget';
import { InstantSearch } from '../../../types';
import { createSearchClient } from '../../../../test/mock/createSearchClient';

describe('connectSearchBox', () => {
const getInitializedWidget = (config = {}) => {
Expand All @@ -16,11 +22,12 @@ describe('connectSearchBox', () => {
const helper = algoliasearchHelper({}, '', initialConfig);
helper.search = jest.fn();

widget.init({
helper,
state: helper.state,
createURL: () => '#',
});
widget.init(
createInitOptions({
helper,
state: helper.state,
})
);

const { refine } = renderFn.mock.calls[0][0];

Expand Down Expand Up @@ -51,7 +58,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/search-box/
init: expect.any(Function),
render: expect.any(Function),
dispose: expect.any(Function),

getWidgetRenderState: expect.any(Function),
getWidgetUiState: expect.any(Function),
getWidgetSearchParameters: expect.any(Function),
})
Expand All @@ -69,11 +76,12 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/search-box/
const helper = algoliasearchHelper({});
helper.search = () => {};

widget.init({
helper,
state: helper.state,
createURL: () => '#',
});
widget.init(
createInitOptions({
helper,
state: helper.state,
})
);

expect(renderFn).toHaveBeenCalledTimes(1);
expect(renderFn).toHaveBeenLastCalledWith(
Expand All @@ -84,13 +92,13 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/search-box/
true
);

widget.render({
results: new SearchResults(helper.state, [{}]),
state: helper.state,
helper,
createURL: () => '#',
searchMetadata: { isSearchStalled: false },
});
widget.render(
createRenderOptions({
results: new SearchResults(helper.state, [{}]),
state: helper.state,
helper,
})
);

expect(renderFn).toHaveBeenCalledTimes(2);
expect(renderFn).toHaveBeenLastCalledWith(
Expand All @@ -110,11 +118,12 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/search-box/
const helper = algoliasearchHelper({});
helper.search = jest.fn();

widget.init({
helper,
state: helper.state,
createURL: () => '#',
});
widget.init(
createInitOptions({
helper,
state: helper.state,
})
);

{
const { refine, query } = renderFn.mock.calls[0][0];
Expand All @@ -125,13 +134,13 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/search-box/
expect(helper.search).toHaveBeenCalledTimes(1);
}

widget.render({
results: new SearchResults(helper.state, [{}]),
state: helper.state,
helper,
createURL: () => '#',
searchMetadata: { isSearchStalled: false },
});
widget.render(
createRenderOptions({
results: new SearchResults(helper.state, [{}]),
state: helper.state,
helper,
})
);

{
const { refine, query } = renderFn.mock.calls[1][0];
Expand All @@ -153,11 +162,12 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/search-box/
});
helper.search = jest.fn();

widget.init({
helper,
state: helper.state,
createURL: () => '#',
});
widget.init(
createInitOptions({
helper,
state: helper.state,
})
);

{
expect(helper.state.query).toBe('bup');
Expand All @@ -168,13 +178,13 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/search-box/
refine('bip'); // triggers a search
}

widget.render({
results: new SearchResults(helper.state, [{}]),
state: helper.state,
helper,
createURL: () => '#',
searchMetadata: { isSearchStalled: false },
});
widget.render(
createRenderOptions({
results: new SearchResults(helper.state, [{}]),
state: helper.state,
helper,
})
);

{
expect(helper.state.query).toBe('bip');
Expand All @@ -200,11 +210,12 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/search-box/
const helper = algoliasearchHelper({});
helper.search = jest.fn();

widget.init({
helper,
state: helper.state,
createURL: () => '#',
});
widget.init(
createInitOptions({
helper,
state: helper.state,
})
);

{
const { refine } = renderFn.mock.calls[0][0];
Expand All @@ -224,13 +235,13 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/search-box/

letSearchThrough = false;

widget.render({
results: new SearchResults(helper.state, [{}]),
state: helper.state,
helper,
createURL: () => '#',
searchMetadata: { isSearchStalled: false },
});
widget.render(
createRenderOptions({
results: new SearchResults(helper.state, [{}]),
state: helper.state,
helper,
})
);

{
const { refine } = renderFn.mock.calls[1][0];
Expand All @@ -248,42 +259,27 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/search-box/
}
});

it('should always provide the same refine() and clear() function reference', () => {
const renderFn = jest.fn();
const makeWidget = connectSearchBox(renderFn);
const widget = makeWidget();

const helper = algoliasearchHelper({});
helper.search = () => {};

widget.init({
helper,
state: helper.state,
createURL: () => '#',
});

widget.render({
results: new SearchResults(helper.state, [{}]),
state: helper.state,
helper,
createURL: () => '#',
searchMetadata: { isSearchStalled: false },
});

const firstRenderOptions = renderFn.mock.calls[0][0];

widget.render({
results: new SearchResults(helper.state, [{}]),
state: helper.state,
helper,
createURL: () => '#',
searchMetadata: { isSearchStalled: false },
it('provides the same `refine` and `clear` function references', done => {
const initRenderState = {};
const createSearchBox = connectSearchBox(
({ refine, clear }, isFirstRender) => {
if (isFirstRender) {
initRenderState.refine = refine;
initRenderState.clear = clear;
} else {
expect(refine).toBe(initRenderState.refine);
expect(clear).toBe(initRenderState.clear);
done();
}
}
);
const search = new InstantSearch({
searchClient: createSearchClient(),
indexName: 'indexName',
});

const secondRenderOptions = renderFn.mock.calls[1][0];

expect(firstRenderOptions.clear).toBe(secondRenderOptions.clear);
expect(firstRenderOptions.refine).toBe(secondRenderOptions.refine);
search.addWidgets([createSearchBox()]);
search.start();
});

it('should clear on init as well', () => {
Expand All @@ -297,11 +293,12 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/search-box/

expect(helper.state.query).toBe('foobar');

widget.init({
helper,
state: helper.state,
createURL: () => '#',
});
widget.init(
createInitOptions({
helper,
state: helper.state,
})
);

const { clear } = renderFn.mock.calls[0][0];
clear();
Expand All @@ -310,6 +307,95 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/search-box/
expect(helper.search).toHaveBeenCalledTimes(1);
});

describe('getWidgetRenderState', () => {
test('returns the render state with default render options', () => {
const renderFn = jest.fn();
const unmountFn = jest.fn();
const queryHook = jest.fn();
const createSearchBox = connectSearchBox(renderFn, unmountFn);
const searchBox = createSearchBox({
queryHook,
});

const renderState1 = searchBox.getWidgetRenderState(
{},
createInitOptions()
);

expect(renderState1.searchBox).toEqual({
clear: expect.any(Function),
isSearchStalled: false,
query: '',
refine: undefined,
widgetParams: { queryHook },
});

searchBox.init(createInitOptions());

const renderState2 = searchBox.getWidgetRenderState(
{},
createRenderOptions()
);

expect(renderState2.searchBox).toEqual({
clear: renderState2.searchBox.clear,
isSearchStalled: false,
query: '',
refine: expect.any(Function),
widgetParams: {
queryHook,
},
});
});

test('returns the render state with a query', () => {
const renderFn = jest.fn();
const unmountFn = jest.fn();
const createSearchBox = connectSearchBox(renderFn, unmountFn);
const searchBox = createSearchBox();
const helper = algoliasearchHelper(createSearchClient(), 'indexName', {
query: 'query',
});

searchBox.init(createInitOptions());

const renderState = searchBox.getWidgetRenderState(
{},
createRenderOptions({ helper })
);

expect(renderState.searchBox).toEqual({
clear: expect.any(Function),
isSearchStalled: false,
query: 'query',
refine: expect.any(Function),
widgetParams: {},
});
});

test('returns the render state with stalled search', () => {
const renderFn = jest.fn();
const unmountFn = jest.fn();
const createSearchBox = connectSearchBox(renderFn, unmountFn);
const searchBox = createSearchBox();

searchBox.init(createInitOptions());

const renderState = searchBox.getWidgetRenderState(
{},
createRenderOptions({ searchMetadata: { isSearchStalled: true } })
);

expect(renderState.searchBox).toEqual({
clear: expect.any(Function),
isSearchStalled: true,
query: '',
refine: expect.any(Function),
widgetParams: {},
});
});
});

describe('dispose', () => {
it('calls the unmount function', () => {
const helper = algoliasearchHelper({}, '');
Expand Down
Loading