Skip to content

Commit

Permalink
fix: the temporal x-axis results in a none time_range. (apache#25429)
Browse files Browse the repository at this point in the history
Co-authored-by: Elizabeth Thompson <eschutho@gmail.com>
  • Loading branch information
mapledan and eschutho authored Nov 3, 2023
1 parent 24a2213 commit ae619b1
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 3 deletions.
45 changes: 42 additions & 3 deletions superset/common/query_object_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,21 @@
# under the License.
from __future__ import annotations

from typing import Any, TYPE_CHECKING
from typing import Any, cast, TYPE_CHECKING

from superset.common.chart_data import ChartDataResultType
from superset.common.query_object import QueryObject
from superset.common.utils.time_range_utils import get_since_until_from_time_range
from superset.utils.core import apply_max_row_limit, DatasourceDict, DatasourceType
from superset.constants import NO_TIME_RANGE
from superset.superset_typing import Column
from superset.utils.core import (
apply_max_row_limit,
DatasourceDict,
DatasourceType,
FilterOperator,
get_xaxis_label,
QueryObjectFilterClause,
)

if TYPE_CHECKING:
from sqlalchemy.orm import sessionmaker
Expand Down Expand Up @@ -61,8 +70,11 @@ def create( # pylint: disable=too-many-arguments
processed_extras = self._process_extras(extras)
result_type = kwargs.setdefault("result_type", parent_result_type)
row_limit = self._process_row_limit(row_limit, result_type)
processed_time_range = self._process_time_range(
time_range, kwargs.get("filters"), kwargs.get("columns")
)
from_dttm, to_dttm = get_since_until_from_time_range(
time_range, time_shift, processed_extras
processed_time_range, time_shift, processed_extras
)
kwargs["from_dttm"] = from_dttm
kwargs["to_dttm"] = to_dttm
Expand Down Expand Up @@ -99,6 +111,33 @@ def _process_row_limit(
)
return apply_max_row_limit(row_limit or default_row_limit)

@staticmethod
def _process_time_range(
time_range: str | None,
filters: list[QueryObjectFilterClause] | None = None,
columns: list[Column] | None = None,
) -> str:
if time_range is None:
time_range = NO_TIME_RANGE
temporal_flt = [
flt
for flt in filters or []
if flt.get("op") == FilterOperator.TEMPORAL_RANGE
]
if temporal_flt:
# Use the temporal filter as the time range.
# if the temporal filters uses x-axis as the temporal filter
# then use it or use the first temporal filter
xaxis_label = get_xaxis_label(columns or [])
match_flt = [
flt for flt in temporal_flt if flt.get("col") == xaxis_label
]
if match_flt:
time_range = cast(str, match_flt[0].get("val"))
else:
time_range = cast(str, temporal_flt[0].get("val"))
return time_range

# light version of the view.utils.core
# import view.utils require application context
# Todo: move it and the view.utils.core to utils package
48 changes: 48 additions & 0 deletions tests/unit_tests/common/test_process_time_range.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
from superset.common.query_object_factory import QueryObjectFactory
from superset.constants import NO_TIME_RANGE


def test_process_time_range():
"""
correct empty time range
"""
assert QueryObjectFactory._process_time_range(None) == NO_TIME_RANGE

"""
Use the first temporal filter as time range
"""
filters = [
{"col": "dttm", "op": "TEMPORAL_RANGE", "val": "2001 : 2002"},
{"col": "dttm2", "op": "TEMPORAL_RANGE", "val": "2002 : 2003"},
]
assert QueryObjectFactory._process_time_range(None, filters) == "2001 : 2002"

"""
Use the BASE_AXIS temporal filter as time range
"""
columns = [
{
"columnType": "BASE_AXIS",
"label": "dttm2",
"sqlExpression": "dttm",
}
]
assert (
QueryObjectFactory._process_time_range(None, filters, columns) == "2002 : 2003"
)

0 comments on commit ae619b1

Please sign in to comment.