[enh] Add timeout limit per request (#1640)

The new url parameter "timeout_limit" set timeout limit defined in second.
Example "timeout_limit=1.5" means the timeout limit is 1.5 seconds.

In addition, the query can start with <[number] to set the timeout limit.

For number between 0 and 99, the unit is the second :
Example: "<30 searx" means the timeout limit is 3 seconds

For number above 100, the unit is the millisecond:
Example: "<850 searx" means the timeout is 850 milliseconds.

In addition, there is a new optional setting: outgoing.max_request_timeout.
If not set, the user timeout can't go above searx configuration (as before: the max timeout of selected engine for a query).

If the value is set, the user can set a timeout between 0 and max_request_timeout using
<[number] or timeout_limit query parameter.

Related to #1077
Updated version of PR #1413 from @isj-privacore

2 files changed, 95 insertions, 3 deletions

diff --git a/tests/unit/test_query.py b/tests/unit/test_query.py
index 49ccb608f..e4c0bdeed 100644
--- a/tests/unit/test_query.py
+++ b/tests/unit/test_query.py
@@ -62,3 +62,45 @@ class TestQuery(SearxTestCase):
         self.assertEquals(len(query.query_parts), 1)
         self.assertEquals(len(query.languages), 0)
         self.assertFalse(query.specific)
+
+    def test_timeout_below100(self):
+        query_text = '<3 the query'
+        query = RawTextQuery(query_text, [])
+        query.parse_query()
+
+        self.assertEquals(query.getFullQuery(), query_text)
+        self.assertEquals(len(query.query_parts), 3)
+        self.assertEquals(query.timeout_limit, 3)
+        self.assertFalse(query.specific)
+
+    def test_timeout_above100(self):
+        query_text = '<350 the query'
+        query = RawTextQuery(query_text, [])
+        query.parse_query()
+
+        self.assertEquals(query.getFullQuery(), query_text)
+        self.assertEquals(len(query.query_parts), 3)
+        self.assertEquals(query.timeout_limit, 0.35)
+        self.assertFalse(query.specific)
+
+    def test_timeout_above1000(self):
+        query_text = '<3500 the query'
+        query = RawTextQuery(query_text, [])
+        query.parse_query()
+
+        self.assertEquals(query.getFullQuery(), query_text)
+        self.assertEquals(len(query.query_parts), 3)
+        self.assertEquals(query.timeout_limit, 3.5)
+        self.assertFalse(query.specific)
+
+    def test_timeout_invalid(self):
+        # invalid number: it is not bang but it is part of the query
+        query_text = '<xxx the query'
+        query = RawTextQuery(query_text, [])
+        query.parse_query()
+
+        self.assertEquals(query.getFullQuery(), query_text)
+        self.assertEquals(len(query.query_parts), 1)
+        self.assertEquals(query.query_parts[0], query_text)
+        self.assertEquals(query.timeout_limit, None)
+        self.assertFalse(query.specific)
diff --git a/tests/unit/test_search.py b/tests/unit/test_search.py
index af5fffd8b..a39786d1a 100644
--- a/tests/unit/test_search.py
+++ b/tests/unit/test_search.py
@@ -2,9 +2,59 @@
 
 from searx.testing import SearxTestCase
 
+import searx.preferences
+import searx.search
+import searx.engines
+
 
-#  TODO
 class SearchTestCase(SearxTestCase):
 
-    def test_(self):
-        pass
+    @classmethod
+    def setUpClass(cls):
+        searx.engines.initialize_engines([{
+            'name': 'general dummy',
+            'engine': 'dummy',
+            'categories': 'general',
+            'shortcut': 'gd',
+            'timeout': 3.0
+        }])
+
+    def test_timeout_simple(self):
+        searx.search.max_request_timeout = None
+        search_query = searx.query.SearchQuery('test', [{'category': 'general', 'name': 'general dummy'}],
+                                               ['general'], 'en-US', 0, 1, None, None)
+        search = searx.search.Search(search_query)
+        search.search()
+        self.assertEquals(search.actual_timeout, 3.0)
+
+    def test_timeout_query_above_default_nomax(self):
+        searx.search.max_request_timeout = None
+        search_query = searx.query.SearchQuery('test', [{'category': 'general', 'name': 'general dummy'}],
+                                               ['general'], 'en-US', 0, 1, None, 5.0)
+        search = searx.search.Search(search_query)
+        search.search()
+        self.assertEquals(search.actual_timeout, 3.0)
+
+    def test_timeout_query_below_default_nomax(self):
+        searx.search.max_request_timeout = None
+        search_query = searx.query.SearchQuery('test', [{'category': 'general', 'name': 'general dummy'}],
+                                               ['general'], 'en-US', 0, 1, None, 1.0)
+        search = searx.search.Search(search_query)
+        search.search()
+        self.assertEquals(search.actual_timeout, 1.0)
+
+    def test_timeout_query_below_max(self):
+        searx.search.max_request_timeout = 10.0
+        search_query = searx.query.SearchQuery('test', [{'category': 'general', 'name': 'general dummy'}],
+                                               ['general'], 'en-US', 0, 1, None, 5.0)
+        search = searx.search.Search(search_query)
+        search.search()
+        self.assertEquals(search.actual_timeout, 5.0)
+
+    def test_timeout_query_above_max(self):
+        searx.search.max_request_timeout = 10.0
+        search_query = searx.query.SearchQuery('test', [{'category': 'general', 'name': 'general dummy'}],
+                                               ['general'], 'en-US', 0, 1, None, 15.0)
+        search = searx.search.Search(search_query)
+        search.search()
+        self.assertEquals(search.actual_timeout, 10.0)