feat: include subscription id in onSubscriptionEnd hook (#963)

* feat: include subscription id in onSubscriptionEnd hook * chore: check that the subscription id matches
mercurius-js · Feb 17, 2023 · 0e8dc55 · 0e8dc55
1 parent 6e0b15d
commit 0e8dc55
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 9 deletions.
diff --git a/docs/hooks.md b/docs/hooks.md
@@ -181,7 +181,7 @@ fastify.graphql.addHook('onSubscriptionResolution', async (execution, context) =
 This hook will be triggered when a subscription ends.
 
 ```js
-fastify.graphql.addHook('onSubscriptionEnd', async (context) => {
+fastify.graphql.addHook('onSubscriptionEnd', async (context, id) => {
   await asyncMethod()
 })
 ```

diff --git a/examples/hooks-subscription.js b/examples/hooks-subscription.js
@@ -70,7 +70,7 @@ async function start () {
     console.log('onSubscriptionResolution called')
   })
 
-  app.graphql.addHook('onSubscriptionEnd', async function (context) {
+  app.graphql.addHook('onSubscriptionEnd', async function (context, id) {
     console.log('onSubscriptionEnd called')
   })
 

diff --git a/index.d.ts b/index.d.ts
@@ -167,6 +167,7 @@ export interface onSubscriptionResolutionHookHandler<TData extends Record<string
 export interface onSubscriptionEndHookHandler<TContext = MercuriusContext> {
   (
     context: TContext,
+    id: string | number,
   ): Promise<void> | void;
 }
 

diff --git a/lib/hooks.js b/lib/hooks.js
@@ -113,7 +113,7 @@ function onResolutionHookRunner (fn, request) {
 }
 
 function onEndHookRunner (fn, request) {
-  return fn(request.context)
+  return fn(request.context, request.id)
 }
 
 module.exports = {

diff --git a/lib/subscription-connection.js b/lib/subscription-connection.js
@@ -278,6 +278,7 @@ module.exports = class SubscriptionConnection {
         get __currentQuery () {
           return print(document)
         },
+        id,
         pubsub: sc,
         lruGatewayResolvers: this.lruGatewayResolvers,
         reply: {
@@ -343,7 +344,7 @@ module.exports = class SubscriptionConnection {
   async handleGQLStop (data) {
     if (this.context.onSubscriptionEnd) {
       try {
-        await onSubscriptionEndHandler({ context: this.context })
+        await onSubscriptionEndHandler({ context: this.context, id: data.id })
       } catch (error) {
         this.fastify.log.error(error)
         return this.handleConnectionClose()

diff --git a/test/subscription-hooks.js b/test/subscription-hooks.js
@@ -319,11 +319,12 @@ test('subscription - should handle onSubscriptionResolution hook errors', async
 // onSubscriptionEnd
 // -----------------
 test('subscription - should call onSubscriptionEnd when subscription ends', async t => {
-  t.plan(4)
+  t.plan(5)
   const app = await createTestServer(t)
 
-  app.graphql.addHook('onSubscriptionEnd', async (context) => {
+  app.graphql.addHook('onSubscriptionEnd', async (context, id) => {
     t.type(context, 'object')
+    t.equal(id, 1)
     t.ok('onSubscriptionEnd called')
   })
 
@@ -364,7 +365,7 @@ test('subscription - should handle onSubscriptionEnd hook errors', async t => {
   t.plan(2)
   const app = await createTestServer(t)
 
-  app.graphql.addHook('onSubscriptionEnd', async (context) => {
+  app.graphql.addHook('onSubscriptionEnd', async (context, id) => {
     throw new Error('kaboom')
   })
 

diff --git a/test/types/index.ts b/test/types/index.ts
@@ -540,12 +540,14 @@ app.graphql.addHook('onSubscriptionResolution', function (execution, context) {
   expectAssignable<MercuriusContext>(context)
 })
 
-app.graphql.addHook('onSubscriptionEnd', async function (context) {
+app.graphql.addHook('onSubscriptionEnd', async function (context, id) {
   expectAssignable<MercuriusContext>(context)
+  expectAssignable<string | number>(id)
 })
 
-app.graphql.addHook('onSubscriptionEnd', function (context) {
+app.graphql.addHook('onSubscriptionEnd', function (context, id) {
   expectAssignable<MercuriusContext>(context)
+  expectAssignable<string | number>(id)
 })
 
 expectError(() => {