Merge #232

232: Added an option to specify a timeout duration r=bidoubiwa a=sanders41

Closes #231

I did not implement this with the Session as suggested in the issue simply because in the requests documentation there doesn't seem to be a way to set a default timeout for the session. It is possible with httpx to do this so maybe I'm missing something in requests. If anyone knows how and would rather use a session I can update it.

As an added bonus this does speed up the tests significantly be setting a timeout of 1 second on the communication error test.

Co-authored-by: Paul Sanders <[email protected]>

Author: bors[bot]

meilisearch/_httprequests.py

@@ -1,5 +1,9 @@
 import requests
-from meilisearch.errors import MeiliSearchApiError, MeiliSearchCommunicationError
+from meilisearch.errors import (
+    MeiliSearchApiError,
+    MeiliSearchCommunicationError,
+    MeiliSearchTimeoutError,
+)
 
 class HttpRequests:
 
@@ -17,10 +21,22 @@ def send_request(self, http_method, path, body=None):
         try:
             request_path = self.config.url + '/' + path
             if body is None:
-                request = http_method(request_path, headers=self.headers)
+                request = http_method(
+                    request_path,
+                    timeout=self.config.timeout,
+                    headers=self.headers,
+                )
             else:
-                request = http_method(request_path, headers=self.headers, json=body)
+                request = http_method(
+                    request_path,
+                    timeout=self.config.timeout,
+                    headers=self.headers,
+                    json=body,
+                )
             return self.__validate(request)
+
+        except requests.exceptions.Timeout as err:
+            raise MeiliSearchTimeoutError(err) from err
         except requests.exceptions.ConnectionError as err:
             raise MeiliSearchCommunicationError(err) from err
 

meilisearch/client.py

@@ -14,7 +14,7 @@ class Client():
     config = None
     http = None
 
-    def __init__(self, url, apiKey=None):
+    def __init__(self, url, apiKey=None, timeout=None):
         """
         Parameters
         ----------
@@ -23,7 +23,8 @@ def __init__(self, url, apiKey=None):
         apiKey : str
             The optional API key for MeiliSearch
         """
-        self.config = Config(url, apiKey)
+        self.config = Config(url, apiKey, timeout=timeout)
+
         self.http = HttpRequests(self.config)
 
     def create_index(self, uid, options=None):

meilisearch/config.py

@@ -23,7 +23,7 @@ class Paths():
         attributes_for_faceting = 'attributes-for-faceting'
         dumps = 'dumps'
 
-    def __init__(self, url, api_key=None):
+    def __init__(self, url, api_key=None, timeout=None):
         """
         Parameters
         ----------
@@ -35,4 +35,5 @@ def __init__(self, url, api_key=None):
 
         self.url = url
         self.api_key = api_key
+        self.timeout = timeout
         self.paths = self.Paths()

meilisearch/tests/client/test_client.py

@@ -3,9 +3,26 @@
 import meilisearch
 from meilisearch.tests import BASE_URL, MASTER_KEY
 
+
 def test_get_client():
     """Tests getting a client instance."""
     client = meilisearch.Client(BASE_URL, MASTER_KEY)
     assert client.config
     response = client.health()
     assert response.status_code >= 200 and response.status_code < 400
+
+
+def test_client_timeout_set():
+    timeout = 5
+    client = meilisearch.Client(BASE_URL, MASTER_KEY, timeout=timeout)
+    response = client.health()
+    assert client.config.timeout == timeout
+    assert response.status_code >= 200 and response.status_code < 400
+
+
+def test_client_timeout_not_set():
+    default_timeout = None
+    client = meilisearch.Client(BASE_URL, MASTER_KEY)
+    response = client.health()
+    assert client.config.timeout == default_timeout
+    assert response.status_code >= 200 and response.status_code < 400

meilisearch/tests/errors/test_communication_error_meilisearch.py

@@ -1,12 +1,16 @@
 # pylint: disable=invalid-name
 
+from unittest.mock import patch
 import pytest
+import requests
 import meilisearch
 from meilisearch.errors import MeiliSearchCommunicationError
 from meilisearch.tests import MASTER_KEY
 
 
-def test_meilisearch_communication_error_host():
+@patch("requests.post")
+def test_meilisearch_communication_error_host(mock_post):
+    mock_post.side_effect = requests.exceptions.ConnectionError()
     client = meilisearch.Client("http://wrongurl:1234", MASTER_KEY)
     with pytest.raises(MeiliSearchCommunicationError):
         client.create_index("some_index")

meilisearch/tests/errors/test_timeout_error_meilisearch.py

@@ -0,0 +1,23 @@
+import pytest
+import meilisearch
+from meilisearch.errors import MeiliSearchTimeoutError
+from meilisearch.tests import BASE_URL, MASTER_KEY
+
+
+@pytest.mark.usefixtures("indexes_sample")
+def test_client_timeout_error(small_movies):
+    client = meilisearch.Client(BASE_URL, MASTER_KEY, timeout=1e-99)
+
+    with pytest.raises(MeiliSearchTimeoutError):
+        index = client.index("indexUID")
+        index.add_documents(small_movies)
+
+
+def test_client_timeout_set():
+    timeout = 1
+    client = meilisearch.Client("http://wrongurl:1234", MASTER_KEY, timeout=timeout)
+
+    with pytest.raises(Exception):
+        client.health()
+
+    assert client.config.timeout == timeout