Add integration and unit tests on filters

Author: bidoubiwa

src/adapter/index.ts

@@ -1,4 +1,5 @@
 export * from './to-meilisearch-params'
+export * from './to-meilisearch-filters'
 export * from './to-instantsearch-response'
 export * from './to-instantsearch-hits'
 export * from './to-instantsearch-highlight'

src/adapter/to-meilisearch-params.ts

@@ -1,4 +1,5 @@
 import { AdaptToMeiliSearchParams } from '../types'
+import { mergeFiltersAndNumericFilters } from './to-meilisearch-filters'
 
 export const adaptToMeiliSearchParams: AdaptToMeiliSearchParams = function (
   {
@@ -14,10 +15,7 @@ export const adaptToMeiliSearchParams: AdaptToMeiliSearchParams = function (
   { paginationTotalHits, placeholderSearch }
 ) {
   const limit = paginationTotalHits
-  const filter = [numericFilters.join(' AND '), filters.trim()]
-    .filter((x) => x)
-    .join(' AND ')
-    .trim()
+  const filter = mergeFiltersAndNumericFilters(filters, numericFilters)
 
   // Creates search params object compliant with MeiliSearch
   return {

src/transformers/__tests__/filters.tests.ts

@@ -0,0 +1,52 @@
+import { mergeFiltersAndNumericFilters } from '../'
+
+const filtersTestsParameters = [
+  {
+    filters: '',
+    numericFilters: [],
+    returnFilter: '',
+  },
+  {
+    filters: 'hello = hello',
+    numericFilters: [],
+    returnFilter: '(hello = hello)',
+  },
+  {
+    filters: '(hello = hello AND (hello1 = hello1 OR hello2 = hello2))',
+    numericFilters: [],
+    returnFilter: '((hello = hello AND (hello1 = hello1 OR hello2 = hello2)))',
+  },
+  {
+    filters: '(hello = hello AND (hello1 = hello1 OR hello2 = hello2))',
+    numericFilters: [],
+    returnFilter: '((hello = hello AND (hello1 = hello1 OR hello2 = hello2)))',
+  },
+  {
+    filters: '',
+    numericFilters: [' 1 < hello ', ' hello < 2 '],
+    returnFilter: '1 < hello AND hello < 2',
+  },
+  {
+    filters: ' ',
+    numericFilters: [' ', ' '],
+    returnFilter: '',
+  },
+  {
+    filters: 'hello = hello AND hello1 = hello1',
+    numericFilters: [' 1 < hello ', ' hello < 2 '],
+    returnFilter:
+      '1 < hello AND hello < 2 AND (hello = hello AND hello1 = hello1)',
+  },
+]
+
+describe.each(filtersTestsParameters)(
+  'Filter tests',
+  ({ filters, numericFilters, returnFilter }) => {
+    it(`Should return ${returnFilter} pages when filter is ${filters} and Numeric Filters is ${JSON.stringify(
+      numericFilters
+    )}`, () => {
+      const response = mergeFiltersAndNumericFilters(filters, numericFilters)
+      expect(response).toBe(returnFilter)
+    })
+  }
+)

src/transformers/to-meilisearch-filters.ts

@@ -0,0 +1,23 @@
+import { MergeFiltersAndNumericFilters } from '../types'
+
+const mergeFiltersAndNumericFilters: MergeFiltersAndNumericFilters = (
+  filters,
+  numericFilters
+) => {
+  const trimFilters = filters ? filters.trim() : ''
+  const enClosedFilter = trimFilters ? `(${trimFilters})` : ''
+  const joinedNumericFilters = numericFilters
+    ? numericFilters
+        .map((filter) => filter.trim())
+        .filter((x) => x)
+        .join(' AND ')
+    : ''
+
+  const filter = [joinedNumericFilters, enClosedFilter]
+    .filter((x) => x)
+    .join(' AND ')
+    .trim()
+  return filter
+}
+
+export { mergeFiltersAndNumericFilters }

src/types/types.ts

@@ -71,6 +71,11 @@ export type ReplaceHighlightTags = (
   highlightPostTag?: string
 ) => string
 
+export type MergeFiltersAndNumericFilters = (
+  filters?: string,
+  numericFilters?: string[]
+) => string
+
 export type CreateSnippetResult = (
   snippetsParams: HighLightParams & SnippetsParams & FormattedHit
 ) => { formattedHit: any } & IMSearchParams

tests/configure.filters.tests.ts

@@ -0,0 +1,80 @@
+import { searchClient, dataset, Movies } from './assets/utils'
+
+describe('Instant MeiliSearch Browser test', () => {
+  beforeAll(async () => {
+    try {
+      await searchClient.MeiliSearchClient.deleteIndex('movies')
+    } catch (e) {
+      // movies does not exist
+    }
+    const moviesUpdate = await searchClient.MeiliSearchClient.index(
+      'movies'
+    ).addDocuments(dataset)
+    await searchClient.MeiliSearchClient.index('movies').waitForPendingUpdate(
+      moviesUpdate.updateId
+    )
+  })
+
+  test('Test multiple filters', async () => {
+    const response = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          filters:
+            'title = "Four Rooms" OR title = "Ariel" AND release_date > 593395200',
+          query: '',
+        },
+      },
+    ])
+
+    const hit = <Movies>response.results[0].hits[0]
+    expect(hit.title).toEqual('Four Rooms')
+  })
+
+  test('Test empty', async () => {
+    const response = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          filters: '',
+          query: '',
+        },
+      },
+    ])
+
+    const hit = <Movies>response.results[0].hits[0]
+    expect(hit.title).toEqual('Ariel')
+  })
+
+  test('Test multiple filters', async () => {
+    const response = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          filters: 'title = "Four Rooms" OR title = "Ariel"',
+          numericFilters: ['release_date > 593395200'],
+          query: '',
+        },
+      },
+    ])
+
+    const hit = <Movies>response.results[0].hits[0]
+    expect(hit.title).toEqual('Four Rooms')
+  })
+
+  test('Only numeric filters', async () => {
+    const response = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          filters: 'title = "Four Rooms" OR title = "Ariel"',
+          numericFilters: ['release_date > 593395200'],
+          query: '',
+        },
+      },
+    ])
+
+    const hit = <Movies>response.results[0].hits[0]
+    expect(hit.title).toEqual('Four Rooms')
+  })
+})