fix type and documentation for dynamic schema function (#3004)

* fix type and documentation for dynamic schema function

* fix schema tests

* changeset

* fix type for generic auth

* fix createSchema type

* fix createSchema tests

Author: EmrysMyrddin

.changeset/wicked-feet-drop.md

@@ -0,0 +1,5 @@
+---
+'graphql-yoga': patch
+---
+
+Fix dynamic schema function type and documentation

packages/graphql-yoga/__tests__/schema.spec.ts

@@ -1,5 +1,5 @@
 import { GraphQLSchema } from 'graphql';
-import { createSchema, createYoga, YogaInitialContext } from '../src/index.js';
+import { createSchema, createYoga } from '../src/index.js';
 
 describe('schema', () => {
   it('missing schema causes a error', async () => {
@@ -39,23 +39,22 @@ describe('schema', () => {
   });
 
   it('schema factory function', async () => {
-    const schemaFactory = async (ctx: YogaInitialContext) => {
-      const strFromContext = ctx.request.headers.get('str');
-      return createSchema({
-        typeDefs: /* GraphQL */ `
-          type Query {
-            foo: String
-          }
-        `,
-        resolvers: {
-          Query: {
-            foo: () => strFromContext,
-          },
-        },
-      });
-    };
     const yoga = createYoga({
-      schema: schemaFactory,
+      async schema(ctx) {
+        const strFromContext = ctx.request.headers.get('str');
+        return createSchema({
+          typeDefs: /* GraphQL */ `
+            type Query {
+              foo: String
+            }
+          `,
+          resolvers: {
+            Query: {
+              foo: () => strFromContext,
+            },
+          },
+        });
+      },
     });
     const query = `{foo}`;
     let result = await yoga.fetch('http://yoga/graphql', {

packages/graphql-yoga/src/plugins/use-schema.ts

@@ -3,18 +3,22 @@ import { PromiseOrValue } from '@envelop/core';
 import type { GraphQLSchemaWithContext, YogaInitialContext } from '../types.js';
 import type { Plugin } from './types.js';
 
-export type YogaSchemaDefinition<TContext> =
-  | PromiseOrValue<GraphQLSchemaWithContext<TContext>>
+export type YogaSchemaDefinition<TServerContext, TUserContext> =
+  | PromiseOrValue<GraphQLSchemaWithContext<TServerContext & YogaInitialContext & TUserContext>>
   | ((
-      context: TContext & YogaInitialContext,
-    ) => PromiseOrValue<GraphQLSchemaWithContext<TContext>>);
+      context: TServerContext & { request: YogaInitialContext['request'] },
+    ) => PromiseOrValue<
+      GraphQLSchemaWithContext<TServerContext & YogaInitialContext & TUserContext>
+    >);
 
 export const useSchema = <
   // eslint-disable-next-line @typescript-eslint/ban-types
-  TContext = {},
+  TServerContext = {},
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  TUserContext = {},
 >(
-  schemaDef?: YogaSchemaDefinition<TContext>,
-): Plugin<YogaInitialContext & TContext> => {
+  schemaDef?: YogaSchemaDefinition<TServerContext, TUserContext>,
+): Plugin<YogaInitialContext & TServerContext> => {
   if (schemaDef == null) {
     return {};
   }
@@ -51,9 +55,9 @@ export const useSchema = <
       return {
         async onRequestParseDone() {
           const schema = await schemaDef({
-            ...serverContext,
+            ...(serverContext as TServerContext),
             request,
-          } as TContext & YogaInitialContext);
+          });
           schemaByRequest.set(request, schema);
         },
       };

packages/graphql-yoga/src/schema.ts

@@ -4,6 +4,6 @@ import { GraphQLSchemaWithContext, YogaInitialContext } from './types.js';
 // eslint-disable-next-line @typescript-eslint/ban-types
 export function createSchema<TContext = {}>(
   opts: IExecutableSchemaDefinition<TContext & YogaInitialContext>,
-): GraphQLSchemaWithContext<TContext> {
+): GraphQLSchemaWithContext<TContext & YogaInitialContext> {
   return makeExecutableSchema<TContext & YogaInitialContext>(opts);
 }

packages/graphql-yoga/src/server.ts

@@ -129,7 +129,7 @@ export type YogaServerOptions<TServerContext, TUserContext> = {
 
   renderGraphiQL?: ((options?: GraphiQLOptions) => PromiseOrValue<BodyInit>) | undefined;
 
-  schema?: YogaSchemaDefinition<TUserContext & TServerContext> | undefined;
+  schema?: YogaSchemaDefinition<TServerContext, TUserContext> | undefined;
 
   /**
    * Envelop Plugins

website/src/pages/docs/features/schema.mdx

@@ -46,7 +46,7 @@ import { createYoga } from 'graphql-yoga'
 import { getSchemaForViewer } from './schema.js'
 
 const yoga = createYoga({
-  schema: async request => getSchemaForViewer(request.headers.get('x-schema') ?? 'default')
+  schema: async ({ request }) => getSchemaForViewer(request.headers.get('x-schema') ?? 'default')
 })
 const server = createServer(yoga)