Rename defaultFacetDistribution to initialFacetDistribution

Author: bidoubiwa

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

@@ -1,10 +1,9 @@
 import { adaptSearchParams } from '../search-params-adapter'
-import { MatchingStrategies } from '../../../types'
+import { MatchingStrategies, SearchContext } from '../../../types'
 
-const DEFAULT_CONTEXT = {
+const DEFAULT_CONTEXT: SearchContext = {
   indexUid: 'test',
   pagination: { page: 0, hitsPerPage: 6, finite: false },
-  defaultFacetDistribution: {},
   placeholderSearch: true,
   keepZeroFacets: false,
 }

src/adapter/search-response-adapter/__tests__/facet-distribution.tests.ts

@@ -1,6 +1,6 @@
 import { adaptFacetDistribution } from '../../search-response-adapter/facet-distribution-adapter'
 
-const facetDistribution = {
+const initialFacetDistribution = {
   movie: {
     genre: { comedy: 3, horror: 2, drama: 4 },
     releaseYear: { '1990': 10, '2001': 30 },
@@ -12,7 +12,7 @@ describe('Facet distribution unit tests', () => {
     const returnedDistribution = adaptFacetDistribution(
       true,
       undefined,
-      facetDistribution.movie,
+      initialFacetDistribution.movie,
       { genre: { comedy: 3 } }
     )
 
@@ -23,7 +23,7 @@ describe('Facet distribution unit tests', () => {
     const returnedDistribution = adaptFacetDistribution(
       true,
       'genre',
-      facetDistribution.movie,
+      initialFacetDistribution.movie,
       { genre: { comedy: 3 } }
     )
 
@@ -36,7 +36,7 @@ describe('Facet distribution unit tests', () => {
     const returnedDistribution = adaptFacetDistribution(
       true,
       ['genre'],
-      facetDistribution.movie,
+      initialFacetDistribution.movie,
       { genre: { comedy: 3 } }
     )
 
@@ -49,7 +49,7 @@ describe('Facet distribution unit tests', () => {
     const returnedDistribution = adaptFacetDistribution(
       false,
       ['genre'],
-      facetDistribution.movie,
+      initialFacetDistribution.movie,
       { genre: { comedy: 3 } }
     )
 
@@ -62,7 +62,7 @@ describe('Facet distribution unit tests', () => {
     const returnedDistribution = adaptFacetDistribution(
       true,
       'genre',
-      facetDistribution.movie,
+      initialFacetDistribution.movie,
       {}
     )
 
@@ -75,7 +75,7 @@ describe('Facet distribution unit tests', () => {
     const returnedDistribution = adaptFacetDistribution(
       true,
       'genre',
-      facetDistribution.movie,
+      initialFacetDistribution.movie,
       undefined
     )
 
@@ -84,7 +84,7 @@ describe('Facet distribution unit tests', () => {
     })
   })
 
-  test('Fill facet values on empty default distribution and empty distribution', () => {
+  test('Fill facet values on empty initial distribution and empty distribution', () => {
     const returnedDistribution = adaptFacetDistribution(
       true,
       'genre',
@@ -99,7 +99,7 @@ describe('Facet distribution unit tests', () => {
     const returnedDistribution = adaptFacetDistribution(
       true,
       ['genre', 'releaseYear'],
-      facetDistribution.movie,
+      initialFacetDistribution.movie,
       { genre: { comedy: 3 } }
     )
 
@@ -113,7 +113,7 @@ describe('Facet distribution unit tests', () => {
     const returnedDistribution = adaptFacetDistribution(
       true,
       ['genre', 'releaseYear'],
-      facetDistribution.movie,
+      initialFacetDistribution.movie,
       { genre: { comedy: 3 }, releaseYear: { '1990': 1 } }
     )
 
@@ -127,7 +127,7 @@ describe('Facet distribution unit tests', () => {
     const returnedDistribution = adaptFacetDistribution(
       true,
       ['genre', 'releaseYear'],
-      facetDistribution.movie,
+      initialFacetDistribution.movie,
       {}
     )
 

src/adapter/search-response-adapter/facet-distribution-adapter.ts

@@ -9,30 +9,30 @@ function getFacetNames(
 }
 
 // Fills the missing facetValue in the current facet distribution if `keepZeroFacet` is true
-// using the initial facet distribution.
-// Ex:
+// using the initial facet distribution. Ex:
+//
 // Initial distribution: { genres: { horror: 10, comedy: 4 } }
 // Current distribution: { genres: { horror: 3 }}
-// returned distribution: { genres: { horror: 3, comedy: 0 }}
+// Returned distribution: { genres: { horror: 3, comedy: 0 }}
 function fillMissingFacetValues(
   facets: SearchContext['facets'] | string,
-  defaultFacetDistribution: FacetDistribution,
-  currentFacetDistribution: FacetDistribution
+  initialFacetDistribution: FacetDistribution,
+  facetDistribution: FacetDistribution
 ): FacetDistribution {
   const facetNames = getFacetNames(facets)
   const filledDistribution: FacetDistribution = {}
 
   for (const facet of facetNames) {
-    for (const facetValue in defaultFacetDistribution[facet]) {
+    for (const facetValue in initialFacetDistribution[facet]) {
       if (!filledDistribution[facet]) {
         // initialize sub object
-        filledDistribution[facet] = currentFacetDistribution[facet] || {}
+        filledDistribution[facet] = facetDistribution[facet] || {}
       }
       if (!filledDistribution[facet][facetValue]) {
         filledDistribution[facet][facetValue] = 0
       } else {
         filledDistribution[facet][facetValue] =
-          currentFacetDistribution[facet][facetValue]
+          facetDistribution[facet][facetValue]
       }
     }
   }
@@ -43,14 +43,14 @@ function fillMissingFacetValues(
 function adaptFacetDistribution(
   keepZeroFacets: boolean,
   facets: SearchContext['facets'] | string,
-  defaultFacetDistribution: FacetDistribution,
+  initialFacetDistribution: FacetDistribution,
   facetDistribution: FacetDistribution | undefined
 ) {
   if (keepZeroFacets) {
     facetDistribution = facetDistribution || {}
     return fillMissingFacetValues(
       facets,
-      defaultFacetDistribution,
+      initialFacetDistribution,
       facetDistribution
     )
   }

src/adapter/search-response-adapter/search-response-adapter.ts

@@ -20,7 +20,7 @@ import { adaptFacetDistribution } from './facet-distribution-adapter'
 export function adaptSearchResponse<T>(
   searchResponse: MeiliSearchResponse<Record<string, any>>,
   searchContext: SearchContext,
-  defaultFacetDistribution: FacetDistribution
+  initialFacetDistribution: FacetDistribution
 ): AlgoliaSearchResponse<T> {
   const searchResponseOptionals: Record<string, any> = {}
   const {
@@ -42,7 +42,7 @@ export function adaptSearchResponse<T>(
   const facetDistribution = adaptFacetDistribution(
     keepZeroFacets,
     facets,
-    defaultFacetDistribution,
+    initialFacetDistribution,
     responseFacetDistribution
   )
 

src/cache/index.ts

@@ -1,2 +1,2 @@
 export * from './search-cache'
-export * from './first-facets-distribution'
+export * from './init-facets-distribution'

src/cache/first-facets-distribution.ts renamed to src/cache/init-facets-distribution.ts

@@ -1,7 +1,7 @@
 import { FacetDistribution, SearchContext } from '../types'
 import { MeiliParamsCreator } from '../adapter'
 
-export async function cacheFirstFacetDistribution(
+async function getIndexFacetDistribution(
   searchResolver: any,
   searchContext: SearchContext
 ): Promise<FacetDistribution> {
@@ -23,3 +23,20 @@ export async function cacheFirstFacetDistribution(
   )
   return searchResponse.facetDistribution || {}
 }
+
+export async function initFacetDistribution(
+  searchResolver: any,
+  searchContext: SearchContext,
+  initialFacetDistribution: Record<string, FacetDistribution>
+): Promise<Record<string, FacetDistribution>> {
+  // Fetch the initial facets distribution of an Index
+  // Used to show the facets when `placeholderSearch` is set to true
+  // Used to fill the missing facet values when `keepZeroFacets` is set to true
+  if (!initialFacetDistribution[searchContext.indexUid]) {
+    initialFacetDistribution[
+      searchContext.indexUid
+    ] = await getIndexFacetDistribution(searchResolver, searchContext)
+  }
+
+  return initialFacetDistribution
+}

src/client/instant-meilisearch-client.ts

@@ -13,7 +13,7 @@ import {
   SearchResolver,
 } from '../adapter'
 import { createSearchContext } from '../contexts'
-import { SearchCache, cacheFirstFacetDistribution } from '../cache/'
+import { SearchCache, initFacetDistribution } from '../cache/'
 import { constructClientAgents } from './agents'
 import { validateInstantMeiliSearchParams } from '../utils'
 
@@ -55,7 +55,7 @@ export function instantMeiliSearch(
   // create search resolver with included cache
   const searchResolver = SearchResolver(meilisearchClient, searchCache)
 
-  let defaultFacetDistribution: Record<string, FacetDistribution>
+  let initialFacetDistribution: Record<string, FacetDistribution> = {}
 
   return {
     clearCache: () => searchCache.clearCache(),
@@ -82,18 +82,11 @@ export function instantMeiliSearch(
           // Adapt search request to Meilisearch compliant search request
           const adaptedSearchRequest = adaptSearchParams(searchContext)
 
-          // Cache first facets distribution of the instantMeilisearch instance
-          // Needed to add in the facetDistribution the fields that were not returned
-          // When the user sets `keepZeroFacets` to true.
-          if (
-            !defaultFacetDistribution ||
-            !defaultFacetDistribution[searchRequest.indexName]
-          ) {
-            defaultFacetDistribution = {}
-            defaultFacetDistribution[
-              searchRequest.indexName
-            ] = await cacheFirstFacetDistribution(searchResolver, searchContext)
-          }
+          initialFacetDistribution = await initFacetDistribution(
+            searchResolver,
+            searchContext,
+            initialFacetDistribution
+          )
 
           // Search response from Meilisearch
           const searchResponse = await searchResolver.searchResponse(
@@ -105,7 +98,7 @@ export function instantMeiliSearch(
           const adaptedSearchResponse = adaptSearchResponse<T>(
             searchResponse,
             searchContext,
-            defaultFacetDistribution[searchRequest.indexName]
+            initialFacetDistribution[searchRequest.indexName]
           )
 
           searchResponses.results.push(adaptedSearchResponse)

tests/disjunctive-facet-search.tests.ts

@@ -3,6 +3,8 @@ import { Movies, meilisearchClient } from './assets/utils'
 import movies from './assets/movies.json'
 import games from './assets/games.json'
 
+// TODO: re-read for review
+
 describe('Keep zero facets tests', () => {
   beforeAll(async () => {
     const moviesIndex = meilisearchClient.index('movies')
@@ -68,7 +70,6 @@ describe('Keep zero facets tests', () => {
     const moviesGenresRes = response.results[2]
 
     expect(moviesMainRes.hits.length).toBe(1)
-
     expect(moviesMainRes.facets).toEqual({
       color: {
         green: 1,
@@ -81,14 +82,12 @@ describe('Keep zero facets tests', () => {
         MacOS: 1,
       },
     })
-
     expect(moviesGenresRes.facets).toEqual({
       color: {
         green: 1,
         red: 1,
       },
     })
-
     expect(moviesColorRes.facets).toEqual({
       genres: {
         Adventure: 1,
@@ -193,14 +192,12 @@ describe('Keep zero facets tests', () => {
         MacOS: 1,
       },
     })
-
     expect(moviesGenresRes.facets).toEqual({
       color: {
         green: 1,
         red: 1,
       },
     })
-
     expect(moviesColorRes.facets).toEqual({
       genres: {
         Adventure: 1,
@@ -356,7 +353,6 @@ describe('Keep zero facets tests', () => {
         MacOS: 1,
       },
     })
-
     expect(moviesGenresRes.facets).toEqual({
       color: {
         green: 1,