fix(geocoder): Propogate geocoder error to consumer

prateek3255 · prateek3255 · commit afdce17e416b · 2021-06-13T00:05:35.000+05:30
closes ubilabs#486 Add a new prop to propogate errors from the Geocoder.geocode API to the consumer application
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -28,7 +28,7 @@
     "@rollup/plugin-replace": "^2.3.3",
     "@types/chai": "^4.2.12",
     "@types/classnames": "^2.2.10",
-    "@types/googlemaps": "^3.39.13",
+    "@types/google.maps": "^3.45.2",
     "@types/jsdom": "^16.2.4",
     "@types/lodash.debounce": "^4.0.6",
     "@types/mocha": "^8.0.3",
diff --git a/src/Geosuggest.tsx b/src/Geosuggest.tsx
@@ -542,7 +542,7 @@ export default class extends React.Component<IProps, IState> {
       this.placesService.getDetails(options, (results, status) => {
         if (status === this.googleMaps.places.PlacesServiceStatus.OK) {
           const gmaps = results;
-          const location = (gmaps.geometry &&
+          const location = (gmaps?.geometry &&
             gmaps.geometry.location) as google.maps.LatLng;
           const suggest = {
             ...suggestToGeocode,
@@ -560,35 +560,41 @@ export default class extends React.Component<IProps, IState> {
         }
       });
     } else {
+      const country = Array.isArray(this.props.country)
+        ? this.props.country[0]
+        : this.props.country;
       const options: google.maps.GeocoderRequest = {
         address: suggestToGeocode.label,
         bounds: this.props.bounds,
-        componentRestrictions: this.props.country
-          ? {country: this.props.country}
-          : // eslint-disable-next-line no-undefined
-            undefined,
+        componentRestrictions: {country},
         location: this.props.location
       };
 
-      this.geocoder.geocode(options, (results, status) => {
-        if (status === this.googleMaps.GeocoderStatus.OK) {
-          const gmaps = results[0];
-          const location = (gmaps.geometry &&
-            gmaps.geometry.location) as google.maps.LatLng;
-          const suggest = {
-            ...suggestToGeocode,
-            gmaps,
-            location: {
-              lat: location.lat(),
-              lng: location.lng()
-            }
-          };
+      this.geocoder
+        .geocode(options, (results, status) => {
+          if (status === this.googleMaps.GeocoderStatus.OK) {
+            const gmaps = results?.[0];
+            const location = (gmaps?.geometry &&
+              gmaps.geometry.location) as google.maps.LatLng;
+            const suggest = {
+              ...suggestToGeocode,
+              gmaps,
+              location: {
+                lat: location.lat(),
+                lng: location.lng()
+              }
+            };
 
-          if (this.props.onSuggestSelect) {
-            this.props.onSuggestSelect(suggest);
+            if (this.props.onSuggestSelect) {
+              this.props.onSuggestSelect(suggest);
+            }
           }
-        }
-      });
+        })
+        ?.catch((error) => {
+          if (this.props.handleGeocodingError) {
+            this.props.handleGeocodingError(error);
+          }
+        });
     }
   }
 
diff --git a/src/types/location.d.ts b/src/types/location.d.ts
@@ -8,6 +8,9 @@ type ILocation = ISuggest & {
     lat: number;
     lng: number;
   };
-  readonly gmaps?: google.maps.GeocoderResult | google.maps.places.PlaceResult;
+  readonly gmaps?:
+    | google.maps.GeocoderResult
+    | google.maps.places.PlaceResult
+    | null;
 };
 export default ILocation;
diff --git a/src/types/props.d.ts b/src/types/props.d.ts
@@ -58,4 +58,5 @@ export default interface IProps {
   readonly minLength?: number;
   readonly placeDetailFields?: string[] | null;
   readonly inputType?: string;
+  readonly handleGeocodingError?: (error: Error) => void;
 }
diff --git a/test/fixtures/predictions.ts b/test/fixtures/predictions.ts
@@ -4,15 +4,13 @@ export default function predictions(): google.maps.places.AutocompletePrediction
   return [
     {
       description: 'New York, NY, United States',
-      id: '7eae6a016a9c6f58e2044573fb8f14227b6e1f96',
       matched_substrings: [
         {
           length: 2,
           offset: 0
         }
       ],
       place_id: 'ChIJOwg_06VPwokRYv534QaPC8g',
-      reference: '...',
       structured_formatting: {
         main_text: 'New York, NY, United States',
         main_text_matched_substrings: [
@@ -41,15 +39,13 @@ export default function predictions(): google.maps.places.AutocompletePrediction
     },
     {
       description: 'New York, IA, United States',
-      id: '329cb7144660f29514f351db26cef864634f748a',
       matched_substrings: [
         {
           length: 2,
           offset: 0
         }
       ],
       place_id: 'ChIJD_qB3F8X6YcRDraFbXmLUD4',
-      reference: '...',
       structured_formatting: {
         main_text: 'New York, IA, United States',
         main_text_matched_substrings: [
@@ -78,15 +74,13 @@ export default function predictions(): google.maps.places.AutocompletePrediction
     },
     {
       description: 'New York, United States',
-      id: '349c7fc49816ce54bb586cf8fa2cd79b255746b3',
       matched_substrings: [
         {
           length: 2,
           offset: 0
         }
       ],
       place_id: 'ChIJqaUj8fBLzEwRZ5UY3sHGz90',
-      reference: '...',
       structured_formatting: {
         main_text: 'New York, United States',
         main_text_matched_substrings: [
@@ -111,15 +105,13 @@ export default function predictions(): google.maps.places.AutocompletePrediction
     },
     {
       description: 'New Jersey, United States',
-      id: '10806aba84cf3520ebd83c6a3f749bad23c4e2e6',
       matched_substrings: [
         {
           length: 2,
           offset: 0
         }
       ],
       place_id: 'ChIJn0AAnpX7wIkRjW0_-Ad70iw',
-      reference: '...',
       structured_formatting: {
         main_text: 'New Jersey, United States',
         main_text_matched_substrings: [
@@ -144,15 +136,13 @@ export default function predictions(): google.maps.places.AutocompletePrediction
     },
     {
       description: 'Newark, NJ, United States',
-      id: 'c71040d6268e495203b4ca7ca4299893601f63fc',
       matched_substrings: [
         {
           length: 2,
           offset: 0
         }
       ],
       place_id: 'ChIJHQ6aMnBTwokRc-T-3CrcvOE',
-      reference: '...',
       structured_formatting: {
         main_text: 'Newark, NJ, United States',
         main_text_matched_substrings: [

Original file line number	Diff line number	Diff line change
`@@ -58,4 +58,5 @@ export default interface IProps {`
`58`	`58`	`readonly minLength?: number;`
`59`	`59`	`readonly placeDetailFields?: string[] \| null;`
`60`	`60`	`readonly inputType?: string;`
	`61`	`+ readonly handleGeocodingError?: (error: Error) => void;`
`61`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,15 +4,13 @@ export default function predictions(): google.maps.places.AutocompletePrediction`
`4`	`4`	`return [`
`5`	`5`	`{`
`6`	`6`	`description: 'New York, NY, United States',`
`7`		`- id: '7eae6a016a9c6f58e2044573fb8f14227b6e1f96',`
`8`	`7`	`matched_substrings: [`
`9`	`8`	`{`
`10`	`9`	`length: 2,`
`11`	`10`	`offset: 0`
`12`	`11`	`}`
`13`	`12`	`],`
`14`	`13`	`place_id: 'ChIJOwg_06VPwokRYv534QaPC8g',`
`15`		`- reference: '...',`
`16`	`14`	`structured_formatting: {`
`17`	`15`	`main_text: 'New York, NY, United States',`
`18`	`16`	`main_text_matched_substrings: [`
`@@ -41,15 +39,13 @@ export default function predictions(): google.maps.places.AutocompletePrediction`
`41`	`39`	`},`
`42`	`40`	`{`
`43`	`41`	`description: 'New York, IA, United States',`
`44`		`- id: '329cb7144660f29514f351db26cef864634f748a',`
`45`	`42`	`matched_substrings: [`
`46`	`43`	`{`
`47`	`44`	`length: 2,`
`48`	`45`	`offset: 0`
`49`	`46`	`}`
`50`	`47`	`],`
`51`	`48`	`place_id: 'ChIJD_qB3F8X6YcRDraFbXmLUD4',`
`52`		`- reference: '...',`
`53`	`49`	`structured_formatting: {`
`54`	`50`	`main_text: 'New York, IA, United States',`
`55`	`51`	`main_text_matched_substrings: [`
`@@ -78,15 +74,13 @@ export default function predictions(): google.maps.places.AutocompletePrediction`
`78`	`74`	`},`
`79`	`75`	`{`
`80`	`76`	`description: 'New York, United States',`
`81`		`- id: '349c7fc49816ce54bb586cf8fa2cd79b255746b3',`
`82`	`77`	`matched_substrings: [`
`83`	`78`	`{`
`84`	`79`	`length: 2,`
`85`	`80`	`offset: 0`
`86`	`81`	`}`
`87`	`82`	`],`
`88`	`83`	`place_id: 'ChIJqaUj8fBLzEwRZ5UY3sHGz90',`
`89`		`- reference: '...',`
`90`	`84`	`structured_formatting: {`
`91`	`85`	`main_text: 'New York, United States',`
`92`	`86`	`main_text_matched_substrings: [`
`@@ -111,15 +105,13 @@ export default function predictions(): google.maps.places.AutocompletePrediction`
`111`	`105`	`},`
`112`	`106`	`{`
`113`	`107`	`description: 'New Jersey, United States',`
`114`		`- id: '10806aba84cf3520ebd83c6a3f749bad23c4e2e6',`
`115`	`108`	`matched_substrings: [`
`116`	`109`	`{`
`117`	`110`	`length: 2,`
`118`	`111`	`offset: 0`
`119`	`112`	`}`
`120`	`113`	`],`
`121`	`114`	`place_id: 'ChIJn0AAnpX7wIkRjW0_-Ad70iw',`
`122`		`- reference: '...',`
`123`	`115`	`structured_formatting: {`
`124`	`116`	`main_text: 'New Jersey, United States',`
`125`	`117`	`main_text_matched_substrings: [`
`@@ -144,15 +136,13 @@ export default function predictions(): google.maps.places.AutocompletePrediction`
`144`	`136`	`},`
`145`	`137`	`{`
`146`	`138`	`description: 'Newark, NJ, United States',`
`147`		`- id: 'c71040d6268e495203b4ca7ca4299893601f63fc',`
`148`	`139`	`matched_substrings: [`
`149`	`140`	`{`
`150`	`141`	`length: 2,`
`151`	`142`	`offset: 0`
`152`	`143`	`}`
`153`	`144`	`],`
`154`	`145`	`place_id: 'ChIJHQ6aMnBTwokRc-T-3CrcvOE',`
`155`		`- reference: '...',`
`156`	`146`	`structured_formatting: {`
`157`	`147`	`main_text: 'Newark, NJ, United States',`
`158`	`148`	`main_text_matched_substrings: [`