Merge pull request #3479 from SeedCompany/gql-tada

Author: CarsonF

.eslintrc.cjs

@@ -93,6 +93,16 @@ const restrictedImports = [
     kind: 'value',
     message: 'Be sure to specify the `type` modifier',
   },
+  {
+    importNames: ['ResultOf', 'VariablesOf'],
+    path: '@graphql-typed-document-node/core',
+    replacement: { path: '~/graphql' },
+  },
+  {
+    importNames: ['FragmentOf', 'ResultOf', 'VariablesOf'],
+    path: 'gql.tada',
+    replacement: { path: '~/graphql' },
+  },
 ];
 
 const namingConvention = [

.github/workflows/lint.yml

@@ -21,11 +21,12 @@ jobs:
       - name: Check for no duplicate dependencies
         run: yarn dedupe --check
 
+      - name: Generate GQL Schema
+        run: yarn start -- --gen-schema && yarn gql-tada generate output
+
       - name: Check TypeScript
         run: yarn type-check
 
-      - name: Generate GQL Schema
-        run: yarn start -- --gen-schema
       - name: Upload GQL Schema
         uses: actions/upload-artifact@v4
         with:

.github/workflows/test.yml

@@ -18,6 +18,9 @@ jobs:
       - name: Gel Setup
         uses: ./.github/actions/gel-setup
 
+      - name: Generate GQL Schema
+        run: yarn start -- --gen-schema && yarn gql-tada generate output
+
       - name: Tests
         run: yarn test --reporters=github-actions
 
@@ -59,6 +62,9 @@ jobs:
       - name: Gel Setup
         uses: ./.github/actions/gel-setup
 
+      - name: Generate GQL Schema
+        run: yarn start -- --gen-schema && yarn gql-tada generate output
+
       - name: E2E Tests
         run: yarn test:e2e --shard=${{ matrix.shard }}/6 --reporters=github-actions
         env:

.gitignore

@@ -7,6 +7,7 @@
 src/core/gel/generated-client
 src/core/gel/schema.ts
 src/**/*.edgeql.ts
+*.generated.*
 
 # Yarn / NPM
 .yarn/cache

package.json

@@ -74,6 +74,7 @@
     "gel": "^2.1.0-canary.20250319T143140",
     "glob": "^11.0.2",
     "got": "^14.3.0",
+    "gql.tada": "^1.8.10",
     "graphql": "^16.9.0",
     "graphql-parse-resolve-info": "^4.14.0",
     "graphql-scalars": "^1.22.4",

src/graphql.ts

@@ -0,0 +1,25 @@
+/* eslint-disable @seedcompany/no-restricted-imports */
+import { initGraphQLTada, type VariablesOf } from 'gql.tada';
+import { type ID } from '~/common';
+import type { introspection } from './graphql-env.generated';
+
+export const graphql = initGraphQLTada<{
+  introspection: introspection;
+  scalars: {
+    ID: ID;
+    Date: string;
+    DateTime: string;
+    InlineMarkdown: string;
+    Markdown: string;
+    RichText: object;
+    URL: string;
+  };
+  disableMasking: true;
+}>();
+
+export type { FragmentOf, ResultOf, VariablesOf } from 'gql.tada';
+export { readFragment } from 'gql.tada';
+
+export type InputOf<T> = VariablesOf<T> extends { input?: infer Input }
+  ? Input
+  : never;

test/authentication.e2e-spec.ts

@@ -3,18 +3,17 @@ import { jest } from '@jest/globals';
 import { EmailService } from '@seedcompany/nestjs-email';
 import { Connection } from 'cypher-query-builder';
 import { isValidId } from '~/common';
+import { graphql } from '~/graphql';
 import {
   createSession,
   createTestApp,
   fragments,
   generateRegisterInput,
-  gql,
   login,
   logout,
   registerUser,
   type TestApp,
 } from './utility';
-import { type RawUser } from './utility/fragments';
 
 describe('Authentication e2e', () => {
   let app: TestApp;
@@ -38,13 +37,13 @@ describe('Authentication e2e', () => {
     // create user first
     await registerUser(app, fakeUser);
     await app.graphql.mutate(
-      gql`
+      graphql(`
         mutation forgotPassword($email: String!) {
           forgotPassword(email: $email) {
             __typename
           }
         }
-      `,
+      `),
       {
         email: email,
       },
@@ -59,13 +58,13 @@ describe('Authentication e2e', () => {
     const token = tokenRes ? tokenRes.token : '';
     const newPassword = faker.internet.password();
     await app.graphql.mutate(
-      gql`
+      graphql(`
         mutation resetPassword($input: ResetPasswordInput!) {
           resetPassword(input: $input) {
             __typename
           }
         }
-      `,
+      `),
       {
         input: {
           token: token,
@@ -90,20 +89,22 @@ describe('Authentication e2e', () => {
 
     await login(app, { email: fakeUser.email, password: fakeUser.password });
     const result = await app.graphql.query(
-      gql`
-        query user($id: ID!) {
-          user(id: $id) {
-            ...user
+      graphql(
+        `
+          query user($id: ID!) {
+            user(id: $id) {
+              ...user
+            }
           }
-        }
-        ${fragments.user}
-      `,
+        `,
+        [fragments.user],
+      ),
       {
         id: user.id,
       },
     );
 
-    const actual: RawUser = result.user;
+    const actual = result.user;
     expect(actual).toBeTruthy();
     expect(isValidId(actual.id)).toBe(true);
     expect(actual.email.value).toBe(fakeUser.email.toLowerCase());
@@ -125,13 +126,13 @@ describe('Authentication e2e', () => {
 
     const newPassword = faker.internet.password();
     await app.graphql.mutate(
-      gql`
+      graphql(`
         mutation changePassword($oldPassword: String!, $newPassword: String!) {
           changePassword(oldPassword: $oldPassword, newPassword: $newPassword) {
             __typename
           }
         }
-      `,
+      `),
       {
         oldPassword: fakeUser.password,
         newPassword: newPassword,

test/education.e2e-spec.ts

@@ -1,21 +1,19 @@
 import { faker } from '@faker-js/faker';
 import { times } from 'lodash';
 import { isValidId, Role } from '~/common';
-import { type User } from '../src/components/user/dto';
-import { type Education } from '../src/components/user/education/dto';
+import { graphql } from '~/graphql';
 import {
   createEducation,
   createSession,
   createTestApp,
-  gql,
+  fragments,
   registerUser,
   type TestApp,
 } from './utility';
-import { fragments } from './utility/fragments';
 
 describe('Education e2e', () => {
   let app: TestApp;
-  let user: User;
+  let user: fragments.user;
 
   beforeAll(async () => {
     app = await createTestApp();
@@ -36,14 +34,16 @@ describe('Education e2e', () => {
     const education = await createEducation(app, { userId: user.id });
 
     const { education: actual } = await app.graphql.query(
-      gql`
-        query education($id: ID!) {
-          education(id: $id) {
-            ...education
+      graphql(
+        `
+          query education($id: ID!) {
+            education(id: $id) {
+              ...education
+            }
           }
-        }
-        ${fragments.education}
-      `,
+        `,
+        [fragments.education],
+      ),
       {
         id: education.id,
       },
@@ -60,16 +60,18 @@ describe('Education e2e', () => {
     const newInstitution = faker.company.name();
 
     const result = await app.graphql.mutate(
-      gql`
-        mutation updateEducation($input: UpdateEducationInput!) {
-          updateEducation(input: $input) {
-            education {
-              ...education
+      graphql(
+        `
+          mutation updateEducation($input: UpdateEducationInput!) {
+            updateEducation(input: $input) {
+              education {
+                ...education
+              }
             }
           }
-        }
-        ${fragments.education}
-      `,
+        `,
+        [fragments.education],
+      ),
       {
         input: {
           education: {
@@ -90,18 +92,18 @@ describe('Education e2e', () => {
     const education = await createEducation(app, { userId: user.id });
 
     const result = await app.graphql.mutate(
-      gql`
+      graphql(`
         mutation deleteEducation($id: ID!) {
           deleteEducation(id: $id) {
             __typename
           }
         }
-      `,
+      `),
       {
         id: education.id,
       },
     );
-    const actual: Education | undefined = result.deleteEducation;
+    const actual = result.deleteEducation;
     expect(actual).toBeTruthy();
   });
 
@@ -114,20 +116,22 @@ describe('Education e2e', () => {
     );
 
     const result = await app.graphql.query(
-      gql`
-        query UserEducation($id: ID!) {
-          user(id: $id) {
-            education {
-              items {
-                ...education
+      graphql(
+        `
+          query UserEducation($id: ID!) {
+            user(id: $id) {
+              education {
+                items {
+                  ...education
+                }
+                hasMore
+                total
               }
-              hasMore
-              total
             }
           }
-        }
-        ${fragments.education}
-      `,
+        `,
+        [fragments.education],
+      ),
       {
         id: user.id,
       },