fix: improve error handling for invalid profile parameters

Author: merydian

ORStools/proc/directions_lines_proc.py

@@ -50,7 +50,7 @@
 )
 
 from qgis.PyQt.QtGui import QIcon
-from ORStools.common import directions_core, PROFILES, PREFERENCES, OPTIMIZATION_MODES, EXTRA_INFOS
+from ORStools.common import directions_core, PREFERENCES, OPTIMIZATION_MODES, EXTRA_INFOS
 from ORStools.utils import transform, exceptions, logger
 from .base_processing_algorithm import ORSBaseProcessingAlgorithm
 from ..utils.processing import get_params_optimize
@@ -245,7 +245,16 @@ def processAlgorithm(
                             )
                         )
             except (exceptions.ApiError, exceptions.InvalidKey, exceptions.GenericServerError) as e:
-                msg = f"Feature ID {num} caused a {e.__class__.__name__}:\n{str(e)}"
+                if (
+                    isinstance(e, exceptions.ApiError)
+                    and "Parameter 'profile' has incorrect value" in e.message
+                ):
+                    provider = self.providers[parameters[self.IN_PROVIDER]]["name"]
+                    msg = self.tr(
+                        f'The selected profile "{profile}" is not available in the chosen provider "{provider}"'
+                    )
+                else:
+                    msg = f"Feature ID {num} caused a {e.__class__.__name__}:\n{str(e)}"
                 feedback.reportError(msg)
                 logger.log(msg)
                 continue

ORStools/proc/directions_points_layer_proc.py

@@ -49,7 +49,7 @@
     QgsProcessingFeedback,
 )
 
-from ORStools.common import directions_core, PROFILES, PREFERENCES, OPTIMIZATION_MODES, EXTRA_INFOS
+from ORStools.common import directions_core, PREFERENCES, OPTIMIZATION_MODES, EXTRA_INFOS
 from ORStools.utils import transform, exceptions, logger
 from .base_processing_algorithm import ORSBaseProcessingAlgorithm
 from ..utils.gui import GuiUtils
@@ -286,7 +286,16 @@ def sort(f):
                             )
                         )
             except (exceptions.ApiError, exceptions.InvalidKey, exceptions.GenericServerError) as e:
-                msg = f"Feature ID {from_value} caused a {e.__class__.__name__}:\n{str(e)}"
+                if (
+                    isinstance(e, exceptions.ApiError)
+                    and "Parameter 'profile' has incorrect value" in e.message
+                ):
+                    provider = self.providers[parameters[self.IN_PROVIDER]]["name"]
+                    msg = self.tr(
+                        f'The selected profile "{profile}" is not available in the chosen provider "{provider}"'
+                    )
+                else:
+                    msg = f"Feature ID {from_value} caused a {e.__class__.__name__}:\n{str(e)}"
                 feedback.reportError(msg)
                 logger.log(msg)
                 continue

ORStools/proc/directions_points_layers_proc.py

@@ -46,7 +46,7 @@
     QgsProcessingFeedback,
 )
 
-from ORStools.common import directions_core, PROFILES, PREFERENCES, EXTRA_INFOS
+from ORStools.common import directions_core, PREFERENCES, EXTRA_INFOS
 from ORStools.utils import transform, exceptions, logger
 from .base_processing_algorithm import ORSBaseProcessingAlgorithm
 
@@ -246,9 +246,21 @@ def sort_end(f):
                     f"/v2/{endpoint}/{profile}/geojson", {}, post_json=params
                 )
             except (exceptions.ApiError, exceptions.InvalidKey, exceptions.GenericServerError) as e:
-                msg = f"Route from {values[0]} to {values[1]} caused a {e.__class__.__name__}:\n{str(e)}"
-                feedback.reportError(msg)
-                logger.log(msg)
+                if (
+                    isinstance(e, exceptions.ApiError)
+                    and "Parameter 'profile' has incorrect value" in e.message
+                ):
+                    provider = self.providers[parameters[self.IN_PROVIDER]]["name"]
+                    msg = self.tr(
+                        f'The selected profile "{profile}" is not available in the chosen provider "{provider}"'
+                    )
+                    feedback.reportError(msg)
+                    logger.log(msg)
+                    break
+                else:
+                    msg = f"Route from {values[0]} to {values[1]} caused a {e.__class__.__name__}:\n{str(e)}"
+                    feedback.reportError(msg)
+                    logger.log(msg)
                 continue
 
             if extra_info:

ORStools/proc/export_proc.py

@@ -49,7 +49,6 @@
 from ..utils.wrapper import create_qgs_field
 
 
-from ORStools.common import PROFILES
 from ORStools.utils import exceptions, logger
 from .base_processing_algorithm import ORSBaseProcessingAlgorithm
 
