[UXP-120] Error handling

Author: davide-negretti

src/app/core/services/location.service.ts

@@ -2,7 +2,7 @@ import { Injectable } from '@angular/core';
 import { HttpClient, HttpParams } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { environment } from '../../../environments/environment';
-import { map, take } from 'rxjs/operators';
+import { catchError, map, take } from 'rxjs/operators';
 import { hasValue } from '../../shared/empty.util';
 
 export interface LocationCoordinates {
@@ -19,6 +19,7 @@ export enum LocationErrorCodes {
   // define a `location.error.*` i18n label for each error code
   INVALID_COORDINATES = 'invalid-coordinates',
   LOCATION_NOT_FOUND = 'location-not-found',
+  API_ERROR = 'api-error',
 }
 
 const IS_COORDINATE_PAIR_REGEXP = /^\d+\.?\d*,\d+\.?\d*$/;
@@ -46,10 +47,14 @@ export class LocationService {
     let params = new HttpParams().append('q', address).append('format', NOMINATIM_RESPONSE_FORMAT);
 
     return this.http.get<Record<string,any>[]>(this.searchEndpoint, { params: params }).pipe(
+      catchError((err) => {
+        console.error('Location service', err);
+        throw Error(LocationErrorCodes.API_ERROR);
+      }),
       take(1),
       map((searchResults) => {
         if (searchResults.length > 1) {
-          console.warn(`Multiple locations found for address "${address}", showing top matches`, searchResults.slice(0,5));
+          console.warn('Location service', `Multiple locations found for address "${address}"`, 'Showing top matches', searchResults.slice(0,5));
         }
         if (searchResults.length > 0) {
           const firstMatch = searchResults[0];
@@ -63,8 +68,8 @@ export class LocationService {
           };
           return info;
         } else {
-          console.warn(`Location service: location "${address}" not found`);
-          throw new Error(LocationErrorCodes.LOCATION_NOT_FOUND);
+          console.warn('Location service', `Location "${address}" not found`);
+          throw Error(LocationErrorCodes.LOCATION_NOT_FOUND);
         }
       }),
     );
@@ -82,10 +87,13 @@ export class LocationService {
       .append('format', NOMINATIM_RESPONSE_FORMAT);
 
     return this.http.get<Record<string,any>>(this.reverseSearchEndpoint, { params: params }).pipe(
+      catchError((err) => {
+        throw Error(LocationErrorCodes.API_ERROR);
+      }),
       take(1),
       map((searchResults) => {
         if (hasValue(searchResults.error)) {
-          throw new Error(searchResults.error);
+          throw Error(searchResults.error);
         } else {
           return searchResults.display_name;
         }
@@ -140,8 +148,8 @@ export class LocationService {
       const longitude = parseFloat(coordinateArr[1]);
       return { latitude, longitude };
     } else {
-      console.warn(`Location service: invalid coordinates "${coordinates}"`);
-      throw new Error(LocationErrorCodes.INVALID_COORDINATES);
+      console.warn('Location service', `Invalid coordinates "${coordinates}"`);
+      throw Error(LocationErrorCodes.INVALID_COORDINATES);
     }
   }
 }

src/app/cris-layout/cris-layout-matrix/cris-layout-box-container/boxes/metadata/rendering-types/open-street-map/open-street-map-rendering.component.ts

@@ -15,8 +15,6 @@ import { TranslateService } from '@ngx-translate/core';
 import { map } from 'rxjs/operators';
 import { OpenStreetMapPointer } from '../../../../../../../shared/open-street-map/open-street-map.component';
 
-const LocationErrorCodeEnum = LocationErrorCodes;
-
 @Component({
   selector: 'ds-open-street-map-rendering',
   templateUrl: './open-street-map-rendering.component.html',
@@ -81,16 +79,21 @@ export class OpenStreetMapRenderingComponent extends RenderingTypeValueModelComp
             this.place.next(place);
           },
           error: (err) => {
+            // show the map centered on provided coordinates despite the possibility to retrieve a description for the place
             const place: LocationPlace = {
               coordinates: coordinates,
             };
             this.place.next(place);
-            console.warn(err.message);
+            if (err.message === LocationErrorCodes.API_ERROR) {
+              console.error(err.message);
+            } else {
+              console.warn(err.message);
+            }
           },
         });
       } else {
         console.error(`Invalid coordinates: "${position}"`);
-        this.invalidLocationErrorCode.next(LocationErrorCodeEnum.INVALID_COORDINATES);
+        this.invalidLocationErrorCode.next(LocationErrorCodes.INVALID_COORDINATES);
       }
 
     } else {
@@ -103,8 +106,12 @@ export class OpenStreetMapRenderingComponent extends RenderingTypeValueModelComp
           this.place.next(place);
         },
         error: (err) => {
-          this.invalidLocationErrorCode.next(LocationErrorCodeEnum.LOCATION_NOT_FOUND);
-          console.error(err.message);
+          this.invalidLocationErrorCode.next(err.message); // either LOCATION_NOT_FOUND or API_ERROR
+          if (err.message === LocationErrorCodes.API_ERROR) {
+            console.error(err.message);
+          } else {
+            console.warn(err.message);
+          }
         },
       });
     }

src/assets/i18n/en.json5

@@ -870,6 +870,8 @@
 
   "location.error.location-not-found": "Location not found",
 
+  "location.error.api-error": "The service that retrieves the position on the map is currently not available.",
+
   "auth.errors.invalid-user": "Invalid email address or password.",
 
   "auth.messages.expired": "Your session has expired. Please log in again.",