npm install --save-dev @pothos/core graphql

import SchemaBuilder from '@pothos/core';

const builder = new SchemaBuilder({});

builder.queryType({
  fields: (t) => ({
    hello: t.string({
      args: { name: t.arg.string() },
      resolve: (_parent, { name }) => `hello, ${name || 'World'}`,
    }),
  }),
});

export const schema = builder.toSchema();

import { graphql } from 'graphql';
import { schema } from './schema';

test('hello resolver', async () => {
  const result = await graphql({
    schema,
    source: `{ hello(name: "alice") }`,
  });
  expect(result.errors).toBeUndefined();
  expect(result.data?.hello).toBe('hello, alice');
});

import { lexicographicSortSchema, printSchema } from 'graphql';
import { schema } from './schema';

test('schema snapshot', () => {
  // lexicographicSortSchema produces deterministic ordering
  const printed = printSchema(lexicographicSortSchema(schema));
  expect(printed).toMatchSnapshot();
});

import { ApolloServer } from '@apollo/server';
import { schema } from './schema';

const server = new ApolloServer({ schema });
// ... use apollo-server-tests patterns from here

import { createYoga } from 'graphql-yoga';
import { schema } from './schema';

const yoga = createYoga({ schema });
// ... use graphql-yoga-tests patterns from here

npm test
npm test -- --updateSnapshot       # accept schema changes

import RelayPlugin from '@pothos/plugin-relay';

const builder = new SchemaBuilder<{ Context: AuthContext }>({
  plugins: [RelayPlugin],
  relay: { clientMutationId: 'optional' },
});

builder.queryType({ /* ... */ });
const schema = builder.toSchema();

test('relay plugin adds Node interface', () => {
  const printed = printSchema(lexicographicSortSchema(schema));
  expect(printed).toContain('interface Node');
});

test('me resolver returns current user', async () => {
  const result = await graphql({
    schema,
    source: `{ me { id name } }`,
    contextValue: { user: { id: 'u1', name: 'alice' } },
  });
  expect(result.data?.me).toEqual({ id: 'u1', name: 'alice' });
});

test('me resolver errors without auth', async () => {
  const result = await graphql({
    schema,
    source: `{ me { id name } }`,
    contextValue: { user: null },
  });
  expect(result.errors?.[0].message).toMatch(/authenticate/i);
});

{
  data?: { ... },         // null on error if root resolver failed
  errors?: GraphQLError[],
  extensions?: { ... }
}

jobs:
  pothos:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: actions/setup-node@v4
        with: { node-version: '20' }
      - run: npm ci
      - run: npm test
      - name: Schema snapshot must match
        run: |
          # Fails the build if snapshot would change
          npx jest --ci tests/schema-snapshot.test.ts