@@ -150,7 +149,16 @@ def processAlgorithm(
                 sink_point.addFeature(point_feat)
 
         except (exceptions.ApiError, exceptions.InvalidKey, exceptions.GenericServerError) as e:
-            msg = f"{e.__class__.__name__}: {str(e)}"
+            if (
+                isinstance(e, exceptions.ApiError)
+                and "Parameter 'profile' has incorrect value" in e.message
+            ):
+                provider = self.providers[parameters[self.IN_PROVIDER]]["name"]
+                msg = self.tr(
+                    f'The selected profile "{profile}" is not available in the chosen provider "{provider}"'
+                )
+            else:
+                msg = f"{e.__class__.__name__}: {str(e)}"
             feedback.reportError(msg)
             logger.log(msg)
 

ORStools/proc/isochrones_layer_proc.py

@@ -45,7 +45,7 @@
     QgsProcessingFeedback,
 )
 
-from ORStools.common import isochrones_core, PROFILES, DIMENSIONS, LOCATION_TYPES
+from ORStools.common import isochrones_core, DIMENSIONS, LOCATION_TYPES
 from ORStools.proc.base_processing_algorithm import ORSBaseProcessingAlgorithm
 from ORStools.utils import transform, exceptions, logger
 from ORStools.utils.gui import GuiUtils
@@ -206,9 +206,21 @@ def processAlgorithm(
                     sink.addFeature(isochrone)
 
             except (exceptions.ApiError, exceptions.InvalidKey, exceptions.GenericServerError) as e:
-                msg = f"Feature ID {params['id']} caused a {e.__class__.__name__}:\n{str(e)}"
-                feedback.reportError(msg)
-                logger.log(msg, 2)
+                if (
+                    isinstance(e, exceptions.ApiError)
+                    and "Parameter 'profile' has incorrect value" in e.message
+                ):
+                    provider = self.providers[parameters[self.IN_PROVIDER]]["name"]
+                    msg = self.tr(
+                        f'The selected profile "{profile}" is not available in the chosen provider "{provider}"'
+                    )
+                    feedback.reportError(msg)
+                    logger.log(msg, 2)
+                    break
+                else:
+                    msg = f"Feature ID {params['id']} caused a {e.__class__.__name__}:\n{str(e)}"
+                    feedback.reportError(msg)
+                    logger.log(msg, 2)
                 continue
             feedback.setProgress(int(100.0 / source.featureCount() * num))
 

ORStools/proc/isochrones_point_proc.py

@@ -42,7 +42,7 @@
     QgsProcessingFeedback,
 )
 
-from ORStools.common import isochrones_core, PROFILES, DIMENSIONS, LOCATION_TYPES
+from ORStools.common import isochrones_core, DIMENSIONS, LOCATION_TYPES
 from ORStools.utils import exceptions, logger
 from .base_processing_algorithm import ORSBaseProcessingAlgorithm
 from ..utils.gui import GuiUtils
