Action Cable for real-time updates in Ruby on Rails - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is Action Cable in Rails?

Action Cable is a Rails framework that integrates WebSockets to provide real-time features like live chat or notifications in web applications.

beginner

How does Action Cable maintain a live connection between client and server?

It uses WebSockets to keep an open, two-way connection allowing the server to send data to the client instantly without the client asking repeatedly.

beginner

What is a Channel in Action Cable?

A Channel is like a chat room or topic where clients subscribe to receive real-time updates related to that topic.

intermediate

How do you broadcast a message to all subscribers of a channel in Action Cable?

You use the `broadcast` method on the channel's stream, for example: `ActionCable.server.broadcast 'channel_name', message`.

beginner

Why is Action Cable useful for features like live notifications or chat?

Because it allows the server to push updates instantly to users without page reloads, making the app feel fast and interactive.

What technology does Action Cable use to enable real-time communication?

A AJAX polling

B WebSockets

C REST API

D Server-Sent Events

Action Cable uses WebSockets to keep an open connection for real-time data exchange.

In Action Cable, what is the purpose of a Channel?

A To serve static files

B To store database records

C To manage user authentication

D To handle user subscriptions and broadcast messages

Channels manage subscriptions and broadcast messages to connected clients.

Which method is used to send data from the server to clients subscribed to a channel?

A broadcast

B emit_event

C push_message

D send_data

The `broadcast` method sends data to all subscribers of a channel.

What happens if a client disconnects from an Action Cable channel?

A The client stops receiving messages until it reconnects

B The server keeps sending messages to the client

C The server crashes

D The client automatically reconnects without any delay

When disconnected, the client stops receiving messages until it reconnects.

Which Rails component integrates Action Cable into the application?

A Active Record

B Action Controller

C Action Cable server

D Active Job

Action Cable server handles WebSocket connections and real-time communication.

Explain how Action Cable enables real-time updates in a Rails app.

Think about how the server talks to the browser without waiting for requests.

Describe the role of a Channel in Action Cable and how clients interact with it.

Imagine a chat room where people join to get messages.

Practice

1. What is the main purpose of Action Cable in a Rails application?

easy

A. To add real-time features allowing live updates without page reloads

B. To manage database migrations automatically

C. To handle background jobs and scheduling

D. To style the application with CSS frameworks

Solution

1. Step 1: Understand Action Cable's role

   Action Cable integrates WebSockets into Rails to enable live, real-time communication.

2. Step 2: Compare options with Action Cable's purpose

   Only To add real-time features allowing live updates without page reloads describes real-time updates without page reloads, which is what Action Cable does.

3. Final Answer:

   To add real-time features allowing live updates without page reloads -> Option A

4. Quick Check:

   Real-time updates = To add real-time features allowing live updates without page reloads [OK]

Hint: Remember: Action Cable = live updates without refreshing [OK]

Common Mistakes:

• Confusing Action Cable with background job tools
• Thinking it manages database tasks
• Assuming it styles the app

2. Which of the following is the correct way to create a channel subscription in a Rails JavaScript client using Action Cable?

easy

A. App.cable.subscriptions.create('ChatChannel')

B. App.cable.subscribe('ChatChannel')

C. App.cable.connect('ChatChannel')

D. App.cable.open('ChatChannel')

Solution

1. Step 1: Recall Action Cable subscription syntax

   The correct method to subscribe to a channel is using subscriptions.create.

2. Step 2: Match options with correct method

   Only App.cable.subscriptions.create('ChatChannel') uses subscriptions.create('ChatChannel'), which is the correct syntax.

3. Final Answer:

   App.cable.subscriptions.create('ChatChannel') -> Option A

4. Quick Check:

   Subscription method = subscriptions.create [OK]

Hint: Use subscriptions.create to subscribe to channels [OK]

Common Mistakes:

• Using subscribe instead of subscriptions.create
• Using connect or open which are invalid methods
• Missing quotes around channel name

3. Given this channel code in Rails:

class ChatChannel < ApplicationCable::Channel
  def subscribed
    stream_from 'chat_room'
  end
end

And this JavaScript subscription:

App.cable.subscriptions.create('ChatChannel', {
  received(data) {
    console.log(data.message)
  }
})

What will happen when the server broadcasts { message: 'Hello!' } to 'chat_room'?

medium

A. Nothing will happen because the channel name is incorrect

B. The message 'Hello!' will be logged in the browser console

C. The message will be displayed as an alert popup

D. The server will throw an error due to missing perform method

Solution

1. Step 1: Understand the channel subscription and streaming

   The channel streams from 'chat_room', and the client subscribes to 'ChatChannel' with a received callback logging data.message.

2. Step 2: Analyze the broadcast effect

   When the server broadcasts { message: 'Hello!' } to 'chat_room', the client receives it and logs 'Hello!' to the console.

3. Final Answer:

   The message 'Hello!' will be logged in the browser console -> Option B

4. Quick Check:

   Broadcast to stream triggers received callback = The message 'Hello!' will be logged in the browser console [OK]

Hint: Broadcast to stream triggers received callback logging message [OK]

Common Mistakes:

• Confusing channel name with stream name
• Expecting alert instead of console log
• Thinking server errors without perform method

4. Identify the error in this Action Cable channel code:

class NotificationsChannel < ApplicationCable::Channel
  def subscribed
    stream_from notifications
  end
end

medium

A. The channel class should inherit from ApplicationController

B. The subscribed method is missing a call to reject unauthorized users

C. The stream_from argument should be a string, not a variable

D. The stream_from method is deprecated and should not be used

Solution

1. Step 1: Check the stream_from argument type

   The argument to stream_from must be a string representing the stream name, e.g., 'notifications'.

2. Step 2: Identify the error in the code

   The code uses notifications without quotes, treating it as a variable, which causes an error.

3. Final Answer:

   The stream_from argument should be a string, not a variable -> Option C

4. Quick Check:

   stream_from needs string argument [OK]

Hint: Always quote stream names in stream_from method [OK]

Common Mistakes:

• Forgetting quotes around stream name
• Inheriting from wrong class
• Assuming stream_from is deprecated

5. You want to broadcast a message to all users subscribed to 'notifications' channel whenever a new comment is created. Which code snippet correctly achieves this in Rails?

hard

A. ActionCable.broadcast('notifications', @comment.body)

B. NotificationsChannel.broadcast_to('notifications', { comment: @comment.body })

C. broadcast_to('notifications', { comment: @comment.body })

D. ActionCable.server.broadcast('notifications', { comment: @comment.body })

Solution

1. Step 1: Identify the correct broadcast method

   To send a message to all subscribers of a stream, use ActionCable.server.broadcast(stream, data).

2. Step 2: Analyze options for correct usage

   ActionCable.server.broadcast('notifications', { comment: @comment.body }) uses ActionCable.server.broadcast with stream name and data hash, which is correct.

3. Final Answer:

   ActionCable.server.broadcast('notifications', { comment: @comment.body }) -> Option D

4. Quick Check:

   Broadcast to stream uses ActionCable.server.broadcast [OK]

Hint: Use ActionCable.server.broadcast to send to all subscribers [OK]

Common Mistakes:

• Using broadcast_to without a model instance
• Calling broadcast on ActionCable directly
• Passing data without wrapping in a hash