feat(timeseries): Allow passing query options to useFetchEventsTimeSeries (#101270)

A lot of our data fetching hooks support this. Useful for specifying
custom stale time, for example.

Author: gggritso

static/app/utils/timeSeries/useFetchEventsTimeSeries.tsx

@@ -3,7 +3,7 @@ import type {PageFilters} from 'sentry/types/core';
 import {encodeSort} from 'sentry/utils/discover/eventView';
 import type {Sort} from 'sentry/utils/discover/fields';
 import {DiscoverDatasets} from 'sentry/utils/discover/types';
-import {useApiQuery} from 'sentry/utils/queryClient';
+import {useApiQuery, type UseApiQueryOptions} from 'sentry/utils/queryClient';
 import type {MutableSearch} from 'sentry/utils/tokenizeSearch';
 import useOrganization from 'sentry/utils/useOrganization';
 import usePageFilters from 'sentry/utils/usePageFilters';
@@ -48,6 +48,10 @@ interface UseFetchEventsTimeSeriesOptions<YAxis, Attribute> {
    * Query to apply to the data set. Can be either a `MutableSearch` object (preferred) or a plain string.
    */
   query?: MutableSearch | string;
+  /**
+   * Options to pass to `useApiQuery`
+   */
+  queryOptions?: Partial<UseApiQueryOptions<EventsTimeSeriesResponse>>;
   /**
    * Sampling mode. Only specify this if you're sure you require a specific sampling mode. In most cases, the backend will automatically decide this.
    */
@@ -78,27 +82,31 @@ export function useFetchSpanTimeSeries<
  */
 export function useFetchEventsTimeSeries<YAxis extends string, Attribute extends string>(
   dataset: DiscoverDatasets,
-  {
+  options: UseFetchEventsTimeSeriesOptions<YAxis, Attribute>,
+  referrer: string
+) {
+  const {
     yAxis,
     excludeOther,
     enabled,
     groupBy,
-    interval,
     query,
     sampling,
     pageFilters,
     sort,
     topEvents,
-  }: UseFetchEventsTimeSeriesOptions<YAxis, Attribute>,
-  referrer: string
-) {
+  } = options;
+
   const organization = useOrganization();
 
   const {isReady: arePageFiltersReady, selection: defaultSelection} = usePageFilters();
 
   const hasCustomPageFilters = Boolean(pageFilters);
   const selection = pageFilters ?? defaultSelection;
 
+  const interval =
+    options.interval ?? getIntervalForTimeSeriesQuery(yAxis, selection.datetime);
+
   if (!referrer) {
     throw new Error(
       '`useFetchEventsTimeSeries` cannot accept an empty referrer string, please specify a referrer!'
@@ -118,7 +126,7 @@ export function useFetchEventsTimeSeries<YAxis extends string, Attribute extends
           ...normalizeDateTimeParams(selection.datetime),
           project: selection.projects,
           environment: selection.environments,
-          interval: interval ?? getIntervalForTimeSeriesQuery(yAxis, selection.datetime),
+          interval,
           query: query
             ? typeof query === 'string'
               ? query
@@ -137,6 +145,7 @@ export function useFetchEventsTimeSeries<YAxis extends string, Attribute extends
       retryDelay: getRetryDelay,
       refetchOnWindowFocus: false,
       enabled: enabled && (hasCustomPageFilters ? true : arePageFiltersReady),
+      ...options.queryOptions,
     }
   );
 }