@@ -164,7 +164,16 @@ def processAlgorithm(
                 sink.addFeature(isochrone)
 
         except (exceptions.ApiError, exceptions.InvalidKey, exceptions.GenericServerError) as e:
-            msg = f"Feature ID {params['id']} caused a {e.__class__.__name__}:\n{str(e)}"
+            if (
+                isinstance(e, exceptions.ApiError)
+                and "Parameter 'profile' has incorrect value" in e.message
+            ):
+                provider = self.providers[parameters[self.IN_PROVIDER]]["name"]
+                msg = self.tr(
+                    f'The selected profile "{profile}" is not available in the chosen provider "{provider}"'
+                )
+            else:
+                msg = f"Feature ID {params['id']} caused a {e.__class__.__name__}:\n{str(e)}"
             feedback.reportError(msg)
             logger.log(msg, 2)
 

ORStools/proc/matrix_proc.py

@@ -46,7 +46,6 @@
 
 from qgis.PyQt.QtCore import QMetaType
 
-from ORStools.common import PROFILES
 from ORStools.utils import transform, exceptions, logger
 from .base_processing_algorithm import ORSBaseProcessingAlgorithm
 from ..utils.gui import GuiUtils
@@ -182,41 +181,52 @@ def processAlgorithm(
             endpoint = self.get_endpoint_names_from_provider(parameters[self.IN_PROVIDER])["matrix"]
             response = ors_client.request(f"/v2/{endpoint}/{profile}", {}, post_json=params)
 
-        except (exceptions.ApiError, exceptions.InvalidKey, exceptions.GenericServerError) as e:
-            msg = f"{e.__class__.__name__}: {str(e)}"
-            feedback.reportError(msg)
-            logger.log(msg)
+            (sink, dest_id) = self.parameterAsSink(
+                parameters, self.OUT, context, sink_fields, QgsWkbTypes.Type.NoGeometry
+            )
 
-        (sink, dest_id) = self.parameterAsSink(
-            parameters, self.OUT, context, sink_fields, QgsWkbTypes.Type.NoGeometry
-        )
+            sources_attributes = [
+                feat.attribute(source_field_name) if source_field_name else feat.id()
+                for feat in sources_features
+            ]
+            destinations_attributes = [
+                feat.attribute(destination_field_name) if destination_field_name else feat.id()
+                for feat in destination_features
+            ]
 
-        sources_attributes = [
-            feat.attribute(source_field_name) if source_field_name else feat.id()
-            for feat in sources_features
-        ]
-        destinations_attributes = [
-            feat.attribute(destination_field_name) if destination_field_name else feat.id()
-            for feat in destination_features
-        ]
+            for s, source in enumerate(sources_attributes):
+                for d, destination in enumerate(destinations_attributes):
+                    duration = response["durations"][s][d]
+                    distance = response["distances"][s][d]
+                    feat = QgsFeature()
+                    feat.setAttributes(
+                        [
+                            source,
+                            destination,
+                            duration / 3600 if duration is not None else None,
+                            distance / 1000 if distance is not None else None,
+                        ]
+                    )
 
-        for s, source in enumerate(sources_attributes):
-            for d, destination in enumerate(destinations_attributes):
-                duration = response["durations"][s][d]
-                distance = response["distances"][s][d]
-                feat = QgsFeature()
-                feat.setAttributes(
-                    [
-                        source,
-                        destination,
-                        duration / 3600 if duration is not None else None,
-                        distance / 1000 if distance is not None else None,
-                    ]
-                )
+                    sink.addFeature(feat)
 
-                sink.addFeature(feat)
+            return {self.OUT: dest_id}
+
+        except (exceptions.ApiError, exceptions.InvalidKey, exceptions.GenericServerError) as e:
+            if (
+                isinstance(e, exceptions.ApiError)
+                and "Parameter 'profile' has incorrect value" in e.message
+            ):
+                provider = self.providers[parameters[self.IN_PROVIDER]]["name"]
+                msg = self.tr(
+                    f'The selected profile "{profile}" is not available in the chosen provider "{provider}"'
+                )
+            else:
+                msg = f"Feature ID {params['id']} caused a {e.__class__.__name__}:\n{str(e)}"
+            feedback.reportError(msg)
+            logger.log(msg)
 
-        return {self.OUT: dest_id}
+        return {self.OUT: ""}
 
     # TODO working source_type and destination_type differ in both name and type from get_fields in directions_core.
     #  Change to be consistent

ORStools/proc/snap_layer_proc.py

@@ -42,7 +42,6 @@
     QgsCoordinateReferenceSystem,
 )
 
-from ORStools.common import PROFILES
 from ORStools.utils.gui import GuiUtils
 from ORStools.utils.processing import get_snapped_point_features
 from ORStools.proc.base_processing_algorithm import ORSBaseProcessingAlgorithm
@@ -131,7 +130,16 @@ def processAlgorithm(
                 sink.addFeature(feat)
 
         except (exceptions.ApiError, exceptions.InvalidKey, exceptions.GenericServerError) as e:
-            msg = f"{e.__class__.__name__}: {str(e)}"
+            if (
+                isinstance(e, exceptions.ApiError)
+                and "Parameter 'profile' has incorrect value" in e.message
+            ):
+                provider = self.providers[parameters[self.IN_PROVIDER]]["name"]
+                msg = self.tr(
+                    f'The selected profile "{profile}" is not available in the chosen provider "{provider}"'
+                )
+            else:
+                msg = f"{e.__class__.__name__}: {str(e)}"
             feedback.reportError(msg)
             logger.log(msg)
 

ORStools/proc/snap_point_proc.py

@@ -41,7 +41,6 @@
     QgsCoordinateReferenceSystem,
 )
 
-from ORStools.common import PROFILES
 from ORStools.utils.gui import GuiUtils
 from ORStools.utils.processing import get_snapped_point_features
 from ORStools.proc.base_processing_algorithm import ORSBaseProcessingAlgorithm
@@ -116,7 +115,16 @@ def processAlgorithm(
                 sink.addFeature(feat)
 
         except (exceptions.ApiError, exceptions.InvalidKey, exceptions.GenericServerError) as e:
-            msg = f"{e.__class__.__name__}: {str(e)}"
+            if (
+                isinstance(e, exceptions.ApiError)
+                and "Parameter 'profile' has incorrect value" in e.message
+            ):
+                provider = self.providers[parameters[self.IN_PROVIDER]]["name"]
+                msg = self.tr(
+                    f'The selected profile "{profile}" is not available in the chosen provider "{provider}"'
+                )
+            else:
+                msg = f"Feature ID {params['id']} caused a {e.__class__.__name__}:\n{str(e)}"
             feedback.reportError(msg)
             logger.log(msg)