Merge #408

408: Add snippet/highlight/pagination integration tests r=bidoubiwa a=bidoubiwa see #389 Unit tests have also been added see: #387 Co-authored-by: Charlotte Vermandel <charlottevermandel@gmail.com>
meilisearch · May 25, 2021 · 300b7bb · 300b7bb
2 parents af194db + ed06520
commit 300b7bb
Show file tree

Hide file tree

Showing 6 changed files with 502 additions and 3 deletions.
diff --git a/src/types/types.ts b/src/types/types.ts
@@ -35,7 +35,11 @@ export type IMResponse = {
   nbPages?: number
 }
 
-export type SearchResponse = IStypes.SearchResponse & IMResponse
+export type SearchResponse = Omit<IStypes.SearchResponse, 'hits'> &
+  IStypes.SearchResponse &
+  IMResponse & {
+    hits: ISHits[]
+  }
 
 export type InstantMeiliSearchContext = {
   page: number

diff --git a/tests/assets/utils.ts b/tests/assets/utils.ts
@@ -37,6 +37,22 @@ const dataset = [
     poster: 'https://image.tmdb.org/t/p/w500/6FfCtAuVAW8XJjZ7eWeLibRLWTw.jpg',
     release_date: 233366400,
   },
+  {
+    id: 30,
+    title: 'Magnetic Rose',
+    overview: '',
+    genres: ['Animation', 'Science Fiction'],
+    poster: 'https://image.tmdb.org/t/p/w500/gSuHDeWemA1menrwfMRChnSmMVN.jpg',
+    release_date: 819676800,
+  },
+  {
+    id: 24,
+    title: 'Kill Bill: Vol. 1',
+    overview: null,
+    genres: ['Action', 'Crime'],
+    poster: 'https://image.tmdb.org/t/p/w500/v7TaX8kXMXs5yFFGR41guUDNcnB.jpg',
+    release_date: 1065744000,
+  },
 ]
 
 export type Movies = {

diff --git a/tests/facetsDistribution.tests.ts b/tests/facetsDistribution.tests.ts
@@ -41,7 +41,7 @@ describe('Instant MeiliSearch Browser test', () => {
         },
       },
     ])
-    expect(response.results[0].facets?.genres?.Action).toEqual(2)
+    expect(response.results[0].facets?.genres?.Action).toEqual(3)
   })
 
   test('Test non-existent facets on facetsDistribution', async () => {
@@ -54,6 +54,6 @@ describe('Instant MeiliSearch Browser test', () => {
         },
       },
     ])
-    expect(response.results[0].facets?.genres?.Action).toEqual(2)
+    expect(response.results[0].facets?.genres?.Action).toEqual(3)
   })
 })
