diff --git a/pyproject.toml b/pyproject.toml index 436592f30a13..d7b459799d6d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -388,7 +388,6 @@ ignore_missing_imports = true # - python3 -m tools.mypy_helpers.find_easiest_modules [[tool.mypy.overrides]] module = [ - "sentry.snuba.metrics.query_builder", "sentry.testutils.cases", ] disable_error_code = [ diff --git a/src/sentry/snuba/metrics/query_builder.py b/src/sentry/snuba/metrics/query_builder.py index 066d553cc6f3..ce5ff5caadd7 100644 --- a/src/sentry/snuba/metrics/query_builder.py +++ b/src/sentry/snuba/metrics/query_builder.py @@ -3,7 +3,7 @@ from collections.abc import Mapping, Sequence from datetime import datetime, timedelta from enum import Enum -from typing import Any, TypedDict, overload +from typing import Any, TypedDict, cast, overload import sentry_sdk from snuba_sdk import ( @@ -66,7 +66,9 @@ DATASET_COLUMNS, FIELD_ALIAS_MAPPINGS, FILTERABLE_TAGS, + MetricOperationType, NON_RESOLVABLE_TAG_VALUES, + OPERATIONS, TS_COL_GROUP, DerivedMetricParseException, MetricDoesNotExistException, @@ -95,6 +97,16 @@ QUERY_PROJECT_LIMIT = 10 +MetricExpressionKey = tuple[MetricOperationType | None, str, str] +MetricScalarParams = Mapping[str, str | int | float] + + +def _coerce_scalar_metric_params( + params: dict[str, None | str | int | float | Sequence[tuple[str | int, ...]]] | None, +) -> MetricScalarParams | None: + return cast(MetricScalarParams | None, params) + + def _strip_project_id(condition: Condition) -> Condition | None: if isinstance(condition, BooleanCondition): new_boolean_condition = BooleanCondition() @@ -128,7 +140,7 @@ def parse_public_field(field: str) -> MetricField: matches = PUBLIC_EXPRESSION_REGEX.match(field) if matches is not None: - operation = matches[1] + operation = cast(MetricOperationType, matches[1]) if matches[1] in OPERATIONS else None metric_name = matches[2] else: operation = None @@ -747,11 +759,13 @@ def translate_meta_results( continue elif alias_type == AliasMetaType.GROUP_BY_METRIC_FIELD: metric_groupby_field = alias_to_metric_group_by_field[record["name"]] + assert isinstance(metric_groupby_field.field, MetricField) defined_parent_meta_type = get_metric_object_from_metric_field( metric_groupby_field.field ).get_meta_type() - record["type"] = defined_parent_meta_type + if defined_parent_meta_type is not None: + record["type"] = defined_parent_meta_type elif alias_type == AliasMetaType.TAG: record["type"] = "string" elif alias_type == AliasMetaType.DATASET_COLUMN or alias_type == AliasMetaType.TIME_COLUMN: @@ -828,12 +842,15 @@ def generate_snql_for_action_by_fields( is_order_by = isinstance(metric_action_by_field, MetricOrderByField) if not is_group_by and not is_order_by: raise InvalidParams("The metric action must either be an order by or group by.") + metric_groupby_field = cast(MetricGroupByField, metric_action_by_field) if is_group_by else None + metric_orderby_field = cast(MetricOrderByField, metric_action_by_field) if is_order_by else None if isinstance(metric_action_by_field.field, str): # This transformation is currently supported only for group by because OrderBy doesn't support the Function type. if is_group_by and metric_action_by_field.field == "transaction": + assert metric_groupby_field is not None return transform_null_transaction_to_unparameterized( - use_case_id, org_id, metric_action_by_field.alias + use_case_id, org_id, metric_groupby_field.alias ) # Handles the case when we are trying to group or order by `project` for example, but we want @@ -853,19 +870,20 @@ def generate_snql_for_action_by_fields( f"Unsupported string field: {metric_action_by_field.field}" ) - exp = ( - AliasedExpression( + if is_group_by and not is_column: + assert metric_groupby_field is not None + exp = AliasedExpression( exp=Column(name=column_name), - alias=metric_action_by_field.alias, + alias=metric_groupby_field.alias, ) - if is_group_by and not is_column - else Column(name=column_name) - ) + else: + exp = Column(name=column_name) if is_order_by: + assert metric_orderby_field is not None # We return a list in order to use the "extend" method and reduce the number of changes across # the codebase. - exp = [OrderBy(exp=exp, direction=metric_action_by_field.direction)] + exp = [OrderBy(exp=exp, direction=metric_orderby_field.direction)] return exp elif isinstance(metric_action_by_field.field, MetricField): @@ -878,16 +896,17 @@ def generate_snql_for_action_by_fields( return metric_expression.generate_groupby_statements( use_case_id=use_case_id, alias=metric_action_by_field.field.alias, - params=metric_action_by_field.field.params, + params=_coerce_scalar_metric_params(metric_action_by_field.field.params), projects=projects, )[0] elif is_order_by: + assert metric_orderby_field is not None return metric_expression.generate_orderby_clause( use_case_id=use_case_id, alias=metric_action_by_field.field.alias, - params=metric_action_by_field.field.params, + params=_coerce_scalar_metric_params(metric_action_by_field.field.params), projects=projects, - direction=metric_action_by_field.direction, + direction=metric_orderby_field.direction, ) else: raise NotImplementedError( @@ -921,20 +940,26 @@ def _build_where(self) -> list[BooleanCondition | Condition]: condition.lhs.op, condition.lhs.metric_mri ) try: + lhs_op = condition.lhs.op + rhs_value: int | float | str + if lhs_op is not None and require_rhs_condition_resolution(lhs_op): + if not isinstance(condition.rhs, str): + raise InvalidParams( + f"Cannot resolve non-string RHS for operation {lhs_op}: {condition.rhs!r}" + ) + rhs_value = resolve_tag_value(self._use_case_id, self._org_id, condition.rhs) + else: + rhs_value = condition.rhs metric_condition_filters.append( Condition( lhs=metric_expression.generate_where_statements( use_case_id=self._use_case_id, - params=condition.lhs.params, + params=_coerce_scalar_metric_params(condition.lhs.params), projects=self._projects, alias=condition.lhs.alias, )[0], op=condition.op, - rhs=( - resolve_tag_value(self._use_case_id, self._org_id, condition.rhs) - if require_rhs_condition_resolution(condition.lhs.op) - else condition.rhs - ), + rhs=rhs_value, ) ) except IndexError: @@ -1069,6 +1094,8 @@ def __build_totals_and_series_queries( series_limit = self._metrics_query.max_limit if self._use_case_id in [UseCaseID.TRANSACTIONS, UseCaseID.SPANS]: + if self._metrics_query.interval is None: + raise InvalidParams("Interval is required for discover query time grouping") time_groupby_column = self.__generate_time_groupby_column_for_discover_queries( self._metrics_query.interval ) @@ -1099,17 +1126,19 @@ def __generate_time_groupby_column_for_discover_queries(interval: int) -> Functi def __update_query_dicts_with_component_entities( self, - component_entities: dict[MetricEntity, Sequence[str]], - metric_mri_to_obj_dict: dict[tuple[str | None, str, str], MetricExpressionBase], - fields_in_entities: dict[MetricEntity, list[tuple[str | None, str, str]]], + component_entities: Mapping[MetricEntity | None, Sequence[str]], + metric_mri_to_obj_dict: dict[MetricExpressionKey, MetricExpressionBase], + fields_in_entities: dict[MetricEntity, list[MetricExpressionKey]], parent_alias, - ) -> dict[tuple[str | None, str, str], MetricExpressionBase]: + ) -> dict[MetricExpressionKey, MetricExpressionBase]: # At this point in time, we are only supporting raw metrics in the metrics attribute of # any instance of DerivedMetric, and so in this case the op will always be None # ToDo(ahmed): In future PR, we might want to allow for dependency metrics to also have an # an aggregate and in this case, we would need to parse the op here op = None for entity, metric_mris in component_entities.items(): + if entity is None: + raise DerivedMetricParseException("Entity parsed is in incorrect format") for metric_mri in metric_mris: # The constituents of an instance of CompositeEntityDerivedMetric will have a reference to their parent # alias so that we are able to distinguish the constituents in case we have naming collisions that could @@ -1128,8 +1157,8 @@ def __update_query_dicts_with_component_entities( return metric_mri_to_obj_dict def get_snuba_queries(self): - metric_mri_to_obj_dict: dict[tuple[str | None, str, str], MetricExpressionBase] = {} - fields_in_entities: dict[MetricEntity, list[tuple[str | None, str, str]]] = {} + metric_mri_to_obj_dict: dict[MetricExpressionKey, MetricExpressionBase] = {} + fields_in_entities: dict[MetricEntity, list[MetricExpressionKey]] = {} for select_field in self._metrics_query.select: metric_field_obj = metric_object_factory(select_field.op, select_field.metric_mri) @@ -1201,7 +1230,7 @@ def get_snuba_queries(self): projects=self._projects, use_case_id=self._use_case_id, alias=field[2], - params=params, + params=_coerce_scalar_metric_params(params), ) metric_ids_set |= metric_field_obj.generate_metric_ids( self._projects, self._use_case_id @@ -1255,7 +1284,7 @@ def __init__( self, organization_id: int, metrics_query: DeprecatingMetricsQuery, - fields_in_entities: dict[MetricEntity, list[tuple[str | None, str, str]]], + fields_in_entities: dict[MetricEntity, list[MetricExpressionKey]], intervals: list[datetime], results, use_case_id: UseCaseID, @@ -1273,7 +1302,7 @@ def __init__( } # This is a set of all the `(op, metric_mri, alias)` combinations passed in the metrics_query - self._metrics_query_fields_set = { + self._metrics_query_fields_set: set[MetricExpressionKey] = { (field.op, field.metric_mri, field.alias) for field in metrics_query.select } # This is a set of all queryable `(op, metric_mri)` combinations. Queryable can mean it @@ -1281,10 +1310,10 @@ def __init__( # SingularEntityDerivedMetric or the instances of SingularEntityDerivedMetric that are # the constituents necessary to calculate instances of CompositeEntityDerivedMetric but # are not necessarily requested in the query definition - self._fields_in_entities_set = { + self._fields_in_entities_set: set[MetricExpressionKey] = { elem for fields_in_entity in fields_in_entities.values() for elem in fields_in_entity } - self._set_of_constituent_queries = self._fields_in_entities_set.union( + self._set_of_constituent_queries: set[MetricExpressionKey] = self._fields_in_entities_set.union( self._metrics_query_fields_set ) @@ -1436,7 +1465,7 @@ def resolve_tag_value(value: int | str | None) -> str | None: except KeyError: params = None totals[alias] = metric_obj.run_post_query_function( - totals, params=params, alias=alias + totals, params=_coerce_scalar_metric_params(params), alias=alias ) if series is not None: @@ -1451,7 +1480,7 @@ def resolve_tag_value(value: int | str | None) -> str | None: except KeyError: params = None series[alias][idx] = metric_obj.run_post_query_function( - series, params=params, idx=idx, alias=alias + series, params=_coerce_scalar_metric_params(params), idx=idx, alias=alias ) # Remove the extra fields added due to the constituent metrics that were added