test(client-preset): operation names with custom suffix

This commit added a test case to make sure the generated operations' name is correct when the user specifies a `namingConvention` function.
dotansimha · Jun 19, 2024 · 96c2667 · 96c2667
1 parent 9af9ce2
commit 96c2667
Showing 1 changed file with 132 additions and 0 deletions.
diff --git a/packages/presets/client/tests/client-preset.spec.ts b/packages/presets/client/tests/client-preset.spec.ts
@@ -182,6 182,138 @@ export * from "./gql";`);
  expect(graphqlFile).toBeDefined();
  });
 
  it('can generate simple examples uppercase names with custom suffix', async () => {
  const result = await executeCodegen({
  schema: [
  /* GraphQL */ `
  type Query {
  a: String
  b: String
  c: String
  }
  `,
  ],
  documents: path.join(__dirname, 'fixtures/simple-uppercase-operation-name.ts'),
  generates: {
  'out1/': {
  preset,
  },
  },
  config: {
  namingConvention: name => `${name}Suffix`,
  },
  });
 
  expect(result).toHaveLength(4);
 
  // index.ts (re-exports)
  const indexFile = result.find(file => file.filename === 'out1/index.ts');
  expect(indexFile.content).toEqual(`export * from "./fragment-masking";
 export * from "./gql";`);
 
  // gql.ts
  const gqlFile = result.find(file => file.filename === 'out1/gql.ts');
  expect(gqlFile.content).toMatchInlineSnapshot(`
  "/* eslint-disable */
  import * as types from './graphql';
  import { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core';
 
  /**
  * Map of all GraphQL operations in the project.
  *
  * This map has several performance disadvantages:
  * 1. It is not tree-shakeable, so it will include all operations in the project.
  * 2. It is not minifiable, so the string of a GraphQL query will be multiple times inside the bundle.
  * 3. It does not support dead code elimination, so it will add unused operations.
  *
  * Therefore it is highly recommended to use the babel or swc plugin for production.
  */
  const documents = {
  "\\n query A {\\n a\\n }\\n": types.ADocumentSuffix,
  "\\n query B {\\n b\\n }\\n": types.BDocumentSuffix,
  "\\n fragment C on Query {\\n c\\n }\\n": types.CFragmentDocSuffix,
  };
 
  /**
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  *
  *
  * @example
  * \`\`\`ts
  * const query = graphql(\`query GetUser($id: ID!) { user(id: $id) { name } }\`);
  * \`\`\`
  *
  * The query argument is unknown!
  * Please regenerate the types.
  */
  export function graphql(source: string): unknown;
 
  /**
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  */
  export function graphql(source: "\\n query A {\\n a\\n }\\n"): (typeof documents)["\\n query A {\\n a\\n }\\n"];
  /**
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  */
  export function graphql(source: "\\n query B {\\n b\\n }\\n"): (typeof documents)["\\n query B {\\n b\\n }\\n"];
  /**
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  */
  export function graphql(source: "\\n fragment C on Query {\\n c\\n }\\n"): (typeof documents)["\\n fragment C on Query {\\n c\\n }\\n"];
 
  export function graphql(source: string) {
  return (documents as any)[source] ?? {};
  }
 
  export type DocumentType<TDocumentNode extends DocumentNode<any, any>> = TDocumentNode extends DocumentNode< infer TType, any> ? TType : never;"
  `);
 
  // graphql.ts
  const graphqlFile = result.find(file => file.filename === 'out1/graphql.ts');
  expect(graphqlFile.content).toMatchInlineSnapshot(`
  "/* eslint-disable */
  import { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core';
  export type Maybe<T> = T | null;
  export type InputMaybe<T> = Maybe<T>;
  export type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
  export type MakeOptional<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]?: Maybe<T[SubKey]> };
  export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]: Maybe<T[SubKey]> };
  export type MakeEmpty<T extends { [key: string]: unknown }, K extends keyof T> = { [_ in K]?: never };
  export type Incremental<T> = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never };
  /** All built-in and custom scalars, mapped to their actual values */
  export type Scalars = {
  ID: { input: string; output: string; }
  String: { input: string; output: string; }
  Boolean: { input: boolean; output: boolean; }
  Int: { input: number; output: number; }
  Float: { input: number; output: number; }
  };
 
  export type QuerySuffix = {
  __typename?: 'Query';
  a?: Maybe<Scalars['String']['output']>;
  b?: Maybe<Scalars['String']['output']>;
  c?: Maybe<Scalars['String']['output']>;
  };
 
  export type AQueryVariablesSuffix = Exact<{ [key: string]: never; }>;
 
 
  export type AQuerySuffix = { __typename?: 'Query', a?: string | null };
 
  export type BQueryVariablesSuffix = Exact<{ [key: string]: never; }>;
 
 
  export type BQuerySuffix = { __typename?: 'Query', b?: string | null };
 
  export type CFragmentSuffix = { __typename?: 'Query', c?: string | null } & { ' $fragmentName'?: 'CFragmentSuffix' };
 
  export const CFragmentDocSuffix = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"C"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Query"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"c"}}]}}]} as unknown as DocumentNode<CFragmentSuffix, unknown>;
  export const ADocumentSuffix = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"A"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"a"}}]}}]} as unknown as DocumentNode<AQuerySuffix, AQueryVariablesSuffix>;
  export const BDocumentSuffix = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"B"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"b"}}]}}]} as unknown as DocumentNode<BQuerySuffix, BQueryVariablesSuffix>;"
  `);
  });
 
  it('generates \\n regardless of whether the source contains LF or CRLF', async () => {
  const result = await executeCodegen({
  schema: [