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

fix(headless): update recent queries only when query has results #2110

Merged
merged 3 commits into from
Jun 21, 2022
Merged

fix(headless): update recent queries only when query has results #2110

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
24aef67
feat(atomic): update recent queries only when query has results
Jun 16, 2022
fa345d2
Merge branch 'master' of github.com:coveo/ui-kit into KIT-1751-update…
Jun 17, 2022
9aa6e39
update quantic tests
Jun 20, 2022
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
47 changes: 36 additions & 11 deletions packages/headless/src/features/recent-queries/recent-queries-slice.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@ import {
getRecentQueriesInitialState,
RecentQueriesState,
} from './recent-queries-state';
import {Result} from '../../api/search/search/result';

function withResult(rest = {}) {
return {
results: [{title: 'result'} as Result],
...rest,
};
}

describe('recent-queries-slice', () => {
let state: RecentQueriesState;
Expand Down Expand Up @@ -62,9 +70,11 @@ describe('recent-queries-slice', () => {
const searchAction = executeSearch.fulfilled(
buildMockSearch({
queryExecuted: testQuery,
response: buildMockSearchResponse({
queryCorrections: [{correctedQuery: 'foo', wordCorrections: []}],
}),
response: buildMockSearchResponse(
withResult({
queryCorrections: [{correctedQuery: 'foo', wordCorrections: []}],
})
),
}),
'',
logSearchEvent({evt: 'foo'})
Expand All @@ -82,9 +92,11 @@ describe('recent-queries-slice', () => {
const searchAction = executeSearch.fulfilled(
buildMockSearch({
queryExecuted: otherTestQuery,
response: buildMockSearchResponse({
queryCorrections: [{correctedQuery: 'foo', wordCorrections: []}],
}),
response: buildMockSearchResponse(
withResult({
queryCorrections: [{correctedQuery: 'foo', wordCorrections: []}],
})
),
}),
'',
logSearchEvent({evt: 'foo'})
Expand All @@ -102,7 +114,7 @@ describe('recent-queries-slice', () => {
const searchAction = executeSearch.fulfilled(
buildMockSearch({
queryExecuted: '6',
response: buildMockSearchResponse({}),
response: buildMockSearchResponse(withResult()),
}),
'',
logSearchEvent({evt: 'foo'})
Expand All @@ -118,14 +130,14 @@ describe('recent-queries-slice', () => {
});

it('should not add new recent query on search fulfilled if queue already contains the query', () => {
const duplicates = ['what is a query', ' what is a query '];
const duplicates = [testQuery, ` ${testQuery} `];
for (const i in duplicates) {
state.queries = testQueries;
state.maxLength = 10;
const searchAction = executeSearch.fulfilled(
buildMockSearch({
queryExecuted: duplicates[i],
response: buildMockSearchResponse({}),
response: buildMockSearchResponse(withResult()),
}),
'',
logSearchEvent({evt: 'foo'})
Expand All @@ -137,13 +149,26 @@ describe('recent-queries-slice', () => {
}
});

it('should not add new recent query on search fulfilled if there are no results', () => {
const searchAction = executeSearch.fulfilled(
buildMockSearch({
queryExecuted: 'bloobloo',
response: buildMockSearchResponse({}),
}),
'',
logSearchEvent({evt: 'foo'})
);

expect(recentQueriesReducer(state, searchAction).queries).toEqual([]);
});

it('should not add an empty query to the list', () => {
const emptyQueries = ['', ' '];
for (const i in emptyQueries) {
const searchAction = executeSearch.fulfilled(
buildMockSearch({
queryExecuted: emptyQueries[i],
response: buildMockSearchResponse({}),
response: buildMockSearchResponse(withResult()),
}),
'',
logSearchEvent({evt: 'foo'})
Expand All @@ -161,7 +186,7 @@ describe('recent-queries-slice', () => {
const searchAction = executeSearch.fulfilled(
buildMockSearch({
queryExecuted: '3',
response: buildMockSearchResponse({}),
response: buildMockSearchResponse(withResult()),
}),
'',
logSearchEvent({evt: 'foo'})
Expand Down
3 changes: 2 additions & 1 deletion packages/headless/src/features/recent-queries/recent-queries-slice.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ export const recentQueriesReducer = createReducer(
})
.addCase(executeSearch.fulfilled, (state, action) => {
const query = action.payload.queryExecuted.trim();
if (!query.length) {
const results = action.payload.response.results;
if (!query.length || !results.length) {
return;
}
state.queries = state.queries.filter((q) => q !== query);
Expand Down