From 40a96bee8dec22049924967839c9d3c63084d3f9 Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Sat, 3 Oct 2026 12:11:57 +0000 Subject: [PATCH] Remove query_builder from mypy typing issues list Co-authored-by: Armen Zambrano G. --- pyproject.toml | 1 - src/sentry/snuba/metrics/query_builder.py | 103 +++++++++++++++------- 2 files changed, 72 insertions(+), 32 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index c911aeadcd78..a032cae080b7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -392,7 +392,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 025565831bab..3611307916ca 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 ( @@ -67,10 +67,12 @@ FIELD_ALIAS_MAPPINGS, FILTERABLE_TAGS, NON_RESOLVABLE_TAG_VALUES, + OPERATIONS, TS_COL_GROUP, DerivedMetricParseException, MetricDoesNotExistException, MetricEntity, + MetricOperationType, get_num_intervals, get_timestamp_column_name, require_rhs_condition_resolution, @@ -125,18 +127,29 @@ def parse_field(field: str, allow_mri: bool = False) -> MetricField: def parse_public_field(field: str) -> MetricField: + operation_str: str | None matches = PUBLIC_EXPRESSION_REGEX.match(field) if matches is not None: - operation = matches[1] + operation_str = matches[1] metric_name = matches[2] else: - operation = None + operation_str = None metric_name = field + if operation_str is not None and operation_str not in OPERATIONS: + raise InvalidParams(f"Invalid operation '{operation_str}'") + + operation = cast(MetricOperationType | None, operation_str) return MetricField(operation, get_mri(metric_name)) +def _metric_operation_params( + params: dict[str, None | str | int | float | Sequence[tuple[str | int, ...]]] | None, +) -> Mapping[str, str | int | float] | None: + return cast(Mapping[str, str | int | float] | None, params) + + def transform_null_transaction_to_unparameterized(use_case_id, org_id, alias=None): """ This function transforms any null tag.transaction to '<< unparameterized >>' so that it can be handled @@ -747,11 +760,12 @@ def translate_meta_results( continue elif alias_type == AliasMetaType.GROUP_BY_METRIC_FIELD: metric_groupby_field = alias_to_metric_group_by_field[record["name"]] - defined_parent_meta_type = get_metric_object_from_metric_field( - metric_groupby_field.field - ).get_meta_type() - - record["type"] = defined_parent_meta_type + if isinstance(metric_groupby_field.field, MetricField): + defined_parent_meta_type = get_metric_object_from_metric_field( + metric_groupby_field.field + ).get_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: @@ -825,12 +839,19 @@ 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.") + group_by_field = cast( + MetricGroupByField | None, metric_action_by_field if is_group_by else None + ) + order_by_field = cast( + MetricOrderByField | None, 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 group_by_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, group_by_field.alias ) # Handles the case when we are trying to group or order by `project` for example, but we want @@ -853,7 +874,7 @@ 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 "", ) if is_group_by and not is_column else Column(name=column_name) @@ -862,7 +883,8 @@ def generate_snql_for_action_by_fields( if is_order_by: # 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)] + assert order_by_field is not None + exp = [OrderBy(exp=exp, direction=order_by_field.direction)] return exp elif isinstance(metric_action_by_field.field, MetricField): @@ -875,16 +897,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=_metric_operation_params(metric_action_by_field.field.params), projects=projects, )[0] elif is_order_by: + assert 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=_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( @@ -922,16 +945,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=_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_condition_rhs(condition), ) ) except IndexError: @@ -965,6 +984,15 @@ def _build_timeframe(self) -> list[BooleanCondition | Condition]: return where + def _resolve_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"Cannot resolve non-string rhs value for condition: {condition}") + + return resolve_tag_value(self._use_case_id, self._org_id, condition.rhs) + def _build_groupby(self) -> list[Column] | None: if self._metrics_query.groupby is None: return None @@ -1066,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 series queries") time_groupby_column = self.__generate_time_groupby_column_for_discover_queries( self._metrics_query.interval ) @@ -1096,11 +1126,13 @@ 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, Sequence[str]], + metric_mri_to_obj_dict: dict[ + tuple[MetricOperationType | None, str, str], MetricExpressionBase + ], + fields_in_entities: dict[MetricEntity, list[tuple[MetricOperationType | None, str, str]]], parent_alias, - ) -> dict[tuple[str | None, str, str], MetricExpressionBase]: + ) -> dict[tuple[MetricOperationType | None, str, str], 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 @@ -1125,8 +1157,12 @@ 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[ + tuple[MetricOperationType | None, str, str], MetricExpressionBase + ] = {} + fields_in_entities: dict[ + MetricEntity, list[tuple[MetricOperationType | None, str, str]] + ] = {} for select_field in self._metrics_query.select: metric_field_obj = metric_object_factory(select_field.op, select_field.metric_mri) @@ -1149,8 +1185,13 @@ def get_snuba_queries(self): # lists of metric_mris as values representing all the entities and # metric_mris combination that this metric_object is composed of, or rather # the instances of SingleEntityDerivedMetric that it is composed of + filtered_entities = { + entity: metric_mris + for entity, metric_mris in component_entities.items() + if entity is not None + } metric_mri_to_obj_dict = self.__update_query_dicts_with_component_entities( - component_entities=component_entities, + component_entities=filtered_entities, metric_mri_to_obj_dict=metric_mri_to_obj_dict, fields_in_entities=fields_in_entities, parent_alias=select_field.alias, @@ -1198,7 +1239,7 @@ def get_snuba_queries(self): projects=self._projects, use_case_id=self._use_case_id, alias=field[2], - params=params, + params=_metric_operation_params(params), ) metric_ids_set |= metric_field_obj.generate_metric_ids( self._projects, self._use_case_id @@ -1252,7 +1293,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[tuple[MetricOperationType | None, str, str]]], intervals: list[datetime], results, use_case_id: UseCaseID, @@ -1433,7 +1474,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=_metric_operation_params(params), alias=alias ) if series is not None: @@ -1448,7 +1489,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=_metric_operation_params(params), idx=idx, alias=alias ) # Remove the extra fields added due to the constituent metrics that were added