Skip to content

refactor(tanstack): unify operation naming using SDK serviceFunctionIdentifier #2312

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { tsNodeToString } from '../../../compiler/utils';
import { clientApi } from '../../../generate/client';
import { operationPagination } from '../../../ir/operation';
import type { IR } from '../../../ir/types';
import { serviceFunctionIdentifier } from '../../@hey-api/sdk/plugin-legacy';
import {
createOperationComment,
isOperationOptionsRequired,
Expand Down Expand Up @@ -312,9 +313,15 @@ export const createInfiniteQueryOptions = ({
});
file.add(node);

const functionIdentifier = serviceFunctionIdentifier({
config: plugin.context.config,
id: operation.id,
operation,
});

const identifierInfiniteQueryKey = file.identifier({
// TODO: refactor for better cross-plugin compatibility
$ref: `#/tanstack-query-infinite-query-key/${operation.id}`,
$ref: `#/tanstack-query-infinite-query-key/${functionIdentifier}`,
case: plugin.config.infiniteQueryKeys.case,
nameTransformer: plugin.config.infiniteQueryKeys.name,
namespace: 'value',
Expand Down Expand Up @@ -429,7 +436,7 @@ export const createInfiniteQueryOptions = ({

const identifierInfiniteQueryOptions = file.identifier({
// TODO: refactor for better cross-plugin compatibility
$ref: `#/tanstack-query-infinite-query-options/${operation.id}`,
$ref: `#/tanstack-query-infinite-query-options/${functionIdentifier}`,
case: plugin.config.infiniteQueryOptions.case,
create: true,
nameTransformer: plugin.config.infiniteQueryOptions.name,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import type ts from 'typescript';

import { compiler } from '../../../compiler';
import type { IR } from '../../../ir/types';
import { serviceFunctionIdentifier } from '../../@hey-api/sdk/plugin-legacy';
import { createOperationComment } from '../../shared/utils/operation';
import type { PluginInstance, PluginState } from './types';
import { useTypeData, useTypeError, useTypeResponse } from './useType';
Expand Down Expand Up @@ -101,9 +102,15 @@ export const createMutationOptions = ({
);
}

const functionIdentifier = serviceFunctionIdentifier({
config: plugin.context.config,
id: operation.id,
operation,
});

const identifier = file.identifier({
// TODO: refactor for better cross-plugin compatibility
$ref: `#/tanstack-query-mutation-options/${operation.id}`,
$ref: `#/tanstack-query-mutation-options/${functionIdentifier}`,
case: plugin.config.mutationOptions.case,
create: true,
nameTransformer: plugin.config.mutationOptions.name,
Expand Down
14 changes: 11 additions & 3 deletions packages/openapi-ts/src/plugins/@tanstack/query-core/queryKey.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { clientApi } from '../../../generate/client';
import { hasOperationDataRequired } from '../../../ir/operation';
import type { IR } from '../../../ir/types';
import { getClientBaseUrlKey } from '../../@hey-api/client-core/utils';
import { serviceFunctionIdentifier } from '../../@hey-api/sdk/plugin-legacy';
import type { PluginInstance } from './types';
import { useTypeData } from './useType';

Expand Down Expand Up @@ -306,18 +307,25 @@ export const queryKeyStatement = ({
}) => {
const file = plugin.context.file({ id: plugin.name })!;
const typeData = useTypeData({ operation, plugin });

const functionIdentifier = serviceFunctionIdentifier({
config: plugin.context.config,
id: operation.id,
operation,
});

const identifier = isInfinite
? file.identifier({
// TODO: refactor for better cross-plugin compatibility
$ref: `#/tanstack-query-infinite-query-key/${operation.id}`,
$ref: `#/tanstack-query-infinite-query-key/${functionIdentifier}`,
case: plugin.config.infiniteQueryKeys.case,
create: true,
nameTransformer: plugin.config.infiniteQueryKeys.name,
namespace: 'value',
})
: file.identifier({
// TODO: refactor for better cross-plugin compatibility
$ref: `#/tanstack-query-query-key/${operation.id}`,
$ref: `#/tanstack-query-query-key/${functionIdentifier}`,
case: plugin.config.queryKeys.case,
create: true,
nameTransformer: plugin.config.queryKeys.name,
Expand All @@ -335,7 +343,7 @@ export const queryKeyStatement = ({
],
returnType: isInfinite ? typeQueryKey : undefined,
statements: createQueryKeyLiteral({
id: operation.id,
id: functionIdentifier,
isInfinite,
plugin,
}),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import type ts from 'typescript';

import { compiler } from '../../../compiler';
import type { IR } from '../../../ir/types';
import { serviceFunctionIdentifier } from '../../@hey-api/sdk/plugin-legacy';
import {
createOperationComment,
isOperationOptionsRequired,
Expand Down Expand Up @@ -68,9 +69,15 @@ export const createQueryOptions = ({

const typeData = useTypeData({ operation, plugin });

const functionIdentifier = serviceFunctionIdentifier({
config: plugin.context.config,
id: operation.id,
operation,
});

const identifierQueryKey = file.identifier({
// TODO: refactor for better cross-plugin compatibility
$ref: `#/tanstack-query-query-key/${operation.id}`,
$ref: `#/tanstack-query-query-key/${functionIdentifier}`,
case: plugin.config.queryKeys.case,
nameTransformer: plugin.config.queryKeys.name,
namespace: 'value',
Expand Down Expand Up @@ -129,7 +136,7 @@ export const createQueryOptions = ({

const identifierQueryOptions = file.identifier({
// TODO: refactor for better cross-plugin compatibility
$ref: `#/tanstack-query-query-options/${operation.id}`,
$ref: `#/tanstack-query-query-options/${functionIdentifier}`,
case: plugin.config.queryOptions.case,
create: true,
nameTransformer: plugin.config.queryOptions.name,
Expand Down
Loading