ref: referrer should always be present for snuba calls (#97002)

<!-- Describe your PR here. -->

Author: asottile-sentry

src/sentry/search/base.py

@@ -38,8 +38,9 @@ def query(
         date_from: datetime | None = None,
         date_to: datetime | None = None,
         max_hits: int | None = None,
-        referrer: str | None = None,
         actor: Any | None = None,
         aggregate_kwargs: TrendsSortWeights | None = None,
+        *,
+        referrer: str,
     ) -> CursorResult[Group]:
         raise NotImplementedError

src/sentry/search/events/builder/base.py

@@ -1590,7 +1590,7 @@ def get_snql_query(self) -> Request:
 
     def run_query(
         self,
-        referrer: str | None,
+        referrer: str,
         use_cache: bool = False,
         query_source: QuerySource | None = None,
     ) -> Any:

src/sentry/search/snuba/backend.py

@@ -379,9 +379,10 @@ def query(
         date_from: datetime | None = None,
         date_to: datetime | None = None,
         max_hits: int | None = None,
-        referrer: str | None = None,
         actor: Any | None = None,
         aggregate_kwargs: TrendsSortWeights | None = None,
+        *,
+        referrer: str,
     ) -> CursorResult[Group]:
         search_filters = search_filters if search_filters is not None else []
         # ensure projects are from same org

src/sentry/search/snuba/executors.py

@@ -216,9 +216,10 @@ def query(
         date_from: datetime | None,
         date_to: datetime | None,
         max_hits: int | None = None,
-        referrer: str | None = None,
         actor: Any | None = None,
         aggregate_kwargs: TrendsSortWeights | None = None,
+        *,
+        referrer: str,
     ) -> CursorResult[Group]:
         """This function runs your actual query and returns the results
         We usually return a paginator object, which contains the results and the number of hits"""
@@ -396,9 +397,10 @@ def snuba_search(
         offset: int = 0,
         get_sample: bool = False,
         search_filters: Sequence[SearchFilter] | None = None,
-        referrer: str | None = None,
         actor: Any | None = None,
         aggregate_kwargs: TrendsSortWeights | None = None,
+        *,
+        referrer: str,
     ) -> tuple[list[tuple[int, Any]], int]:
         """Queries Snuba for events with associated Groups based on the input criteria.
 
@@ -747,9 +749,10 @@ def query(
         date_from: datetime | None,
         date_to: datetime | None,
         max_hits: int | None = None,
-        referrer: str | None = None,
         actor: Any | None = None,
         aggregate_kwargs: TrendsSortWeights | None = None,
+        *,
+        referrer: str,
     ) -> CursorResult[Group]:
         now = timezone.now()
         end = None
@@ -903,6 +906,7 @@ def query(
             start,
             end,
             actor,
+            referrer=referrer,
         )
         if count_hits and hits == 0:
             return self.empty_result
@@ -1046,6 +1050,8 @@ def calculate_hits(
         start: datetime,
         end: datetime,
         actor: Any | None = None,
+        *,
+        referrer: str,
     ) -> int | None:
         """
         This method should return an integer representing the number of hits (results) of your search.
@@ -1088,7 +1094,11 @@ def calculate_hits(
             # +/-10% @ 95% confidence.
 
             sample_size = options.get("snuba.search.hits-sample-size")
-            kwargs = dict(
+            kwargs = {}
+            if not too_many_candidates:
+                kwargs["group_ids"] = group_ids
+
+            snuba_groups, snuba_total = self.snuba_search(
                 start=start,
                 end=end,
                 project_ids=[p.id for p in projects],
@@ -1100,11 +1110,9 @@ def calculate_hits(
                 get_sample=True,
                 search_filters=search_filters,
                 actor=actor,
+                referrer=referrer,
+                **kwargs,
             )
-            if not too_many_candidates:
-                kwargs["group_ids"] = group_ids
-
-            snuba_groups, snuba_total = self.snuba_search(**kwargs)
             snuba_count = len(snuba_groups)
             if snuba_count == 0:
                 # Maybe check for 0 hits and return EMPTY_RESULT in ::query? self.empty_result

src/sentry/snuba/discover.py

@@ -165,7 +165,6 @@ def query(
     orderby: list[str] | None = None,
     offset: int | None = None,
     limit: int = 50,
-    referrer: str | None = None,
     auto_fields: bool = False,
     auto_aggregations: bool = False,
     include_equation_fields: bool = False,
@@ -185,6 +184,8 @@ def query(
     fallback_to_transactions: bool = False,
     query_source: QuerySource | None = None,
     debug: bool = False,
+    *,
+    referrer: str,
 ) -> EventsResponse:
     """
     High-level API for doing arbitrary user queries against events.
@@ -268,7 +269,6 @@ def timeseries_query(
     query: str,
     snuba_params: SnubaParams,
     rollup: int,
-    referrer: str | None = None,
     zerofill_results: bool = True,
     comparison_delta: timedelta | None = None,
     functions_acl: list[str] | None = None,
@@ -281,6 +281,8 @@ def timeseries_query(
     query_source: QuerySource | None = None,
     fallback_to_transactions: bool = False,
     transform_alias_to_input_format: bool = False,
+    *,
+    referrer: str,
 ) -> SnubaTSResult:
     """
     High-level API for doing arbitrary user timeseries queries against events.
@@ -447,7 +449,6 @@ def top_events_timeseries(
     limit: int,
     organization: Organization,
     equations: list[str] | None = None,
-    referrer: str | None = None,
     top_events: EventsResponse | None = None,
     allow_empty: bool = True,
     zerofill_results: bool = True,
@@ -459,6 +460,8 @@ def top_events_timeseries(
     query_source: QuerySource | None = None,
     fallback_to_transactions: bool = False,
     transform_alias_to_input_format: bool = False,
+    *,
+    referrer: str,
 ) -> dict[str, SnubaTSResult] | SnubaTSResult:
     """
     High-level API for doing arbitrary user timeseries queries for a limited number of top events
@@ -805,7 +808,6 @@ def spans_histogram_query(
     min_value: float | None = None,
     max_value: float | None = None,
     data_filter: Literal["exclude_outliers"] | None = None,
-    referrer: str | None = None,
     group_by: list[str] | None = None,
     order_by: list[str] | None = None,
     limit_by: list[str] | None = None,
@@ -815,6 +817,8 @@ def spans_histogram_query(
     on_demand_metrics_enabled: bool = False,
     on_demand_metrics_type: MetricSpecType | None = None,
     query_source: QuerySource | None = None,
+    *,
+    referrer: str,
 ) -> EventsResponse | SnubaData:
     """
     API for generating histograms for span exclusive time.
@@ -894,7 +898,6 @@ def histogram_query(
     min_value: float | None = None,
     max_value: float | None = None,
     data_filter: Literal["exclude_outliers"] | None = None,
-    referrer: str | None = None,
     group_by: list[str] | None = None,
     order_by: list[str] | None = None,
     limit_by: list[str] | None = None,
@@ -905,6 +908,8 @@ def histogram_query(
     on_demand_metrics_enabled: bool = False,
     on_demand_metrics_type: MetricSpecType | None = None,
     query_source: QuerySource | None = None,
+    *,
+    referrer: str,
 ):
     """
     API for generating histograms for numeric columns.

src/sentry/snuba/errors.py

@@ -40,7 +40,6 @@ def query(
     orderby: list[str] | None = None,
     offset: int | None = None,
     limit: int = 50,
-    referrer: str | None = None,
     auto_fields: bool = False,
     auto_aggregations: bool = False,
     include_equation_fields: bool = False,
@@ -60,6 +59,8 @@ def query(
     fallback_to_transactions: bool = False,
     query_source: QuerySource | None = None,
     debug: bool = False,
+    *,
+    referrer: str,
 ) -> EventsResponse:
     if not selected_columns:
         raise InvalidSearchQuery("No columns selected")
@@ -101,7 +102,6 @@ def timeseries_query(
     query: str,
     snuba_params: SnubaParams,
     rollup: int,
-    referrer: str | None = None,
     zerofill_results: bool = True,
     comparison_delta: timedelta | None = None,
     functions_acl: list[str] | None = None,
@@ -113,6 +113,8 @@ def timeseries_query(
     query_source: QuerySource | None = None,
     fallback_to_transactions: bool = False,
     transform_alias_to_input_format: bool = False,
+    *,
+    referrer: str,
 ):
 
     with sentry_sdk.start_span(op="errors", name="timeseries.filter_transform"):
@@ -211,7 +213,6 @@ def top_events_timeseries(
     limit: int,
     organization: Organization,
     equations: list[str] | None = None,
-    referrer: str | None = None,
     top_events: EventsResponse | None = None,
     allow_empty: bool = True,
     zerofill_results: bool = True,
@@ -223,6 +224,8 @@ def top_events_timeseries(
     query_source: QuerySource | None = None,
     fallback_to_transactions: bool = False,
     transform_alias_to_input_format: bool = False,
+    *,
+    referrer: str,
 ) -> dict[str, SnubaTSResult] | SnubaTSResult:
     """
     High-level API for doing arbitrary user timeseries queries for a limited number of top events

src/sentry/snuba/functions.py

@@ -29,7 +29,6 @@ def query(
     offset: int = 0,
     limit: int = 50,
     limitby: tuple[str, int] | None = None,
-    referrer: str = "",
     auto_fields: bool = False,
     auto_aggregations: bool = False,
     use_aggregate_conditions: bool = False,
@@ -44,6 +43,8 @@ def query(
     fallback_to_transactions=False,
     query_source: QuerySource | None = None,
     debug: bool = False,
+    *,
+    referrer: str,
 ) -> Any:
     if not selected_columns:
         raise InvalidSearchQuery("No columns selected")
@@ -82,7 +83,6 @@ def timeseries_query(
     query: str | None,
     snuba_params: SnubaParams,
     rollup: int,
-    referrer: str = "",
     zerofill_results: bool = True,
     comparison_delta: timedelta | None = None,
     functions_acl: list[str] | None = None,
@@ -94,6 +94,8 @@ def timeseries_query(
     query_source: QuerySource | None = None,
     fallback_to_transactions: bool = False,
     transform_alias_to_input_format: bool = False,
+    *,
+    referrer: str,
 ) -> Any:
 
     builder = ProfileFunctionsTimeseriesQueryBuilder(
@@ -143,7 +145,6 @@ def top_events_timeseries(
     limit,
     organization,
     equations=None,
-    referrer=None,
     top_events=None,
     allow_empty=True,
     zerofill_results=True,
@@ -155,6 +156,8 @@ def top_events_timeseries(
     query_source: QuerySource | None = None,
     fallback_to_transactions: bool = False,
     transform_alias_to_input_format: bool = False,
+    *,
+    referrer: str,
 ):
     assert not include_other, "Other is not supported"  # TODO: support other
 

src/sentry/snuba/issue_platform.py

@@ -23,7 +23,6 @@ def query(
     orderby=None,
     offset=None,
     limit=50,
-    referrer=None,
     auto_fields=False,
     auto_aggregations=False,
     include_equation_fields=False,
@@ -41,6 +40,8 @@ def query(
     fallback_to_transactions=False,
     query_source: QuerySource | None = None,
     debug: bool = False,
+    *,
+    referrer: str,
 ) -> EventsResponse:
     """
     High-level API for doing arbitrary user queries against events.
@@ -112,7 +113,6 @@ def timeseries_query(
     query: str,
     snuba_params: SnubaParams,
     rollup: int,
-    referrer: str | None = None,
     zerofill_results: bool = True,
     comparison_delta: timedelta | None = None,
     functions_acl: list[str] | None = None,
@@ -124,6 +124,8 @@ def timeseries_query(
     query_source: QuerySource | None = None,
     fallback_to_transactions: bool = False,
     transform_alias_to_input_format: bool = False,
+    *,
+    referrer: str,
 ):
     """
     High-level API for doing arbitrary user timeseries queries against events.