Merge #1161

1161: Fix bug when sort-by contains geo points r=bidoubiwa a=bidoubiwa

Fixes: #1159 

The old implementation did not take into account that a sorting rule could contain the `,` character and naively splited on that char.

Which resulted in 

```
"indexName:_geoPoint(37.8153, -122.4784):asc"
```

Being transformed into:
```
[
      "indexName:_geoPoint(37.8153",
      "-122.4784):asc"
 ]
```

Instead of splitting solely on `,`, we now split on a coma if it is prepended by `asc` or `desc`.

Co-authored-by: Charlotte Vermandel <[email protected]>
Co-authored-by: cvermand <[email protected]>

Author: meili-bors[bot]

.changeset/dirty-mangos-tie.md

@@ -0,0 +1,5 @@
+---
+"@meilisearch/instant-meilisearch": patch
+---
+
+Fix bug where sort-by failed on geo_points

packages/instant-meilisearch/__tests__/sort.test.ts

@@ -5,6 +5,8 @@ import {
   meilisearchClient,
 } from './assets/utils'
 
+import { splitSortString } from '../src/contexts/sort-context'
+
 describe('Sort browser test', () => {
   beforeAll(async () => {
     const deleteTask = await meilisearchClient.deleteIndex('movies')
@@ -48,4 +50,28 @@ describe('Sort browser test', () => {
     const hits = response.results[0].hits
     expect(hits.length).toBe(1)
   })
+
+  test('split multiple sorting rules', () => {
+    const sortRules = splitSortString(
+      '_geoPoint(37.8153, -122.4784):asc,title:asc,description:desc'
+    )
+
+    expect(sortRules).toEqual([
+      '_geoPoint(37.8153, -122.4784):asc',
+      'title:asc',
+      'description:desc',
+    ])
+  })
+
+  test('split one sorting rule', () => {
+    const sortRules = splitSortString('_geoPoint(37.8153, -122.4784):asc')
+
+    expect(sortRules).toEqual(['_geoPoint(37.8153, -122.4784):asc'])
+  })
+
+  test.only('split no sorting rule', () => {
+    const sortRules = splitSortString('')
+
+    expect(sortRules).toEqual([])
+  })
 })

packages/instant-meilisearch/src/contexts/search-context.ts

@@ -3,9 +3,25 @@ import {
   AlgoliaMultipleQueriesQuery,
   SearchContext,
 } from '../types'
-
+import { splitSortString } from './sort-context'
 import { createPaginationState } from './pagination-context'
-import { createSortState } from './sort-context'
+
+function separateIndexFromSortRules(indexName: string): {
+  indexUid: string
+  sortBy: string
+} {
+  const colonIndex = indexName.indexOf(':')
+  if (colonIndex === -1) {
+    return {
+      indexUid: indexName,
+      sortBy: '',
+    }
+  }
+  return {
+    indexUid: indexName.substring(0, colonIndex),
+    sortBy: indexName.substring(colonIndex + 1),
+  }
+}
 
 /**
  * @param  {AlgoliaMultipleQueriesQuery} searchRequest
@@ -16,23 +32,21 @@ export function createSearchContext(
   searchRequest: AlgoliaMultipleQueriesQuery,
   options: InstantMeiliSearchOptions
 ): SearchContext {
+  const { query, indexName, params: instantSearchParams } = searchRequest
   // Split index name and possible sorting rules
-  const [indexUid, ...sortByArray] = searchRequest.indexName.split(':')
-  const { query, params: instantSearchParams } = searchRequest
+  const { indexUid, sortBy } = separateIndexFromSortRules(indexName)
 
   const paginationState = createPaginationState(
     options.finitePagination,
     instantSearchParams?.hitsPerPage,
     instantSearchParams?.page
   )
 
-  const sortState = createSortState(sortByArray.join(':'))
-
   const searchContext: SearchContext = {
     ...options,
     query,
     ...instantSearchParams,
-    sort: sortState,
+    sort: splitSortString(sortBy),
     indexUid,
     pagination: paginationState,
     placeholderSearch: options.placeholderSearch !== false, // true by default

packages/instant-meilisearch/src/contexts/sort-context.ts

@@ -1,10 +1,22 @@
 /**
- * @param {string} rawSort
+ * Split sort string into an array.
+ *
+ * Example:
+ * '_geoPoint(37.8153, -122.4784):asc,title:asc,description:desc'
+ *
+ * becomes:
+ * [
+ * '_geoPoint(37.8153, -122.4784):asc',
+ * 'title:asc',
+ * 'description:desc',
+ * ]
+ *
+ * @param {string} sortStr
  * @returns {string[]}
  */
-export function createSortState(rawSort: string): string[] {
-  return rawSort
-    .split(',')
-    .map((sort) => sort.trim())
-    .filter((sort) => !!sort)
+export function splitSortString(sortStr: string): string[] {
+  if (!sortStr) return []
+  const sortRules = sortStr.split(/,(?=\w+:(?:asc|desc))/)
+
+  return sortRules
 }