From 5d07f85e4f60c7579df803b1bdd07d62adf9e1ff Mon Sep 17 00:00:00 2001 From: TkDodo Date: Tue, 4 Mar 2025 09:42:57 +0100 Subject: [PATCH 1/8] ref: add the eslint-plugin-query --- eslint.config.mjs | 11 +++++++++ package.json | 1 + yarn.lock | 57 +++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 69 insertions(+) diff --git a/eslint.config.mjs b/eslint.config.mjs index 4a432b279499..630bc9a5cccb 100644 --- a/eslint.config.mjs +++ b/eslint.config.mjs @@ -11,6 +11,7 @@ */ import * as emotion from '@emotion/eslint-plugin'; import eslint from '@eslint/js'; +import pluginQuery from '@tanstack/eslint-plugin-query'; import prettier from 'eslint-config-prettier'; // @ts-expect-error TS(7016): Could not find a declaration file import importPlugin from 'eslint-plugin-import'; @@ -319,6 +320,16 @@ export default typescript.config([ 'import/no-unresolved': 'off', // Disabled in favor of typescript-eslint }, }, + { + name: 'plugin/tanstack/query', + plugins: { + '@tanstack/query': pluginQuery, + }, + rules: { + ...pluginQuery.configs.recommended.rules, + '@tanstack/query/no-rest-destructuring': 'error', + }, + }, { name: 'plugin/react', // https://github.com/jsx-eslint/eslint-plugin-react/tree/master/docs/rules diff --git a/package.json b/package.json index f1ec77844861..8339accb603a 100644 --- a/package.json +++ b/package.json @@ -185,6 +185,7 @@ "@sentry/jest-environment": "6.0.0", "@sentry/profiling-node": "9.2.0-alpha.1", "@styled/typescript-styled-plugin": "^1.0.1", + "@tanstack/eslint-plugin-query": "^5.66.1", "@testing-library/dom": "10.4.0", "@testing-library/jest-dom": "6.6.3", "@testing-library/react": "16.2.0", diff --git a/yarn.lock b/yarn.lock index b3a096f59de0..0ced0e706dc7 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3675,6 +3675,13 @@ dependencies: tslib "^2.4.0" +"@tanstack/eslint-plugin-query@^5.66.1": + version "5.66.1" + resolved "https://registry.yarnpkg.com/@tanstack/eslint-plugin-query/-/eslint-plugin-query-5.66.1.tgz#9951e4d3633ca6248196742cad437b4d7c760cd7" + integrity sha512-pYMVTGgJ7yPk9Rm6UWEmbY6TX0EmMmxJqYkthgeDCwEznToy2m+W928nUODFirtZBZlhBsqHy33LO0kyTlgf0w== + dependencies: + "@typescript-eslint/utils" "^8.18.1" + "@tanstack/query-core@5.64.1": version "5.64.1" resolved "https://registry.yarnpkg.com/@tanstack/query-core/-/query-core-5.64.1.tgz#d56e26b3e29fc68a89d140f1fd92900bc8f3fc86" @@ -4408,6 +4415,14 @@ "@typescript-eslint/types" "8.18.2" "@typescript-eslint/visitor-keys" "8.18.2" +"@typescript-eslint/scope-manager@8.26.0": + version "8.26.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-8.26.0.tgz#b06623fad54a3a77fadab5f652ef75ed3780b545" + integrity sha512-E0ntLvsfPqnPwng8b8y4OGuzh/iIOm2z8U3S9zic2TeMLW61u5IH2Q1wu0oSTkfrSzwbDJIB/Lm8O3//8BWMPA== + dependencies: + "@typescript-eslint/types" "8.26.0" + "@typescript-eslint/visitor-keys" "8.26.0" + "@typescript-eslint/type-utils@8.18.2": version "8.18.2" resolved "https://registry.yarnpkg.com/@typescript-eslint/type-utils/-/type-utils-8.18.2.tgz#5ad07e09002eee237591881df674c1c0c91ca52f" @@ -4428,6 +4443,11 @@ resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-8.18.2.tgz#5ebad5b384c8aa1c0f86cee1c61bcdbe7511f547" integrity sha512-Z/zblEPp8cIvmEn6+tPDIHUbRu/0z5lqZ+NvolL5SvXWT5rQy7+Nch83M0++XzO0XrWRFWECgOAyE8bsJTl1GQ== +"@typescript-eslint/types@8.26.0": + version "8.26.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-8.26.0.tgz#c4e93a8faf3a38a8d8adb007dc7834f1c89ee7bf" + integrity sha512-89B1eP3tnpr9A8L6PZlSjBvnJhWXtYfZhECqlBl1D9Lme9mHO6iWlsprBtVenQvY1HMhax1mWOjhtL3fh/u+pA== + "@typescript-eslint/typescript-estree@5.62.0": version "5.62.0" resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-5.62.0.tgz#7d17794b77fabcac615d6a48fb143330d962eb9b" @@ -4455,6 +4475,20 @@ semver "^7.6.0" ts-api-utils "^1.3.0" +"@typescript-eslint/typescript-estree@8.26.0": + version "8.26.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-8.26.0.tgz#128972172005a7376e34ed2ecba4e29363b0cad1" + integrity sha512-tiJ1Hvy/V/oMVRTbEOIeemA2XoylimlDQ03CgPPNaHYZbpsc78Hmngnt+WXZfJX1pjQ711V7g0H7cSJThGYfPQ== + dependencies: + "@typescript-eslint/types" "8.26.0" + "@typescript-eslint/visitor-keys" "8.26.0" + debug "^4.3.4" + fast-glob "^3.3.2" + is-glob "^4.0.3" + minimatch "^9.0.4" + semver "^7.6.0" + ts-api-utils "^2.0.1" + "@typescript-eslint/utils@5.62.0", "@typescript-eslint/utils@^5.25.0": version "5.62.0" resolved "https://registry.yarnpkg.com/@typescript-eslint/utils/-/utils-5.62.0.tgz#141e809c71636e4a75daa39faed2fb5f4b10df86" @@ -4479,6 +4513,16 @@ "@typescript-eslint/types" "8.18.2" "@typescript-eslint/typescript-estree" "8.18.2" +"@typescript-eslint/utils@^8.18.1": + version "8.26.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/utils/-/utils-8.26.0.tgz#845d20ed8378a5594e6445f54e53b972aee7b3e6" + integrity sha512-2L2tU3FVwhvU14LndnQCA2frYC8JnPDVKyQtWFPf8IYFMt/ykEN1bPolNhNbCVgOmdzTlWdusCTKA/9nKrf8Ig== + dependencies: + "@eslint-community/eslint-utils" "^4.4.0" + "@typescript-eslint/scope-manager" "8.26.0" + "@typescript-eslint/types" "8.26.0" + "@typescript-eslint/typescript-estree" "8.26.0" + "@typescript-eslint/visitor-keys@5.62.0": version "5.62.0" resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-5.62.0.tgz#2174011917ce582875954ffe2f6912d5931e353e" @@ -4495,6 +4539,14 @@ "@typescript-eslint/types" "8.18.2" eslint-visitor-keys "^4.2.0" +"@typescript-eslint/visitor-keys@8.26.0": + version "8.26.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-8.26.0.tgz#a4876216756c69130ea958df3b77222c2ad95290" + integrity sha512-2z8JQJWAzPdDd51dRQ/oqIJxe99/hoLIqmf8RMCAJQtYDc535W/Jt2+RTP4bP0aKeBG1F65yjIZuczOXCmbWwg== + dependencies: + "@typescript-eslint/types" "8.26.0" + eslint-visitor-keys "^4.2.0" + "@vscode/emmet-helper@^2.9.2": version "2.10.0" resolved "https://registry.yarnpkg.com/@vscode/emmet-helper/-/emmet-helper-2.10.0.tgz#a0add01dddce3e07b3f4169b559067096203263a" @@ -11904,6 +11956,11 @@ ts-api-utils@^1.3.0: resolved "https://registry.yarnpkg.com/ts-api-utils/-/ts-api-utils-1.4.3.tgz#bfc2215fe6528fecab2b0fba570a2e8a4263b064" integrity sha512-i3eMG77UTMD0hZhgRS562pv83RC6ukSAC2GMNWc+9dieh/+jDM5u5YG+NHX6VNDRHQcHwmsTHctP9LhbC3WxVw== +ts-api-utils@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/ts-api-utils/-/ts-api-utils-2.0.1.tgz#660729385b625b939aaa58054f45c058f33f10cd" + integrity sha512-dnlgjFSVetynI8nzgJ+qF62efpglpWRk8isUEWZGWlJYySCTD6aKvbUDu+zbPeDakk3bg5H4XpitHukgfL1m9w== + ts-node@^10.9.2: version "10.9.2" resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-10.9.2.tgz#70f021c9e185bccdca820e26dc413805c101c71f" From dcb1fb4580c4fed8ece64ba4d6d831e2f9a799fb Mon Sep 17 00:00:00 2001 From: TkDodo Date: Tue, 4 Mar 2025 09:56:05 +0100 Subject: [PATCH 2/8] ref: fix @tanstack/query/no-unstable-deps violations --- .../app/components/feedback/useMutateActivity.tsx | 14 +++++++------- .../app/components/feedback/useMutateFeedback.tsx | 10 +++++----- .../newTraceDetails/traceApi/useTraceMeta.tsx | 2 +- .../accountSecurity/accountSecurityWrapper.tsx | 5 +++-- .../project/projectOwnership/addCodeOwnerModal.tsx | 6 +++--- 5 files changed, 19 insertions(+), 18 deletions(-) diff --git a/static/app/components/feedback/useMutateActivity.tsx b/static/app/components/feedback/useMutateActivity.tsx index c500b7bc4a51..614fdea45492 100644 --- a/static/app/components/feedback/useMutateActivity.tsx +++ b/static/app/components/feedback/useMutateActivity.tsx @@ -58,7 +58,7 @@ export default function useMutateActivity({ persistInFlight: false, }); - const mutation = useMutation({ + const {mutate} = useMutation({ onMutate: onMutate ?? undefined, mutationFn: ([{note, noteId}, method]) => { const url = @@ -79,23 +79,23 @@ export default function useMutateActivity({ const handleUpdate = useCallback( (note, noteId, activity, options) => { - mutation.mutate([{note, noteId, activity}, 'PUT'], options); + mutate([{note, noteId, activity}, 'PUT'], options); }, - [mutation] + [mutate] ); const handleCreate = useCallback( (note, activity, options) => { - mutation.mutate([{note, activity}, 'POST'], options); + mutate([{note, activity}, 'POST'], options); }, - [mutation] + [mutate] ); const handleDelete = useCallback( (noteId, activity, options) => { - mutation.mutate([{noteId, activity}, 'DELETE'], options); + mutate([{noteId, activity}, 'DELETE'], options); }, - [mutation] + [mutate] ); return { diff --git a/static/app/components/feedback/useMutateFeedback.tsx b/static/app/components/feedback/useMutateFeedback.tsx index d8d119d3991b..9ec159ffccef 100644 --- a/static/app/components/feedback/useMutateFeedback.tsx +++ b/static/app/components/feedback/useMutateFeedback.tsx @@ -36,7 +36,7 @@ export default function useMutateFeedback({ const {listQueryKey} = useFeedbackQueryKeys(); const {updateCached, invalidateCached} = useFeedbackCache(); - const mutation = useMutation({ + const {mutate} = useMutation({ onMutate: ([ids, payload]) => { updateCached(ids, payload); }, @@ -64,9 +64,9 @@ export default function useMutateFeedback({ const markAsRead = useCallback( (hasSeen: boolean, options?: MutateOptions) => { - mutation.mutate([feedbackIds, {hasSeen}], options); + mutate([feedbackIds, {hasSeen}], options); }, - [mutation, feedbackIds] + [mutate, feedbackIds] ); const resolve = useCallback( @@ -74,9 +74,9 @@ export default function useMutateFeedback({ status: GroupStatus, options?: MutateOptions ) => { - mutation.mutate([feedbackIds, {status}], options); + mutate([feedbackIds, {status}], options); }, - [mutation, feedbackIds] + [mutate, feedbackIds] ); return { diff --git a/static/app/views/performance/newTraceDetails/traceApi/useTraceMeta.tsx b/static/app/views/performance/newTraceDetails/traceApi/useTraceMeta.tsx index e70dfd139a31..83710b3c99f6 100644 --- a/static/app/views/performance/newTraceDetails/traceApi/useTraceMeta.tsx +++ b/static/app/views/performance/newTraceDetails/traceApi/useTraceMeta.tsx @@ -163,7 +163,7 @@ export function useTraceMeta(replayTraces: ReplayTrace[]): TraceMetaQueryResults status: query.data?.apiErrors?.length === replayTraces.length ? 'error' : query.status, }; - }, [query, replayTraces.length]); + }, [query.data, query.status, replayTraces.length]); // When projects don't have performance set up, we allow them to view a sample transaction. // The backend creates the sample transaction, however the trace is created async, so when the diff --git a/static/app/views/settings/account/accountSecurity/accountSecurityWrapper.tsx b/static/app/views/settings/account/accountSecurity/accountSecurityWrapper.tsx index fe3aedf3be2e..75ef617afc8b 100644 --- a/static/app/views/settings/account/accountSecurity/accountSecurityWrapper.tsx +++ b/static/app/views/settings/account/accountSecurity/accountSecurityWrapper.tsx @@ -28,14 +28,15 @@ function AccountSecurityWrapper({children}: Props) { queryFn: () => fetchOrganizations(api), staleTime: 0, }); + const {refetch: refetchOrganizations} = orgRequest; const emailsRequest = useApiQuery(['/users/me/emails/'], {staleTime: 0}); const authenticatorsRequest = useApiQuery([ENDPOINT], {staleTime: 0}); const handleRefresh = useCallback(() => { - orgRequest.refetch(); + refetchOrganizations(); authenticatorsRequest.refetch(); emailsRequest.refetch(); - }, [orgRequest, authenticatorsRequest, emailsRequest]); + }, [refetchOrganizations, authenticatorsRequest, emailsRequest]); const disableAuthenticatorMutation = useMutation({ mutationFn: async (auth: Authenticator) => { diff --git a/static/app/views/settings/project/projectOwnership/addCodeOwnerModal.tsx b/static/app/views/settings/project/projectOwnership/addCodeOwnerModal.tsx index 8bfb0504ba01..069b71fd6db1 100644 --- a/static/app/views/settings/project/projectOwnership/addCodeOwnerModal.tsx +++ b/static/app/views/settings/project/projectOwnership/addCodeOwnerModal.tsx @@ -1,4 +1,4 @@ -import {type Dispatch, Fragment, type SetStateAction, useCallback, useState} from 'react'; +import {type Dispatch, Fragment, type SetStateAction, useState} from 'react'; import styled from '@emotion/styled'; import {addErrorMessage} from 'sentry/actionCreators/indicator'; @@ -121,11 +121,11 @@ export default function AddCodeOwnerModal({ gcTime: 0, }); - const addFile = useCallback(() => { + const addFile = () => { if (codeownersFile) { mutation.mutate([{codeMappingId, raw: codeownersFile.raw}]); } - }, [codeMappingId, codeownersFile, mutation]); + }; if (isCodeMappingsPending || isIntegrationsPending) { return ; From c78f47c7fbb4c1cc7ebec5387c36da79a4397ba1 Mon Sep 17 00:00:00 2001 From: TkDodo Date: Tue, 4 Mar 2025 12:27:30 +0100 Subject: [PATCH 3/8] ref: fix @tanstack/query/exhaustive-deps violations --- .../tokens/filter/valueCombobox.tsx | 16 +-- .../utils/discover/genericDiscoverQuery.tsx | 1 + .../profiling/hooks/useHasProfileChunks.tsx | 20 +-- static/app/utils/queryClient.tsx | 1 + static/app/utils/useServiceIncidents.tsx | 9 +- .../common/queries/useSpanSamples.tsx | 39 ++---- .../newTraceDetails/traceApi/useTraceMeta.tsx | 122 ++++++++++-------- .../accountSecurityWrapper.tsx | 1 + .../utils/useSamplingProjectRates.tsx | 47 ++++--- .../utils/useOrganizationDetails.tsx | 16 ++- .../utils/useOrganizationProjects.tsx | 19 ++- .../utils/useOrganizationTeams.tsx | 12 +- 12 files changed, 158 insertions(+), 145 deletions(-) diff --git a/static/app/components/searchQueryBuilder/tokens/filter/valueCombobox.tsx b/static/app/components/searchQueryBuilder/tokens/filter/valueCombobox.tsx index 3272aba80e33..39659d984e4b 100644 --- a/static/app/components/searchQueryBuilder/tokens/filter/valueCombobox.tsx +++ b/static/app/components/searchQueryBuilder/tokens/filter/valueCombobox.tsx @@ -56,7 +56,7 @@ import {trackAnalytics} from 'sentry/utils/analytics'; import {uniq} from 'sentry/utils/array/uniq'; import {type FieldDefinition, FieldValueType} from 'sentry/utils/fields'; import {isCtrlKeyPressed} from 'sentry/utils/isCtrlKeyPressed'; -import {keepPreviousData, type QueryKey, useQuery} from 'sentry/utils/queryClient'; +import {keepPreviousData, useQuery} from 'sentry/utils/queryClient'; import {useDebouncedValue} from 'sentry/utils/useDebouncedValue'; import useKeyPress from 'sentry/utils/useKeyPress'; import useOrganization from 'sentry/utils/useOrganization'; @@ -327,17 +327,17 @@ function useFilterSuggestions({ fieldDefinition ); - const queryKey = useMemo( - () => ['search-query-builder-tag-values', keyName, filterValue], - [filterValue, keyName] + const queryParams = useMemo( + () => [key ? key : {key: keyName, name: keyName}, filterValue] as const, + [filterValue, key, keyName] ); - const debouncedQueryKey = useDebouncedValue(queryKey); - // TODO(malwilley): Display error states const {data, isFetching} = useQuery({ - queryKey: debouncedQueryKey, - queryFn: () => getTagValues(key ? key : {key: keyName, name: keyName}, filterValue), + queryKey: useDebouncedValue( + useMemo(() => ['search-query-builder-tag-values', queryParams], [queryParams]) + ), + queryFn: () => getTagValues(...queryParams), placeholderData: keepPreviousData, enabled: shouldFetchValues, }); diff --git a/static/app/utils/discover/genericDiscoverQuery.tsx b/static/app/utils/discover/genericDiscoverQuery.tsx index c20fb678add9..7d6737da0805 100644 --- a/static/app/utils/discover/genericDiscoverQuery.tsx +++ b/static/app/utils/discover/genericDiscoverQuery.tsx @@ -428,6 +428,7 @@ export function useGenericDiscoverQuery(props: Props) { const apiPayload = getPayload(props); const res = useQuery<[T, string | undefined, ResponseMeta | undefined], QueryError>({ + // eslint-disable-next-line @tanstack/query/exhaustive-deps queryKey: [route, apiPayload], queryFn: ({signal: _signal}) => doDiscoverQuery(api, url, apiPayload, { diff --git a/static/app/utils/profiling/hooks/useHasProfileChunks.tsx b/static/app/utils/profiling/hooks/useHasProfileChunks.tsx index 2bb38bfcb458..fa80456456ac 100644 --- a/static/app/utils/profiling/hooks/useHasProfileChunks.tsx +++ b/static/app/utils/profiling/hooks/useHasProfileChunks.tsx @@ -10,18 +10,22 @@ export function useHasProfilingChunks(): UseQueryResult { const api = useApi(); const organization = useOrganization(); const {selection} = usePageFilters(); + const queryParams = { + query: { + project: selection.projects, + environment: selection.environments, + ...normalizeDateTimeParams(selection.datetime), + }, + }; return useQuery({ - queryKey: [`/organizations/${organization.slug}/profiling/has-chunks/`], + queryKey: [`/organizations/${organization.slug}/profiling/has-chunks/`, queryParams], queryFn: () => api - .requestPromise(`/organizations/${organization.slug}/profiling/has-chunks/`, { - query: { - project: selection.projects, - environment: selection.environments, - ...normalizeDateTimeParams(selection.datetime), - }, - }) + .requestPromise( + `/organizations/${organization.slug}/profiling/has-chunks/`, + queryParams + ) .then((res: {hasChunks: boolean}) => res.hasChunks), staleTime: 0, }); diff --git a/static/app/utils/queryClient.tsx b/static/app/utils/queryClient.tsx index a6b483b0be30..37e90bbdcab4 100644 --- a/static/app/utils/queryClient.tsx +++ b/static/app/utils/queryClient.tsx @@ -126,6 +126,7 @@ export function useApiQuery( const api = useApi({persistInFlight: PERSIST_IN_FLIGHT}); const queryFn = fetchDataQuery(api); + // eslint-disable-next-line @tanstack/query/no-rest-destructuring const {data, ...rest} = useQuery({ queryKey, queryFn, diff --git a/static/app/utils/useServiceIncidents.tsx b/static/app/utils/useServiceIncidents.tsx index 09a077734c62..cb4a65053e2e 100644 --- a/static/app/utils/useServiceIncidents.tsx +++ b/static/app/utils/useServiceIncidents.tsx @@ -26,26 +26,25 @@ export function useServiceIncidents({ componentFilter, }: UseServiceIncidentsOptions = {}) { const {statuspage} = useLegacyStore(ConfigStore); + const {api_host, id} = statuspage ?? {}; return useQuery({ - queryKey: ['statuspage-incidents', includeResolved], + queryKey: ['statuspage-incidents', {api_host, id, includeResolved}], gcTime: 60 * 5, queryFn: async () => { - const {api_host, id} = statuspage ?? {}; - if (!api_host || !id) { return null; } // We can avoid fetching lots of data by only querying the unresolved API // when we filter to only unresolved incidents - const sttusPageUrl = includeResolved + const statusPageUrl = includeResolved ? `https://${id}.${api_host}/api/v2/incidents.json` : `https://${id}.${api_host}/api/v2/incidents/unresolved.json`; let resp: Response; try { - resp = await fetch(sttusPageUrl); + resp = await fetch(statusPageUrl); } catch { // No point in capturing this as we can't make statuspage come back. return null; diff --git a/static/app/views/insights/common/queries/useSpanSamples.tsx b/static/app/views/insights/common/queries/useSpanSamples.tsx index 72d458285642..9a64b324e3d1 100644 --- a/static/app/views/insights/common/queries/useSpanSamples.tsx +++ b/static/app/views/insights/common/queries/useSpanSamples.tsx @@ -102,34 +102,23 @@ export const useSpanSamples = (options: Options) => { ); const queryString = query.formatString(); + const fullUrl = `${url}?${qs.stringify({ + ...dateCondtions, + ...{utc: location.query.utc}, + lowerBound: 0, + firstBound: maxYValue * (1 / 3), + secondBound: maxYValue * (2 / 3), + upperBound: maxYValue, + project: pageFilter.selection.projects, + environment: pageFilter.selection.environments, + query: queryString, + ...(additionalFields?.length ? {additionalFields} : {}), + })}`; const result = useQuery({ - queryKey: [ - 'span-samples', - groupId, - transactionName, - dateCondtions.statsPeriod, - dateCondtions.start, - dateCondtions.end, - queryString, - subregions?.join(','), - additionalFields?.join(','), - ], + queryKey: ['span-samples', fullUrl], queryFn: async () => { - const {data} = await api.requestPromise( - `${url}?${qs.stringify({ - ...dateCondtions, - ...{utc: location.query.utc}, - lowerBound: 0, - firstBound: maxYValue * (1 / 3), - secondBound: maxYValue * (2 / 3), - upperBound: maxYValue, - project: pageFilter.selection.projects, - environment: pageFilter.selection.environments, - query: queryString, - ...(additionalFields?.length ? {additionalFields} : {}), - })}` - ); + const {data} = await api.requestPromise(fullUrl); return data ?.map((d: SpanSample) => ({ ...d, diff --git a/static/app/views/performance/newTraceDetails/traceApi/useTraceMeta.tsx b/static/app/views/performance/newTraceDetails/traceApi/useTraceMeta.tsx index 83710b3c99f6..95b7fa33299c 100644 --- a/static/app/views/performance/newTraceDetails/traceApi/useTraceMeta.tsx +++ b/static/app/views/performance/newTraceDetails/traceApi/useTraceMeta.tsx @@ -57,62 +57,65 @@ async function fetchSingleTraceMetaNew( return data; } -async function fetchTraceMetaInBatches( - api: Client, - organization: Organization, - replayTraces: ReplayTrace[], - normalizedParams: any, - filters: Partial = {} -) { - const clonedTraceIds = [...replayTraces]; - const meta: TraceMeta = { - errors: 0, - performance_issues: 0, - projects: 0, - transactions: 0, - transaction_child_count_map: {}, - span_count: 0, - span_count_map: {}, - }; +function useFetchTraceMetaInBatches() { + const api = useApi(); - const apiErrors: Error[] = []; - - while (clonedTraceIds.length > 0) { - const batch = clonedTraceIds.splice(0, 3); - const results = await Promise.allSettled( - batch.map(replayTrace => { - const queryParams = getMetaQueryParams(replayTrace, normalizedParams, filters); - return fetchSingleTraceMetaNew(api, organization, replayTrace, queryParams); - }) - ); - - results.reduce((acc, result) => { - if (result.status === 'fulfilled') { - acc.errors += result.value.errors; - acc.performance_issues += result.value.performance_issues; - acc.projects = Math.max(acc.projects, result.value.projects); - acc.transactions += result.value.transactions; - - // Turn the transaction_child_count_map array into a map of transaction id to child count - // for more efficient lookups. - result.value.transaction_child_count_map.forEach( - ({'transaction.id': id, count}: any) => { - acc.transaction_child_count_map[id] = count; - } - ); - - acc.span_count += result.value.span_count; - Object.entries(result.value.span_count_map).forEach(([span_op, count]: any) => { - acc.span_count_map[span_op] = (acc.span_count_map[span_op] ?? 0) + count; - }); - } else { - apiErrors.push(new Error(result?.reason)); - } - return acc; - }, meta); - } + return async ( + organization: Organization, + replayTraces: ReplayTrace[], + normalizedParams: any, + filters: Partial = {} + ) => { + const clonedTraceIds = [...replayTraces]; + const meta: TraceMeta = { + errors: 0, + performance_issues: 0, + projects: 0, + transactions: 0, + transaction_child_count_map: {}, + span_count: 0, + span_count_map: {}, + }; + + const apiErrors: Error[] = []; + + while (clonedTraceIds.length > 0) { + const batch = clonedTraceIds.splice(0, 3); + const results = await Promise.allSettled( + batch.map(replayTrace => { + const queryParams = getMetaQueryParams(replayTrace, normalizedParams, filters); + return fetchSingleTraceMetaNew(api, organization, replayTrace, queryParams); + }) + ); + + results.reduce((acc, result) => { + if (result.status === 'fulfilled') { + acc.errors += result.value.errors; + acc.performance_issues += result.value.performance_issues; + acc.projects = Math.max(acc.projects, result.value.projects); + acc.transactions += result.value.transactions; + + // Turn the transaction_child_count_map array into a map of transaction id to child count + // for more efficient lookups. + result.value.transaction_child_count_map.forEach( + ({'transaction.id': id, count}: any) => { + acc.transaction_child_count_map[id] = count; + } + ); + + acc.span_count += result.value.span_count; + Object.entries(result.value.span_count_map).forEach(([span_op, count]: any) => { + acc.span_count_map[span_op] = (acc.span_count_map[span_op] ?? 0) + count; + }); + } else { + apiErrors.push(new Error(result?.reason)); + } + return acc; + }, meta); + } - return {meta, apiErrors}; + return {meta, apiErrors}; + }; } export type TraceMetaQueryResults = { @@ -122,7 +125,7 @@ export type TraceMetaQueryResults = { }; export function useTraceMeta(replayTraces: ReplayTrace[]): TraceMetaQueryResults { - const api = useApi(); + const fetchTraceMetaInBatches = useFetchTraceMetaInBatches(); const filters = usePageFilters(); const organization = useOrganization(); @@ -144,10 +147,15 @@ export function useTraceMeta(replayTraces: ReplayTrace[]): TraceMetaQueryResults }, Error >({ - queryKey: ['traceData', replayTraces], + queryKey: [ + 'traceData', + organization, + replayTraces, + normalizedParams, + filters.selection, + ], queryFn: () => fetchTraceMetaInBatches( - api, organization, replayTraces, normalizedParams, diff --git a/static/app/views/settings/account/accountSecurity/accountSecurityWrapper.tsx b/static/app/views/settings/account/accountSecurity/accountSecurityWrapper.tsx index 75ef617afc8b..60b23a64829a 100644 --- a/static/app/views/settings/account/accountSecurity/accountSecurityWrapper.tsx +++ b/static/app/views/settings/account/accountSecurity/accountSecurityWrapper.tsx @@ -24,6 +24,7 @@ function AccountSecurityWrapper({children}: Props) { const {authId} = useParams<{authId?: string}>(); const orgRequest = useQuery({ + // eslint-disable-next-line @tanstack/query/exhaustive-deps queryKey: ['organizations'], queryFn: () => fetchOrganizations(api), staleTime: 0, diff --git a/static/app/views/settings/dynamicSampling/utils/useSamplingProjectRates.tsx b/static/app/views/settings/dynamicSampling/utils/useSamplingProjectRates.tsx index 1e5d340bace2..75b4fdd10364 100644 --- a/static/app/views/settings/dynamicSampling/utils/useSamplingProjectRates.tsx +++ b/static/app/views/settings/dynamicSampling/utils/useSamplingProjectRates.tsx @@ -1,4 +1,3 @@ -import type {Client} from 'sentry/api'; import type {Organization} from 'sentry/types/organization'; import parseLinkHeader from 'sentry/utils/parseLinkHeader'; import { @@ -28,41 +27,41 @@ function getQueryKey(organization: Organization): ApiQueryKey { * Fetches all sampling rates for the organization by looping through * the paginated results. */ -const fetchAllSamplingRates = async ( - api: Client, - organization: Organization -): Promise => { - const endpoint = getEndpoint(organization); - let cursor: string | null = ''; - let result: SamplingProjectRate[] = []; +const useFetchAllSamplingRates = () => { + const api = useApi(); + return async (organization: Organization): Promise => { + const endpoint = getEndpoint(organization); + let cursor: string | null = ''; + let result: SamplingProjectRate[] = []; - while (cursor !== null) { - const [data, _, response] = await api.requestPromise(endpoint, { - method: 'GET', - includeAllArgs: true, - query: {cursor}, - }); + while (cursor !== null) { + const [data, _, response] = await api.requestPromise(endpoint, { + method: 'GET', + includeAllArgs: true, + query: {cursor}, + }); - result = result.concat(data); + result = result.concat(data); - cursor = null; - const linkHeader = response?.getResponseHeader('Link'); + cursor = null; + const linkHeader = response?.getResponseHeader('Link'); - if (linkHeader) { - const links = parseLinkHeader(linkHeader); - cursor = (links.next!.results && links.next!.cursor) || null; + if (linkHeader) { + const links = parseLinkHeader(linkHeader); + cursor = (links.next!.results && links.next!.cursor) || null; + } } - } - return result; + return result; + }; }; export function useGetSamplingProjectRates() { - const api = useApi(); + const fetchAllSamplingRates = useFetchAllSamplingRates(); const organization = useOrganization(); return useQuery({ queryKey: getQueryKey(organization), - queryFn: () => fetchAllSamplingRates(api, organization), + queryFn: () => fetchAllSamplingRates(organization), staleTime: 0, }); } diff --git a/static/app/views/setupWizard/utils/useOrganizationDetails.tsx b/static/app/views/setupWizard/utils/useOrganizationDetails.tsx index 684932944170..0b11a9aaf452 100644 --- a/static/app/views/setupWizard/utils/useOrganizationDetails.tsx +++ b/static/app/views/setupWizard/utils/useOrganizationDetails.tsx @@ -11,15 +11,17 @@ export function useOrganizationDetails({ }) { const api = useApi(); + const queryParams = { + host: organization?.region.url, + query: { + include_feature_flags: 1, + }, + }; + return useQuery({ - queryKey: [`/organizations/${organization?.slug}/`], + queryKey: [`/organizations/${organization?.slug}/`, queryParams], queryFn: () => { - return api.requestPromise(`/organizations/${organization?.slug}/`, { - host: organization?.region.url, - query: { - include_feature_flags: 1, - }, - }); + return api.requestPromise(`/organizations/${organization?.slug}/`, queryParams); }, enabled: !!organization, refetchOnWindowFocus: true, diff --git a/static/app/views/setupWizard/utils/useOrganizationProjects.tsx b/static/app/views/setupWizard/utils/useOrganizationProjects.tsx index 2d277f93b8d4..f37cf307e5f8 100644 --- a/static/app/views/setupWizard/utils/useOrganizationProjects.tsx +++ b/static/app/views/setupWizard/utils/useOrganizationProjects.tsx @@ -13,15 +13,20 @@ export function useOrganizationProjects({ }) { const api = useApi(); + const queryParams = { + host: organization?.region.url, + query: { + query, + }, + }; + return useQuery({ - queryKey: [`/organizations/${organization?.slug}/projects/`, {query}], + queryKey: [`/organizations/${organization?.slug}/projects/`, {queryParams}], queryFn: () => { - return api.requestPromise(`/organizations/${organization?.slug}/projects/`, { - host: organization?.region.url, - query: { - query, - }, - }); + return api.requestPromise( + `/organizations/${organization?.slug}/projects/`, + queryParams + ); }, enabled: !!organization, refetchOnWindowFocus: true, diff --git a/static/app/views/setupWizard/utils/useOrganizationTeams.tsx b/static/app/views/setupWizard/utils/useOrganizationTeams.tsx index 2350f9177472..f10c97fca378 100644 --- a/static/app/views/setupWizard/utils/useOrganizationTeams.tsx +++ b/static/app/views/setupWizard/utils/useOrganizationTeams.tsx @@ -10,13 +10,17 @@ export function useOrganizationTeams({ organization?: OrganizationWithRegion; }) { const api = useApi(); + const queryParams = { + host: organization?.region.url, + }; return useQuery({ - queryKey: [`/organizations/${organization?.slug}/teams/`], + queryKey: [`/organizations/${organization?.slug}/teams/`, queryParams], queryFn: () => { - return api.requestPromise(`/organizations/${organization?.slug}/user-teams/`, { - host: organization?.region.url, - }); + return api.requestPromise( + `/organizations/${organization?.slug}/user-teams/`, + queryParams + ); }, enabled: !!organization, refetchOnWindowFocus: true, From a8643f60dd830281f02b12989368972b6c4b5373 Mon Sep 17 00:00:00 2001 From: TkDodo Date: Tue, 4 Mar 2025 13:23:42 +0100 Subject: [PATCH 4/8] ref: store a structured queryKey --- .../app/views/insights/common/queries/useSpanSamples.tsx | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/static/app/views/insights/common/queries/useSpanSamples.tsx b/static/app/views/insights/common/queries/useSpanSamples.tsx index 9a64b324e3d1..0bc1c0169b4e 100644 --- a/static/app/views/insights/common/queries/useSpanSamples.tsx +++ b/static/app/views/insights/common/queries/useSpanSamples.tsx @@ -102,7 +102,7 @@ export const useSpanSamples = (options: Options) => { ); const queryString = query.formatString(); - const fullUrl = `${url}?${qs.stringify({ + const queryParams = { ...dateCondtions, ...{utc: location.query.utc}, lowerBound: 0, @@ -113,12 +113,11 @@ export const useSpanSamples = (options: Options) => { environment: pageFilter.selection.environments, query: queryString, ...(additionalFields?.length ? {additionalFields} : {}), - })}`; - + }; const result = useQuery({ - queryKey: ['span-samples', fullUrl], + queryKey: ['span-samples', {url, queryParams}], queryFn: async () => { - const {data} = await api.requestPromise(fullUrl); + const {data} = await api.requestPromise(`${url}?${qs.stringify(queryParams)}`); return data ?.map((d: SpanSample) => ({ ...d, From ae81228803a12d9522e158aac6ba03486dec5a0b Mon Sep 17 00:00:00 2001 From: TkDodo Date: Tue, 11 Mar 2025 15:05:05 +0100 Subject: [PATCH 5/8] ref: run as many queries as possible with fetchDataQuery because it uses the internal api client (so it doesn't need to go into the queryKey) --- .../profiling/hooks/useHasProfileChunks.tsx | 19 +-- .../common/queries/useSpanSamples.tsx | 36 ++--- .../newTraceDetails/traceApi/useTraceMeta.tsx | 123 +++++++++--------- .../utils/useSamplingProjectRates.tsx | 48 +++---- .../utils/useOrganizationDetails.tsx | 29 ++--- .../utils/useOrganizationProjects.tsx | 32 ++--- .../utils/useOrganizationTeams.tsx | 25 ++-- .../setupWizard/wizardProjectSelection.tsx | 3 +- 8 files changed, 146 insertions(+), 169 deletions(-) diff --git a/static/app/utils/profiling/hooks/useHasProfileChunks.tsx b/static/app/utils/profiling/hooks/useHasProfileChunks.tsx index fa80456456ac..b8a9e3e1abe6 100644 --- a/static/app/utils/profiling/hooks/useHasProfileChunks.tsx +++ b/static/app/utils/profiling/hooks/useHasProfileChunks.tsx @@ -1,13 +1,10 @@ import {normalizeDateTimeParams} from 'sentry/components/organizations/pageFilters/parse'; -import type {UseQueryResult} from 'sentry/utils/queryClient'; -import {useQuery} from 'sentry/utils/queryClient'; +import {fetchDataQuery, useQuery, type UseQueryResult} from 'sentry/utils/queryClient'; import type RequestError from 'sentry/utils/requestError/requestError'; -import useApi from 'sentry/utils/useApi'; import useOrganization from 'sentry/utils/useOrganization'; import usePageFilters from 'sentry/utils/usePageFilters'; export function useHasProfilingChunks(): UseQueryResult { - const api = useApi(); const organization = useOrganization(); const {selection} = usePageFilters(); const queryParams = { @@ -19,14 +16,12 @@ export function useHasProfilingChunks(): UseQueryResult { }; return useQuery({ - queryKey: [`/organizations/${organization.slug}/profiling/has-chunks/`, queryParams], - queryFn: () => - api - .requestPromise( - `/organizations/${organization.slug}/profiling/has-chunks/`, - queryParams - ) - .then((res: {hasChunks: boolean}) => res.hasChunks), + queryKey: [ + `/organizations/${organization.slug}/profiling/has-chunks/`, + queryParams, + ] as const, + queryFn: context => + fetchDataQuery<{hasChunks: boolean}>(context).then(res => res[0].hasChunks), staleTime: 0, }); } diff --git a/static/app/views/insights/common/queries/useSpanSamples.tsx b/static/app/views/insights/common/queries/useSpanSamples.tsx index 0bc1c0169b4e..8803cdf6615f 100644 --- a/static/app/views/insights/common/queries/useSpanSamples.tsx +++ b/static/app/views/insights/common/queries/useSpanSamples.tsx @@ -1,9 +1,7 @@ import moment from 'moment-timezone'; -import * as qs from 'query-string'; -import {useQuery} from 'sentry/utils/queryClient'; +import {fetchDataQuery, useQuery} from 'sentry/utils/queryClient'; import {MutableSearch} from 'sentry/utils/tokenizeSearch'; -import useApi from 'sentry/utils/useApi'; import {useLocation} from 'sentry/utils/useLocation'; import useOrganization from 'sentry/utils/useOrganization'; import usePageFilters from 'sentry/utils/usePageFilters'; @@ -44,8 +42,6 @@ export type SpanSample = Pick< export const useSpanSamples = (options: Options) => { const organization = useOrganization(); - const url = `/api/0/organizations/${organization.slug}/spans-samples/`; - const api = useApi(); const pageFilter = usePageFilters(); const { groupId, @@ -101,7 +97,6 @@ export const useSpanSamples = (options: Options) => { groupId && transactionName && !isLoadingSeries && pageFilter.isReady ); - const queryString = query.formatString(); const queryParams = { ...dateCondtions, ...{utc: location.query.utc}, @@ -111,19 +106,26 @@ export const useSpanSamples = (options: Options) => { upperBound: maxYValue, project: pageFilter.selection.projects, environment: pageFilter.selection.environments, - query: queryString, + query: query.formatString(), ...(additionalFields?.length ? {additionalFields} : {}), }; - const result = useQuery({ - queryKey: ['span-samples', {url, queryParams}], - queryFn: async () => { - const {data} = await api.requestPromise(`${url}?${qs.stringify(queryParams)}`); - return data - ?.map((d: SpanSample) => ({ - ...d, - timestamp: moment(d.timestamp).format(DATE_FORMAT), - })) - .sort((a: SpanSample, b: SpanSample) => b[SPAN_SELF_TIME] - a[SPAN_SELF_TIME]); + const result = useQuery({ + queryKey: [ + `/api/0/organizations/${organization.slug}/spans-samples/`, + {query: queryParams}, + ] as const, + queryFn: async context => { + const [data] = await fetchDataQuery(context); + return ( + data + ?.map((d: SpanSample) => ({ + ...d, + timestamp: moment(d.timestamp).format(DATE_FORMAT), + })) + .sort( + (a: SpanSample, b: SpanSample) => b[SPAN_SELF_TIME] - a[SPAN_SELF_TIME] + ) ?? [] + ); }, refetchOnWindowFocus: false, enabled, diff --git a/static/app/views/performance/newTraceDetails/traceApi/useTraceMeta.tsx b/static/app/views/performance/newTraceDetails/traceApi/useTraceMeta.tsx index 95b7fa33299c..9dd3b4556b05 100644 --- a/static/app/views/performance/newTraceDetails/traceApi/useTraceMeta.tsx +++ b/static/app/views/performance/newTraceDetails/traceApi/useTraceMeta.tsx @@ -57,65 +57,62 @@ async function fetchSingleTraceMetaNew( return data; } -function useFetchTraceMetaInBatches() { - const api = useApi(); - - return async ( - organization: Organization, - replayTraces: ReplayTrace[], - normalizedParams: any, - filters: Partial = {} - ) => { - const clonedTraceIds = [...replayTraces]; - const meta: TraceMeta = { - errors: 0, - performance_issues: 0, - projects: 0, - transactions: 0, - transaction_child_count_map: {}, - span_count: 0, - span_count_map: {}, - }; +async function fetchTraceMetaInBatches( + api: Client, + organization: Organization, + replayTraces: ReplayTrace[], + normalizedParams: any, + filters: Partial = {} +) { + const clonedTraceIds = [...replayTraces]; + const meta: TraceMeta = { + errors: 0, + performance_issues: 0, + projects: 0, + transactions: 0, + transaction_child_count_map: {}, + span_count: 0, + span_count_map: {}, + }; - const apiErrors: Error[] = []; - - while (clonedTraceIds.length > 0) { - const batch = clonedTraceIds.splice(0, 3); - const results = await Promise.allSettled( - batch.map(replayTrace => { - const queryParams = getMetaQueryParams(replayTrace, normalizedParams, filters); - return fetchSingleTraceMetaNew(api, organization, replayTrace, queryParams); - }) - ); - - results.reduce((acc, result) => { - if (result.status === 'fulfilled') { - acc.errors += result.value.errors; - acc.performance_issues += result.value.performance_issues; - acc.projects = Math.max(acc.projects, result.value.projects); - acc.transactions += result.value.transactions; - - // Turn the transaction_child_count_map array into a map of transaction id to child count - // for more efficient lookups. - result.value.transaction_child_count_map.forEach( - ({'transaction.id': id, count}: any) => { - acc.transaction_child_count_map[id] = count; - } - ); - - acc.span_count += result.value.span_count; - Object.entries(result.value.span_count_map).forEach(([span_op, count]: any) => { - acc.span_count_map[span_op] = (acc.span_count_map[span_op] ?? 0) + count; - }); - } else { - apiErrors.push(new Error(result?.reason)); - } - return acc; - }, meta); - } + const apiErrors: Error[] = []; + + while (clonedTraceIds.length > 0) { + const batch = clonedTraceIds.splice(0, 3); + const results = await Promise.allSettled( + batch.map(replayTrace => { + const queryParams = getMetaQueryParams(replayTrace, normalizedParams, filters); + return fetchSingleTraceMetaNew(api, organization, replayTrace, queryParams); + }) + ); + + results.reduce((acc, result) => { + if (result.status === 'fulfilled') { + acc.errors += result.value.errors; + acc.performance_issues += result.value.performance_issues; + acc.projects = Math.max(acc.projects, result.value.projects); + acc.transactions += result.value.transactions; + + // Turn the transaction_child_count_map array into a map of transaction id to child count + // for more efficient lookups. + result.value.transaction_child_count_map.forEach( + ({'transaction.id': id, count}: any) => { + acc.transaction_child_count_map[id] = count; + } + ); + + acc.span_count += result.value.span_count; + Object.entries(result.value.span_count_map).forEach(([span_op, count]: any) => { + acc.span_count_map[span_op] = (acc.span_count_map[span_op] ?? 0) + count; + }); + } else { + apiErrors.push(new Error(result?.reason)); + } + return acc; + }, meta); + } - return {meta, apiErrors}; - }; + return {meta, apiErrors}; } export type TraceMetaQueryResults = { @@ -125,7 +122,7 @@ export type TraceMetaQueryResults = { }; export function useTraceMeta(replayTraces: ReplayTrace[]): TraceMetaQueryResults { - const fetchTraceMetaInBatches = useFetchTraceMetaInBatches(); + const api = useApi(); const filters = usePageFilters(); const organization = useOrganization(); @@ -147,15 +144,11 @@ export function useTraceMeta(replayTraces: ReplayTrace[]): TraceMetaQueryResults }, Error >({ - queryKey: [ - 'traceData', - organization, - replayTraces, - normalizedParams, - filters.selection, - ], + // eslint-disable-next-line @tanstack/query/exhaustive-deps + queryKey: ['traceData', replayTraces], queryFn: () => fetchTraceMetaInBatches( + api, organization, replayTraces, normalizedParams, diff --git a/static/app/views/settings/dynamicSampling/utils/useSamplingProjectRates.tsx b/static/app/views/settings/dynamicSampling/utils/useSamplingProjectRates.tsx index 75b4fdd10364..4ac9f4021471 100644 --- a/static/app/views/settings/dynamicSampling/utils/useSamplingProjectRates.tsx +++ b/static/app/views/settings/dynamicSampling/utils/useSamplingProjectRates.tsx @@ -1,3 +1,4 @@ +import type {Client} from 'sentry/api'; import type {Organization} from 'sentry/types/organization'; import parseLinkHeader from 'sentry/utils/parseLinkHeader'; import { @@ -27,41 +28,42 @@ function getQueryKey(organization: Organization): ApiQueryKey { * Fetches all sampling rates for the organization by looping through * the paginated results. */ -const useFetchAllSamplingRates = () => { - const api = useApi(); - return async (organization: Organization): Promise => { - const endpoint = getEndpoint(organization); - let cursor: string | null = ''; - let result: SamplingProjectRate[] = []; +const fetchAllSamplingRates = async ( + api: Client, + organization: Organization +): Promise => { + const endpoint = getEndpoint(organization); + let cursor: string | null = ''; + let result: SamplingProjectRate[] = []; - while (cursor !== null) { - const [data, _, response] = await api.requestPromise(endpoint, { - method: 'GET', - includeAllArgs: true, - query: {cursor}, - }); + while (cursor !== null) { + const [data, _, response] = await api.requestPromise(endpoint, { + method: 'GET', + includeAllArgs: true, + query: {cursor}, + }); - result = result.concat(data); + result = result.concat(data); - cursor = null; - const linkHeader = response?.getResponseHeader('Link'); + cursor = null; + const linkHeader = response?.getResponseHeader('Link'); - if (linkHeader) { - const links = parseLinkHeader(linkHeader); - cursor = (links.next!.results && links.next!.cursor) || null; - } + if (linkHeader) { + const links = parseLinkHeader(linkHeader); + cursor = (links.next!.results && links.next!.cursor) || null; } + } - return result; - }; + return result; }; export function useGetSamplingProjectRates() { - const fetchAllSamplingRates = useFetchAllSamplingRates(); + const api = useApi(); const organization = useOrganization(); return useQuery({ + // eslint-disable-next-line @tanstack/query/exhaustive-deps queryKey: getQueryKey(organization), - queryFn: () => fetchAllSamplingRates(organization), + queryFn: () => fetchAllSamplingRates(api, organization), staleTime: 0, }); } diff --git a/static/app/views/setupWizard/utils/useOrganizationDetails.tsx b/static/app/views/setupWizard/utils/useOrganizationDetails.tsx index 0b11a9aaf452..60f21ba273d9 100644 --- a/static/app/views/setupWizard/utils/useOrganizationDetails.tsx +++ b/static/app/views/setupWizard/utils/useOrganizationDetails.tsx @@ -1,7 +1,5 @@ import type {Organization} from 'sentry/types/organization'; -import {useQuery} from 'sentry/utils/queryClient'; -import type RequestError from 'sentry/utils/requestError/requestError'; -import useApi from 'sentry/utils/useApi'; +import {type ApiQueryKey, fetchDataQuery, useQuery} from 'sentry/utils/queryClient'; import type {OrganizationWithRegion} from 'sentry/views/setupWizard/types'; export function useOrganizationDetails({ @@ -9,20 +7,17 @@ export function useOrganizationDetails({ }: { organization?: OrganizationWithRegion; }) { - const api = useApi(); - - const queryParams = { - host: organization?.region.url, - query: { - include_feature_flags: 1, - }, - }; - - return useQuery({ - queryKey: [`/organizations/${organization?.slug}/`, queryParams], - queryFn: () => { - return api.requestPromise(`/organizations/${organization?.slug}/`, queryParams); - }, + return useQuery({ + queryKey: [ + `/organizations/${organization?.slug}/`, + { + host: organization?.region.url, + query: { + include_feature_flags: 1, + }, + }, + ] satisfies ApiQueryKey, + queryFn: context => fetchDataQuery(context).then(result => result[0]), enabled: !!organization, refetchOnWindowFocus: true, retry: false, diff --git a/static/app/views/setupWizard/utils/useOrganizationProjects.tsx b/static/app/views/setupWizard/utils/useOrganizationProjects.tsx index f37cf307e5f8..d09f336136e5 100644 --- a/static/app/views/setupWizard/utils/useOrganizationProjects.tsx +++ b/static/app/views/setupWizard/utils/useOrganizationProjects.tsx @@ -1,7 +1,5 @@ import type {Project} from 'sentry/types/project'; -import {useQuery} from 'sentry/utils/queryClient'; -import type RequestError from 'sentry/utils/requestError/requestError'; -import useApi from 'sentry/utils/useApi'; +import {type ApiQueryKey, fetchDataQuery, useQuery} from 'sentry/utils/queryClient'; import type {OrganizationWithRegion} from 'sentry/views/setupWizard/types'; export function useOrganizationProjects({ @@ -11,22 +9,18 @@ export function useOrganizationProjects({ organization?: OrganizationWithRegion; query?: string; }) { - const api = useApi(); - - const queryParams = { - host: organization?.region.url, - query: { - query, - }, - }; - - return useQuery({ - queryKey: [`/organizations/${organization?.slug}/projects/`, {queryParams}], - queryFn: () => { - return api.requestPromise( - `/organizations/${organization?.slug}/projects/`, - queryParams - ); + return useQuery({ + queryKey: [ + `/organizations/${organization?.slug}/projects/`, + { + host: organization?.region.url, + query: { + query, + }, + }, + ] satisfies ApiQueryKey, + queryFn: context => { + return fetchDataQuery(context).then(result => result[0]); }, enabled: !!organization, refetchOnWindowFocus: true, diff --git a/static/app/views/setupWizard/utils/useOrganizationTeams.tsx b/static/app/views/setupWizard/utils/useOrganizationTeams.tsx index f10c97fca378..d6d372f92eef 100644 --- a/static/app/views/setupWizard/utils/useOrganizationTeams.tsx +++ b/static/app/views/setupWizard/utils/useOrganizationTeams.tsx @@ -1,7 +1,5 @@ import type {Team} from 'sentry/types/organization'; -import {useQuery} from 'sentry/utils/queryClient'; -import type RequestError from 'sentry/utils/requestError/requestError'; -import useApi from 'sentry/utils/useApi'; +import {type ApiQueryKey, fetchDataQuery, useQuery} from 'sentry/utils/queryClient'; import type {OrganizationWithRegion} from 'sentry/views/setupWizard/types'; export function useOrganizationTeams({ @@ -9,18 +7,15 @@ export function useOrganizationTeams({ }: { organization?: OrganizationWithRegion; }) { - const api = useApi(); - const queryParams = { - host: organization?.region.url, - }; - - return useQuery({ - queryKey: [`/organizations/${organization?.slug}/teams/`, queryParams], - queryFn: () => { - return api.requestPromise( - `/organizations/${organization?.slug}/user-teams/`, - queryParams - ); + return useQuery({ + queryKey: [ + `/organizations/${organization?.slug}/teams/`, + { + host: organization?.region.url, + }, + ] satisfies ApiQueryKey, + queryFn: context => { + return fetchDataQuery(context).then(result => result[0]); }, enabled: !!organization, refetchOnWindowFocus: true, diff --git a/static/app/views/setupWizard/wizardProjectSelection.tsx b/static/app/views/setupWizard/wizardProjectSelection.tsx index 673fc61f1d88..55b50c86e9ec 100644 --- a/static/app/views/setupWizard/wizardProjectSelection.tsx +++ b/static/app/views/setupWizard/wizardProjectSelection.tsx @@ -14,6 +14,7 @@ import {t} from 'sentry/locale'; import ConfigStore from 'sentry/stores/configStore'; import {space} from 'sentry/styles/space'; import type {Organization} from 'sentry/types/organization'; +import RequestError from 'sentry/utils/requestError/requestError'; import {useDebouncedValue} from 'sentry/utils/useDebouncedValue'; import {useCompactSelectOptionsCache} from 'sentry/views/insights/common/utils/useCompactSelectOptionsCache'; import {ProjectLoadingError} from 'sentry/views/setupWizard/projectLoadingError'; @@ -275,7 +276,7 @@ export function WizardProjectSelection({ - {orgProjectsRequest.error ? ( + {orgProjectsRequest.error instanceof RequestError ? ( Date: Tue, 11 Mar 2025 15:10:51 +0100 Subject: [PATCH 6/8] ref: disable --- static/app/views/explore/logs/useLogsQuery.tsx | 1 + 1 file changed, 1 insertion(+) diff --git a/static/app/views/explore/logs/useLogsQuery.tsx b/static/app/views/explore/logs/useLogsQuery.tsx index 4201c409cb88..9a0e45fc481c 100644 --- a/static/app/views/explore/logs/useLogsQuery.tsx +++ b/static/app/views/explore/logs/useLogsQuery.tsx @@ -69,6 +69,7 @@ export function useExploreLogsTableRow(_props: { const _project = projects.find(p => p.id === _props.project_id); const {data, isError, isPending} = useQuery({ + // eslint-disable-next-line @tanstack/query/exhaustive-deps queryKey: ['logs-table-row', _props.log_id, _props.project_id], queryFn: async () => { if (!_project) { From 9fd11b830fd1773303ca42e5990ee33b6dd5b044 Mon Sep 17 00:00:00 2001 From: TkDodo Date: Tue, 11 Mar 2025 17:37:37 +0100 Subject: [PATCH 7/8] ref: useApiQuery in useSpanSamples --- .../common/queries/useSpanSamples.tsx | 45 +++++++++---------- .../sampleTable/sampleTable.spec.tsx | 26 +++++++++-- 2 files changed, 44 insertions(+), 27 deletions(-) diff --git a/static/app/views/insights/common/queries/useSpanSamples.tsx b/static/app/views/insights/common/queries/useSpanSamples.tsx index 8803cdf6615f..80c6db1f755c 100644 --- a/static/app/views/insights/common/queries/useSpanSamples.tsx +++ b/static/app/views/insights/common/queries/useSpanSamples.tsx @@ -1,6 +1,6 @@ import moment from 'moment-timezone'; -import {fetchDataQuery, useQuery} from 'sentry/utils/queryClient'; +import {useApiQuery} from 'sentry/utils/queryClient'; import {MutableSearch} from 'sentry/utils/tokenizeSearch'; import {useLocation} from 'sentry/utils/useLocation'; import useOrganization from 'sentry/utils/useOrganization'; @@ -109,28 +109,25 @@ export const useSpanSamples = (options: Options) => { query: query.formatString(), ...(additionalFields?.length ? {additionalFields} : {}), }; - const result = useQuery({ - queryKey: [ - `/api/0/organizations/${organization.slug}/spans-samples/`, - {query: queryParams}, - ] as const, - queryFn: async context => { - const [data] = await fetchDataQuery(context); - return ( - data - ?.map((d: SpanSample) => ({ - ...d, - timestamp: moment(d.timestamp).format(DATE_FORMAT), - })) - .sort( - (a: SpanSample, b: SpanSample) => b[SPAN_SELF_TIME] - a[SPAN_SELF_TIME] - ) ?? [] - ); - }, - refetchOnWindowFocus: false, - enabled, - initialData: [], - }); + const {data, ...result} = useApiQuery<{data: SpanSample[]}>( + [`/api/0/organizations/${organization.slug}/spans-samples/`, {query: queryParams}], + { + refetchOnWindowFocus: false, + enabled, + staleTime: 0, + } + ); - return {...result, isEnabled: enabled}; + return { + ...result, + isEnabled: enabled, + data: + data?.data + .map((d: SpanSample) => ({ + ...d, + timestamp: moment(d.timestamp).format(DATE_FORMAT), + })) + .sort((a: SpanSample, b: SpanSample) => b[SPAN_SELF_TIME] - a[SPAN_SELF_TIME]) ?? + [], + }; }; diff --git a/static/app/views/insights/common/views/spanSummaryPage/sampleList/sampleTable/sampleTable.spec.tsx b/static/app/views/insights/common/views/spanSummaryPage/sampleList/sampleTable/sampleTable.spec.tsx index 803f2a215840..3295c7dd1862 100644 --- a/static/app/views/insights/common/views/spanSummaryPage/sampleList/sampleTable/sampleTable.spec.tsx +++ b/static/app/views/insights/common/views/spanSummaryPage/sampleList/sampleTable/sampleTable.spec.tsx @@ -39,7 +39,7 @@ describe('SampleTable', function () { }); describe('When all data is available', () => { - it('should finsh loading', async () => { + it('should finish loading', async () => { render( { it('should display no query results', async () => { MockApiClient.addMockResponse({ - url: '/api/0/organizations/org-slug/spans-samples/?firstBound=0.6666666666666666&lowerBound=0&query=span.group%3AgroupId123%20transaction%3A%2Fendpoint%20transaction.method%3AGET&secondBound=1.3333333333333333&statsPeriod=14d&upperBound=2', + url: '/api/0/organizations/org-slug/spans-samples/', method: 'GET', + match: [ + MockApiClient.matchQuery({ + firstBound: 0.6666666666666666, + lowerBound: 0, + query: 'span.group:groupId123 transaction:/endpoint transaction.method:GET', + secondBound: 1.3333333333333333, + statsPeriod: '14d', + upperBound: 2, + }), + ], body: { data: [], }, @@ -209,8 +219,18 @@ const initializeMockRequests = () => { ], }); MockApiClient.addMockResponse({ - url: '/api/0/organizations/org-slug/spans-samples/?firstBound=0.6666666666666666&lowerBound=0&query=span.group%3AgroupId123%20transaction%3A%2Fendpoint%20transaction.method%3AGET&secondBound=1.3333333333333333&statsPeriod=14d&upperBound=2', + url: '/api/0/organizations/org-slug/spans-samples/', method: 'GET', + match: [ + MockApiClient.matchQuery({ + firstBound: 0.6666666666666666, + lowerBound: 0, + query: 'span.group:groupId123 transaction:/endpoint transaction.method:GET', + secondBound: 1.3333333333333333, + statsPeriod: '14d', + upperBound: 2, + }), + ], body: { data: [ { From fed57ddc90868fccb52967df4195d4f198325d8b Mon Sep 17 00:00:00 2001 From: TkDodo Date: Tue, 11 Mar 2025 18:04:00 +0100 Subject: [PATCH 8/8] chore: no idea how this worked without this mock... --- static/app/bootstrap/processInitQueue.spec.tsx | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/static/app/bootstrap/processInitQueue.spec.tsx b/static/app/bootstrap/processInitQueue.spec.tsx index b4a7e887d5e6..7df35fc70f40 100644 --- a/static/app/bootstrap/processInitQueue.spec.tsx +++ b/static/app/bootstrap/processInitQueue.spec.tsx @@ -127,6 +127,11 @@ describe('processInitQueue', function () { body: [TeamFixture({id: '1', slug: 'team-1', name: 'Team 1'})], }); + MockApiClient.addMockResponse({ + url: '/organizations/organization-1/teams/', + body: [TeamFixture({id: '1', slug: 'team-1', name: 'Team 1'})], + }); + render(
); processInitQueue();