WebSocket transport in GraphQL - Mini Project: Build & Apply

GraphQL WebSocket Transport Setup

📖 Scenario: You are building a real-time chat application that uses GraphQL subscriptions to receive live updates. To enable this, you need to set up WebSocket transport for your GraphQL server.

🎯 Goal: Set up the WebSocket transport configuration for a GraphQL server to handle subscription operations.

📋 What You'll Learn

Create a WebSocket transport configuration object named wsTransport with the URL "wss://chat.example.com/graphql".

Add a reconnect property set to true to enable automatic reconnection.

Define a connectionParams function that returns an object with an authToken property set to "abc123".

Export the wsTransport object as the default export.

💡 Why This Matters

🌍 Real World

Real-time applications like chat apps, live sports updates, or stock tickers use GraphQL subscriptions over WebSocket transport to receive live data.

💼 Career

Understanding WebSocket transport setup is essential for frontend and backend developers working with real-time GraphQL APIs.

1

Create WebSocket transport object

Create a constant called wsTransport and assign it an object with a url property set to "wss://chat.example.com/graphql".

GraphQL

# Your code here

Hint

Use const wsTransport = { url: "wss://chat.example.com/graphql" };

2

Add reconnect property

Add a reconnect property set to true inside the wsTransport object.

GraphQL

const wsTransport = {
  url: "wss://chat.example.com/graphql",
  // Add reconnect property here
};

Hint

Add reconnect: true inside the object.

3

Add connectionParams function

Add a connectionParams property to wsTransport that is a function returning an object with authToken set to "abc123".

GraphQL

const wsTransport = {
  url: "wss://chat.example.com/graphql",
  reconnect: true,
  // Add connectionParams function here
};

Hint

Use an arrow function that returns { authToken: "abc123" }.

4

Export the WebSocket transport

Export the wsTransport object as the default export using export default wsTransport;.

GraphQL

const wsTransport = {
  url: "wss://chat.example.com/graphql",
  reconnect: true,
  connectionParams: () => ({ authToken: "abc123" })
};
// Export wsTransport as default

Hint

Use export default wsTransport; at the end of the file.

Practice

1. What is the main benefit of using WebSocket transport with GraphQL subscriptions?

easy

A. It converts GraphQL queries into SQL automatically.

B. It stores data permanently in the database.

C. It keeps a live connection for real-time data updates.

D. It compresses data to reduce storage size.

Solution

1. Step 1: Understand WebSocket transport purpose

   WebSocket transport maintains a continuous connection between client and server.

2. Step 2: Connect with GraphQL subscriptions

   This live connection allows instant data updates, which is the main benefit for subscriptions.

3. Final Answer:

   It keeps a live connection for real-time data updates. -> Option C

4. Quick Check:

   WebSocket = live real-time updates [OK]

Hint: WebSocket means live connection for instant updates [OK]

Common Mistakes:

• Confusing WebSocket with data storage
• Thinking it converts queries automatically
• Assuming it compresses data

2. Which of the following is the correct way to initiate a WebSocket connection for GraphQL subscriptions?

easy

A. const ws = new WebSocket('ws://example.com/graphql');

B. const ws = new WebSocket('http://example.com/graphql');

C. const ws = new WebSocket('ftp://example.com/graphql');

D. const ws = new WebSocket('file://example.com/graphql');

Solution

1. Step 1: Identify the correct WebSocket URL scheme

   WebSocket URLs start with 'ws://' or 'wss://' for secure connections.

2. Step 2: Check the options

   Only const ws = new WebSocket('ws://example.com/graphql'); uses 'ws://' which is the correct scheme for WebSocket connections.

3. Final Answer:

   const ws = new WebSocket('ws://example.com/graphql'); -> Option A

4. Quick Check:

   WebSocket URL starts with ws:// [OK]

Hint: WebSocket URLs start with ws:// or wss:// [OK]

Common Mistakes:

• Using http:// instead of ws://
• Using ftp:// or file:// which are invalid for WebSocket
• Confusing secure ws with http

3. Given this GraphQL subscription client code snippet, what will be the output when a new message arrives?

const subscription = client.subscribe({ query: MESSAGE_SUBSCRIPTION });
subscription.subscribe({
  next(data) { console.log(data); },
  error(err) { console.error(err); }
});

medium

A. Does nothing because subscription is not started.

B. Throws a syntax error because subscribe is not a function.

C. Logs an error immediately.

D. Logs the new message data to the console.

Solution

1. Step 1: Understand the subscription method

   The client.subscribe returns an observable that listens for new data.

2. Step 2: Analyze the subscribe callback

   The next callback logs incoming data, so when a new message arrives, it prints it.

3. Final Answer:

   Logs the new message data to the console. -> Option D

4. Quick Check:

   Subscription next callback logs data [OK]

Hint: Subscription next callback logs incoming data [OK]

Common Mistakes:

• Thinking subscribe is not a function
• Assuming subscription needs manual start
• Expecting immediate error without cause

4. Identify the error in this WebSocket transport setup for GraphQL subscriptions:

const ws = new WebSocket('http://example.com/graphql');
const subscription = client.subscribe({ query: SUBSCRIPTION_QUERY });
subscription.subscribe({
  next(data) { console.log(data); },
  error(err) { console.error(err); }
});

medium

A. The error callback is missing a return statement.

B. WebSocket URL uses 'http://' instead of 'ws://'.

C. The subscribe method is called twice incorrectly.

D. Subscription query is missing variables.

Solution

1. Step 1: Check the WebSocket URL scheme

   The URL uses 'http://' which is incorrect for WebSocket connections; it should be 'ws://'.

2. Step 2: Verify other parts

   Subscription query and callbacks are correctly used; no missing variables or double subscribe calls.

3. Final Answer:

   WebSocket URL uses 'http://' instead of 'ws://'. -> Option B

4. Quick Check:

   WebSocket URL must start with ws:// [OK]

Hint: Check WebSocket URL scheme for ws:// [OK]

Common Mistakes:

• Ignoring URL scheme errors
• Assuming variables are always required
• Confusing subscribe method usage

5. You want to build a live chat app using GraphQL subscriptions over WebSocket. Which approach best ensures efficient real-time updates and minimal server load?

hard

A. Use WebSocket transport with filtered subscriptions to send only relevant messages to each client.

B. Use HTTP polling every second to fetch new messages.

C. Send all chat messages to every client regardless of chat room.

D. Use WebSocket but reconnect on every new message.

Solution

1. Step 1: Understand real-time update needs

   Live chat requires instant updates with minimal delay and server load.

2. Step 2: Evaluate options for efficiency

   Using WebSocket with filtered subscriptions sends only needed messages, reducing unnecessary data and load.

3. Step 3: Compare alternatives

   Polling wastes resources; sending all messages to all clients is inefficient; reconnecting often adds overhead.

4. Final Answer:

   Use WebSocket transport with filtered subscriptions to send only relevant messages to each client. -> Option A

5. Quick Check:

   Filtered WebSocket subscriptions = efficient real-time updates [OK]

Hint: Filter subscriptions to send only needed data [OK]

Common Mistakes:

• Using polling instead of WebSocket
• Broadcasting all messages to all clients
• Reconnecting WebSocket too frequently