diff --git a/tests/highlight.tests.ts b/tests/highlight.tests.ts
@@ -0,0 +1,197 @@
+import { searchClient, dataset } from './assets/utils'
+
+describe('Highlight Browser test', () => {
+  beforeAll(async () => {
+    try {
+      await searchClient.MeiliSearchClient.deleteIndex('movies')
+    } catch (e) {
+      // movies does not exist
+    }
+    await searchClient.MeiliSearchClient.index(
+      'movies'
+    ).updateAttributesForFaceting(['genres'])
+    const moviesUpdate = await searchClient.MeiliSearchClient.index(
+      'movies'
+    ).addDocuments(dataset)
+    await searchClient.MeiliSearchClient.index('movies').waitForPendingUpdate(
+      moviesUpdate.updateId
+    )
+  })
+
+  test('Test one attributesToHighlight on placeholder', async () => {
+    const response = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          query: '',
+          attributesToHighlight: ['name'],
+        },
+      },
+    ])
+    const resKeys = Object.keys(response.results[0].hits[0]._highlightResult)
+    expect(resKeys).toEqual(expect.arrayContaining(Object.keys(dataset[0])))
+  })
+
+  test('Test no attributesToHighlight on placeholder', async () => {
+    const response = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          query: '',
+          attributesToHighlight: [],
+        },
+      },
+    ])
+    const resKeys = Object.keys(response.results[0].hits[0]._highlightResult)
+    expect(resKeys).toEqual(expect.arrayContaining(Object.keys(dataset[0])))
+  })
+
+  test('Test one attributesToHighlight on specific query', async () => {
+    const response = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          query: 'Ar',
+          attributesToHighlight: ['title'],
+        },
+      },
+    ])
+    //
+    const highlightedResults = response.results[0].hits[0]._highlightResult
+    const resKeys = Object.keys(highlightedResults)
+    expect(resKeys).toEqual(expect.arrayContaining(Object.keys(dataset[0])))
+    expect(highlightedResults.title?.value).toEqual(
+      '__ais-highlight__Ar__/ais-highlight__iel'
+    )
+  })
+
+  test('Test two attributesToHighlight on specific query', async () => {
+    const response = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          query: 'S',
+          attributesToHighlight: ['title', 'overview'],
+        },
+      },
+    ])
+
+    const highlightedResults = response.results[0].hits[0]._highlightResult
+    const resKeys = Object.keys(highlightedResults)
+    expect(resKeys).toEqual(expect.arrayContaining(Object.keys(dataset[0])))
+    expect(highlightedResults.title?.value).toEqual(
+      '__ais-highlight__S__/ais-highlight__tar Wars'
+    )
+    expect(highlightedResults.overview?.value).toEqual(
+      expect.stringMatching('__ais-highlight__S__/ais-highlight__kywalker')
+    )
+  })
+
+  test('Test two attributesToHighlight on specific query with empty string value', async () => {
+    const response = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          query: 'Magnetic',
+          attributesToHighlight: ['title', 'overview'],
+        },
+      },
+    ])
+
+    const highlightedResults = response.results[0].hits[0]._highlightResult
+    const resKeys = Object.keys(highlightedResults)
+    expect(resKeys).toEqual(expect.arrayContaining(Object.keys(dataset[0])))
+    expect(highlightedResults.title?.value).toEqual(
+      '__ais-highlight__Magnetic__/ais-highlight__ Rose'
+    )
+    expect(highlightedResults.overview?.value).toEqual(
+      expect.not.stringMatching('__ais-highlight__Magnetic__/ais-highlight__')
+    )
+  })
+
+  test('Test two attributesToHighlight on specific query with null value', async () => {
+    const response = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          query: 'Magnetic',
+          attributesToHighlight: ['title', 'overview'],
+        },
+      },
+    ])
+    const highlightedResults = response.results[0].hits[0]._highlightResult
+    const resKeys = Object.keys(highlightedResults)
+    expect(resKeys).toEqual(expect.arrayContaining(Object.keys(dataset[0])))
+    expect(highlightedResults.title?.value).toEqual(
+      '__ais-highlight__Magnetic__/ais-highlight__ Rose'
+    )
+    expect(highlightedResults.overview?.value).toEqual(
+      expect.not.stringMatching('__ais-highlight__Magnetic__/ais-highlight__')
+    )
+  })
+
+  test('Test two attributesToHighlight on specific query with null value', async () => {
+    const response = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          query: 'Magnetic',
+          attributesToHighlight: ['title', 'overview'],
+        },
+      },
+    ])
+    const highlightedResults = response.results[0].hits[0]._highlightResult
+    const resKeys = Object.keys(highlightedResults)
+    expect(resKeys).toEqual(expect.arrayContaining(Object.keys(dataset[0])))
+    expect(highlightedResults.title?.value).toEqual(
+      '__ais-highlight__Magnetic__/ais-highlight__ Rose'
+    )
+    expect(highlightedResults.overview?.value).toEqual(
+      expect.not.stringMatching('__ais-highlight__Magnetic__/ais-highlight__')
+    )
+  })
+
+  test('Test two attributesToHighlight on wild card', async () => {
+    const response = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          query: 'S',
+          attributesToHighlight: ['title', 'overview'],
+        },
+      },
+    ])
+
+    const highlightedResults = response.results[0].hits[0]._highlightResult
+    const resKeys = Object.keys(highlightedResults)
+    expect(resKeys).toEqual(expect.arrayContaining(Object.keys(dataset[0])))
+    expect(highlightedResults.title?.value).toEqual(
+      '__ais-highlight__S__/ais-highlight__tar Wars'
+    )
+    expect(highlightedResults.overview?.value).toEqual(
+      expect.stringMatching('__ais-highlight__S__/ais-highlight__kywalker')
+    )
+  })
+
+  test('Test two attributesToHighlight with different tags', async () => {
+    const response = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          query: 'S',
+          attributesToHighlight: ['title', 'overview'],
+          highlightPreTag: '<p>',
+          highlightPostTag: '</p>',
+        },
+      },
+    ])
+
+    const highlightedResults = response.results[0].hits[0]._highlightResult
+    const resKeys = Object.keys(highlightedResults)
+    expect(resKeys).toEqual(expect.arrayContaining(Object.keys(dataset[0])))
+    expect(highlightedResults.title?.value).toEqual('<p>S</p>tar Wars')
+    expect(highlightedResults.overview?.value).toEqual(
+      expect.stringMatching('<p>S</p>olo')
+    )
+  })
+})
diff --git a/tests/pagination.tests.ts b/tests/pagination.tests.ts
@@ -0,0 +1,99 @@
+import { searchClient, dataset } from './assets/utils'
+
+describe('Pagination browser test', () => {
+  beforeAll(async () => {
+    try {
+      await searchClient.MeiliSearchClient.deleteIndex('movies')
+    } catch (e) {
+      // movies does not exist
+    }
+    await searchClient.MeiliSearchClient.index(
+      'movies'
+    ).updateAttributesForFaceting(['genres'])
+    const moviesUpdate = await searchClient.MeiliSearchClient.index(
+      'movies'
+    ).addDocuments(dataset)
+    await searchClient.MeiliSearchClient.index('movies').waitForPendingUpdate(
+      moviesUpdate.updateId
+    )
+  })
+
+  test('Test 1 hitsPerPage', async () => {
+    const response = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          query: '',
+          hitsPerPage: 1,
+        },
+      },
+    ])
+    const hits = response.results[0].hits
+    expect(hits.length).toBe(1)
+    expect(hits[0].title).toBe('Ariel')
+  })
+
+  test('Test 1 hitsPerPage w/ page 0 ', async () => {
+    const response = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          query: '',
+          hitsPerPage: 1,
+          page: 0,
+        },
+      },
+    ])
+    const hits = response.results[0].hits
+    expect(hits.length).toBe(1)
+    expect(hits[0].title).toBe('Ariel')
+  })
+
+  test('Test 1 hitsPerPage w/ page 1 ', async () => {
+    const response = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          query: '',
+          hitsPerPage: 1,
+          page: 1,
+        },
+      },
+    ])
+    const hits = response.results[0].hits
+    expect(hits.length).toBe(1)
+    expect(hits[0].title).toBe('Four Rooms')
+  })
+
+  test('Test 100 hitsPerPage w/ page 1 ', async () => {
+    const response = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          query: '',
+          hitsPerPage: 100,
+          page: 1,
+        },
+      },
+    ])
+    const hits = response.results[0].hits
+    expect(hits.length).toBe(0)
+    expect(hits).toEqual([])
+  })
+
+  test('Test 0 hitsPerPage w/ page 0 ', async () => {
+    const response = await searchClient.search([
+      {
+        indexName: 'movies',
+        params: {
+          query: '',
+          hitsPerPage: 0,
+          page: 0,
+        },
+      },
+    ])
+    const hits = response.results[0].hits
+    expect(hits.length).toBe(0)
+    expect(hits).toEqual([])
+  })
+})