Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Always teardown subscriptions on completion #846

Merged
merged 2 commits into from
Aug 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
26 changes: 16 additions & 10 deletions lib/subscription-connection.js
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,7 @@ module.exports = class SubscriptionConnection {
}

this.sendMessage(this.protocolMessageTypes.GQL_COMPLETE, id, null)
this.handleGQLComplete(id)
}

async _executeQueryOrMutation ({ query, context, variables, operationName, id }) {
Expand All @@ -284,6 +285,19 @@ module.exports = class SubscriptionConnection {
this.sendMessage(this.protocolMessageTypes.GQL_COMPLETE, id, null)
}

handleGQLComplete (id) {
const sc = this.subscriptionContexts.get(id)
if (sc) {
sc.close && sc.close()
this.subscriptionContexts.delete(id)
}
const subIter = this.subscriptionIters.get(id)
if (subIter) {
subIter.return && subIter.return()
this.subscriptionIters.delete(id)
}
}

async handleGQLStop (data) {
if (this.context.onSubscriptionEnd) {
try {
Expand All @@ -293,16 +307,8 @@ module.exports = class SubscriptionConnection {
return this.handleConnectionClose()
}
}
const sc = this.subscriptionContexts.get(data.id)
if (sc) {
sc.close && sc.close()
this.subscriptionContexts.delete(data.id)
}
const subIter = this.subscriptionIters.get(data.id)
if (subIter) {
subIter.return && subIter.return()
this.subscriptionIters.delete(data.id)
}

this.handleGQLComplete(data.id)
}

handleConnectionClose () {
Expand Down
58 changes: 58 additions & 0 deletions test/subscription-connection.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ const sinon = require('sinon')
const WebSocket = require('ws')
const fastify = require('fastify')
const mq = require('mqemitter')
const { makeExecutableSchema } = require('@graphql-tools/schema')
const SubscriptionConnection = require('../lib/subscription-connection')
const { PubSub } = require('../lib/subscriber')
const { GRAPHQL_WS, GRAPHQL_TRANSPORT_WS } = require('../lib/subscription-protocol')
Expand Down Expand Up @@ -643,3 +644,60 @@ test('subscription connection handles mutation when fullWsTransport: true', asyn
).calledOnce
)
})

test('subscription data is released right after it ends', async (t) => {
const sc = new SubscriptionConnection({
on () {},
close () {},
send () {},
protocol: GRAPHQL_TRANSPORT_WS
}, {
context: { preSubscriptionParsing: null, preSubscriptionExecution: null },
fastify: {
graphql: {
schema: makeExecutableSchema({
typeDefs: ['type Query { blah: String! }', 'type Subscription { onMessage: String! }'],
resolvers: {
Query: {},
Subscription: {
onMessage: {
async * subscribe () {
return 'blah'
}
}
}
}
})
}
}
})

sc.isReady = true

t.equal(sc.subscriptionIters.size, 0)
t.equal(sc.subscriptionContexts.size, 0)

await sc.handleMessage(JSON.stringify({
id: 1,
type: 'subscribe',
payload: {
query: 'subscription { onMessage } '
}
}))

await new Promise(resolve => {
sc.sendMessage = (type, id, payload) => {
t.equal(id, 1)
t.equal(type, 'complete')
t.equal(payload, null)

t.equal(sc.subscriptionIters.size, 1)
t.equal(sc.subscriptionContexts.size, 1)

resolve()
}
})

t.equal(sc.subscriptionIters.size, 0)
t.equal(sc.subscriptionContexts.size, 0)
})