2018-07-23 22:29:31 -04:00
**DO NOT READ THIS FILE ON GITHUB, GUIDES ARE PUBLISHED ON https://guides.rubyonrails.org.**
2017-12-15 00:02:25 -05:00
2015-12-18 15:04:38 -05:00
Action Cable Overview
=====================
2017-11-22 11:33:28 -05:00
In this guide, you will learn how Action Cable works and how to use WebSockets to
2015-12-18 15:04:38 -05:00
incorporate real-time features into your Rails application.
After reading this guide, you will know:
2017-11-22 11:33:28 -05:00
* What Action Cable is and its integration backend and frontend
2019-08-09 17:30:15 -04:00
* How to set up Action Cable
* How to set up channels
2016-07-05 08:09:40 -04:00
* Deployment and Architecture setup for running Action Cable
--------------------------------------------------------------------------------
2016-02-23 22:36:37 -05:00
2019-12-17 03:48:45 -05:00
What is Action Cable?
---------------------
2015-12-18 15:04:38 -05:00
2016-05-14 17:55:07 -04:00
Action Cable seamlessly integrates
[WebSockets ](https://en.wikipedia.org/wiki/WebSocket ) with the rest of your
Rails application. It allows for real-time features to be written in Ruby in the
same style and form as the rest of your Rails application, while still being
performant and scalable. It's a full-stack offering that provides both a
client-side JavaScript framework and a server-side Ruby framework. You have
access to your full domain model written with Active Record or your ORM of
choice.
2015-12-18 15:04:38 -05:00
2019-01-13 14:31:43 -05:00
Terminology
-----------
2020-07-15 04:07:25 -04:00
Action Cable uses WebSockets instead of the HTTP request-response protocol.
Both Action Cable and WebSockets introduce some less familiar terminology:
### Connections
*Connections* form the foundation of the client-server relationship.
2019-01-13 14:31:43 -05:00
A single Action Cable server can handle multiple connection instances. It has one
connection instance per WebSocket connection. A single user may have multiple
WebSockets open to your application if they use multiple browser tabs or devices.
2020-07-15 04:07:25 -04:00
### Consumers
The client of a WebSocket connection is called the *consumer* . In Action Cable
the consumer is created by the client-side JavaScript framework.
### Channels
Each consumer can in turn subscribe to multiple *channels* . Each channel
2019-01-13 14:31:43 -05:00
encapsulates a logical unit of work, similar to what a controller does in
a regular MVC setup. For example, you could have a `ChatChannel` and
an `AppearancesChannel` , and a consumer could be subscribed to either
or to both of these channels. At the very least, a consumer should be subscribed
to one channel.
2020-07-15 04:07:25 -04:00
### Subscribers
When the consumer is subscribed to a channel, they act as a *subscriber* .
2019-01-13 14:31:43 -05:00
The connection between the subscriber and the channel is, surprise-surprise,
called a subscription. A consumer can act as a subscriber to a given channel
any number of times. For example, a consumer could subscribe to multiple chat rooms
at the same time. (And remember that a physical user may have multiple consumers,
one per tab/device open to your connection).
2020-07-15 04:07:25 -04:00
### Pub/Sub
2015-12-18 15:04:38 -05:00
2016-05-14 17:55:07 -04:00
[Pub/Sub ](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern ), or
Publish-Subscribe, refers to a message queue paradigm whereby senders of
information (publishers), send data to an abstract class of recipients
(subscribers), without specifying individual recipients. Action Cable uses this
approach to communicate between the server and many clients.
2015-12-18 15:04:38 -05:00
2020-07-15 04:07:25 -04:00
### Broadcastings
A broadcasting is a pub/sub link where anything transmitted by the broadcaster is
sent directly to the channel subscribers who are streaming that named broadcasting.
Each channel can be streaming zero or more broadcastings.
2015-12-18 15:04:38 -05:00
## Server-Side Components
### Connections
2016-02-28 09:37:58 -05:00
2020-07-15 04:07:25 -04:00
For every WebSocket accepted by the server, a connection object is instantiated. This
2016-05-14 17:55:07 -04:00
object becomes the parent of all the *channel subscriptions* that are created
from there on. The connection itself does not deal with any specific application
logic beyond authentication and authorization. The client of a WebSocket
connection is called the connection *consumer* . An individual user will create
one consumer-connection pair per browser tab, window, or device they have open.
2015-12-18 15:04:38 -05:00
2020-12-02 16:59:00 -05:00
Connections are instances of `ApplicationCable::Connection` , which extends
[`ActionCable::Connection::Base`][]. In `ApplicationCable::Connection` , you
2016-05-14 17:55:07 -04:00
authorize the incoming connection, and proceed to establish it if the user can
be identified.
2015-12-18 15:04:38 -05:00
#### Connection Setup
2016-02-28 09:37:58 -05:00
2015-12-18 15:04:38 -05:00
```ruby
# app/channels/application_cable/connection.rb
module ApplicationCable
class Connection < ActionCable::Connection::Base
identified_by :current_user
def connect
self.current_user = find_verified_user
end
2016-12-23 06:17:32 -05:00
private
2015-12-18 15:04:38 -05:00
def find_verified_user
2017-08-07 23:32:03 -04:00
if verified_user = User.find_by(id: cookies.encrypted[:user_id])
2017-03-25 07:57:40 -04:00
verified_user
2015-12-18 15:04:38 -05:00
else
reject_unauthorized_connection
end
end
end
end
```
2016-02-28 09:37:58 -05:00
2020-12-02 16:59:00 -05:00
Here [`identified_by`][] designates a connection identifier that can be used to find the
2016-04-05 11:25:58 -04:00
specific connection later. Note that anything marked as an identifier will automatically
2016-02-28 09:37:58 -05:00
create a delegate by the same name on any channel instances created off the connection.
2015-12-18 15:04:38 -05:00
2016-02-28 09:37:58 -05:00
This example relies on the fact that you will already have handled authentication of the user
2019-06-05 07:09:34 -04:00
somewhere else in your application, and that a successful authentication sets an encrypted
2016-05-14 17:55:07 -04:00
cookie with the user ID.
2016-02-28 09:37:58 -05:00
The cookie is then automatically sent to the connection instance when a new connection
2015-12-18 15:04:38 -05:00
is attempted, and you use that to set the `current_user` . By identifying the connection
2016-05-14 17:55:07 -04:00
by this same current user, you're also ensuring that you can later retrieve all open
2015-12-18 15:04:38 -05:00
connections by a given user (and potentially disconnect them all if the user is deleted
2016-05-28 16:40:10 -04:00
or unauthorized).
2015-12-18 15:04:38 -05:00
2019-06-24 12:12:44 -04:00
If your authentication approach includes using a session, you use cookie store for the
session, your session cookie is named `_session` and the user ID key is `user_id` you
can use this approach:
2019-12-22 15:47:29 -05:00
2019-06-05 07:09:34 -04:00
```ruby
2019-12-22 15:47:29 -05:00
verified_user = User.find_by(id: cookies.encrypted['_session']['user_id'])
2019-06-05 07:09:34 -04:00
```
2020-12-02 16:59:00 -05:00
[`ActionCable::Connection::Base`]: https://api.rubyonrails.org/classes/ActionCable/Connection/Base.html
[`identified_by`]: https://api.rubyonrails.org/classes/ActionCable/Connection/Identification/ClassMethods.html#method-i-identified_by
2020-03-20 13:35:10 -04:00
#### Exception Handling
By default, unhandled exceptions are caught and logged to Rails' logger. If you would like to
globally intercept these exceptions and report them to an external bug tracking service, for
2020-12-02 16:59:00 -05:00
example, you can do so with [`rescue_from`][]:
2020-03-20 13:35:10 -04:00
```ruby
# app/channels/application_cable/connection.rb
module ApplicationCable
class Connection < ActionCable::Connection::Base
rescue_from StandardError, with: :report_error
private
def report_error(e)
SomeExternalBugtrackingService.notify(e)
end
end
end
```
2020-12-02 16:59:00 -05:00
[`rescue_from`]: https://api.rubyonrails.org/classes/ActiveSupport/Rescuable/ClassMethods.html#method-i-rescue_from
2015-12-18 15:04:38 -05:00
### Channels
2016-02-28 09:37:58 -05:00
2016-05-14 17:55:07 -04:00
A *channel* encapsulates a logical unit of work, similar to what a controller does in a
2016-04-05 11:25:58 -04:00
regular MVC setup. By default, Rails creates a parent `ApplicationCable::Channel` class
2020-12-02 16:59:00 -05:00
(which extends [`ActionCable::Channel::Base`][]) for encapsulating shared logic between your channels.
2015-12-18 15:04:38 -05:00
#### Parent Channel Setup
2016-02-28 09:37:58 -05:00
2015-12-18 15:04:38 -05:00
```ruby
# app/channels/application_cable/channel.rb
module ApplicationCable
class Channel < ActionCable::Channel::Base
end
end
```
2016-02-28 09:37:58 -05:00
Then you would create your own channel classes. For example, you could have a
2016-05-14 17:55:07 -04:00
`ChatChannel` and an `AppearanceChannel` :
2015-12-18 15:04:38 -05:00
```ruby
2016-04-10 08:35:37 -04:00
# app/channels/chat_channel.rb
2015-12-18 15:04:38 -05:00
class ChatChannel < ApplicationCable::Channel
end
2020-12-23 17:29:10 -05:00
```
2015-12-18 15:04:38 -05:00
2020-12-23 17:29:10 -05:00
```ruby
2016-04-10 08:35:37 -04:00
# app/channels/appearance_channel.rb
2015-12-18 15:04:38 -05:00
class AppearanceChannel < ApplicationCable::Channel
end
```
2020-12-02 16:59:00 -05:00
[`ActionCable::Channel::Base`]: https://api.rubyonrails.org/classes/ActionCable/Channel/Base.html
2016-02-28 09:37:58 -05:00
A consumer could then be subscribed to either or both of these channels.
2015-12-18 15:04:38 -05:00
#### Subscriptions
2016-05-14 17:55:07 -04:00
Consumers subscribe to channels, acting as *subscribers* . Their connection is
called a *subscription* . Produced messages are then routed to these channel
2020-07-14 15:17:57 -04:00
subscriptions based on an identifier sent by the channel consumer.
2015-12-18 15:04:38 -05:00
```ruby
2016-04-10 08:35:37 -04:00
# app/channels/chat_channel.rb
2015-12-18 15:04:38 -05:00
class ChatChannel < ApplicationCable::Channel
2016-05-14 17:55:07 -04:00
# Called when the consumer has successfully
2017-11-22 11:33:28 -05:00
# become a subscriber to this channel.
2015-12-18 15:04:38 -05:00
def subscribed
end
end
```
2020-03-20 13:35:10 -04:00
#### Exception Handling
2020-12-02 16:59:00 -05:00
As with `ApplicationCable::Connection` , you can also use [`rescue_from`][] on a
2020-03-20 19:59:23 -04:00
specific channel to handle raised exceptions:
2020-03-20 13:35:10 -04:00
```ruby
# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
rescue_from 'MyError', with: :deliver_error_message
private
def deliver_error_message(e)
broadcast_to(...)
end
end
```
2015-12-18 15:04:38 -05:00
## Client-Side Components
2016-02-28 09:37:58 -05:00
2015-12-18 15:04:38 -05:00
### Connections
2016-02-28 09:37:58 -05:00
2015-12-18 15:04:38 -05:00
Consumers require an instance of the connection on their side. This can be
2016-05-14 17:55:07 -04:00
established using the following JavaScript, which is generated by default by Rails:
2015-12-18 15:04:38 -05:00
#### Connect Consumer
2016-02-28 09:37:58 -05:00
2016-05-06 23:12:27 -04:00
```js
2018-12-14 14:57:37 -05:00
// app/javascript/channels/consumer.js
// Action Cable provides the framework to deal with WebSockets in Rails.
2019-01-22 03:53:47 -05:00
// You can generate new channels where WebSocket features live using the `bin/rails generate channel` command.
2016-05-06 23:12:27 -04:00
2019-01-16 14:09:10 -05:00
import { createConsumer } from "@rails/actioncable"
2015-12-18 15:04:38 -05:00
2019-01-16 14:09:10 -05:00
export default createConsumer()
2015-12-18 15:04:38 -05:00
```
2016-02-28 09:37:58 -05:00
2016-05-14 17:55:07 -04:00
This will ready a consumer that'll connect against `/cable` on your server by default.
2016-02-28 09:37:58 -05:00
The connection won't be established until you've also specified at least one subscription
you're interested in having.
2015-12-18 15:04:38 -05:00
2019-04-01 02:27:08 -04:00
The consumer can optionally take an argument that specifies the URL to connect to. This
2019-03-31 13:41:12 -04:00
can be a string, or a function that returns a string that will be called when the
WebSocket is opened.
```js
2019-04-01 02:27:08 -04:00
// Specify a different URL to connect to
2019-03-31 13:41:12 -04:00
createConsumer('https://ws.example.com/cable')
2019-04-01 02:27:08 -04:00
// Use a function to dynamically generate the URL
2019-03-31 13:41:12 -04:00
createConsumer(getWebSocketURL)
function getWebSocketURL {
const token = localStorage.get('auth-token')
return `https://ws.example.com/cable?token=${token}`
}
```
2015-12-18 15:04:38 -05:00
#### Subscriber
2016-02-28 09:37:58 -05:00
2016-05-14 17:55:07 -04:00
A consumer becomes a subscriber by creating a subscription to a given channel:
2016-02-28 09:37:58 -05:00
2018-12-14 14:57:37 -05:00
```js
2019-01-13 15:54:53 -05:00
// app/javascript/channels/chat_channel.js
2018-12-14 14:57:37 -05:00
import consumer from "./consumer"
consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" })
2019-01-13 15:54:53 -05:00
// app/javascript/channels/appearance_channel.js
2018-12-14 14:57:37 -05:00
import consumer from "./consumer"
2015-12-18 15:04:38 -05:00
2018-12-14 14:57:37 -05:00
consumer.subscriptions.create({ channel: "AppearanceChannel" })
2015-12-18 15:04:38 -05:00
```
While this creates the subscription, the functionality needed to respond to
received data will be described later on.
2016-05-14 17:55:07 -04:00
A consumer can act as a subscriber to a given channel any number of times. For
example, a consumer could subscribe to multiple chat rooms at the same time:
2018-12-14 14:57:37 -05:00
```js
2019-01-13 15:54:53 -05:00
// app/javascript/channels/chat_channel.js
2018-12-14 14:57:37 -05:00
import consumer from "./consumer"
consumer.subscriptions.create({ channel: "ChatChannel", room: "1st Room" })
consumer.subscriptions.create({ channel: "ChatChannel", room: "2nd Room" })
2016-05-14 17:55:07 -04:00
```
2015-12-18 15:04:38 -05:00
## Client-Server Interactions
### Streams
2016-02-28 09:37:58 -05:00
2016-05-14 17:55:07 -04:00
*Streams* provide the mechanism by which channels route published content
2020-12-02 16:59:00 -05:00
(broadcasts) to their subscribers. For example, the following code uses
[`stream_from`][] to subscribe to the broadcasting named `chat_Best Room` when
the value of the `:room` parameter is `"Best Room"` :
2015-12-18 15:04:38 -05:00
```ruby
2016-04-10 08:35:37 -04:00
# app/channels/chat_channel.rb
2015-12-18 15:04:38 -05:00
class ChatChannel < ApplicationCable::Channel
def subscribed
stream_from "chat_#{params[:room]}"
end
end
```
2020-12-02 16:59:00 -05:00
Then, elsewhere in your Rails application, you can broadcast to such a room by
calling [`broadcast`][]:
```ruby
ActionCable.server.broadcast("chat_Best Room", body: "This Room is Best Room.")
```
If you have a stream that is related to a model, then the broadcasting name
can be generated from the channel and model. For example, the following code
uses [`stream_for`][] to subscribe to a broadcasting like
`comments:Z2lkOi8vVGVzdEFwcC9Qb3N0LzE` , where `Z2lkOi8vVGVzdEFwcC9Qb3N0LzE` is
the GlobalID of the Post model.
2016-02-23 22:05:46 -05:00
```ruby
class CommentsChannel < ApplicationCable::Channel
def subscribed
post = Post.find(params[:id])
stream_for post
end
end
```
2016-02-28 09:37:58 -05:00
2020-12-02 16:59:00 -05:00
You can then broadcast to this channel by calling [`broadcast_to`][]:
2016-05-14 17:55:07 -04:00
```ruby
CommentsChannel.broadcast_to(@post, @comment )
```
2016-02-23 22:05:46 -05:00
2020-12-02 16:59:00 -05:00
[`broadcast`]: https://api.rubyonrails.org/classes/ActionCable/Server/Broadcasting.html#method-i-broadcast
[`broadcast_to`]: https://api.rubyonrails.org/classes/ActionCable/Channel/Broadcasting/ClassMethods.html#method-i-broadcast_to
[`stream_for`]: https://api.rubyonrails.org/classes/ActionCable/Channel/Streams.html#method-i-stream_for
[`stream_from`]: https://api.rubyonrails.org/classes/ActionCable/Channel/Streams.html#method-i-stream_from
### Broadcastings
2015-12-18 15:04:38 -05:00
2016-05-14 17:55:07 -04:00
A *broadcasting* is a pub/sub link where anything transmitted by a publisher
2015-12-18 15:04:38 -05:00
is routed directly to the channel subscribers who are streaming that named
2016-02-28 09:12:39 -05:00
broadcasting. Each channel can be streaming zero or more broadcastings.
2016-05-14 17:55:07 -04:00
2017-11-22 11:33:28 -05:00
Broadcastings are purely an online queue and time-dependent. If a consumer is
2016-05-14 17:55:07 -04:00
not streaming (subscribed to a given channel), they'll not get the broadcast
should they connect later.
2015-12-18 15:04:38 -05:00
### Subscriptions
2016-05-14 17:55:07 -04:00
When a consumer is subscribed to a channel, they act as a subscriber. This
connection is called a subscription. Incoming messages are then routed to
these channel subscriptions based on an identifier sent by the cable consumer.
2015-12-18 15:04:38 -05:00
2018-12-14 14:57:37 -05:00
```js
2019-01-13 15:54:53 -05:00
// app/javascript/channels/chat_channel.js
2018-12-14 14:57:37 -05:00
// Assumes you've already requested the right to send web notifications
import consumer from "./consumer"
consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" }, {
received(data) {
this.appendLine(data)
},
appendLine(data) {
const html = this.createLine(data)
const element = document.querySelector("[data-chat-room='Best Room']")
element.insertAdjacentHTML("beforeend", html)
},
createLine(data) {
return `
< article class = "chat-line" >
< span class = "speaker" > ${data["sent_by"]}< / span >
< span class = "body" > ${data["body"]}< / span >
< / article >
`
}
})
2015-12-18 15:04:38 -05:00
```
2016-05-14 17:55:07 -04:00
### Passing Parameters to Channels
2015-12-18 15:04:38 -05:00
2016-05-14 17:55:07 -04:00
You can pass parameters from the client side to the server side when creating a
subscription. For example:
2015-12-18 15:04:38 -05:00
```ruby
# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
def subscribed
stream_from "chat_#{params[:room]}"
end
end
```
2016-05-14 17:55:07 -04:00
An object passed as the first argument to `subscriptions.create` becomes the
params hash in the cable channel. The keyword `channel` is required:
2015-12-18 15:04:38 -05:00
2018-12-14 14:57:37 -05:00
```js
2019-01-13 15:54:53 -05:00
// app/javascript/channels/chat_channel.js
2018-12-14 14:57:37 -05:00
import consumer from "./consumer"
consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" }, {
received(data) {
this.appendLine(data)
},
appendLine(data) {
const html = this.createLine(data)
const element = document.querySelector("[data-chat-room='Best Room']")
element.insertAdjacentHTML("beforeend", html)
},
createLine(data) {
return `
< article class = "chat-line" >
< span class = "speaker" > ${data["sent_by"]}< / span >
< span class = "body" > ${data["body"]}< / span >
< / article >
`
}
})
2015-12-18 15:04:38 -05:00
```
```ruby
2016-05-14 17:55:07 -04:00
# Somewhere in your app this is called, perhaps
# from a NewCommentJob.
2016-08-11 12:29:20 -04:00
ActionCable.server.broadcast(
2016-05-14 17:55:07 -04:00
"chat_#{room}",
sent_by: 'Paul',
body: 'This is a cool chat app.'
)
2015-12-18 15:04:38 -05:00
```
2016-05-14 17:55:07 -04:00
### Rebroadcasting a Message
2015-12-18 15:04:38 -05:00
2016-05-14 17:55:07 -04:00
A common use case is to *rebroadcast* a message sent by one client to any
2015-12-18 15:04:38 -05:00
other connected clients.
```ruby
# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
def subscribed
stream_from "chat_#{params[:room]}"
end
def receive(data)
2016-07-11 11:21:39 -04:00
ActionCable.server.broadcast("chat_#{params[:room]}", data)
2015-12-18 15:04:38 -05:00
end
end
```
2018-12-14 14:57:37 -05:00
```js
2019-01-13 15:54:53 -05:00
// app/javascript/channels/chat_channel.js
2018-12-14 14:57:37 -05:00
import consumer from "./consumer"
const chatChannel = consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" }, {
received(data) {
// data => { sent_by: "Paul", body: "This is a cool chat app." }
}
}
2015-12-18 15:04:38 -05:00
2018-12-14 14:57:37 -05:00
chatChannel.send({ sent_by: "Paul", body: "This is a cool chat app." })
2015-12-18 15:04:38 -05:00
```
The rebroadcast will be received by all connected clients, _including_ the
client that sent the message. Note that params are the same as they were when
you subscribed to the channel.
2016-05-14 17:55:07 -04:00
## Full-Stack Examples
2015-12-18 15:04:38 -05:00
The following setup steps are common to both examples:
2016-05-14 17:55:07 -04:00
1. [Setup your connection ](#connection-setup ).
2. [Setup your parent channel ](#parent-channel-setup ).
3. [Connect your consumer ](#connect-consumer ).
### Example 1: User Appearances
2015-12-18 15:04:38 -05:00
Here's a simple example of a channel that tracks whether a user is online or not
and what page they're on. (This is useful for creating presence features like showing
a green dot next to a user name if they're online).
2016-05-14 17:55:07 -04:00
Create the server-side appearance channel:
2015-12-18 15:04:38 -05:00
```ruby
# app/channels/appearance_channel.rb
class AppearanceChannel < ApplicationCable::Channel
def subscribed
current_user.appear
end
def unsubscribed
current_user.disappear
end
def appear(data)
2016-05-14 17:55:07 -04:00
current_user.appear(on: data['appearing_on'])
2015-12-18 15:04:38 -05:00
end
def away
current_user.away
end
end
```
2016-05-14 17:55:07 -04:00
When a subscription is initiated the `subscribed` callback gets fired and we
take that opportunity to say "the current user has indeed appeared". That
appear/disappear API could be backed by Redis, a database, or whatever else.
2015-12-18 15:04:38 -05:00
2016-05-14 17:55:07 -04:00
Create the client-side appearance channel subscription:
2015-12-18 15:04:38 -05:00
2018-12-14 14:57:37 -05:00
```js
2019-01-13 15:54:53 -05:00
// app/javascript/channels/appearance_channel.js
2018-12-14 14:57:37 -05:00
import consumer from "./consumer"
consumer.subscriptions.create("AppearanceChannel", {
// Called once when the subscription is created.
initialized() {
this.update = this.update.bind(this)
},
// Called when the subscription is ready for use on the server.
connected() {
this.install()
this.update()
},
// Called when the WebSocket connection is closed.
disconnected() {
this.uninstall()
},
// Called when the subscription is rejected by the server.
rejected() {
this.uninstall()
},
update() {
this.documentIsActive ? this.appear() : this.away()
},
appear() {
// Calls `AppearanceChannel#appear(data)` on the server.
this.perform("appear", { appearing_on: this.appearingOn })
},
away() {
// Calls `AppearanceChannel#away` on the server.
this.perform("away")
},
install() {
window.addEventListener("focus", this.update)
window.addEventListener("blur", this.update)
document.addEventListener("turbolinks:load", this.update)
document.addEventListener("visibilitychange", this.update)
},
uninstall() {
window.removeEventListener("focus", this.update)
window.removeEventListener("blur", this.update)
document.removeEventListener("turbolinks:load", this.update)
document.removeEventListener("visibilitychange", this.update)
},
get documentIsActive() {
return document.visibilityState == "visible" & & document.hasFocus()
},
get appearingOn() {
const element = document.querySelector("[data-appearing-on]")
return element ? element.getAttribute("data-appearing-on") : null
}
})
2015-12-18 15:04:38 -05:00
```
##### Client-Server Interaction
2016-05-14 17:55:07 -04:00
1. **Client** connects to the **Server** via `App.cable =
ActionCable.createConsumer("ws://cable.example.com")`. (`cable.js`). The
**Server** identifies this connection by `current_user` .
2. **Client** subscribes to the appearance channel via
2018-12-14 14:57:37 -05:00
`consumer.subscriptions.create({ channel: "AppearanceChannel" })` . (`appearance_channel.js`)
2016-05-14 17:55:07 -04:00
3. **Server** recognizes a new subscription has been initiated for the
appearance channel and runs its `subscribed` callback, calling the `appear`
method on `current_user` . (`appearance_channel.rb`)
4. **Client** recognizes that a subscription has been established and calls
2018-12-14 14:57:37 -05:00
`connected` (`appearance_channel.js`) which in turn calls `install` and `appear` .
`appear` calls `AppearanceChannel#appear(data)` on the server, and supplies a
data hash of `{ appearing_on: this.appearingOn }` . This is
2016-05-14 17:55:07 -04:00
possible because the server-side channel instance automatically exposes all
public methods declared on the class (minus the callbacks), so that these can be
reached as remote procedure calls via a subscription's `perform` method.
5. **Server** receives the request for the `appear` action on the appearance
channel for the connection identified by `current_user`
(`appearance_channel.rb`). **Server** retrieves the data with the
`:appearing_on` key from the data hash and sets it as the value for the `:on`
key being passed to `current_user.appear` .
### Example 2: Receiving New Web Notifications
2015-12-18 15:04:38 -05:00
The appearance example was all about exposing server functionality to
client-side invocation over the WebSocket connection. But the great thing
about WebSockets is that it's a two-way street. So now let's show an example
2016-02-28 09:12:39 -05:00
where the server invokes an action on the client.
2015-12-18 15:04:38 -05:00
This is a web notification channel that allows you to trigger client-side
web notifications when you broadcast to the right streams:
2016-05-14 17:55:07 -04:00
Create the server-side web notifications channel:
2016-02-28 09:12:39 -05:00
2015-12-18 15:04:38 -05:00
```ruby
# app/channels/web_notifications_channel.rb
class WebNotificationsChannel < ApplicationCable::Channel
def subscribed
2016-02-28 09:37:58 -05:00
stream_for current_user
2015-12-18 15:04:38 -05:00
end
end
```
2016-05-14 17:55:07 -04:00
Create the client-side web notifications channel subscription:
2018-12-14 14:57:37 -05:00
```js
2019-01-13 15:54:53 -05:00
// app/javascript/channels/web_notifications_channel.js
2018-12-14 14:57:37 -05:00
// Client-side which assumes you've already requested
// the right to send web notifications.
import consumer from "./consumer"
consumer.subscriptions.create("WebNotificationsChannel", {
received(data) {
new Notification(data["title"], body: data["body"])
}
})
2015-12-18 15:04:38 -05:00
```
2016-05-14 17:55:07 -04:00
Broadcast content to a web notification channel instance from elsewhere in your
application:
2015-12-18 15:04:38 -05:00
```ruby
# Somewhere in your app this is called, perhaps from a NewCommentJob
2016-05-14 17:55:07 -04:00
WebNotificationsChannel.broadcast_to(
current_user,
title: 'New things!',
body: 'All the news fit to print'
)
2015-12-18 15:04:38 -05:00
```
2016-02-23 21:21:05 -05:00
The `WebNotificationsChannel.broadcast_to` call places a message in the current
2016-05-14 17:55:07 -04:00
subscription adapter's pubsub queue under a separate broadcasting name for each
user. For a user with an ID of 1, the broadcasting name would be
2016-08-12 00:19:34 -04:00
`web_notifications:1` .
2016-02-28 09:37:58 -05:00
2015-12-18 15:04:38 -05:00
The channel has been instructed to stream everything that arrives at
2016-08-12 00:19:34 -04:00
`web_notifications:1` directly to the client by invoking the `received`
2016-05-14 17:55:07 -04:00
callback. The data passed as argument is the hash sent as the second parameter
2017-11-22 11:33:28 -05:00
to the server-side broadcast call, JSON encoded for the trip across the wire
and unpacked for the data argument arriving as `received` .
2015-12-18 15:04:38 -05:00
2016-05-14 17:55:07 -04:00
### More Complete Examples
2015-12-18 15:04:38 -05:00
2016-05-06 11:07:27 -04:00
See the [rails/actioncable-examples ](https://github.com/rails/actioncable-examples )
2019-08-09 17:30:15 -04:00
repository for a full example of how to set up Action Cable in a Rails app and adding channels.
2015-12-18 15:04:38 -05:00
## Configuration
2016-02-28 09:37:58 -05:00
Action Cable has two required configurations: a subscription adapter and allowed request origins.
2015-12-18 15:04:38 -05:00
### Subscription Adapter
2016-05-14 17:55:07 -04:00
By default, Action Cable looks for a configuration file in `config/cable.yml` .
2017-01-17 23:37:28 -05:00
The file must specify an adapter for each Rails environment. See the
2016-05-14 17:55:07 -04:00
[Dependencies ](#dependencies ) section for additional information on adapters.
2015-12-18 15:04:38 -05:00
```yaml
2016-05-14 17:55:07 -04:00
development:
2016-02-28 09:37:58 -05:00
adapter: async
2015-12-18 15:04:38 -05:00
2016-05-14 17:55:07 -04:00
test:
adapter: async
2015-12-18 15:04:38 -05:00
2016-05-14 17:55:07 -04:00
production:
adapter: redis
url: redis://10.10.3.153:6381
2017-01-17 23:37:28 -05:00
channel_prefix: appname_production
2015-12-18 15:04:38 -05:00
```
2017-01-17 23:37:28 -05:00
#### Adapter Configuration
2017-01-18 15:21:07 -05:00
Below is a list of the subscription adapters available for end users.
2017-01-17 23:37:28 -05:00
##### Async Adapter
The async adapter is intended for development/testing and should not be used in production.
##### Redis Adapter
2017-10-23 14:18:57 -04:00
The Redis adapter requires users to provide a URL pointing to the Redis server.
2017-10-06 02:02:56 -04:00
Additionally, a `channel_prefix` may be provided to avoid channel name collisions
2017-01-18 15:21:07 -05:00
when using the same Redis server for multiple applications. See the [Redis PubSub documentation ](https://redis.io/topics/pubsub#database-amp-scoping ) for more details.
2017-01-17 23:37:28 -05:00
2017-01-18 15:21:07 -05:00
##### PostgreSQL Adapter
2017-01-17 23:37:28 -05:00
2017-01-18 15:21:07 -05:00
The PostgreSQL adapter uses Active Record's connection pool, and thus the
application's `config/database.yml` database configuration, for its connection.
This may change in the future. [#27214 ](https://github.com/rails/rails/issues/27214 )
2015-12-18 15:04:38 -05:00
### Allowed Request Origins
Action Cable will only accept requests from specified origins, which are
passed to the server config as an array. The origins can be instances of
2017-11-22 11:33:28 -05:00
strings or regular expressions, against which a check for the match will be performed.
2015-12-18 15:04:38 -05:00
```ruby
2019-03-05 22:00:45 -05:00
config.action_cable.allowed_request_origins = ['https://rubyonrails.com', %r{http://ruby.*}]
2015-12-18 15:04:38 -05:00
```
To disable and allow requests from any origin:
```ruby
2016-05-14 17:55:07 -04:00
config.action_cable.disable_request_forgery_protection = true
2015-12-18 15:04:38 -05:00
```
By default, Action Cable allows all requests from localhost:3000 when running
in the development environment.
### Consumer Configuration
2020-12-02 16:59:00 -05:00
To configure the URL, add a call to [`action_cable_meta_tag`][] in your HTML layout
2016-05-14 17:55:07 -04:00
HEAD. This uses a URL or path typically set via `config.action_cable.url` in the
environment configuration files.
2015-12-18 15:04:38 -05:00
2020-12-02 16:59:00 -05:00
[`action_cable_meta_tag`]: https://api.rubyonrails.org/classes/ActionCable/Helpers/ActionCableHelper.html#method-i-action_cable_meta_tag
2019-01-23 17:58:27 -05:00
### Worker Pool Configuration
The worker pool is used to run connection callbacks and channel actions in
isolation from the server's main thread. Action Cable allows the application
to configure the number of simultaneously processed threads in the worker pool.
```ruby
config.action_cable.worker_pool_size = 4
```
Also, note that your server must provide at least the same number of database
connections as you have workers. The default worker pool size is set to 4, so
that means you have to make at least 4 database connections available.
You can change that in `config/database.yml` through the `pool` attribute.
2020-07-06 14:02:31 -04:00
### Client side logging
Client side logging is disabled by default. You can enable this by setting the `ActionCable.logger.enabled` to true.
```ruby
import * as ActionCable from '@rails/actioncable'
ActionCable.logger.enabled = true
```
2015-12-18 15:04:38 -05:00
### Other Configurations
2017-11-22 11:33:28 -05:00
The other common option to configure is the log tags applied to the
2016-06-16 00:57:09 -04:00
per-connection logger. Here's an example that uses
the user account id if available, else "no-account" while tagging:
2015-12-18 15:04:38 -05:00
```ruby
2016-05-14 17:55:07 -04:00
config.action_cable.log_tags = [
2016-06-16 00:57:09 -04:00
-> request { request.env['user_account_id'] || "no-account" },
2015-12-18 15:04:38 -05:00
:action_cable,
-> request { request.uuid }
]
```
2016-05-14 17:55:07 -04:00
For a full list of all configuration options, see the
`ActionCable::Server::Configuration` class.
2015-12-18 15:04:38 -05:00
2016-05-14 17:55:07 -04:00
## Running Standalone Cable Servers
2015-12-18 15:04:38 -05:00
### In App
Action Cable can run alongside your Rails application. For example, to
2016-04-15 04:14:33 -04:00
listen for WebSocket requests on `/websocket` , specify that path to
`config.action_cable.mount_path` :
2015-12-18 15:04:38 -05:00
```ruby
2016-04-15 04:14:33 -04:00
# config/application.rb
class Application < Rails::Application
config.action_cable.mount_path = '/websocket'
2015-12-18 15:04:38 -05:00
end
```
2018-12-14 14:57:37 -05:00
You can use `ActionCable.createConsumer()` to connect to the cable
server if `action_cable_meta_tag` is invoked in the layout. Otherwise, A path is
specified as first argument to `createConsumer` (e.g. `ActionCable.createConsumer("/websocket")` ).
2015-12-18 15:04:38 -05:00
2016-05-14 17:55:07 -04:00
For every instance of your server you create and for every worker your server
spawns, you will also have a new instance of Action Cable, but the use of Redis
keeps messages synced across connections.
2015-12-18 15:04:38 -05:00
### Standalone
2016-02-28 09:46:56 -05:00
2016-05-14 17:55:07 -04:00
The cable servers can be separated from your normal application server. It's
still a Rack application, but it is its own Rack application. The recommended
basic setup is as follows:
2015-12-18 15:04:38 -05:00
```ruby
# cable/config.ru
2020-03-29 19:30:52 -04:00
require_relative "../config/environment"
2015-12-18 15:04:38 -05:00
Rails.application.eager_load!
run ActionCable.server
```
2016-05-14 17:55:07 -04:00
Then you start the server using a binstub in `bin/cable` ala:
2016-02-28 10:19:16 -05:00
2015-12-18 15:04:38 -05:00
```
#!/bin/bash
bundle exec puma -p 28080 cable/config.ru
```
The above will start a cable server on port 28080.
### Notes
The WebSocket server doesn't have access to the session, but it has
access to the cookies. This can be used when you need to handle
2018-10-08 11:07:03 -04:00
authentication. You can see one way of doing that with Devise in this [article ](https://greg.molnar.io/blog/actioncable-devise-authentication/ ).
2015-12-18 15:04:38 -05:00
## Dependencies
Action Cable provides a subscription adapter interface to process its
2017-10-26 01:32:23 -04:00
pubsub internals. By default, asynchronous, inline, PostgreSQL, and Redis
adapters are included. The default adapter
2015-12-18 15:04:38 -05:00
in new Rails applications is the asynchronous (`async`) adapter.
The Ruby side of things is built on top of [websocket-driver ](https://github.com/faye/websocket-driver-ruby ),
[nio4r ](https://github.com/celluloid/nio4r ), and [concurrent-ruby ](https://github.com/ruby-concurrency/concurrent-ruby ).
## Deployment
Action Cable is powered by a combination of WebSockets and threads. Both the
2016-02-28 09:12:39 -05:00
framework plumbing and user-specified channel work are handled internally by
utilizing Ruby's native thread support. This means you can use all your regular
2015-12-18 15:04:38 -05:00
Rails models with no problem, as long as you haven't committed any thread-safety sins.
2016-02-28 09:12:39 -05:00
The Action Cable server implements the Rack socket hijacking API,
2015-12-18 15:04:38 -05:00
thereby allowing the use of a multithreaded pattern for managing connections
internally, irrespective of whether the application server is multi-threaded or not.
2016-05-14 17:55:07 -04:00
Accordingly, Action Cable works with popular servers like Unicorn, Puma, and
Passenger.
2019-01-13 22:58:47 -05:00
## Testing
You can find detailed instructions on how to test your Action Cable functionality in the
[testing guide ](testing.html#testing-action-cable ).