feat(use/express,use/fastify,use/koa): Request context with the response

Closes #66

Author: enisdenjo

docs/interfaces/use_express.RequestContext.md

@@ -0,0 +1,19 @@
+[graphql-http](../README.md) / [use/express](../modules/use_express.md) / RequestContext
+
+# Interface: RequestContext
+
+[use/express](../modules/use_express.md).RequestContext
+
+The context in the request for the handler.
+
+## Table of contents
+
+### Properties
+
+- [res](use_express.RequestContext.md#res)
+
+## Properties
+
+### res
+
+• **res**: `Response`<`any`, `Record`<`string`, `any`\>\>

docs/interfaces/use_fastify.RequestContext.md

@@ -0,0 +1,19 @@
+[graphql-http](../README.md) / [use/fastify](../modules/use_fastify.md) / RequestContext
+
+# Interface: RequestContext
+
+[use/fastify](../modules/use_fastify.md).RequestContext
+
+The context in the request for the handler.
+
+## Table of contents
+
+### Properties
+
+- [reply](use_fastify.RequestContext.md#reply)
+
+## Properties
+
+### reply
+
+• **reply**: `FastifyReply`<`RawServerDefault`, `IncomingMessage`, `ServerResponse`<`IncomingMessage`\>, `RouteGenericInterface`, `unknown`, `FastifySchema`, `FastifyTypeProviderDefault`, `unknown`\>

docs/interfaces/use_koa.RequestContext.md

@@ -0,0 +1,19 @@
+[graphql-http](../README.md) / [use/koa](../modules/use_koa.md) / RequestContext
+
+# Interface: RequestContext
+
+[use/koa](../modules/use_koa.md).RequestContext
+
+The context in the request for the handler.
+
+## Table of contents
+
+### Properties
+
+- [res](use_koa.RequestContext.md#res)
+
+## Properties
+
+### res
+
+• **res**: `Response`

docs/modules/use_express.md

@@ -4,6 +4,10 @@
 
 ## Table of contents
 
+### Interfaces
+
+- [RequestContext](../interfaces/use_express.RequestContext.md)
+
 ### Type Aliases
 
 - [HandlerOptions](use_express.md#handleroptions)
@@ -16,7 +20,7 @@
 
 ### HandlerOptions
 
-Ƭ **HandlerOptions**<`Context`\>: [`HandlerOptions`](../interfaces/handler.HandlerOptions.md)<`Request`, `undefined`, `Context`\>
+Ƭ **HandlerOptions**<`Context`\>: [`HandlerOptions`](../interfaces/handler.HandlerOptions.md)<`Request`, [`RequestContext`](../interfaces/use_express.RequestContext.md), `Context`\>
 
 Handler options when using the express adapter.
 

docs/modules/use_fastify.md

@@ -4,6 +4,10 @@
 
 ## Table of contents
 
+### Interfaces
+
+- [RequestContext](../interfaces/use_fastify.RequestContext.md)
+
 ### Type Aliases
 
 - [HandlerOptions](use_fastify.md#handleroptions)
@@ -16,7 +20,7 @@
 
 ### HandlerOptions
 
-Ƭ **HandlerOptions**<`Context`\>: [`HandlerOptions`](../interfaces/handler.HandlerOptions.md)<`FastifyRequest`, `undefined`, `Context`\>
+Ƭ **HandlerOptions**<`Context`\>: [`HandlerOptions`](../interfaces/handler.HandlerOptions.md)<`FastifyRequest`, [`RequestContext`](../interfaces/use_fastify.RequestContext.md), `Context`\>
 
 Handler options when using the fastify adapter.
 

docs/modules/use_koa.md

@@ -4,6 +4,10 @@
 
 ## Table of contents
 
+### Interfaces
+
+- [RequestContext](../interfaces/use_koa.RequestContext.md)
+
 ### Type Aliases
 
 - [HandlerOptions](use_koa.md#handleroptions)
@@ -16,7 +20,7 @@
 
 ### HandlerOptions
 
-Ƭ **HandlerOptions**<`Context`\>: [`HandlerOptions`](../interfaces/handler.HandlerOptions.md)<`IncomingMessage`, `undefined`, `Context`\>
+Ƭ **HandlerOptions**<`Context`\>: [`HandlerOptions`](../interfaces/handler.HandlerOptions.md)<`IncomingMessage`, [`RequestContext`](../interfaces/use_koa.RequestContext.md), `Context`\>
 
 Handler options when using the koa adapter.
 

src/__tests__/use.ts

@@ -74,6 +74,31 @@ describe('express', () => {
       }
     });
   }
+
+  it('should allow manipulating the response from the request context', async () => {
+    const app = express();
+    app.all(
+      '/',
+      createExpressHandler({
+        schema,
+        context(req) {
+          req.context.res.setHeader('x-test', 'test-x');
+          return undefined;
+        },
+      }),
+    );
+
+    const [url, dispose] = startDisposableServer(app.listen(0));
+
+    const res = await fetch(url + '?query={hello}');
+
+    await expect(res.text()).resolves.toMatchInlineSnapshot(
+      `"{"data":{"hello":"world"}}"`,
+    );
+    expect(res.headers.get('x-test')).toBe('test-x');
+
+    await dispose();
+  });
 });
 
 describe('fastify', () => {
@@ -104,6 +129,35 @@ describe('fastify', () => {
       }
     });
   }
+
+  it('should allow manipulating the response from the request context', async () => {
+    const app = fastify();
+
+    app.all(
+      '/',
+      createFastifyHandler({
+        schema,
+        context(req) {
+          req.context.reply.header('x-test', 'test-x');
+          return undefined;
+        },
+      }),
+    );
+
+    // call ready since we're not calling listen
+    app.ready();
+
+    const [url, dispose] = startDisposableServer(app.server);
+
+    const res = await fetch(url + '?query={hello}');
+
+    await expect(res.text()).resolves.toMatchInlineSnapshot(
+      `"{"data":{"hello":"world"}}"`,
+    );
+    expect(res.headers.get('x-test')).toBe('test-x');
+
+    await dispose();
+  });
 });
 
 describe('fetch', () => {
@@ -137,4 +191,31 @@ describe('koa', () => {
       }
     });
   }
