Add crop marker support (#738)

* Fix tests related to changes in Meilisearch

* Update tests based on placeholder search resolution

* Add crop marker support

Author: bidoubiwa

package.json

@@ -57,7 +57,7 @@
     "url": "https://github.com/meilisearch/instant-meilisearch.git"
   },
   "dependencies": {
-    "meilisearch": "0.25.0"
+    "meilisearch": "^0.26.0-beta.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.17.6",

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

@@ -31,6 +31,12 @@ export function adaptSearchParams(
     meiliSearchParams.attributesToCrop = attributesToCrop
   }
 
+  // Attributes To Crop marker
+  const cropMarker = searchContext?.snippetEllipsisText
+  if (cropMarker != null) {
+    meiliSearchParams.cropMarker = cropMarker
+  }
+
   // Attributes To Retrieve
   const attributesToRetrieve = searchContext?.attributesToRetrieve
   if (attributesToRetrieve) {

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

@@ -1,5 +1,4 @@
 import { adaptHighlight } from './highlight-adapter'
-import { adaptSnippet } from './snippet-adapter'
 import { SearchContext } from '../../../types'
 
 /**
@@ -13,24 +12,16 @@ export function adaptFormating(
   hit: Record<string, any>,
   searchContext: SearchContext
 ): Record<string, any> {
-  const attributesToSnippet = searchContext?.attributesToSnippet
-  const ellipsis = searchContext?.snippetEllipsisText
   const preTag = searchContext?.highlightPreTag
   const postTag = searchContext?.highlightPostTag
 
   if (!hit._formatted) return {}
-  const _highlightResult = adaptHighlight(hit, preTag, postTag)
-
-  // what is ellipsis by default
-  const _snippetResult = adaptHighlight(
-    adaptSnippet(hit, attributesToSnippet, ellipsis),
-    preTag,
-    postTag
-  )
+  const _formattedResult = adaptHighlight(hit, preTag, postTag)
 
   const highlightedHit = {
-    _highlightResult,
-    _snippetResult,
+    // We could not determine what the differences are between those two fields.
+    _highlightResult: _formattedResult,
+    _snippetResult: _formattedResult,
   }
 
   return highlightedHit

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

@@ -81,6 +81,7 @@ export type SearchContext = Omit<
 > & {
   insideBoundingBox?: InsideBoundingBox
   keepZeroFacets?: boolean
+  cropMarker?: string
   defaultFacetDistribution: FacetsDistribution
   pagination: PaginationContext
 }

src/types/types.ts

@@ -13,13 +13,13 @@ const dataset = [
     undefinedArray: [undefined, undefined, undefined],
     nullArray: [null, null, null],
     objectArray: [
-      { name: 'charlotte' },
-      { name: 'charlotte' },
-      { name: 'charlotte' },
+      { name: 'hello world' },
+      { name: 'hello world' },
+      { name: 'hello world' },
     ],
     object: {
       id: 1,
-      name: 'Nader',
+      name: 'One two',
     },
     nullField: null,
   },
@@ -34,13 +34,13 @@ const dataset = [
     undefinedArray: [undefined, undefined, undefined],
     nullArray: [null, null, null],
     objectArray: [
-      { name: 'charlotte' },
-      { name: 'charlotte' },
-      { name: 'charlotte' },
+      { name: 'hello world' },
+      { name: 'hello world' },
+      { name: 'hello world' },
     ],
     object: {
       id: 1,
-      name: 'Nader',
+      name: 'One two',
     },
     nullField: null,
   },
@@ -55,13 +55,13 @@ const dataset = [
     undefinedArray: [undefined, undefined, undefined],
     nullArray: [null, null, null],
     objectArray: [
-      { name: 'charlotte' },
-      { name: 'charlotte' },
-      { name: 'charlotte' },
+      { name: 'hello world' },
+      { name: 'hello world' },
+      { name: 'hello world' },
     ],
     object: {
       id: 1,
-      name: 'Nader',
+      name: 'One two',
     },
     nullField: null,
   },

tests/assets/utils.ts

@@ -261,14 +261,14 @@ describe('Highlight Browser test', () => {
 
     if (hit?.objectArray) {
       // @ts-ignore
-      expect(hit?.objectArray[0]?.value).toEqual('{"name":"charlotte"}')
+      expect(hit?.objectArray[0]?.value).toEqual('{"name":"hello world"}')
       // @ts-ignore
-      expect(hit?.objectArray[1]?.value).toEqual('{"name":"charlotte"}')
+      expect(hit?.objectArray[1]?.value).toEqual('{"name":"hello world"}')
     }
 
     if (hit?.object) {
       // @ts-ignore
-      expect(hit?.object?.value).toEqual('{"id":"1","name":"Nader"}')
+      expect(hit?.object?.value).toEqual('{"id":"1","name":"One two"}')
     }
 
     if (hit?.nullField) {