MichalLytek / MichalLytek/type-graphql

Subscriptions with Apollo-Server v3+

Open
#1,005 18 comments 4 reactions 0 assignees View on GitHub
Community :family_man_girl: Documentation :book:
Dominant language
TypeScript
Stars
8.1k
Forks
672
PR merge metrics
No merged PRs in 30d

Description

With Apollo-Server version 3 forward (NPM shows it released about 2 months ago), the base `apollo-server` package no longer includes a "batteries-included" subscription server. You have to switch to an integrated package like `apollo-server-express` and implement your own using the `http` and [`subscriptions-transport-ws`](https://www.npmjs.com/package/subscriptions-transport-ws) packages.

The [current documentation](https://www.apollographql.com/docs/apollo-server/data/subscriptions/#enabling-subscriptions) explaining how to set up a subscription server with express shows different configuration than previous versions for the base `new ApolloServer()`, throwing some obvious errors.

Is there a current timeline for resolving this? I'm not sure how to go about fixing this myself with a PR, I was just wondering if this was already part of an upcoming release, or if it hasn't been noticed yet.

Contributor guide

Open the contributing guide

Research direction

Start with the Apollo Server subscription documentation linked in the issue and review the existing comment thread to establish the expected Apollo Server v3+ setup. Check how type-graphql integrates with Apollo Server and subscriptions-transport-ws; done means documenting or supporting a working current subscription configuration without the reported errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, typescript
Domain
api, backend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.