Subscription lifecycle in GraphQL - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a subscription in GraphQL?

A subscription in GraphQL is a way to get real-time updates from the server. It keeps a connection open and sends data to the client whenever an event happens.

beginner

What happens when a client starts a subscription?

When a client starts a subscription, it opens a persistent connection to the server, usually over WebSocket, to listen for specific events or data changes.

intermediate

How does the server send data during a subscription?

The server sends data to the client whenever the subscribed event occurs. This data is sent as a stream of messages over the open connection.

intermediate

What is the role of WebSocket in GraphQL subscriptions?

WebSocket provides a full-duplex communication channel that stays open, allowing the server to push updates to the client instantly during a subscription.

beginner

How does a client stop a subscription?

A client stops a subscription by closing the connection or sending an unsubscribe message, which tells the server to stop sending updates.

What does a GraphQL subscription do?

A Provides real-time updates from the server

B Fetches data once like a query

C Deletes data on the server

D Updates data on the client only

Subscriptions keep a connection open to receive real-time data updates from the server.

Which protocol is commonly used to keep a subscription connection open?

A SMTP

B FTP

C HTTP GET

D WebSocket

WebSocket allows full-duplex communication needed for real-time subscriptions.

When does the server send data in a subscription?

A Whenever the subscribed event happens

B Only when the client requests it

C At fixed time intervals

D Only once at the start

The server pushes data to the client whenever the event the client subscribed to occurs.

How does a client end a subscription?

A By sending a query

B By refreshing the page

C By closing the connection or unsubscribing

D By sending a mutation

Closing the connection or sending an unsubscribe message stops the subscription.

What is the main benefit of using subscriptions?

A Faster database writes

B Real-time data updates without polling

C Simpler queries

D Better security

Subscriptions provide real-time updates without the need for repeated polling.

Explain the lifecycle of a GraphQL subscription from start to finish.

Think about how the connection starts, how data flows, and how it ends.

Describe why WebSocket is important for GraphQL subscriptions.

Consider how data moves between client and server continuously.

Practice

1. What is the main purpose of a subscription in GraphQL?

easy

A. To fetch data only once from the server

B. To update data on the server

C. To delete data from the database

D. To receive real-time updates when data changes

Solution

1. Step 1: Understand the role of subscriptions

   Subscriptions are designed to keep the client updated automatically when data changes on the server.

2. Step 2: Compare with other GraphQL operations

   Queries fetch data once, mutations change data, but subscriptions push live updates.

3. Final Answer:

   To receive real-time updates when data changes -> Option D

4. Quick Check:

   Subscriptions = real-time updates [OK]

Hint: Subscriptions push live data updates automatically [OK]

Common Mistakes:

• Confusing subscriptions with queries
• Thinking subscriptions modify data
• Believing subscriptions fetch data only once

2. Which of the following is the correct syntax to start a GraphQL subscription named newMessage that listens for content and sender fields?

easy

A. subscription { newMessage { content sender } }

B. query { newMessage { content sender } }

C. mutation { newMessage { content sender } }

D. subscribe { newMessage { content sender } }

Solution

1. Step 1: Identify the correct keyword for subscriptions

   The keyword to start a subscription is subscription, not query, mutation, or subscribe.

2. Step 2: Check the structure of the subscription

   The subscription should specify the event name and requested fields inside curly braces.

3. Final Answer:

   subscription { newMessage { content sender } } -> Option A

4. Quick Check:

   Subscription syntax = subscription keyword + event + fields [OK]

Hint: Use 'subscription' keyword, not 'query' or 'mutation' [OK]

Common Mistakes:

• Using 'query' or 'mutation' instead of 'subscription'
• Using 'subscribe' keyword which is invalid
• Missing curly braces around fields

3. Given this subscription:

subscription { newNotification { id message } }

What will the client receive when a new notification with id: 5 and message: "Hello" is sent?

medium

A. { "data": { "newNotification": { "id": 5, "message": "Hello" } } }

B. { "data": { "newNotification": { "id": "5", "message": "Hello" } } }

C. { "error": "Subscription not found" }

D. { "data": { "newNotification": { "message": "Hello" } } }

Solution

1. Step 1: Understand subscription response format

   Subscriptions return data wrapped in a data object with the event name as key and requested fields as nested data.

2. Step 2: Match the expected data types and fields

   The id is a number 5, and message is "Hello". Both fields are included as requested.

3. Final Answer:

   { "data": { "newNotification": { "id": 5, "message": "Hello" } } } -> Option A

4. Quick Check:

   Subscription data = event with requested fields [OK]

Hint: Subscription returns data object with event and fields [OK]

Common Mistakes:

• Returning id as string instead of number
• Missing fields in response
• Expecting error when subscription is valid

4. You wrote this subscription:

subscription { newMessage { content sender } }

But your client never receives updates. Which is the most likely cause?

medium

A. The client is using a query instead of a subscription

B. The subscription syntax is invalid

C. The server does not publish events for newMessage

D. The fields content and sender do not exist

Solution

1. Step 1: Check subscription syntax

   The syntax is correct, so syntax errors are unlikely.

2. Step 2: Consider server event publishing

   If the server never sends events for newMessage, the client won't get updates.

3. Step 3: Verify client usage

   The client uses subscription syntax, so it's not using a query.

4. Step 4: Confirm fields existence

   Assuming fields exist, the main issue is missing server events.

5. Final Answer:

   The server does not publish events for newMessage -> Option C

6. Quick Check:

   No server events = no subscription updates [OK]

Hint: Check if server sends events for the subscription [OK]

Common Mistakes:

• Assuming syntax error without checking server
• Confusing query with subscription on client
• Ignoring server-side event publishing

5. You want to create a subscription that only sends updates when a new chat message is sent by user "Alice". Which subscription definition correctly filters messages by sender?

hard

A. subscription { newMessage { content sender } where sender = "Alice" }

B. subscription { newMessage(sender: "Alice") { content sender } }

C. subscription { newMessage { content sender } filter: sender == "Alice" }

D. subscription { newMessage { content sender } if sender = "Alice" }

Solution

1. Step 1: Understand argument usage in subscriptions

   GraphQL subscriptions accept arguments like queries to filter events, e.g., newMessage(sender: "Alice").

2. Step 2: Identify invalid syntax options

   Options B, C, and D use invalid keywords or syntax (where, filter, if) which are not part of GraphQL subscription syntax.

3. Final Answer:

   subscription { newMessage(sender: "Alice") { content sender } } -> Option B

4. Quick Check:

   Use arguments in subscription for filtering [OK]

Hint: Filter subscriptions using arguments inside parentheses [OK]

Common Mistakes:

• Using SQL-like WHERE or IF clauses in subscription
• Trying to filter inside selection set
• Not passing filter as argument