Merge #1314

1314: 🐛 fix: Don't overwrite object ID in geosearch response r=brunoocasali a=queer

# Pull Request

## Related issue

Fixes #1308.

## What does this PR do?

This avoids overwriting the `objectID` field if it is already present. This allows code that depends on the `objectID` returned by Meilisearch to function, while still adding it for data sets that don't have it.

This also updates `CONTRIBUTING.md` to have the right command for the geosearch playground.

## PR checklist

Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Co-authored-by: amy null <null@amy.gg>
Co-authored-by: F. Levi <55688616+flevi29@users.noreply.github.com>

Author: 3 people

.changeset/hip-geese-tell.md

@@ -0,0 +1,5 @@
+---
+"@meilisearch/instant-meilisearch": patch
+---
+
+Don't write objectID property if it already exists when adapting geosearch.

CONTRIBUTING.md

@@ -108,7 +108,7 @@ yarn playground:html
 An additional playground is provided to test out the [GeoSearch](./packages/instant-meilisearch#-geo-search).
 
 ```bash
-yarn playground:geo-javascript
+yarn playground:geosearch
 ```
 
 Note: If the Google Maps stopped working, please create a new [Google Api Key](https://developers.google.com/maps/documentation/javascript/get-api-key) and add it in the `.env` file at the root of the playground: `/playgrounds/geo-javascript`

packages/instant-meilisearch/src/adapter/search-response-adapter/__tests__/geo-adapter.test.ts

@@ -49,4 +49,29 @@ describe('Geopoint adapter', () => {
     expect(adaptedHits[1]._formatted._geoloc).toBeUndefined()
     expect(adaptedHits[1]._formatted._geo).toBeUndefined()
   })
+
+  test('hits with _geoloc field should not overwrite `objectID` property', () => {
+    const hits = [
+      {
+        objectID: '2',
+        id: 2,
+        _geo: {
+          lat: 1,
+          lng: 2,
+        },
+        _formatted: {
+          _geo: {
+            lat: 1,
+            lng: 2,
+          },
+        },
+      },
+    ]
+
+    const adaptedHits = adaptGeoResponse(hits)
+
+    expect(adaptedHits[0]._geoloc).toEqual(hits[0]._geo)
+    expect(adaptedHits[0]._geo).toEqual(hits[0]._geo)
+    expect(adaptedHits[0].objectID).toEqual(hits[0].objectID)
+  })
 })

packages/instant-meilisearch/src/adapter/search-response-adapter/geo-reponse-adapter.ts

@@ -7,12 +7,16 @@ export function adaptGeoResponse(hits: any[]): Array<Record<string, any>> {
     const objectID = `${i + Math.random() * 1000000}`
     if (hits[i]._geo) {
       hits[i]._geoloc = hits[i]._geo
-      hits[i].objectID = objectID
+      if (!hits[i].objectID) {
+        hits[i].objectID = objectID
+      }
     }
 
     if (hits[i]._formatted?._geo) {
       hits[i]._formatted._geoloc = hits[i]._formatted._geo
-      hits[i]._formatted.objectID = objectID
+      if (!hits[i]._formatted.objectID) {
+        hits[i]._formatted.objectID = objectID
+      }
     }
   }
   return hits