Subscription filtering in GraphQL - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is subscription filtering in GraphQL?

Subscription filtering means sending only specific updates to clients based on conditions they care about. It helps avoid sending unnecessary data.

beginner

Why use subscription filtering?

It saves bandwidth and improves performance by sending only relevant data to each client instead of all updates.

intermediate

How do you apply filters in a GraphQL subscription?

You add arguments to the subscription field that specify conditions. The server checks these conditions and sends updates only if they match.

intermediate

Example: Filtering a chat message subscription by room ID

subscription OnMessage($roomId: ID!) { messageAdded(roomId: $roomId) { id content } } This sends messages only from the specified room.

beginner

What happens if no filter is applied in a subscription?

The client receives all updates for that subscription, which can cause unnecessary data transfer and slower performance.

What is the main benefit of subscription filtering?

A All data is sent to every client

B Only relevant updates are sent to clients

C Subscriptions run faster on the client

D It removes the need for queries

Subscription filtering ensures clients get only the updates they want, saving bandwidth and improving efficiency.

How do you specify filters in a GraphQL subscription?

A By adding arguments to the subscription field

B By changing the query type

C By using fragments

D By modifying the schema directly

Filters are passed as arguments to the subscription field to control which updates are sent.

If you subscribe to all messages without filtering, what happens?

A You get all messages, even unwanted ones

B You get no messages

C You get only the latest message

D The subscription fails

Without filters, the client receives every update, which may include irrelevant data.

Which of these is a valid reason to use subscription filtering?

A To disable subscriptions

B To increase server load

C To reduce network traffic

D To send duplicate data

Filtering reduces the amount of data sent, lowering network traffic.

What does the server do when a subscription filter condition is not met?

A It closes the subscription

B It sends the update anyway

C It sends an error

D It does not send the update to that client

The server only sends updates that match the filter conditions for each client.

Explain how subscription filtering works in GraphQL and why it is useful.

Think about how you might want only certain messages in a chat app.

Describe a simple example of subscription filtering with a chat room ID.

Imagine subscribing to messages from one chat room, not all rooms.

Practice

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

easy

A. To batch multiple queries into one request

B. To store data permanently in the database

C. To receive only relevant real-time updates based on specified conditions

D. To convert queries into mutations automatically

Solution

1. Step 1: Understand subscription filtering concept

   Subscription filtering allows clients to specify conditions so they only get updates they care about.

2. Step 2: Compare options with concept

   Only To receive only relevant real-time updates based on specified conditions describes receiving relevant real-time updates, which matches subscription filtering.

3. Final Answer:

   To receive only relevant real-time updates based on specified conditions -> Option C

4. Quick Check:

   Subscription filtering = relevant updates [OK]

Hint: Filtering means getting only updates you want [OK]

Common Mistakes:

• Confusing filtering with data storage
• Thinking filtering batches queries
• Assuming filtering changes query types

2. Which of the following is the correct syntax to add a filter argument to a GraphQL subscription named newMessages that filters by userId?

easy

A. subscription { newMessages(userId: "123") { id content } }

B. subscription { newMessages(filter: { userId: "123" }) { id content } }

C. subscription { newMessages(where: userId = "123") { id content } }

D. subscription { newMessages(user_id: "123") { id content } }

Solution

1. Step 1: Identify correct filter argument syntax

   GraphQL subscriptions commonly use a filter argument with an object specifying conditions.

2. Step 2: Match options to syntax

   subscription { newMessages(filter: { userId: "123" }) { id content } } uses filter: { userId: "123" }, which is the correct way to pass filter conditions.

3. Final Answer:

   subscription { newMessages(filter: { userId: "123" }) { id content } } -> Option B

4. Quick Check:

   Filter argument uses object syntax = subscription { newMessages(filter: { userId: "123" }) { id content } } [OK]

Hint: Use filter: { field: value } for subscription filters [OK]

Common Mistakes:

• Using direct argument instead of filter object
• Incorrect filter keyword like where
• Wrong field name casing or underscores

3. Given this subscription query:

subscription { newOrders(filter: { status: "SHIPPED" }) { id status } }

Which orders will the client receive updates for?

medium

A. All orders regardless of status

B. No orders, because filter syntax is invalid

C. Only orders with status "PENDING"

D. Only orders with status "SHIPPED"

Solution

1. Step 1: Analyze the filter condition

   The filter specifies status: "SHIPPED", so only orders with this status qualify.

2. Step 2: Determine which updates are sent

   The subscription sends updates only for orders matching the filter, so only "SHIPPED" orders.

3. Final Answer:

   Only orders with status "SHIPPED" -> Option D

4. Quick Check:

   Filter status = "SHIPPED" means only shipped orders [OK]

Hint: Filter limits updates to matching status only [OK]

Common Mistakes:

• Ignoring filter and expecting all updates
• Confusing status values
• Assuming filter syntax is wrong without checking

4. Consider this subscription query:

subscription { newComments(filter: { postId: 42 }) { id content } }

It returns no updates even when new comments are added to post 42. What is the likely issue?

medium

A. The filter argument is missing the correct type or schema support

B. Subscription queries cannot have filters

C. The filter field name should be post_id instead of postId

D. The subscription name newComments is invalid

Solution

1. Step 1: Check filter usage in subscription

   Filters require the schema to support filtering on the specified field and type.

2. Step 2: Identify why no updates appear

   If the schema does not support filtering by postId, the filter silently blocks updates.

3. Final Answer:

   The filter argument is missing the correct type or schema support -> Option A

4. Quick Check:

   Schema must support filter fields for updates [OK]

Hint: Check schema supports filter fields used [OK]

Common Mistakes:

• Assuming field name casing is always wrong
• Believing filters are not allowed in subscriptions
• Thinking subscription name causes no updates

5. You want to subscribe to real-time updates of tasks but only for tasks assigned to user ID 7 and with priority "HIGH". Which subscription filter is correct?

hard

A. subscription { tasks(filter: { assignedUserId: 7, priority: "HIGH" }) { id title } }

B. subscription { tasks(filter: { assignedUserId: "7", priority: HIGH }) { id title } }

C. subscription { tasks(filter: { assignedUser: 7, priority: "HIGH" }) { id title } }

D. subscription { tasks(filter: { userId: 7, priority: "HIGH" }) { id title } }

Solution

1. Step 1: Match filter fields to requirements

   The filter must use assignedUserId for user ID 7 and priority as "HIGH" string.

2. Step 2: Check option correctness

   subscription { tasks(filter: { assignedUserId: 7, priority: "HIGH" }) { id title } } correctly uses numeric 7 and string "HIGH" with proper field names.

3. Final Answer:

   subscription { tasks(filter: { assignedUserId: 7, priority: "HIGH" }) { id title } } -> Option A

4. Quick Check:

   Correct fields and types in filter = subscription { tasks(filter: { assignedUserId: 7, priority: "HIGH" }) { id title } } [OK]

Hint: Use exact field names and correct value types in filter [OK]

Common Mistakes:

• Using wrong field names like userId instead of assignedUserId
• Mixing string and number types incorrectly
• Omitting quotes around string values