Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dynamic query time limits #3702

Merged
merged 6 commits into from
Apr 15, 2019
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion redash/settings/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import os
import importlib
from funcy import distinct, remove
from flask_talisman import talisman

Expand Down Expand Up @@ -288,7 +289,8 @@ def email_server_is_configured():
disabled_query_runners = array_from_string(os.environ.get("REDASH_DISABLED_QUERY_RUNNERS", ""))

QUERY_RUNNERS = remove(set(disabled_query_runners), distinct(enabled_query_runners + additional_query_runners))
ADHOC_QUERY_TIME_LIMIT = int_or_none(os.environ.get('REDASH_ADHOC_QUERY_TIME_LIMIT', None))

dynamic_settings = importlib.import_module(os.environ.get('REDASH_DYNAMIC_SETTINGS_MODULE', 'redash.settings.dynamic_settings'))

# Destinations
default_destinations = [
Expand Down
9 changes: 9 additions & 0 deletions redash/settings/dynamic_settings.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import os
from .helpers import int_or_none

# Replace this method with your own implementation in case you want to limit the time limit on certain queries or users.
def query_time_limit(is_scheduled, user_id, org_id):
scheduled_time_limit = int_or_none(os.environ.get('REDASH_SCHEDULED_QUERY_TIME_LIMIT', None))
adhoc_time_limit = int_or_none(os.environ.get('REDASH_ADHOC_QUERY_TIME_LIMIT', None))

return scheduled_time_limit if is_scheduled else adhoc_time_limit
5 changes: 2 additions & 3 deletions redash/tasks/queries.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,15 +120,12 @@ def enqueue_query(query, data_source, user_id, is_api_key=False, scheduled_query
if not job:
pipe.multi()

time_limit = None

if scheduled_query:
queue_name = data_source.scheduled_queue_name
scheduled_query_id = scheduled_query.id
else:
queue_name = data_source.queue_name
scheduled_query_id = None
time_limit = settings.ADHOC_QUERY_TIME_LIMIT

args = (query, data_source.id, metadata, user_id, scheduled_query_id, is_api_key)
argsrepr = json_dumps({
Expand All @@ -140,6 +137,8 @@ def enqueue_query(query, data_source, user_id, is_api_key=False, scheduled_query
'user_id': user_id
})

time_limit = settings.dynamic_settings.query_time_limit(scheduled_query, user_id, data_source.org_id)

result = execute_query.apply_async(args=args,
argsrepr=argsrepr,
queue=queue_name,
Expand Down
10 changes: 10 additions & 0 deletions tests/tasks/test_queries.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,16 @@ def test_multiple_enqueue_of_same_query(self):

self.assertEqual(1, execute_query.apply_async.call_count)

@mock.patch('redash.settings.dynamic_settings.query_time_limit', return_value=60)
def test_limits_query_time(self, _):
query = self.factory.create_query()
execute_query.apply_async = mock.MagicMock(side_effect=gen_hash)

enqueue_query(query.query_text, query.data_source, query.user_id, False, query, {'Username': 'Arik', 'Query ID': query.id})

_, kwargs = execute_query.apply_async.call_args
self.assertEqual(60, kwargs.get('time_limit'))

def test_multiple_enqueue_of_different_query(self):
query = self.factory.create_query()
execute_query.apply_async = mock.MagicMock(side_effect=gen_hash)
Expand Down