Merge pull request #1597 from globaldothealth/task-1306-enable-geocod…

…e-limittocountry Add optional limiToCountry param to geocoder
globaldothealth · Feb 23, 2021 · b28edd6 · b28edd6
2 parents 1064662 + 6bc9b58
commit b28edd6
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 0 deletions.
diff --git a/data-serving/data-service/src/controllers/case.ts b/data-serving/data-service/src/controllers/case.ts
@@ -683,7 +683,9 @@ export class CasesController {
                 'location.query must be specified to be able to geocode',
             );
         }
+
         const opts: GeocodeOptions = {};
+
         if (location['limitToResolution']) {
             opts.limitToResolution = [];
             location['limitToResolution']
@@ -699,6 +701,13 @@ export class CasesController {
                     opts.limitToResolution?.push(resolution);
                 });
         }
+
+        if (location['limitToCountry']) {
+            opts.limitToCountry = location['limitToCountry']
+                .split(',')
+                .filter((countryCode: string) => countryCode.length === 2);
+        }
+
         for (const geocoder of this.geocoders) {
             const features = await geocoder.geocode(location?.query, opts);
             if (features.length === 0) {
@@ -736,6 +745,25 @@ export class CasesController {
     }
 }
 
+/*
+"location": {
+    "country": "Costa Rica",
+    "administrativeAreaLevel1": "Any province in Costa Rica",
+    "administrativeAreaLevel2": "Any canton in Costa Rica",
+    "administrativeAreaLevel3": "Any district in Costa Rica",
+    "place": "Boston Children's Hospital",
+    "name": "Lyon, Auvergne-Rhône-Alpes, France",
+    "geoResolution": "Point",
+    "geometry": {
+      "latitude": 0,
+      "longitude": 0
+    },
+    "query": "string",
+    "limitToResolution": "string",
+    "limitToCountry": string[]
+  }
+ */
+
 // Returns a mongoose query for all cases matching the given search query.
 // If count is true, it returns a query for the number of cases matching
 // the search query.

diff --git a/data-serving/data-service/src/geocoding/geocoder.ts b/data-serving/data-service/src/geocoding/geocoder.ts
@@ -32,6 +32,7 @@ export interface GeocodeOptions {
     // If set, will only return features with the given resolutions.
     // Otherwise all available resolutions can be returned.
     limitToResolution?: Resolution[];
+    limitToCountry?: string[];
 }
 
 // A geocoder can geocode queries into places.

diff --git a/data-serving/data-service/src/geocoding/mapbox.ts b/data-serving/data-service/src/geocoding/mapbox.ts
@@ -121,6 +121,11 @@ export default class MapboxGeocoder {
                     });
                 }
             }
+
+            if (opts?.limitToCountry) {
+                req.countries = opts?.limitToCountry;
+            }
+
             return await new Promise<GeocodeResult[]>((resolve, reject) => {
                 this.limiter.removeTokens(1, async (err, _) => {
                     if (err) {

diff --git a/verification/curator-service/api/openapi/openapi.yaml b/verification/curator-service/api/openapi/openapi.yaml
@@ -1535,6 +1535,12 @@ components:
                             description: >
                                 Comma-separated list of resolutions to restrict geocoding to.
                                 Allowed values are: Point, Admin3, Admin2, Admin1, Country.
+                        limitToCountry:
+                            type: string
+                            description: >
+                                Limit results to one or more countries. 
+                                Permitted values are ISO 3166 alpha 2 country codes separated by commas.
+
             required:
                 - caseReference
                 - location