Avoid using EventSource & getPort (#1763)

Author: ardatan

examples/generic-auth/__integration-tests__/generic-auth.spec.ts

@@ -2,7 +2,6 @@ import { yoga } from '../src/app'
 import { createServer, Server } from 'http'
 import { AddressInfo } from 'net'
 import { fetch } from '@whatwg-node/fetch'
-import EventSource from 'eventsource'
 
 describe('graphql-auth example integration', () => {
   let server: Server
@@ -58,87 +57,66 @@ describe('graphql-auth example integration', () => {
   })
 
   it('should execute on public field with subscription', async () => {
-    const eventSource = new EventSource(
+    expect.assertions(1)
+    const response = await fetch(
       `http://localhost:${port}/graphql?query=subscription{public}`,
+      {
+        headers: {
+          Accept: 'text/event-stream',
+        },
+      },
     )
 
-    const messages: string[] = []
-    try {
-      await new Promise<void>((resolve, reject) => {
-        eventSource.onmessage = (message) => {
-          messages.push(message.data)
-          eventSource.close()
-          resolve()
-        }
-        eventSource.onerror = (error) => {
-          reject(error)
-        }
-      })
-
-      expect(messages).toMatchInlineSnapshot(`
-        [
-          "{"data":{"public":"hi"}}",
-        ]
-      `)
-    } finally {
-      eventSource.close()
+    for await (const chunk of response.body!) {
+      const chunkString = Buffer.from(chunk).toString('utf-8')
+      if (chunkString.includes('data:')) {
+        expect(chunkString.trim()).toBe('data: {"data":{"public":"hi"}}')
+        break
+      }
     }
   })
 
   it('should execute on auth required field with subscription', async () => {
-    const eventSource = new EventSource(
+    expect.assertions(1)
+    const response = await fetch(
       `http://localhost:${port}/graphql?query=subscription{requiresAuth}`,
       {
         headers: {
+          Accept: 'text/event-stream',
           'x-authorization': 'aaa',
         },
       },
     )
 
-    const messages: string[] = []
-    try {
-      await new Promise<void>((resolve, reject) => {
-        eventSource.onmessage = (message) => {
-          messages.push(message.data)
-          eventSource.close()
-          resolve()
-        }
-        eventSource.onerror = (error) => {
-          reject(error)
-        }
-      })
-
-      expect(messages).toMatchInlineSnapshot(`
-        [
-          "{"data":{"requiresAuth":"hi [email protected]"}}",
-        ]
-      `)
-    } finally {
-      eventSource.close()
+    for await (const chunk of response.body!) {
+      const chunkStr = Buffer.from(chunk).toString('utf-8')
+      if (chunkStr.startsWith('data:')) {
+        expect(chunkStr.trim()).toBe(
+          'data: {"data":{"requiresAuth":"hi [email protected]"}}',
+        )
+        break
+      }
     }
   })
 
   it('should not execute on auth required field with subscription', async () => {
-    const eventSource = new EventSource(
+    expect.assertions(1)
+    const response = await fetch(
       `http://localhost:${port}/graphql?query=subscription{requiresAuth}`,
+      {
+        headers: {
+          Accept: 'text/event-stream',
+        },
+      },
     )
-
-    const messages: string[] = []
-    try {
-      await new Promise<void>((resolve, reject) => {
-        eventSource.onmessage = (message) => {
-          messages.push(message.data)
-          eventSource.close()
-          resolve()
-        }
-        eventSource.onerror = (error) => {
-          reject(error)
-        }
-      })
-    } catch (err) {
-      expect(err.message).toEqual('Internal Server Error')
-    } finally {
-      eventSource.close()
+    for await (const chunk of response.body!) {
+      const chunkStr = Buffer.from(chunk).toString('utf-8')
+      if (chunkStr.startsWith('data:')) {
+        expect(chunkStr.trim()).toBe(
+          'data: {"data":null,"errors":[{"message":"Accessing \'Subscription.requiresAuth\' requires authentication.","locations":[{"line":1,"column":14}]}]}',
+        )
+        break
+      }
     }
   })
 })

package.json

@@ -76,7 +76,6 @@
     "babel-plugin-transform-typescript-metadata": "0.3.2",
     "bob-the-bundler": "4.0.0",
     "cross-env": "7.0.3",
-    "get-port": "5.1.1",
     "eslint": "^8.21.0",
     "execa": "5.1.1",
     "graphql": "^16.5.0",
@@ -90,7 +89,7 @@
     "supertest": "^6.1.6",
     "ts-jest": "^29.0.0",
     "typescript": "4.8.3",
-    "weak-napi": ""
+    "weak-napi": "2.0.2"
   },
   "resolutions": {
     "graphql": "16.6.0"

packages/client/apollo-link/__integration-tests__/apollo-link.spec.ts

@@ -5,7 +5,7 @@ import { parse } from 'graphql'
 import { observableToAsyncIterable } from '@graphql-tools/utils'
 import { YogaLink } from '@graphql-yoga/apollo-link'
 import { File } from '@whatwg-node/fetch'
-import getPort from 'get-port'
+import { AddressInfo } from 'node:net'
 
 describe('Yoga Apollo Link', () => {
   const endpoint = '/graphql'
@@ -54,8 +54,9 @@ describe('Yoga Apollo Link', () => {
   let client: ApolloClient<any>
 
   beforeAll(async () => {
-    const port = await getPort()
     server = createServer(yoga)
+    await new Promise<void>((resolve) => server.listen(0, hostname, resolve))
+    const port = (server.address() as AddressInfo).port
     url = `http://${hostname}:${port}${endpoint}`
     client = new ApolloClient({
       link: new YogaLink({
@@ -64,7 +65,6 @@ describe('Yoga Apollo Link', () => {
       }),
       cache: new InMemoryCache(),
     })
-    await new Promise<void>((resolve) => server.listen(port, hostname, resolve))
   })
   afterAll(() => {
     server.close()

packages/client/urql-exchange/__integration-tests__/urql-exchange.spec.ts

@@ -5,7 +5,7 @@ import { pipe, toObservable } from 'wonka'
 import { createYoga, createSchema } from 'graphql-yoga'
 import { File } from '@whatwg-node/fetch'
 import { createServer, Server } from 'http'
-import getPort from 'get-port'
+import { AddressInfo } from 'node:net'
 
 describe('graphExchange', () => {
   const endpoint = '/graphql'
@@ -54,8 +54,9 @@ describe('graphExchange', () => {
   let client: Client
 
   beforeAll(async () => {
-    const port = await getPort()
     server = createServer(yoga)
+    await new Promise<void>((resolve) => server.listen(0, hostname, resolve))
+    const port = (server.address() as AddressInfo).port
     url = `http://${hostname}:${port}${endpoint}`
     client = createClient({
       url,
@@ -65,7 +66,6 @@ describe('graphExchange', () => {
         }),
       ],
     })
-    await new Promise<void>((resolve) => server.listen(port, hostname, resolve))
   })
   afterAll(() => {
     server.close()

packages/graphql-yoga/__integration-tests__/browser.spec.ts

@@ -16,7 +16,7 @@ import {
 } from 'graphql'
 import { GraphQLBigInt } from 'graphql-scalars'
 import 'json-bigint-patch'
-import getPort from 'get-port'
+import { AddressInfo } from 'net'
 
 export function createTestSchema() {
   let liveQueryCounter = 0
@@ -155,8 +155,8 @@ describe('browser', () => {
   const server = createServer(yogaApp)
 
   beforeAll(async () => {
-    port = await getPort()
-    await new Promise<void>((resolve) => server.listen(port, resolve))
+    await new Promise<void>((resolve) => server.listen(0, resolve))
+    port = (server.address() as AddressInfo).port
     browser = await puppeteer.launch({
       // If you wanna run tests with open browser
       // set your PUPPETEER_HEADLESS env to "false"
@@ -384,7 +384,6 @@ describe('browser', () => {
     let anotherServer: Server
     let anotherOriginPort: number
     beforeAll(async () => {
-      anotherOriginPort = await getPort()
       anotherServer = createServer((_req, res) => {
         res.end(/* HTML */ `
           <html>
@@ -422,8 +421,9 @@ describe('browser', () => {
         `)
       })
       await new Promise<void>((resolve) =>
-        anotherServer.listen(anotherOriginPort, () => resolve()),
+        anotherServer.listen(0, () => resolve()),
       )
+      anotherOriginPort = (anotherServer.address() as AddressInfo).port
     })
     afterAll(async () => {
       await new Promise<void>((resolve) => anotherServer.close(() => resolve()))

packages/graphql-yoga/__integration-tests__/file-uploads.spec.ts

@@ -5,7 +5,7 @@ import * as os from 'os'
 import { createServer } from 'http'
 import { createYoga, createSchema } from 'graphql-yoga'
 import { fetch, File, FormData } from '@whatwg-node/fetch'
-import getPort from 'get-port'
+import { AddressInfo } from 'net'
 
 function md5File(path: string) {
   return new Promise((resolve, reject) => {
@@ -68,8 +68,8 @@ describe('file uploads', () => {
     const server = createServer(yoga)
 
     try {
-      const port = await getPort()
-      await new Promise<void>((resolve) => server.listen(port, resolve))
+      await new Promise<void>((resolve) => server.listen(0, resolve))
+      const port = (server.address() as AddressInfo).port
 
       const formData = new FormData()
       formData.set(

packages/graphql-yoga/__integration-tests__/incremental-delivery.spec.ts

@@ -16,9 +16,8 @@ import {
   File,
   FormData,
 } from '@whatwg-node/fetch'
-import getPort from 'get-port'
-import EventSource from 'eventsource'
 import { createGraphQLError } from '@graphql-tools/utils'
+import { AddressInfo } from 'net'
 
 describe('incremental delivery', () => {
   it('incremental delivery source is closed properly', async () => {
@@ -63,23 +62,27 @@ describe('incremental delivery', () => {
     const server = createServer(yoga)
 
     try {
-      await new Promise<void>((resolve) => server.listen(9876, resolve))
+      await new Promise<void>((resolve) => server.listen(0, resolve))
+      const port = (server.address() as AddressInfo).port
       const abortCtrl = new AbortController()
-      const res = await yoga.fetchAPI.fetch('http://localhost:9876/graphql', {
-        method: 'POST',
-        headers: {
-          'content-type': 'application/json',
-          accept: 'multipart/mixed',
+      const res = await yoga.fetchAPI.fetch(
+        `http://localhost:${port}/graphql`,
+        {
+          method: 'POST',
+          headers: {
+            'content-type': 'application/json',
+            accept: 'multipart/mixed',
+          },
+          body: JSON.stringify({
+            query: /* GraphQL */ `
+              query {
+                a
+              }
+            `,
+          }),
+          signal: abortCtrl.signal,
         },
-        body: JSON.stringify({
-          query: /* GraphQL */ `
-            query {
-              a
-            }
-          `,
-        }),
-        signal: abortCtrl.signal,
-      })
+      )
 
       // Start and Close a HTTP Request
       for await (const chunk of res.body!) {
@@ -236,9 +239,9 @@ describe('incremental delivery: node-fetch', () => {
   let url: string
   beforeEach(async () => {
     server = createServer(yoga)
-    const port = await getPort()
+    await new Promise<void>((resolve) => server.listen(0, resolve))
+    const port = (server.address() as AddressInfo).port
     url = `http://localhost:${port}/graphql`
-    await new Promise<void>((resolve) => server.listen(port, resolve))
   })
   afterEach(async () => {
     await new Promise((resolve) => server.close(resolve))
@@ -366,29 +369,36 @@ describe('incremental delivery: node-fetch', () => {
     expect(body.errors[0].message).toBe('File size limit exceeded: 12 bytes')
   })
 
-  it('should get subscription', (done) => {
+  it('should get subscription', async () => {
     expect.assertions(3)
-    const eventSource = new EventSource(`${url}?query=subscription{counter}`)
     let counter = 0
-    eventSource.onmessage = (event) => {
-      const result = JSON.parse(event.data)
-      if (counter === 0) {
-        expect(result.data.counter).toBe(0)
-        counter++
-        push?.(counter)
-      } else if (counter === 1) {
-        expect(result.data.counter).toBe(1)
-        counter++
-        push?.(counter)
-      } else if (counter === 2) {
-        expect(result.data.counter).toBe(2)
-        counter++
-        stop?.()
-        done()
-      }
-    }
-    new Promise((resolve) => setTimeout(resolve, 100)).then(() => {
+    setTimeout(() => {
       push?.(counter)
+    }, 500)
+    const response = await fetch(`${url}?query=subscription{counter}`, {
+      headers: {
+        Accept: 'text/event-stream',
+      },
     })
+    for await (const chunk of response.body!) {
+      const chunkString = Buffer.from(chunk).toString('utf-8')
+      if (chunkString.includes('data:')) {
+        const result = JSON.parse(chunkString.replace('data:', ''))
+        if (counter === 0) {
+          expect(result.data.counter).toBe(0)
+          counter++
+          push?.(counter)
+        } else if (counter === 1) {
+          expect(result.data.counter).toBe(1)
+          counter++
+          push?.(counter)
+        } else if (counter === 2) {
+          expect(result.data.counter).toBe(2)
+          counter++
+          stop?.()
+          return
+        }
+      }
+    }
   })
 })