alpha release testing (#3208)

* alpha release testing

* Try the new alpha fastify

* fastify subscription cleanup test

* update integration guides

* use proper version

* chore(dependencies): updated changesets for modified dependencies

---------

Co-authored-by: Arda TANRIKULU <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: 3 people

.changeset/graphql-yoga-3208-dependencies.md

@@ -0,0 +1,8 @@
+---
+'graphql-yoga': patch
+---
+dependencies updates:
+  - Updated dependency
+    [`@whatwg-node/server@0.9.32-alpha-20240325115716-84ad025b793c368e6cfd30cdc6fce6bc76b862d3`
+    ↗︎](https://www.npmjs.com/package/@whatwg-node/server/v/0.9.32) (from `^0.9.31`, in
+    `dependencies`)

examples/fastify-modules/src/app.ts

@@ -23,7 +23,7 @@ export function createGraphQLHandler(): RouteHandlerMethod & {
   });
 
   const handler = async (req, reply) => {
-    const response = await graphQLServer.handleNodeRequest(req, {
+    const response = await graphQLServer.handleNodeRequestAndResponse(req, reply, {
       req,
       reply,
     });

examples/fastify/__integration-tests__/fastify.spec.ts

@@ -1,4 +1,5 @@
 import request from 'supertest';
+import { eventStream } from '../../../packages/graphql-yoga/__tests__/utilities.js';
 import { buildApp } from '../src/app.js';
 
 describe('fastify example integration', () => {
@@ -180,6 +181,7 @@ event: complete
 data"
 `);
   });
+
   it('handles subscription operations via POST', async () => {
     const [app] = buildApp(false);
     await app.ready();
@@ -235,6 +237,7 @@ event: complete
 data"
 `);
   });
+
   it('should handle file uploads', async () => {
     const [app] = buildApp(false);
     await app.ready();
@@ -259,6 +262,7 @@ data"
       },
     });
   });
+
   it('request cancelation', async () => {
     const [app] = buildApp(false);
     await app.ready();
@@ -308,6 +312,55 @@ data"
       app.log.info = info;
     }
   });
+
+  it('subscription cancelation', async () => {
+    const [app] = buildApp(false);
+    await app.ready();
+    const cancelationIsLoggedPromise = createDeferred();
+    const address = await app.listen({
+      port: 0,
+    });
+
+    // we work with logger statements to detect when the subscription source is cleaned up.
+    const loggerOverwrite = (part: unknown) => {
+      if (part === 'countdown aborted') {
+        cancelationIsLoggedPromise.resolve();
+      }
+    };
+
+    const info = app.log.info;
+    app.log.info = loggerOverwrite;
+
+    try {
+      const abortController = new AbortController();
+      const url = new URL(`${address}/graphql`);
+      url.searchParams.set(
+        'query',
+        /* GraphQL */ `
+          subscription {
+            countdown(from: 10, interval: 5)
+          }
+        `,
+      );
+      const response = await fetch(url, {
+        method: 'GET',
+        headers: {
+          'content-type': 'application/json',
+          accept: 'text/event-stream',
+        },
+        signal: abortController.signal,
+      });
+
+      const iterator = eventStream(response.body!);
+      const next = await iterator.next();
+      expect(next.value).toEqual({ data: { countdown: 10 } });
+      abortController.abort();
+      await expect(iterator.next()).rejects.toMatchInlineSnapshot(`DOMException {}`);
+      await cancelationIsLoggedPromise.promise;
+    } finally {
+      app.log.info = info;
+    }
+  });
 });
 
 type Deferred<T = void> = {

examples/fastify/src/app.ts

@@ -1,5 +1,5 @@
 import fastify, { FastifyReply, FastifyRequest } from 'fastify';
-import { createSchema, createYoga } from 'graphql-yoga';
+import { createSchema, createYoga, Repeater } from 'graphql-yoga';
 
 export function buildApp(logging = true) {
   const app = fastify({
@@ -64,11 +64,26 @@ export function buildApp(logging = true) {
         },
         Subscription: {
           countdown: {
-            async *subscribe(_, { from, interval }) {
-              for (let i = from; i >= 0; i--) {
-                await new Promise(resolve => setTimeout(resolve, interval ?? 1000));
-                yield { countdown: i };
-              }
+            async subscribe(_, { from, interval }, { request }) {
+              return new Repeater(async (push, stop) => {
+                const timeout = setInterval(() => {
+                  push({ countdown: from });
+                  from--;
+                  if (from < 0) {
+                    stop();
+                    return;
+                  }
+                }, interval);
+
+                stop.then(() => {
+                  clearInterval(timeout);
+                });
+
+                request.signal.addEventListener('abort', () => {
+                  app.log.info('countdown aborted');
+                  stop();
+                });
+              });
             },
           },
         },
@@ -102,7 +117,7 @@ export function buildApp(logging = true) {
     url: graphQLServer.graphqlEndpoint,
     method: ['GET', 'POST', 'OPTIONS'],
     handler: async (req, reply) => {
-      const response = await graphQLServer.handleNodeRequest(req, {
+      const response = await graphQLServer.handleNodeRequestAndResponse(req, reply, {
         req,
         reply,
       });

examples/hapi/src/app.ts

@@ -53,7 +53,11 @@ export async function startApp(port: number) {
       },
     },
     handler: async (req, h) => {
-      const { status, headers, body } = await yoga.handleNodeRequest(req.raw.req, { req, h });
+      const { status, headers, body } = await yoga.handleNodeRequestAndResponse(
+        req.raw.req,
+        req.raw.res,
+        { req, h },
+      );
 
       const res = h.response(
         Readable.from(body, {

examples/koa/src/app.ts

@@ -36,7 +36,7 @@ export function buildApp() {
   });
 
   app.use(async ctx => {
-    const response = await yoga.handleNodeRequest(ctx.req, ctx);
+    const response = await yoga.handleNodeRequestAndResponse(ctx.req, ctx.res, ctx);
 
     // Set status code
     ctx.status = response.status;

packages/graphql-yoga/__tests__/utilities.ts

@@ -15,7 +15,7 @@ export function eventStream<TType = unknown>(source: ReadableStream<Uint8Array>)
         break;
       }
 
-      const values = result.value.toString().split('\n').filter(Boolean);
+      const values = Buffer.from(result.value).toString('utf-8').split('\n').filter(Boolean);
       for (const value of values) {
         if (!value.startsWith('data: ')) {
           continue;

packages/graphql-yoga/package.json

@@ -56,7 +56,7 @@
     "@graphql-yoga/logger": "^2.0.0",
     "@graphql-yoga/subscription": "^5.0.0",
     "@whatwg-node/fetch": "^0.9.17",
-    "@whatwg-node/server": "^0.9.31",
+    "@whatwg-node/server": "^0.9.32",
     "dset": "^3.1.1",
     "lru-cache": "^10.0.0",
     "tslib": "^2.5.2"

packages/nestjs/src/index.ts

@@ -162,7 +162,7 @@ export abstract class AbstractYogaDriver<
     this.yoga = yoga as YogaDriverServerInstance<Platform>;
 
     app.all(yoga.graphqlEndpoint, async (req, reply) => {
-      const response = await yoga.handleNodeRequest(req, {
+      const response = await yoga.handleNodeRequestAndResponse(req, reply, {
         req,
         reply,
       });