Skip to content

fix(apiOptions): prevent empty options from being included in queryKey #112370

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TkDodo merged 2 commits into from
Apr 7, 2026
Merged

fix(apiOptions): prevent empty options from being included in queryKey #112370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cb7ee0
fix(apiOptions): prevent empty options from being included in queryKey
TkDodo Apr 7, 2026
1b47afa
fix(apiOptions): strip undefined values from options in queryKey
TkDodo Apr 7, 2026
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
29 changes: 29 additions & 0 deletions static/app/utils/api/apiOptions.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,35 @@ describe('apiOptions', () => {
]);
});

it('should not include options in queryKey when all values are undefined', () => {
Comment thread
TkDodo marked this conversation as resolved.
const options = apiOptions.as<unknown>()('/api-tokens/$tokenId/', {
staleTime: 0,
path: {tokenId: '123'},
query: undefined,
method: undefined,
});

expect(options.queryKey).toEqual([
{infinite: false, version: 'v2'},
'/api-tokens/123/',
]);
});

it('should strip undefined values from options in queryKey', () => {
const options = apiOptions.as<unknown>()('/api-tokens/$tokenId/', {
staleTime: 0,
path: {tokenId: '123'},
query: {cursor: 'abc'},
method: undefined,
});

expect(options.queryKey).toEqual([
{infinite: false, version: 'v2'},
'/api-tokens/123/',
{query: {cursor: 'abc'}},
]);
});

it('should stringify number path params', () => {
const options = apiOptions.as<unknown>()('/api-tokens/$tokenId/', {
staleTime: 0,
Expand Down
16 changes: 11 additions & 5 deletions static/app/utils/api/apiOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,17 @@ import {parseLinkHeader} from 'sentry/utils/parseLinkHeader';

type KnownApiUrls = KnownGetsentryApiUrls | KnownSentryApiUrls;

type Options = QueryKeyEndpointOptions & {staleTime: number};
type Options = QueryKeyEndpointOptions & {staleTime: number | 'static'};

type PathParamOptions<TApiPath extends string> =
ExtractPathParams<TApiPath> extends never
? {path?: never}
: {path: Record<ExtractPathParams<TApiPath>, string | number> | SkipToken};

function stripUndefinedValues(obj: Record<string, unknown>): Record<string, unknown> {
return Object.fromEntries(Object.entries(obj).filter(([, v]) => v !== undefined));
}

const selectJson = <TData>(data: ApiResponse<TData>) => data.json;

export const selectJsonWithHeaders = <TData>(
Expand All @@ -43,11 +47,12 @@ function _apiOptions<
: [Options & PathParamOptions<TApiPath>]
) {
const url = getApiUrl(path, ...([{path: pathParams}] as OptionalPathParams<TApiPath>));
const strippedOptions = stripUndefinedValues(options);

return queryOptions({
queryKey:
Object.keys(options).length > 0
? ([{infinite: false, version: 'v2'}, url, options] as ApiQueryKey)
Object.keys(strippedOptions).length > 0
? ([{infinite: false, version: 'v2'}, url, strippedOptions] as ApiQueryKey)
: ([{infinite: false, version: 'v2'}, url] as ApiQueryKey),
queryFn: pathParams === skipToken ? skipToken : apiFetch<TActualData>,
enabled: pathParams !== skipToken,
Expand Down Expand Up @@ -77,11 +82,12 @@ function _apiOptionsInfinite<
: [Options & PathParamOptions<TApiPath>]
) {
const url = getApiUrl(path, ...([{path: pathParams}] as OptionalPathParams<TApiPath>));
const strippedOptions = stripUndefinedValues(options);

return infiniteQueryOptions({
queryKey:
Object.keys(options).length > 0
? ([{infinite: true, version: 'v2'}, url, options] as InfiniteApiQueryKey)
Object.keys(strippedOptions).length > 0
? ([{infinite: true, version: 'v2'}, url, strippedOptions] as InfiniteApiQueryKey)
: ([{infinite: true, version: 'v2'}, url] as InfiniteApiQueryKey),
queryFn: pathParams === skipToken ? skipToken : apiFetchInfinite<TActualData>,
getPreviousPageParam: parsePageParam('previous'),
Expand Down
Loading