Add tests on placeholder search

Author: bidoubiwa

src/adapter/search-request-adapter/__tests__/search-params.tests.ts

@@ -183,3 +183,29 @@ test('Adapt SearchContext with no finite pagination and pagination total hits lo
 
   expect(searchParams.limit).toBe(4)
 })
+
+test('Adapt SearchContext placeholderSearch set to false', () => {
+  const searchParams = adaptSearchParams({
+    indexUid: 'test',
+    query: '',
+    pagination: { paginationTotalHits: 4, page: 0, hitsPerPage: 6 },
+    defaultFacetDistribution: {},
+    finitePagination: false,
+    placeholderSearch: false,
+  })
+
+  expect(searchParams.limit).toBe(0)
+})
+
+test('Adapt SearchContext placeholderSearch set to false', () => {
+  const searchParams = adaptSearchParams({
+    indexUid: 'test',
+    query: '',
+    pagination: { paginationTotalHits: 200, page: 0, hitsPerPage: 6 },
+    defaultFacetDistribution: {},
+    finitePagination: false,
+    placeholderSearch: true,
+  })
+
+  expect(searchParams.limit).toBe(7)
+})

src/adapter/search-request-adapter/search-resolver.ts

@@ -7,6 +7,17 @@ import {
 } from '../../types'
 import { addMissingFacets, extractFacets } from './filters'
 
+const emptySearch: MeiliSearchResponse<Record<string, any>> = {
+  hits: [],
+  query: '',
+  facetsDistribution: {},
+  limit: 0,
+  offset: 0,
+  exhaustiveNbHits: false,
+  nbHits: 0,
+  processingTimeMs: 0,
+}
+
 /**
  * @param  {ResponseCacher} cache
  */
@@ -23,6 +34,14 @@ export function SearchResolver(cache: SearchCacheInterface) {
       searchParams: MeiliSearchParams,
       client: MeiliSearch
     ): Promise<MeiliSearchResponse<Record<string, any>>> {
+      const { placeholderSearch, query } = searchContext
+
+      // query can be: empty string, undefined or null
+      // all of them are falsy's
+      if (!placeholderSearch && !query) {
+        return emptySearch
+      }
+
       const { pagination } = searchContext
 
       // In case we are in a `finitePagination`, only one big request is made

src/contexts/search-context.ts

@@ -26,14 +26,15 @@ export function createSearchContext(
     hitsPerPage: instantSearchParams?.hitsPerPage,
     page: instantSearchParams?.page,
   })
+
   const searchContext: SearchContext = {
     ...options,
     ...instantSearchParams,
     sort: sortByArray.join(':') || '',
     indexUid,
     pagination,
     defaultFacetDistribution,
-    placeholderSearch: !options.placeholderSearch, // true by default
+    placeholderSearch: options.placeholderSearch !== false, // true by default
     keepZeroFacets: !!options.keepZeroFacets, // false by default
     finitePagination: !!options.finitePagination, // false by default
   }

tests/placeholder-search.tests.ts

@@ -0,0 +1,57 @@
+import { instantMeiliSearch } from '../src'
+import {
+  searchClient,
+  dataset,
+  Movies,
+  meilisearchClient,
+} from './assets/utils'
+
+describe('Pagination browser test', () => {
+  beforeAll(async () => {
+    const deleteTask = await meilisearchClient.deleteIndex('movies')
+    await meilisearchClient.waitForTask(deleteTask.uid)
+    await meilisearchClient
+      .index('movies')
+      .updateFilterableAttributes(['genres'])
+    const documentsTask = await meilisearchClient
+      .index('movies')
+      .addDocuments(dataset)
+    await meilisearchClient.index('movies').waitForTask(documentsTask.uid)
+  })
+
+  test('Test placeholdersearch set to false', async () => {
+    const customClient = instantMeiliSearch(
+      'http://localhost:7700',
+      'masterKey',
+      {
+        paginationTotalHits: 5,
+        placeholderSearch: true,
+      }
+    )
+    const response = await customClient.search<Movies>([
+      {
+        indexName: 'movies',
+      },
+    ])
+    const hits = response.results[0].hits
+    expect(hits.length).toBe(5)
+  })
+
+  test('Test placeholdersearch set to true', async () => {
+    const customClient = instantMeiliSearch(
+      'http://localhost:7700',
+      'masterKey',
+      {
+        paginationTotalHits: 5,
+        placeholderSearch: false,
+      }
+    )
+    const response = await customClient.search<Movies>([
+      {
+        indexName: 'movies',
+      },
+    ])
+    const hits = response.results[0].hits
+    expect(hits.length).toBe(0)
+  })
+})