Unify query based dropdown population

client/app/components/QueryBasedParameterInput.jsx

@@ -7,43 +7,6 @@ import { Query } from '@/services/query';
 
 const { Option } = Select;
 
-function optionsFromQueryResult(queryResult) {
-  const columns = queryResult.data.columns;
-  const numColumns = columns.length;
-  let options = [];
-  // If there are multiple columns, check if there is a column
-  // named 'name' and column named 'value'. If name column is present
-  // in results, use name from name column. Similar for value column.
-  // Default: Use first string column for name and value.
-  if (numColumns > 0) {
-    let nameColumn = null;
-    let valueColumn = null;
-    columns.forEach((column) => {
-      const columnName = column.name.toLowerCase();
-      if (columnName === 'name') {
-        nameColumn = column.name;
-      }
-      if (columnName === 'value') {
-        valueColumn = column.name;
-      }
-      // Assign first string column as name and value column.
-      if (nameColumn === null) {
-        nameColumn = column.name;
-      }
-      if (valueColumn === null) {
-        valueColumn = column.name;
-      }
-    });
-    if (nameColumn !== null && valueColumn !== null) {
-      options = queryResult.data.rows.map(row => ({
-        name: row[nameColumn],
-        value: row[valueColumn],
-      }));
-    }
-  }
-  return options;
-}
-
 export class QueryBasedParameterInput extends React.Component {
   static propTypes = {
     value: PropTypes.any, // eslint-disable-line react/forbid-prop-types
@@ -81,9 +44,8 @@ export class QueryBasedParameterInput extends React.Component {
   _loadOptions(queryId) {
     if (queryId && (queryId !== this.state.queryId)) {
       this.setState({ loading: true });
-      Query.resultById({ id: queryId }, (result) => {
+      Query.dropdownOptions({ id: queryId }, (options) => {
         if (this.props.queryId === queryId) {
-          const options = optionsFromQueryResult(result.query_result);
           this.setState({ options, loading: false });
 
           const found = find(options, option => option.value === this.props.value) !== undefined;

client/app/services/query.js

@@ -353,6 +353,11 @@ function QueryResource(
         isArray: false,
         url: 'api/queries/:id/results.json',
       },
+      dropdownOptions: {
+        method: 'get',
+        isArray: true,
+        url: 'api/queries/:id/dropdown.json',
+      },
       favorites: {
         method: 'get',
         isArray: false,

redash/handlers/api.py

@@ -10,7 +10,7 @@
 from redash.handlers.data_sources import DataSourceTypeListResource, DataSourceListResource, DataSourceSchemaResource, DataSourceResource, DataSourcePauseResource, DataSourceTestResource
 from redash.handlers.events import EventsResource
 from redash.handlers.queries import QueryForkResource, QueryRefreshResource, QueryListResource, QueryRecentResource, QuerySearchResource, QueryResource, MyQueriesResource
-from redash.handlers.query_results import QueryResultListResource, QueryResultResource, JobResource
+from redash.handlers.query_results import QueryResultListResource, QueryResultDropdownResource, QueryResultResource, JobResource
 from redash.handlers.users import UserResource, UserListResource, UserInviteResource, UserResetPasswordResource, UserDisableResource, UserRegenerateApiKeyResource
 from redash.handlers.visualizations import VisualizationListResource
 from redash.handlers.visualizations import VisualizationResource
@@ -69,10 +69,10 @@ def json_representation(data, code, headers=None):
 
 api.add_org_resource(EventsResource, '/api/events', endpoint='events')
 
-api.add_org_resource(QueryFavoriteListResource, '/api/queries/favorites', endpoint='query_fovorites')
-api.add_org_resource(QueryFavoriteResource, '/api/queries/<query_id>/favorite', endpoint='query_fovorite')
-api.add_org_resource(DashboardFavoriteListResource, '/api/dashboards/favorites', endpoint='dashboard_fovorites')
-api.add_org_resource(DashboardFavoriteResource, '/api/dashboards/<object_id>/favorite', endpoint='dashboard_fovorite')
+api.add_org_resource(QueryFavoriteListResource, '/api/queries/favorites', endpoint='query_favorites')
+api.add_org_resource(QueryFavoriteResource, '/api/queries/<query_id>/favorite', endpoint='query_favorite')
+api.add_org_resource(DashboardFavoriteListResource, '/api/dashboards/favorites', endpoint='dashboard_favorites')
+api.add_org_resource(DashboardFavoriteResource, '/api/dashboards/<object_id>/favorite', endpoint='dashboard_favorite')
 
 api.add_org_resource(QueryTagsResource, '/api/queries/tags', endpoint='query_tags')
 api.add_org_resource(DashboardTagsResource, '/api/dashboards/tags', endpoint='dashboard_tags')
@@ -89,6 +89,7 @@ def json_representation(data, code, headers=None):
 api.add_org_resource(CheckPermissionResource, '/api/<object_type>/<object_id>/acl/<access_type>', endpoint='check_permissions')
 
 api.add_org_resource(QueryResultListResource, '/api/query_results', endpoint='query_results')
+api.add_org_resource(QueryResultDropdownResource, '/api/queries/<query_id>/dropdown.json', endpoint='query_result_dropdown')
 api.add_org_resource(QueryResultResource,
                      '/api/query_results/<query_result_id>.<filetype>',
                      '/api/query_results/<query_result_id>',

redash/handlers/query_results.py

@@ -11,7 +11,7 @@
 from redash.tasks import QueryTask
 from redash.tasks.queries import enqueue_query
 from redash.utils import (collect_parameters_from_request, gen_query_hash, json_dumps, utcnow)
-from redash.utils.parameterized_query import ParameterizedQuery
+from redash.utils.parameterized_query import ParameterizedQuery, dropdown_values
 
 
 def error_response(message):
@@ -64,7 +64,7 @@ def run_query_sync(data_source, parameter_values, query_text, max_age=0):
         return None
 
 
-def run_query(data_source, parameter_values, query_text, query_id, max_age=0):
+def run_query(data_source, parameter_values, query_text, query_id, max_age=0, parameter_schema=None):
     if data_source.paused:
         if data_source.pause_reason:
             message = '{} is paused ({}). Please try later.'.format(data_source.name, data_source.pause_reason)
@@ -73,7 +73,7 @@ def run_query(data_source, parameter_values, query_text, query_id, max_age=0):
 
         return error_response(message)
 
-    query = ParameterizedQuery(query_text).apply(parameter_values)
+    query = ParameterizedQuery(query_text, parameter_schema, data_source.org).apply(parameter_values)
 
     if query.missing_params:
         return error_response(u'Missing parameter value for: {}'.format(u", ".join(query.missing_params)))
@@ -131,6 +131,13 @@ def post(self):
 ONE_YEAR = 60 * 60 * 24 * 365.25
 
 
+class QueryResultDropdownResource(BaseResource):
+    def get(self, query_id):
+        data = dropdown_values(query_id, self.current_org)
+        headers = {'Content-Type': "application/json"}
+        return make_response(json_dumps(data), 200, headers)
+
+
 class QueryResultResource(BaseResource):
     @staticmethod
     def add_cors_headers(headers):
@@ -171,11 +178,12 @@ def post(self, query_id):
         max_age = int(params.get('max_age', 0))
 
         query = get_object_or_404(models.Query.get_by_id_and_org, query_id, self.current_org)
+        parameter_schema = query.options.get("parameters", [])
 
         if not has_access(query.data_source.groups, self.current_user, not_view_only):
             return {'job': {'status': 4, 'error': 'You do not have permission to run queries with this data source.'}}, 403
         else:
-            return run_query(query.data_source, parameters, query.query_text, query_id, max_age)
+            return run_query(query.data_source, parameters, query.query_text, query_id, max_age, parameter_schema=parameter_schema)
 
     @require_permission('view_query')
     def get(self, query_id=None, query_result_id=None, filetype='json'):

redash/utils/parameterized_query.py

@@ -1,6 +1,27 @@
 import pystache
-from redash.utils import mustache_render
+from flask_login import current_user
+from numbers import Number
+from redash import models
+from redash.utils import mustache_render, json_loads
+from redash.permissions import require_access, view_only
 from funcy import distinct
+from dateutil.parser import parse
+
+
+def dropdown_values(query_id, org):
+    def _pluck_name_and_value(row):
+        name_column = "name" if "name" in row.keys() else row.keys()[-1]
+        value_column = "value" if "value" in row.keys() else row.keys()[-1]
+
+        return {"name": row[name_column], "value": row[value_column]}
+
+    query = models.Query.get_by_id_and_org(query_id, org)
+    require_access(query.data_source.groups, current_user, view_only)
+    query_result = models.QueryResult.get_by_id_and_org(query.latest_query_data_id, org)
+
+    rows = json_loads(query_result.data)["rows"]
+
+    return map(_pluck_name_and_value, rows)
 
 
 def _collect_key_names(nodes):
@@ -33,17 +54,62 @@ def _parameter_names(parameter_values):
     return names
 
 
+def _is_date(string):
+    try:
+        parse(string)
+        return True
+    except ValueError:
+        return False
+
+
+def _is_date_range(obj):
+    try:
+        return _is_date(obj["start"]) and _is_date(obj["end"])
+    except (KeyError, TypeError):
+        return False
+
+
 class ParameterizedQuery(object):
-    def __init__(self, template):
+    def __init__(self, template, schema=None, org=None):
+        self.schema = schema or []
         self.template = template
         self.query = template
         self.parameters = {}
+        self.org = org
 
     def apply(self, parameters):
-        self.parameters.update(parameters)
-        self.query = mustache_render(self.template, self.parameters)
+        invalid_parameter_names = [key for (key, value) in parameters.iteritems() if not self._valid(key, value)]
+        if invalid_parameter_names:
+            raise InvalidParameterError(invalid_parameter_names)
+        else:
+            self.parameters.update(parameters)
+            self.query = mustache_render(self.template, self.parameters)
+
         return self
 
+    def _valid(self, name, value):
+        definition = next((definition for definition in self.schema if definition["name"] == name), None)
+
+        if not definition:
+            return True
+
+        validators = {
+            "text": lambda value: isinstance(value, basestring),
+            "number": lambda value: isinstance(value, Number),
+            "enum": lambda value: value in definition["enumOptions"],
+            "query": lambda value: value in [v["value"] for v in dropdown_values(definition["queryId"], self.org)],
+            "date": _is_date,
+            "datetime-local": _is_date,
+            "datetime-with-seconds": _is_date,
+            "date-range": _is_date_range,
+            "datetime-range": _is_date_range,
+            "datetime-range-with-seconds": _is_date_range,
+        }
+
+        validate = validators.get(definition["type"], lambda x: False)
+
+        return validate(value)
+
     @property
     def missing_params(self):
         query_parameters = set(_collect_query_parameters(self.template))
@@ -52,3 +118,9 @@ def missing_params(self):
     @property
     def text(self):
         return self.query
+
+
+class InvalidParameterError(Exception):
+    def __init__(self, parameters):
+        message = u"The following parameter values are incompatible with their type definitions: {}".format(", ".join(parameters))
+        super(InvalidParameterError, self).__init__(message)