feat: download progress reporting

merydian · merydian · commit 7a9583e27678 · 2025-10-21T13:25:35.000+02:00
diff --git a/ORStools/common/client.py b/ORStools/common/client.py
@@ -48,7 +48,7 @@ class Client(QObject):
     """Performs requests to the ORS API services."""
 
     overQueryLimit = pyqtSignal(int)
-    downloadProgress = pyqtSignal(int, int)
+    downloadProgress = pyqtSignal(int)
 
 
     def __init__(self, provider: Optional[dict] = None, agent: Optional[str] = None) -> None:
@@ -120,9 +120,7 @@ def fetch_with_retry(
 
         blocking_request = QgsBlockingNetworkRequest()
 
-        blocking_request.downloadProgress.connect(
-            lambda r, t: self.downloadProgress.emit(r, t)
-        )
+        blocking_request.downloadProgress.connect(lambda r, t: self.downloadProgress.emit(r/t))
 
         logger.log(f"url: {self.url}\nParameters: {json.dumps(post_json, indent=2)}", 0)
 
@@ -146,7 +144,7 @@ def fetch_with_retry(
                 loop = QEventLoop()
                 QTimer.singleShot(delay_seconds * 1000, loop.quit)  # milliseconds
                 loop.exec_()
-                
+
             except exceptions.ApiError as e:
                 if post_json:
                     logger.log(
diff --git a/ORStools/proc/base_processing_algorithm.py b/ORStools/proc/base_processing_algorithm.py
@@ -232,6 +232,17 @@ def parseOptions(self, parameters: dict, context: QgsProcessingContext) -> dict:
 
         return options
 
+    def get_client(
+        self, parameters: dict, context: QgsProcessingContext, feedback: QgsProcessingFeedback
+    ) -> client.Client:
+        """
+        Returns a client instance for requests to the ors API
+        """
+        ors_client = self._get_ors_client_from_provider(parameters[self.IN_PROVIDER], feedback)
+        ors_client.downloadProgress.connect(feedback.setProgress)
+
+        return ors_client
+
     # noinspection PyUnusedLocal
     def initAlgorithm(self, configuration: Dict) -> None:
         """
diff --git a/ORStools/proc/directions_lines_proc.py b/ORStools/proc/directions_lines_proc.py
@@ -128,7 +128,7 @@ def __init__(self):
     def processAlgorithm(
         self, parameters: dict, context: QgsProcessingContext, feedback: QgsProcessingFeedback
     ) -> Dict[str, str]:
-        ors_client = self._get_ors_client_from_provider(parameters[self.IN_PROVIDER], feedback)
+        ors_client = self.get_client(parameters, context, feedback)
 
         profile = dict(enumerate(PROFILES))[parameters[self.IN_PROFILE]]
 
diff --git a/ORStools/proc/directions_points_layer_proc.py b/ORStools/proc/directions_points_layer_proc.py
@@ -135,7 +135,7 @@ def __init__(self):
     def processAlgorithm(
         self, parameters: dict, context: QgsProcessingContext, feedback: QgsProcessingFeedback
     ) -> Dict[str, str]:
-        ors_client = self._get_ors_client_from_provider(parameters[self.IN_PROVIDER], feedback)
+        ors_client = self.get_client(parameters, context, feedback)
 
         profile = dict(enumerate(PROFILES))[parameters[self.IN_PROFILE]]
 
diff --git a/ORStools/proc/directions_points_layers_proc.py b/ORStools/proc/directions_points_layers_proc.py
@@ -149,7 +149,7 @@ def __init__(self):
     def processAlgorithm(
         self, parameters: dict, context: QgsProcessingContext, feedback: QgsProcessingFeedback
     ) -> Dict[str, str]:
-        ors_client = self._get_ors_client_from_provider(parameters[self.IN_PROVIDER], feedback)
+        ors_client = self.get_client(parameters, context, feedback)
 
         profile = dict(enumerate(PROFILES))[parameters[self.IN_PROFILE]]
 
diff --git a/ORStools/proc/export_proc.py b/ORStools/proc/export_proc.py
@@ -77,7 +77,7 @@ def __init__(self):
     def processAlgorithm(
         self, parameters: dict, context: QgsProcessingContext, feedback: QgsProcessingFeedback
     ) -> Dict[str, str]:
-        ors_client = self._get_ors_client_from_provider(parameters[self.IN_PROVIDER], feedback)
+        ors_client = self.get_client(parameters, context, feedback)
 
         # Get profile value
         profile = dict(enumerate(PROFILES))[parameters[self.IN_PROFILE]]
@@ -113,7 +113,9 @@ def processAlgorithm(
         # Make request and catch ApiError
         try:
             endpoint = self.get_endpoint_names_from_provider(parameters[self.IN_PROVIDER])["export"]
-            response = ors_client.fetch_with_retry(f"/v2/{endpoint}/{profile}", {}, post_json=params)
+            response = ors_client.fetch_with_retry(
+                f"/v2/{endpoint}/{profile}", {}, post_json=params
+            )
             nodes_dict = {item["nodeId"]: item["location"] for item in response["nodes"]}
             edges = response["edges"]
             for edge in edges:
diff --git a/ORStools/proc/isochrones_layer_proc.py b/ORStools/proc/isochrones_layer_proc.py
@@ -123,7 +123,7 @@ def __init__(self):
     def processAlgorithm(
         self, parameters: dict, context: QgsProcessingContext, feedback: QgsProcessingFeedback
     ) -> Dict[str, str]:
-        ors_client = self._get_ors_client_from_provider(parameters[self.IN_PROVIDER], feedback)
+        ors_client = self.get_client(parameters, context, feedback)
 
         profile = dict(enumerate(PROFILES))[parameters[self.IN_PROFILE]]
         dimension = dict(enumerate(DIMENSIONS))[parameters[self.IN_METRIC]]
@@ -200,7 +200,9 @@ def processAlgorithm(
                 endpoint = self.get_endpoint_names_from_provider(parameters[self.IN_PROVIDER])[
                     "isochrones"
                 ]
-                response = ors_client.fetch_with_retry(f"/v2/{endpoint}/{profile}", {}, post_json=params)
+                response = ors_client.fetch_with_retry(
+                    f"/v2/{endpoint}/{profile}", {}, post_json=params
+                )
 
                 for isochrone in self.isochrones.get_features(response, params["id"]):
                     sink.addFeature(isochrone)
diff --git a/ORStools/proc/isochrones_point_proc.py b/ORStools/proc/isochrones_point_proc.py
@@ -109,7 +109,7 @@ def __init__(self):
     def processAlgorithm(
         self, parameters: dict, context: QgsProcessingContext, feedback: QgsProcessingFeedback
     ) -> Dict[str, str]:
-        ors_client = self._get_ors_client_from_provider(parameters[self.IN_PROVIDER], feedback)
+        ors_client = self.get_client(parameters, context, feedback)
 
         profile = dict(enumerate(PROFILES))[parameters[self.IN_PROFILE]]
         dimension = dict(enumerate(DIMENSIONS))[parameters[self.IN_METRIC]]
@@ -157,7 +157,9 @@ def processAlgorithm(
             endpoint = self.get_endpoint_names_from_provider(parameters[self.IN_PROVIDER])[
                 "isochrones"
             ]
-            response = ors_client.fetch_with_retry(f"/v2/{endpoint}/{profile}", {}, post_json=params)
+            response = ors_client.fetch_with_retry(
+                f"/v2/{endpoint}/{profile}", {}, post_json=params
+            )
 
             # Populate features from response
             for isochrone in self.isochrones.get_features(response, params["id"]):
diff --git a/ORStools/proc/matrix_proc.py b/ORStools/proc/matrix_proc.py
@@ -93,7 +93,7 @@ def __init__(self):
     def processAlgorithm(
         self, parameters: dict, context: QgsProcessingContext, feedback: QgsProcessingFeedback
     ) -> Dict[str, str]:
-        ors_client = self._get_ors_client_from_provider(parameters[self.IN_PROVIDER], feedback)
+        ors_client = self.get_client(parameters, context, feedback)
 
         # Get profile value
         profile = dict(enumerate(PROFILES))[parameters[self.IN_PROFILE]]
@@ -180,7 +180,9 @@ def processAlgorithm(
         # Make request and catch ApiError
         try:
             endpoint = self.get_endpoint_names_from_provider(parameters[self.IN_PROVIDER])["matrix"]
-            response = ors_client.fetch_with_retry(f"/v2/{endpoint}/{profile}", {}, post_json=params)
+            response = ors_client.fetch_with_retry(
+                f"/v2/{endpoint}/{profile}", {}, post_json=params
+            )
 
         except (exceptions.ApiError, exceptions.InvalidKey, exceptions.GenericServerError) as e:
             msg = f"{e.__class__.__name__}: {str(e)}"
diff --git a/ORStools/proc/snap_layer_proc.py b/ORStools/proc/snap_layer_proc.py
@@ -76,7 +76,7 @@ def __init__(self) -> None:
     def processAlgorithm(
         self, parameters: dict, context: QgsProcessingContext, feedback: QgsProcessingFeedback
     ) -> Dict[str, str]:
-        ors_client = self._get_ors_client_from_provider(parameters[self.IN_PROVIDER], feedback)
+        ors_client = self.get_client(parameters, context, feedback)
 
         # Get profile value
         profile = dict(enumerate(PROFILES))[parameters[self.IN_PROFILE]]
diff --git a/ORStools/proc/snap_point_proc.py b/ORStools/proc/snap_point_proc.py
@@ -79,7 +79,7 @@ def __init__(self) -> None:
     def processAlgorithm(
         self, parameters: dict, context: QgsProcessingContext, feedback: QgsProcessingFeedback
     ) -> Dict[str, str]:
-        ors_client = self._get_ors_client_from_provider(parameters[self.IN_PROVIDER], feedback)
+        ors_client = self.get_client(parameters, context, feedback)
 
         # Get profile value
         profile = dict(enumerate(PROFILES))[parameters[self.IN_PROFILE]]
diff --git a/ORStools/utils/router.py b/ORStools/utils/router.py
@@ -85,7 +85,9 @@ def route_as_layer(dlg):
                 logger.log(msg, 0)
                 dlg.debug_text.setText(msg)
                 return
-            response = clnt.fetch_with_retry("/v2/directions/" + profile + "/geojson", {}, post_json=params)
+            response = clnt.fetch_with_retry(
+                "/v2/directions/" + profile + "/geojson", {}, post_json=params
+            )
             feat = directions_core.get_output_feature_directions(
                 response, profile, params["preference"], directions.options
             )
diff --git a/tests/test_common.py b/tests/test_common.py
@@ -21,7 +21,7 @@ def test_client_retry_on_over_query_limit(self):
             "name": "openrouteservice",
             "timeout": 60,
         }
-        
+
         params = {
             "preference": "fastest",
             "geometry": "true",
@@ -30,38 +30,37 @@ def test_client_retry_on_over_query_limit(self):
             "id": 1,
             "coordinates": [[8.684101, 50.131613], [8.68534, 50.131651]],
         }
-        
+
         agent = "QGIS_ORStools_testing"
         profile = "driving-car"
         clnt = client.Client(provider, agent)
-        
+
         # Mock to fail twice, then succeed
         call_count = [0]
+
         def mock_request(post_json, blocking_request, request):
             call_count[0] += 1
             if call_count[0] <= 2:
                 raise client.exceptions.OverQueryLimit("429", "Over query limit")
-            
+
             # Return a mock successful response on third call
             from unittest.mock import Mock
+
             mock_reply = Mock()
             mock_content = Mock()
             mock_data = Mock()
             mock_data.decode.return_value = '{"success": true}'
             mock_content.data.return_value = mock_data
             mock_reply.content.return_value = mock_content
             return mock_reply
-        
+
         clnt._request = mock_request
         clnt.get_delay_seconds = lambda x: 0  # Speed up test by removing delays
-        
+
         response = clnt.fetch_with_retry(
-            "/v2/directions/" + profile + "/geojson", 
-            {}, 
-            post_json=params,
-            max_retries=5
+            "/v2/directions/" + profile + "/geojson", {}, post_json=params, max_retries=5
         )
-        
+
         self.assertEqual(call_count[0], 3)  # Should have made 3 attempts
         self.assertTrue(response)
         self.assertEqual(response["success"], True)
@@ -148,7 +147,9 @@ def test_client_request_geometry(self):
         agent = "QGIS_ORStools_testing"
         profile = "driving-car"
         clnt = client.Client(provider, agent)
-        response = clnt.fetch_with_retry("/v2/directions/" + profile + "/geojson", {}, post_json=params)
+        response = clnt.fetch_with_retry(
+            "/v2/directions/" + profile + "/geojson", {}, post_json=params
+        )
         self.assertAlmostEqual(
             response["features"][0]["geometry"]["coordinates"][0][0],
             test_response["features"][0]["geometry"]["coordinates"][0][0],
