Add tests and improve commenting on tests

Author: bidoubiwa

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

@@ -64,7 +64,6 @@ export function SearchResolver(
       // all of them are falsy's
       if (!placeholderSearch && !query) {
         searchResponse.hits = []
-        searchResponse.estimatedTotalHits = 0
       }
       // Cache response
       cache.setEntry<MeiliSearchResponse>(key, searchResponse)

tests/first-facets-distribution.tests.ts

@@ -1,7 +1,7 @@
 import { dataset, meilisearchClient, HOST, API_KEY } from './assets/utils'
 import { instantMeiliSearch } from '../src'
 
-describe('First facet distribution', () => {
+describe('Default facet distribution', () => {
   beforeAll(async () => {
     const deleteTask = await meilisearchClient.deleteIndex('movies')
     await meilisearchClient.waitForTask(deleteTask.taskUid)
@@ -14,6 +14,10 @@ describe('First facet distribution', () => {
     await meilisearchClient.index('movies').waitForTask(documentsTask.taskUid)
   })
 
+  // Without facets
+  // Without keepZeroFacets
+  // With placeholderSearch
+  // With empty query
   test('creation of facet distribution without facets', async () => {
     const searchClient = instantMeiliSearch(HOST, API_KEY)
     const response = await searchClient.search([
@@ -28,9 +32,13 @@ describe('First facet distribution', () => {
     expect(response.results[0].facets).toEqual({})
   })
 
+  // Without facets
+  // With keepZeroFacets
+  // With placeholderSearch
+  // With empty query
   test('creation of facet distribution without facets and with keepZeroFacets to true', async () => {
     const searchClient = instantMeiliSearch(HOST, API_KEY, {
-      keepZeroFacets: false,
+      keepZeroFacets: true,
     })
     const response = await searchClient.search([
       {
@@ -44,6 +52,58 @@ describe('First facet distribution', () => {
     expect(response.results[0].facets).toEqual({})
   })
 
+  // With facets
+  // without keepZeroFacets
+  // without placeholderSearch
+  // With multiple searchs
+  test('creation of facet distribution with facets, with keepZeroFacets to false and placeholdersearch to false', async () => {
+    const searchClient = instantMeiliSearch(HOST, API_KEY, {
+      keepZeroFacets: false,
+      placeholderSearch: false, // only test false since `true` is default value
+    })
+    const response = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          facets: ['genres'],
+          query: '',
+        },
+      },
+    ])
+    expect(response.results[0].facets).toEqual({
+      genres: {
+        Action: 3,
+        Adventure: 1,
+        Animation: 1,
+        Comedy: 2,
+        Crime: 4,
+        Drama: 1,
+        'Science Fiction': 2,
+        Thriller: 1,
+      },
+    })
+
+    // Ensure cached default facet distribution between searchClient is correct
+    const response2 = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          facets: ['genres'],
+          query: 'no results',
+        },
+      },
+    ])
+
+    // No `0` are showcased as `keepZeroFacets` is set to false
+    expect(response2.results[0].facets).toEqual({
+      genres: {},
+    })
+  })
+
+  // With facets
+  // without keepZeroFacets
+  // with placeholderSearch
+  // With empty query
   test('creation of facet distribution with facets', async () => {
     const searchClient = instantMeiliSearch(HOST, API_KEY)
     const response = await searchClient.search([
@@ -67,8 +127,27 @@ describe('First facet distribution', () => {
         Thriller: 1,
       },
     })
+
+    const response2 = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          facets: ['genres'],
+          query: 'no results',
+        },
+      },
+    ])
+
+    // No `0` are showcased as `keepZeroFacets` is set to false
+    expect(response2.results[0].facets).toEqual({
+      genres: {},
+    })
   })
 
+  // With facets
+  // with keepZeroFacets
+  // with placeholderSearch
+  // With multiple search (empty and no results expected)
   test('creation of facet distribution with facets and keepZeroFacets to true', async () => {
     const searchClient = instantMeiliSearch(HOST, API_KEY, {
       keepZeroFacets: true,
@@ -119,6 +198,68 @@ describe('First facet distribution', () => {
     })
   })
 
+  // With facets
+  // with keepZeroFacets
+  // without placeholderSearch
+  // With multiple search (empty and no results expected)
+  test('creation of facet distribution with facets, keepZeroFacets to true and placeholderSearch to false', async () => {
+    const searchClient = instantMeiliSearch(HOST, API_KEY, {
+      keepZeroFacets: true,
+      placeholderSearch: false,
+    })
+    const response = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          facets: ['genres'],
+          query: '',
+        },
+      },
+    ])
+
+    expect(response.results[0].facets).toEqual({
+      genres: {
+        Action: 3,
+        Adventure: 1,
+        Animation: 1,
+        Comedy: 2,
+        Crime: 4,
+        Drama: 1,
+        'Science Fiction': 2,
+        Thriller: 1,
+      },
+    })
+    expect(response.results[0].hits.length).toEqual(0)
+
+    const response2 = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          facets: ['genres'],
+          query: 'no results',
+        },
+      },
+    ])
+
+    expect(response2.results[0].facets).toEqual({
+      genres: {
+        Action: 0,
+        Adventure: 0,
+        Animation: 0,
+        Comedy: 0,
+        Crime: 0,
+        Drama: 0,
+        'Science Fiction': 0,
+        Thriller: 0,
+      },
+    })
+  })
+
+  // With facets
+  // with keepZeroFacets
+  // with placeholderSearch
+  // Without multiple search
+  // Without query expecting no results
   test('creation of facet distribution with facets, keepZeroFacets to true, and query', async () => {
     const searchClient = instantMeiliSearch(HOST, API_KEY, {
       keepZeroFacets: true,