Merge pull request #1470 from Qwant/use_qwant_id

Use qwant_id param for poi
Qwant · Oct 17, 2023 · 6603bc8 · 6603bc8
2 parents 4442ebd + f962c04
commit 6603bc8
Show file tree

Hide file tree

Showing 12 changed files with 39 additions and 14 deletions.
diff --git a/@types/idunn.ts b/@types/idunn.ts
@@ -1178,6 +1178,8 @@ export interface components {
       type: string;
       /** Id */
       id?: string;
+      /** Qwant Id */
+      qwant_id?: string;
       /** Name */
       name?: string;
       /** Local Name */

diff --git a/src/adapters/poi/bragi_poi.js b/src/adapters/poi/bragi_poi.js
@@ -45,6 +45,7 @@ export default class BragiPoi extends Poi {
     }
 
     super(
+      id,
       id,
       name,
       type,

diff --git a/src/adapters/poi/idunn_poi.ts b/src/adapters/poi/idunn_poi.ts
@@ -34,7 +34,15 @@ export default class IdunnPoi extends Poi {
       lng: (rawPoi?.geometry?.coordinates as number[])[0],
     } as TPoi['latLon'];
 
-    super(rawPoi.id, rawPoi.name, rawPoi.type, latLng, rawPoi.class_name, rawPoi.subclass_name);
+    super(
+      rawPoi.id,
+      rawPoi.id,
+      rawPoi.name,
+      rawPoi.type,
+      latLng,
+      rawPoi.class_name,
+      rawPoi.subclass_name
+    );
     this.blocks = rawPoi.blocks;
     this.localName = rawPoi.local_name;
     this.bbox = rawPoi?.geometry?.bbox as [number, number, number, number]; // TODO: Check if there is always a bbox on Idunn Place
@@ -115,11 +123,12 @@ export default class IdunnPoi extends Poi {
   static async poiApiLoad(
     obj: {
       id?: string;
+      qwant_id?: string;
       queryContext?: TQueryContext;
     },
     options: { simple?: boolean } = {}
   ) {
-    const url = `${serviceConfig.idunn.url}/v1/places/${obj.id}`;
+    const url = `${serviceConfig.idunn.url}/v1/places/${obj.qwant_id}`;
     let requestParams = {};
     if (options.simple) {
       requestParams = { verbosity: 'list' };

diff --git a/src/adapters/poi/latlon_poi.ts b/src/adapters/poi/latlon_poi.ts
@@ -14,7 +14,7 @@ export default class LatLonPoi extends Poi {
     if (!label) {
       label = `${lnglat.lat.toFixed(5)} : ${lnglat.lng.toFixed(5)}`;
     }
-    super(id, label, undefined, lnglat, undefined, undefined);
+    super(id, id, label, undefined, lnglat, undefined, undefined);
     this.type = 'latlon';
   }
 }
diff --git a/src/adapters/poi/map_poi.js b/src/adapters/poi/map_poi.js
@@ -3,8 +3,14 @@ import Poi, { POI_TYPE } from './poi';
 
 export default class MapPoi extends Poi {
   constructor(feature) {
-    const { global_id, ['class']: className, subclass: subClassName, name } = feature.properties;
+    const {
+      global_id,
+      ['class']: className,
+      subclass: subClassName,
+      name,
+      qwant_id,
+    } = feature.properties;
     const ll = LngLat.convert(feature.geometry.coordinates);
-    super(global_id || feature.id, name, POI_TYPE, ll, className, subClassName);
+    super(global_id || feature.id, qwant_id, name, POI_TYPE, ll, className, subClassName);
   }
 }
diff --git a/src/adapters/poi/poi.ts b/src/adapters/poi/poi.ts
@@ -7,6 +7,7 @@ export const POI_TYPE = 'poi';
 
 export type TPoi = {
   id?: string;
+  qwant_id?: string;
   name?: string;
   type?: string;
   latLon?: LngLat;
@@ -17,6 +18,7 @@ export type TPoi = {
 
 export default class Poi {
   id: TPoi['id'];
+  qwant_id: TPoi['qwant_id'];
   name: TPoi['name'];
   type: TPoi['type'];
   latLon: TPoi['latLon'];
@@ -26,6 +28,7 @@ export default class Poi {
 
   constructor(
     id: TPoi['id'],
+    qwant_id: TPoi['qwant_id'],
     name: TPoi['name'],
     type: TPoi['type'],
     latLon: TPoi['latLon'],
@@ -34,6 +37,7 @@ export default class Poi {
     bbox?: TPoi['bbox']
   ) {
     this.id = id;
+    this.qwant_id = qwant_id;
     this.name = name;
     this.type = type;
     this.latLon = latLon;
@@ -43,7 +47,7 @@ export default class Poi {
   }
 
   static deserialize(raw: TPoi) {
-    const { id, name, type, latLon, className, subClassName, bbox } = raw;
-    return new Poi(id, name, type, latLon, className, subClassName, bbox);
+    const { id, qwant_id, name, type, latLon, className, subClassName, bbox } = raw;
+    return new Poi(id, qwant_id, name, type, latLon, className, subClassName, bbox);
   }
 }
diff --git a/src/adapters/poi/specials/navigator_geolocalisation_poi.js b/src/adapters/poi/specials/navigator_geolocalisation_poi.js
@@ -12,7 +12,7 @@ export const navigatorGeolocationStatus = {
 };
 export default class NavigatorGeolocalisationPoi extends Poi {
   constructor() {
-    super('geolocalisation', _('Your position', 'direction'), 'geoloc');
+    super('geolocalisation', 'geolocalisation', _('Your position', 'direction'), 'geoloc');
     this.status = navigatorGeolocationStatus.UNKNOWN;
   }
 

diff --git a/src/adapters/poi_popup.js b/src/adapters/poi_popup.js
@@ -67,7 +67,10 @@ PoiPopup.prototype.addListener = function (layer) {
 };
 
 PoiPopup.prototype.createOSMPopup = async function (layerPoi, event) {
-  const poi = await ApiPoi.poiApiLoad({ id: layerPoi.properties.global_id }, { simple: true });
+  const poi = await ApiPoi.poiApiLoad(
+    { id: layerPoi.properties.global_id, qwant_id: layerPoi.properties.qwant_id },
+    { simple: true }
+  );
   if (poi) {
     this.showPopup(poi, event);
   }

diff --git a/src/adapters/scene.js b/src/adapters/scene.js
@@ -321,7 +321,6 @@ Scene.prototype.initMapBox = function ({ locationHash, bbox }) {
 Scene.prototype.clickOnMap = function (lngLat, clickedFeature, { longTouch = false } = {}) {
   // Instantiate the place clicked as a PoI
   const poi = clickedFeature ? new MapPoi(clickedFeature) : new LatLonPoi(lngLat);
-
   if (document.querySelector('.directions-open')) {
     // If Direction panel is open, tell it to fill its fields with this PoI
     fire('set_direction_point', poi);

diff --git a/src/libs/pois.js b/src/libs/pois.js
@@ -9,7 +9,7 @@ export function toUrl(poi) {
   if (poi.id === 'geolocalisation' || poi.type === 'latlon') {
     return `latlon:${poi.latLon.lat.toFixed(5)}:${poi.latLon.lng.toFixed(5)}`;
   }
-  return poi.name ? `${poi.id}@${slug(poi.name)}` : poi.id;
+  return poi.name ? `${poi.qwant_id}@${slug(poi.name)}` : poi.qwant_id;
 }
 
 export function toAbsoluteUrl(poi) {
@@ -36,7 +36,7 @@ export function fromUrl(urlParam) {
   urlData = urlParam.match(/^(.*?)(@(.*))?$/);
   if (urlData) {
     const idunnId = urlData[1];
-    return IdunnPoi.poiApiLoad({ id: idunnId });
+    return IdunnPoi.poiApiLoad({ id: idunnId, qwant_id: idunnId });
   }
   return Promise.reject();
 }

diff --git a/tests/integration/favorites_tools.js b/tests/integration/favorites_tools.js
@@ -38,9 +38,9 @@ export async function toggleFavoritePanel(page) {
 
 export async function storePoi(
   page,
-  { id = 'A', title = 'poi', coords = { lat: 43, lng: 2 } } = {}
+  { id = 'A', qwant_id = 'A', title = 'poi', coords = { lat: 43, lng: 2 } } = {}
 ) {
-  const poi = new Poi(id, title, 'poi', coords, '', '');
+  const poi = new Poi(id, qwant_id, title, 'poi', coords, '', '');
   await page.evaluate(
     (storageKey, serializedPoi) => {
       window.localStorage.setItem(storageKey, serializedPoi);

diff --git a/tests/integration/tools.js b/tests/integration/tools.js
@@ -63,6 +63,7 @@ export async function simulateClickOnMapPoi(page, poi) {
   const mapPoiMock = {
     properties: {
       global_id: poi.id,
+      qwant_id: poi.id,
       name: poi.name,
     },
     geometry: poi.geometry,