Fix keepZeroFacets on disjunctive facet search #918

bidoubiwa · 2022-12-12T17:37:59Z

Since introducing the multi-index search here #888 the setting keepZeroFacets was broken.

This PR introduces the fix to this issue

Dec-13-2022.17-12-15.mp4

What was done in this pr:

keepZeroFacet management has been moved to the response adapter instead of the request adapter
Filtering methods and filtering tests were removed as the new facet distribution management has completely changed
defaultFacetDistribution is renamed initialFacetDistribution and contains the distribution of an index without any other requests
Initialization of facet distribution was moved from client to its own file

Playgrounds:

New SingleMovieIndex playground to create a new environment for testing
Updated SingleIndex with keepZeroFacets
Updated MultiIndex with keepZeroFacets

bidoubiwa · 2022-12-12T17:42:13Z

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

-      if (searchContext.keepZeroFacets) {
-        const cachedFacets = extractFacets(searchContext, searchParams)
-
-        // Add missing facets back into facetDistribution
-        searchResponse.facetDistribution = addMissingFacets(
-          cachedFacets,
-          searchResponse.facetDistribution
-        )
-      }
-


Moved as it should be in the response adapter

bidoubiwa · 2022-12-13T16:17:56Z

src/client/instant-meilisearch-client.ts

-          // 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 === undefined) {
-            defaultFacetDistribution = await cacheFirstFacetDistribution(
-              searchResolver,
-              searchContext
-            )
-            searchContext.defaultFacetDistribution = defaultFacetDistribution
-          }


removed to its own file init-facet-distribution.ts

bidoubiwa · 2022-12-13T16:18:18Z

src/client/instant-meilisearch-client.ts

  const searchResolver = SearchResolver(meilisearchClient, searchCache)

-  let defaultFacetDistribution: FacetDistribution
+  let initialFacetDistribution: Record<string, FacetDistribution>


Changed name to better understand what it contains

bidoubiwa · 2022-12-13T16:19:33Z

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

-  return {
-    results: [adaptedSearchResponse],
-  }
+  return adaptedSearchResponse


return value was changed as this is legacy that made the process weird

bidoubiwa · 2022-12-13T16:21:02Z

src/client/instant-meilisearch-client.ts

+            searchContext,
+            initialFacetDistribution[searchRequest.indexName]


removed initialFacetDistribution from the searchContext as it is not correlated to the current search request but as value for the whole instance

bidoubiwa · 2022-12-13T16:21:15Z

src/contexts/search-context.ts

    sort: sortByArray.join(':') || '',
    indexUid,
    pagination: paginationState,
-    defaultFacetDistribution: defaultFacetDistribution || {},


removed defaultFacetDistribution from the searchContext as it is not correlated to the current search request but as value for the whole instance.

bidoubiwa · 2022-12-13T16:21:46Z

src/types/types.ts

+
 export type SearchContext = Omit<InstantSearchParams, 'insideBoundingBox'> &
  InstantSearchParams & {
-    defaultFacetDistribution: FacetDistribution


removed defaultFacetDistribution from the searchContext as it is not correlated to the current search request but as value for the whole instance.

bidoubiwa · 2022-12-13T16:22:53Z

src/types/types.ts

  nbPages: number
 }

+export type Facets = string | string[] | undefined


Creation of own Facets type as the one from instant-search does not represent the reality.

instant-search may provide only a string as a Facets but the type states that it only accepts string[] | undefined.

See this issue

bidoubiwa · 2022-12-13T17:48:54Z

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

  SearchCacheInterface,
  MeiliSearchParams,
 } from '../../types'
-import { addMissingFacets, extractFacets } from './filters'


removed as facet managements has changed and moved to the response adapter

brunoocasali

I left some comments that can be done in a new PR maybe, I don't want to block the merge :)

LGTM!

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

bidoubiwa · 2022-12-15T11:58:01Z

bors merge

meili-bors · 2022-12-15T12:00:14Z

Build succeeded:

bidoubiwa commented Dec 12, 2022

View reviewed changes

bidoubiwa force-pushed the fix_keep_zero_facets branch from 290371a to a4a845a Compare December 13, 2022 16:11

bidoubiwa commented Dec 13, 2022

View reviewed changes

bidoubiwa force-pushed the fix_keep_zero_facets branch from cf5ffe0 to 0d1b9ea Compare December 13, 2022 17:47

bidoubiwa commented Dec 13, 2022

View reviewed changes

Fix keepZeroFacets on disjunctive facet search

568531e

bidoubiwa force-pushed the fix_keep_zero_facets branch 3 times, most recently from 63cc33a to 8f1e01c Compare December 13, 2022 19:00

bidoubiwa marked this pull request as ready for review December 14, 2022 15:13

bidoubiwa force-pushed the fix_keep_zero_facets branch from 8f1e01c to 78d8870 Compare December 14, 2022 15:13

brunoocasali approved these changes Dec 14, 2022

View reviewed changes

src/adapter/search-response-adapter/facet-distribution-adapter.ts Outdated Show resolved Hide resolved

src/adapter/search-response-adapter/facet-distribution-adapter.ts Show resolved Hide resolved

bidoubiwa added 2 commits December 15, 2022 12:55

Rename defaultFacetDistribution to initialFacetDistribution

9b13454

Upgrade playgrounds to include keepZeroFacets and multi-index

40a13a7

bidoubiwa force-pushed the fix_keep_zero_facets branch from 2927583 to 40a13a7 Compare December 15, 2022 11:55

meili-bors bot merged commit f836516 into beta/multi-index-search Dec 15, 2022

meili-bors bot deleted the fix_keep_zero_facets branch December 15, 2022 12:00

bidoubiwa mentioned this pull request Dec 15, 2022

Add multi index and disjunctive facet search #888

Merged

9 tasks

		searchContext,
		initialFacetDistribution[searchRequest.indexName]

Fix keepZeroFacets on disjunctive facet search #918

Fix keepZeroFacets on disjunctive facet search #918

Uh oh!

Conversation

bidoubiwa commented Dec 12, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bidoubiwa Dec 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bidoubiwa Dec 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

brunoocasali left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bidoubiwa commented Dec 15, 2022

Uh oh!

meili-bors bot commented Dec 15, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bidoubiwa commented Dec 12, 2022 •

edited

Loading

bidoubiwa Dec 13, 2022 •

edited

Loading

bidoubiwa Dec 13, 2022 •

edited

Loading