Document HTTP Executor & Fix ending multipart requests (#2137)

* test: http executor defer/stream

update docs

* Pass

* chore(dependencies): updated changesets for modified dependencies

* Snapshots

---------

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

.changeset/@graphql-yoga_urql-exchange-2137-dependencies.md

@@ -0,0 +1,5 @@
+---
+'@graphql-yoga/urql-exchange': patch
+---
+dependencies updates:
+  - Updated dependency [`@graphql-tools/executor-http@0.1.3` ↗︎](https://www.npmjs.com/package/@graphql-tools/executor-http/v/0.1.3) (from `0.1.2`, in `dependencies`)

.changeset/strange-beers-promise.md

@@ -0,0 +1,5 @@
+---
+'graphql-yoga': patch
+---
+
+Close multipart responses correctly

examples/defer-stream/__integration-tests__/__snapshots__/defer-stream.spec.ts.snap

@@ -11,7 +11,6 @@ Content-Type: application/json; charset=utf-8
 Content-Length: 78
 
 {"incremental":[{"data":{"slowField":"I am slow"},"path":[]}],"hasNext":false}
----
 -----
 "
 `;
@@ -157,7 +156,6 @@ Content-Type: application/json; charset=utf-8
 Content-Length: 17
 
 {"hasNext":false}
----
 -----
 "
 `;

packages/client/urql-exchange/package.json

@@ -49,7 +49,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@graphql-tools/executor-http": "0.1.2",
+    "@graphql-tools/executor-http": "0.1.3",
     "@graphql-tools/executor-urql-exchange": "0.0.6",
     "tslib": "^2.4.0"
   },

packages/graphql-yoga/src/plugins/resultProcessor/multipart.ts

@@ -65,7 +65,7 @@ export function processMultipartResult(
         controller.enqueue(textEncoder.encode('---'))
       }
       if (done) {
-        controller.enqueue(textEncoder.encode('\r\n-----\r\n'))
+        controller.enqueue(textEncoder.encode('--\r\n'))
         controller.close()
       }
     },

packages/plugins/defer-stream/__tests__/defer-stream.spec.ts

@@ -3,10 +3,12 @@ import {
   GraphQLObjectType,
   GraphQLSchema,
   GraphQLString,
+  parse,
 } from 'graphql'
 import { useDeferStream } from '@graphql-yoga/plugin-defer-stream'
 import { createSchema, createYoga, Repeater } from 'graphql-yoga'
 
+import { buildHTTPExecutor } from '@graphql-tools/executor-http'
 import { createPushPullAsyncIterable } from './push-pull-async-iterable.js'
 
 function multipartStream<TType = unknown>(source: ReadableStream<Uint8Array>) {
@@ -127,7 +129,6 @@ describe('Defer/Stream', () => {
       Content-Length: 74
 
       {"incremental":[{"data":{"goodbye":"goodbye"},"path":[]}],"hasNext":false}
-      ---
       -----
       "
     `)
@@ -170,7 +171,6 @@ describe('Defer/Stream', () => {
       Content-Length: 17
 
       {"hasNext":false}
-      ---
       -----
       "
     `)
@@ -459,4 +459,90 @@ describe('Defer/Stream', () => {
       )
     })
   })
+
+  describe('@graphql-tools/buildHTTPExecutor', () => {
+    it('execute stream operation', async () => {
+      const yoga = createYoga({ schema, plugins: [useDeferStream()] })
+      const executor = buildHTTPExecutor({
+        fetch: yoga.fetch,
+      })
+
+      const result = await executor({
+        document: parse(/* GraphQL */ `
+          query {
+            stream @stream(initialCount: 2)
+          }
+        `),
+      })
+
+      if (Symbol.asyncIterator in result) {
+        let counter = 0
+        for await (const item of result) {
+          if (counter === 0) {
+            expect(item).toEqual({
+              data: { stream: ['A', 'B'] },
+            })
+            counter++
+          } else if (counter >= 1) {
+            expect(item).toEqual({
+              data: { stream: ['A', 'B', 'C'] },
+            })
+            counter++
+          } else {
+            throw new Error('LOL, this should not happen.')
+          }
+        }
+      } else {
+        throw new Error('Expected AsyncIterator')
+      }
+    })
+    it('execute defer operation', async () => {
+      const yoga = createYoga({ schema, plugins: [useDeferStream()] })
+      const executor = buildHTTPExecutor({
+        endpoint: 'http://yoga/graphql',
+        fetch: yoga.fetch,
+      })
+
+      const result = await executor({
+        document: parse(/* GraphQL */ `
+          query {
+            hello
+            ... on Query @defer {
+              goodbye
+            }
+          }
+        `),
+      })
+
+      if (Symbol.asyncIterator in result) {
+        let counter = 0
+        for await (const item of result) {
+          if (counter === 0) {
+            expect(item).toMatchInlineSnapshot(`
+              {
+                "data": {
+                  "hello": "hello",
+                },
+              }
+            `)
+            counter++
+          } else if (counter === 1) {
+            expect(item).toMatchInlineSnapshot(`
+              {
+                "data": {
+                  "goodbye": "goodbye",
+                  "hello": "hello",
+                },
+              }
+            `)
+            counter++
+          } else {
+            throw new Error('LOL, this should not happen.')
+          }
+        }
+      } else {
+        throw new Error('Expected AsyncIterator')
+      }
+    })
+  })
 })

packages/plugins/defer-stream/package.json

@@ -44,6 +44,7 @@
     "graphql-yoga": "^3.5.0"
   },
   "devDependencies": {
+    "@graphql-tools/executor-http": "0.1.3",
     "@whatwg-node/fetch": "0.6.5"
   },
   "type": "module",