diff --git a/pyproject.toml b/pyproject.toml index e0fb98375ec8..f264fa4075d2 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..815034b3847b 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 ( @@ -71,6 +71,7 @@ DerivedMetricParseException, MetricDoesNotExistException, MetricEntity, + MetricOperationType, get_num_intervals, get_timestamp_column_name, require_rhs_condition_resolution, @@ -94,6 +95,20 @@ QUERY_PROJECT_LIMIT = 10 +MetricOperationParam = str | int | float +MetricFieldParamValue = None | MetricOperationParam | Sequence[tuple[str | int, ...]] +MetricFieldParams = Mapping[str, MetricFieldParamValue] | None +MetricFieldKey = tuple[MetricOperationType | None, str, str] + + +def _to_metric_operation_params( + params: MetricFieldParams, +) -> Mapping[str, MetricOperationParam] | None: + # MetricField.params supports some richer value shapes (e.g. tuple lists for + # team_key_transaction), while MetricExpression signatures type params as + # scalar mappings. Keep runtime values intact and narrow for static typing. + return cast(Mapping[str, MetricOperationParam] | None, params) + def _strip_project_id(condition: Condition) -> Condition | None: if isinstance(condition, BooleanCondition): @@ -128,7 +143,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]) metric_name = matches[2] else: operation = None @@ -747,11 +762,14 @@ def translate_meta_results( continue elif alias_type == AliasMetaType.GROUP_BY_METRIC_FIELD: metric_groupby_field = alias_to_metric_group_by_field[record["name"]] + if not isinstance(metric_groupby_field.field, MetricField): + raise InvalidParams(f"Field {record['name']} was not a metric group by field") 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: @@ -824,16 +842,26 @@ def generate_snql_for_action_by_fields( the snql generation starts to diverge significantly. """ - is_group_by = isinstance(metric_action_by_field, MetricGroupByField) - is_order_by = isinstance(metric_action_by_field, MetricOrderByField) + group_by_field = ( + metric_action_by_field + if isinstance(metric_action_by_field, MetricGroupByField) + else None + ) + order_by_field = ( + metric_action_by_field + if isinstance(metric_action_by_field, MetricOrderByField) + else None + ) + is_group_by = group_by_field is not None + is_order_by = order_by_field is not None if not is_group_by and not is_order_by: raise InvalidParams("The metric action must either be an order by or group by.") 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": + if group_by_field is not None and metric_action_by_field.field == "transaction": return transform_null_transaction_to_unparameterized( - use_case_id, org_id, metric_action_by_field.alias + use_case_id, org_id, group_by_field.alias ) # Handles the case when we are trying to group or order by `project` for example, but we want @@ -856,16 +884,16 @@ def generate_snql_for_action_by_fields( exp = ( AliasedExpression( exp=Column(name=column_name), - alias=metric_action_by_field.alias, + alias=group_by_field.alias if group_by_field is not None else None, ) if is_group_by and not is_column else Column(name=column_name) ) - if is_order_by: + if order_by_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=order_by_field.direction)] return exp elif isinstance(metric_action_by_field.field, MetricField): @@ -878,16 +906,16 @@ 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=_to_metric_operation_params(metric_action_by_field.field.params), projects=projects, )[0] - elif is_order_by: + elif order_by_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=_to_metric_operation_params(metric_action_by_field.field.params), projects=projects, - direction=metric_action_by_field.direction, + direction=order_by_field.direction, ) else: raise NotImplementedError( @@ -901,6 +929,17 @@ def generate_snql_for_action_by_fields( f"Unsupported {'group by' if is_group_by else 'order by' if is_order_by else 'None'} field: {metric_action_by_field.field} needs to be either a MetricField or a string" ) + def _resolve_metric_condition_rhs(self, condition: MetricConditionField) -> int | float | str: + if condition.lhs.op is None or not require_rhs_condition_resolution(condition.lhs.op): + return condition.rhs + + if not isinstance(condition.rhs, str): + raise InvalidParams( + f"Metric condition {condition.lhs} requires a string rhs value; got {type(condition.rhs).__name__}" + ) + + return resolve_tag_value(self._use_case_id, self._org_id, condition.rhs) + def _build_where(self) -> list[BooleanCondition | Condition]: where: list[BooleanCondition | Condition] = [ Condition(Column("org_id"), Op.EQ, self._org_id), @@ -925,16 +964,12 @@ def _build_where(self) -> list[BooleanCondition | Condition]: Condition( lhs=metric_expression.generate_where_statements( use_case_id=self._use_case_id, - params=condition.lhs.params, + params=_to_metric_operation_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=self._resolve_metric_condition_rhs(condition), ) ) except IndexError: @@ -1069,6 +1104,10 @@ 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 transactions and spans series queries" + ) time_groupby_column = self.__generate_time_groupby_column_for_discover_queries( self._metrics_query.interval ) @@ -1099,17 +1138,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]]], - parent_alias, - ) -> dict[tuple[str | None, str, str], MetricExpressionBase]: + component_entities: Mapping[MetricEntity | None, Sequence[str]], + metric_mri_to_obj_dict: dict[MetricFieldKey, MetricExpressionBase], + fields_in_entities: dict[MetricEntity, list[MetricFieldKey]], + parent_alias: str, + ) -> dict[MetricFieldKey, 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 +1169,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[MetricFieldKey, MetricExpressionBase] = {} + fields_in_entities: dict[MetricEntity, list[MetricFieldKey]] = {} for select_field in self._metrics_query.select: metric_field_obj = metric_object_factory(select_field.op, select_field.metric_mri) @@ -1190,18 +1231,20 @@ def get_snuba_queries(self): for field in fields: metric_field_obj = metric_mri_to_obj_dict[field] try: - params = self._alias_to_metric_field[field[2]].params + raw_params = self._alias_to_metric_field[field[2]].params except KeyError: - params = None + raw_params = None # In order to support on demand metrics which require an interval (e.g. epm), # we want to pass the interval down via params so we can pass it to the associated snql_factory - params = {"interval": self._metrics_query.interval, **(params or {})} + params = dict(_to_metric_operation_params(raw_params) or {}) + if self._metrics_query.interval is not None: + params["interval"] = self._metrics_query.interval select += metric_field_obj.generate_select_statements( projects=self._projects, use_case_id=self._use_case_id, alias=field[2], - params=params, + params=params or None, ) metric_ids_set |= metric_field_obj.generate_metric_ids( self._projects, self._use_case_id @@ -1255,7 +1298,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[MetricFieldKey]], intervals: list[datetime], results, use_case_id: UseCaseID, @@ -1273,7 +1316,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[MetricFieldKey] = { (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 +1324,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[MetricFieldKey] = { 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[MetricFieldKey] = self._fields_in_entities_set.union( self._metrics_query_fields_set ) @@ -1432,11 +1475,13 @@ def resolve_tag_value(value: int | str | None) -> str | None: metric_obj = metric_object_factory(op=op, metric_mri=metric_mri) if totals is not None: try: - params = self._alias_to_metric_field[alias].params + raw_params = self._alias_to_metric_field[alias].params except KeyError: - params = None + raw_params = None totals[alias] = metric_obj.run_post_query_function( - totals, params=params, alias=alias + totals, + params=_to_metric_operation_params(raw_params), + alias=alias, ) if series is not None: @@ -1447,11 +1492,14 @@ def resolve_tag_value(value: int | str | None) -> str | None: [metric_obj.generate_default_null_values()] * len(self._intervals), ) try: - params = self._alias_to_metric_field[alias].params + raw_params = self._alias_to_metric_field[alias].params except KeyError: - params = None + raw_params = None series[alias][idx] = metric_obj.run_post_query_function( - series, params=params, idx=idx, alias=alias + series, + params=_to_metric_operation_params(raw_params), + idx=idx, + alias=alias, ) # Remove the extra fields added due to the constituent metrics that were added