Add unit test for readOnly

Author: eddeee888

packages/plugins/typescript/operations/tests/ts-documents.documentsReadonly.spec.ts

@@ -0,0 +1,64 @@
+import { buildSchema, parse } from 'graphql';
+import { mergeOutputs } from '@graphql-codegen/plugin-helpers';
+import { createTestDocument } from '@graphql-codegen/testing';
+import { plugin } from '../src/index.js';
+
+describe('TypeScript Operations Plugin - documentsReadOnly', () => {
+  it('uses read-only document file as reference, without generating types for it', async () => {
+    const schema = buildSchema(/* GraphQL */ `
+      type Query {
+        user(id: ID!): User
+      }
+
+      type User {
+        id: ID!
+        name: String!
+        role: UserRole!
+      }
+
+      enum UserRole {
+        ADMIN
+        CUSTOMER
+      }
+    `);
+    const query = parse(/* GraphQL */ `
+      query User {
+        user(id: "100") {
+          id
+          ...UserFragment
+        }
+      }
+    `);
+
+    const fragment = parse(/* GraphQL */ `
+      fragment UserFragment on User {
+        id
+        name
+      }
+    `);
+
+    const result = mergeOutputs([
+      await plugin(
+        schema,
+        [
+          createTestDocument({ location: '', document: query, type: 'standard' }),
+          createTestDocument({ location: '', document: fragment, type: 'standard' }),
+        ],
+        {},
+        { outputFile: '' },
+      ),
+    ]);
+
+    expect(result).toMatchInlineSnapshot(`
+      "export type UserQueryVariables = Exact<{ [key: string]: never; }>;
+
+
+      export type UserQuery = { __typename?: 'Query', user?: { __typename?: 'User', id: string, name: string } | null };
+      "
+    `);
+
+    // FIXME: cannot call `validateTs` until next major version
+    // https://github.com/dotansimha/graphql-code-generator/pull/10496/changes
+    // validateTs(result, undefined, undefined, undefined, undefined, true);
+  });
+});

packages/utils/graphql-codegen-testing/src/operations.ts

@@ -4,14 +4,16 @@ import type { Types } from '@graphql-codegen/plugin-helpers';
 export const createTestDocument = ({
   location,
   document,
+  type = 'standard',
 }: {
   location: string;
   document: DocumentNode;
+  type?: 'standard' | 'read-only';
 }): Types.DocumentFile => {
   return {
     location,
     document,
     hash: 'mocked',
-    type: 'standard',
+    type,
   };
 };