+
+  it('should allow manipulating the response from the request context', async () => {
+    const app = new Koa();
+    app.use(
+      mount(
+        '/',
+        createKoaHandler({
+          schema,
+          context(req) {
+            req.context.res.set('x-test', 'test-x');
+            return undefined;
+          },
+        }),
+      ),
+    );
+
+    const [url, dispose] = startDisposableServer(app.listen(0));
+
+    const res = await fetch(url + '?query={hello}');
+
+    await expect(res.text()).resolves.toMatchInlineSnapshot(
+      `"{"data":{"hello":"world"}}"`,
+    );
+    expect(res.headers.get('x-test')).toBe('test-x');
+
+    await dispose();
+  });
 });

src/use/express.ts

@@ -1,17 +1,26 @@
-import type { Request, Handler } from 'express';
+import type { Request, Response, Handler } from 'express';
 import {
   createHandler as createRawHandler,
   HandlerOptions as RawHandlerOptions,
   OperationContext,
 } from '../handler';
 
+/**
+ * The context in the request for the handler.
+ *
+ * @category Server/express
+ */
+export interface RequestContext {
+  res: Response;
+}
+
 /**
  * Handler options when using the express adapter.
  *
  * @category Server/express
  */
 export type HandlerOptions<Context extends OperationContext = undefined> =
-  RawHandlerOptions<Request, undefined, Context>;
+  RawHandlerOptions<Request, RequestContext, Context>;
 
 /**
  * Create a GraphQL over HTTP spec compliant request handler for
@@ -54,7 +63,7 @@ export function createHandler<Context extends OperationContext = undefined>(
           });
         },
         raw: req,
-        context: undefined,
+        context: { res },
       });
       res.writeHead(init.status, init.statusText, init.headers).end(body);
     } catch (err) {

src/use/fastify.ts

@@ -1,17 +1,26 @@
-import type { FastifyRequest, RouteHandler } from 'fastify';
+import type { FastifyRequest, FastifyReply, RouteHandler } from 'fastify';
 import {
   createHandler as createRawHandler,
   HandlerOptions as RawHandlerOptions,
   OperationContext,
 } from '../handler';
 
+/**
+ * The context in the request for the handler.
+ *
+ * @category Server/fastify
+ */
+export interface RequestContext {
+  reply: FastifyReply;
+}
+
 /**
  * Handler options when using the fastify adapter.
  *
  * @category Server/fastify
  */
 export type HandlerOptions<Context extends OperationContext = undefined> =
-  RawHandlerOptions<FastifyRequest, undefined, Context>;
+  RawHandlerOptions<FastifyRequest, RequestContext, Context>;
 
 /**
  * Create a GraphQL over HTTP spec compliant request handler for
@@ -45,7 +54,7 @@ export function createHandler<Context extends OperationContext = undefined>(
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         body: req.body as any,
         raw: req,
-        context: undefined,
+        context: { reply },
       });
       reply
         .status(init.status)

src/use/koa.ts

@@ -1,18 +1,27 @@
-import type { Middleware } from 'koa';
+import type { Middleware, Response } from 'koa';
 import type { IncomingMessage } from 'http';
 import {
   createHandler as createRawHandler,
   HandlerOptions as RawHandlerOptions,
   OperationContext,
 } from '../handler';
 
+/**
+ * The context in the request for the handler.
+ *
+ * @category Server/koa
+ */
+export interface RequestContext {
+  res: Response;
+}
+
 /**
  * Handler options when using the koa adapter.
  *
  * @category Server/koa
  */
 export type HandlerOptions<Context extends OperationContext = undefined> =
-  RawHandlerOptions<IncomingMessage, undefined, Context>;
+  RawHandlerOptions<IncomingMessage, RequestContext, Context>;
 
 /**
  * Create a GraphQL over HTTP spec compliant request handler for
@@ -56,7 +65,7 @@ export function createHandler<Context extends OperationContext = undefined>(
           });
         },
         raw: ctx.req,
-        context: undefined,
+        context: { res: ctx.response },
       });
       ctx.body = body;
       ctx.response.status = init.status;