Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
*/
import * as emotion from '@emotion/eslint-plugin';
import eslint from '@eslint/js';
import pluginQuery from '@tanstack/eslint-plugin-query';
import {globalIgnores} from 'eslint/config';
import prettier from 'eslint-config-prettier';
// @ts-expect-error TS(7016): Could not find a declaration file
Expand Down Expand Up @@ -316,6 +317,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',

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this defaults to warning, but I think it’s important enough to up to error.

},
},
{
name: 'plugin/react',
// https://github.com/jsx-eslint/eslint-plugin-react/tree/master/docs/rules
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,7 @@
"@sentry/jest-environment": "6.0.0",
"@sentry/profiling-node": "9.6.0-alpha.0",
"@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",
Expand Down
5 changes: 5 additions & 0 deletions static/app/bootstrap/processInitQueue.spec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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(<div id="setup-wizard-container" />);
processInitQueue();

Expand Down
14 changes: 7 additions & 7 deletions static/app/components/feedback/useMutateActivity.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ export default function useMutateActivity({
onMutate,
onSettled,
}: Props) {
const mutation = useMutation<TData, TError, TVariables, TContext>({
const {mutate} = useMutation<TData, TError, TVariables, TContext>({
onMutate: onMutate ?? undefined,
mutationFn: ([{note, noteId}, method]) => {
const url =
Expand All @@ -74,23 +74,23 @@ export default function useMutateActivity({

const handleUpdate = useCallback<UpdateCommentCallback>(
(note, noteId, activity, options) => {
mutation.mutate([{note, noteId, activity}, 'PUT'], options);
mutate([{note, noteId, activity}, 'PUT'], options);
},
[mutation]
[mutate]
Comment on lines -77 to +79

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

top-level objects returned by useQuery and useMutation are not referentially stable, but functions and values on them are. The linter knows this and now recommends destructuring those.

Essentially, the memoization with useCallback didn’t do anything before, so I’m wondering why we are having it in the first place?

);

const handleCreate = useCallback<CreateCommentCallback>(
(note, activity, options) => {
mutation.mutate([{note, activity}, 'POST'], options);
mutate([{note, activity}, 'POST'], options);
},
[mutation]
[mutate]
);

const handleDelete = useCallback<DeleteCommentCallback>(
(noteId, activity, options) => {
mutation.mutate([{noteId, activity}, 'DELETE'], options);
mutate([{noteId, activity}, 'DELETE'], options);
},
[mutation]
[mutate]
);

return {
Expand Down
10 changes: 5 additions & 5 deletions static/app/components/feedback/useMutateFeedback.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export default function useMutateFeedback({
const {listQueryKey} = useFeedbackQueryKeys();
const {updateCached, invalidateCached} = useFeedbackCache();

const mutation = useMutation<TData, TError, TVariables, TContext>({
const {mutate} = useMutation<TData, TError, TVariables, TContext>({
onMutate: ([ids, payload]) => {
updateCached(ids, payload);
},
Expand Down Expand Up @@ -60,19 +60,19 @@ export default function useMutateFeedback({

const markAsRead = useCallback(
(hasSeen: boolean, options?: MutateOptions<TData, TError, TVariables, TContext>) => {
mutation.mutate([feedbackIds, {hasSeen}], options);
mutate([feedbackIds, {hasSeen}], options);
},
[mutation, feedbackIds]
[mutate, feedbackIds]
);

const resolve = useCallback(
(
status: GroupStatus,
options?: MutateOptions<TData, TError, TVariables, TContext>
) => {
mutation.mutate([feedbackIds, {status}], options);
mutate([feedbackIds, {status}], options);
},
[mutation, feedbackIds]
[mutate, feedbackIds]
);

return {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -327,17 +327,17 @@ function useFilterSuggestions({
fieldDefinition
);

const queryKey = useMemo<QueryKey>(
() => ['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<string[]>({
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,
});
Expand Down
1 change: 1 addition & 0 deletions static/app/utils/discover/genericDiscoverQuery.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,7 @@ export function useGenericDiscoverQuery<T, P>(props: Props<T, P>) {
const apiPayload = getPayload<T, P>(props);

const res = useQuery<[T, string | undefined, ResponseMeta<T> | undefined], QueryError>({
// eslint-disable-next-line @tanstack/query/exhaustive-deps
queryKey: [route, apiPayload],
queryFn: ({signal: _signal}) =>
doDiscoverQuery<T>(api, url, apiPayload, {
Expand Down
29 changes: 14 additions & 15 deletions static/app/utils/profiling/hooks/useHasProfileChunks.tsx
Original file line number Diff line number Diff line change
@@ -1,28 +1,27 @@
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<boolean, RequestError> {
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/`],
queryFn: () =>
api
.requestPromise(`/organizations/${organization.slug}/profiling/has-chunks/`, {
query: {
project: selection.projects,
environment: selection.environments,
...normalizeDateTimeParams(selection.datetime),
},
})
.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,
});
}
1 change: 1 addition & 0 deletions static/app/utils/queryClient.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ export function useApiQuery<TResponseData, TError = RequestError>(
queryKey: ApiQueryKey,
options: UseApiQueryOptions<TResponseData, TError>
): UseApiQueryResult<TResponseData, TError> {
// eslint-disable-next-line @tanstack/query/no-rest-destructuring
const {data, ...rest} = useQuery({
queryKey,
queryFn: fetchDataQuery<TResponseData>,
Expand Down
9 changes: 4 additions & 5 deletions static/app/utils/useServiceIncidents.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -26,26 +26,25 @@ export function useServiceIncidents({
componentFilter,
}: UseServiceIncidentsOptions = {}) {
const {statuspage} = useLegacyStore(ConfigStore);
const {api_host, id} = statuspage ?? {};

return useQuery<StatuspageIncident[] | null>({
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;
Expand Down
1 change: 1 addition & 0 deletions static/app/views/explore/logs/useLogsQuery.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ export function useExploreLogsTableRow(_props: {
const _project = projects.find(p => p.id === _props.project_id);

const {data, isError, isPending} = useQuery<OurLogsTableRowDetails>({
// eslint-disable-next-line @tanstack/query/exhaustive-deps
queryKey: ['logs-table-row', _props.log_id, _props.project_id],
queryFn: async () => {
if (!_project) {
Expand Down
75 changes: 31 additions & 44 deletions static/app/views/insights/common/queries/useSpanSamples.tsx
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
import moment from 'moment-timezone';
import * as qs from 'query-string';

import {useQuery} from 'sentry/utils/queryClient';
import {useApiQuery} 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';
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -101,46 +97,37 @@ export const useSpanSamples = (options: Options) => {
groupId && transactionName && !isLoadingSeries && pageFilter.isReady
);

const queryString = query.formatString();

const result = useQuery<SpanSample[]>({
queryKey: [
'span-samples',
groupId,
transactionName,
dateCondtions.statsPeriod,
dateCondtions.start,
dateCondtions.end,
queryString,
subregions?.join(','),
additionalFields?.join(','),
],
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} : {}),
})}`
);
return data
?.map((d: SpanSample) => ({
const queryParams = {
...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: query.formatString(),
...(additionalFields?.length ? {additionalFields} : {}),
};
const {data, ...result} = useApiQuery<{data: SpanSample[]}>(
[`/api/0/organizations/${organization.slug}/spans-samples/`, {query: queryParams}],
{
refetchOnWindowFocus: false,
enabled,
staleTime: 0,
}
);

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]);
},
refetchOnWindowFocus: false,
enabled,
initialData: [],
});

return {...result, isEnabled: enabled};
.sort((a: SpanSample, b: SpanSample) => b[SPAN_SELF_TIME] - a[SPAN_SELF_TIME]) ??
[],
};
};
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ describe('SampleTable', function () {
});

describe('When all data is available', () => {
it('should finsh loading', async () => {
it('should finish loading', async () => {
render(
<SampleTable
groupId="groupId123"
Expand Down Expand Up @@ -127,8 +127,18 @@ describe('SampleTable', function () {
describe('When there is missing data', () => {
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: [],
},
Expand Down Expand Up @@ -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: [
{
Expand Down
Loading