@isometriks/live_cable 0.2.1 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +62 -0
- package/README.md +13 -15
- package/app/assets/javascript/controllers/live_controller.js +3 -6
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -6,6 +6,68 @@ The Ruby gem (`live_cable`) and the npm package (`@isometriks/live_cable`) are
|
|
|
6
6
|
released together and share a single version number. Entries below note which
|
|
7
7
|
side of the pair a change affects when it isn't both.
|
|
8
8
|
|
|
9
|
+
## 0.3.0 - 2026-09-26
|
|
10
|
+
|
|
11
|
+
### Upgrading from 0.2
|
|
12
|
+
|
|
13
|
+
Upgrade the gem and the npm package together. The 0.3 client no longer sends
|
|
14
|
+
the `_csrf_token` field that the 0.2 gem checks on every message, so a newer
|
|
15
|
+
client talking to an older gem has every action refused.
|
|
16
|
+
|
|
17
|
+
If your `ApplicationCable::Connection` follows the 0.2 installation guide,
|
|
18
|
+
delete both LiveCable lines from it. LiveCable now attaches `live_connection`
|
|
19
|
+
to every connection itself.
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
# app/channels/application_cable/connection.rb - delete these
|
|
23
|
+
identified_by :live_connection
|
|
24
|
+
|
|
25
|
+
def connect
|
|
26
|
+
self.live_connection = LiveCable::Connection.new(request)
|
|
27
|
+
end
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Delete them together. Without `identified_by` there is no `live_connection=`
|
|
31
|
+
for `connect` to call and every handshake fails. Without the `connect` override
|
|
32
|
+
the identifier shadows the `live_connection` LiveCable attaches with a nil one,
|
|
33
|
+
and every subscribe fails with a `LiveCable::Error` that says so. Leaving both
|
|
34
|
+
in place keeps working, at the cost described under *Changed*.
|
|
35
|
+
|
|
36
|
+
### Fixed
|
|
37
|
+
|
|
38
|
+
- **A message could be refused with no answer, leaving the component stuck in
|
|
39
|
+
its loading state.** `LiveChannel#receive` had no rescue of its own, so
|
|
40
|
+
anything raised before an action's own rescue — a component that failed to
|
|
41
|
+
subscribe, the CSRF check — went to ActionCable, which only logs it. The
|
|
42
|
+
client holds `live-loading` and `live-disable-with` until it hears back, so
|
|
43
|
+
the button stayed disabled until a reload. Every batch is now answered with a
|
|
44
|
+
`_refresh`, `_ack` or `_error`. A subscribe that fails at any point transmits
|
|
45
|
+
an `_error` too, and the client's unsubscribe then removes the half-built
|
|
46
|
+
component from the connection rather than leaving it for the next subscribe
|
|
47
|
+
to resurrect (gem).
|
|
48
|
+
|
|
49
|
+
### Changed
|
|
50
|
+
|
|
51
|
+
- `live_connection` is attached to every `ActionCable::Connection` by LiveCable
|
|
52
|
+
itself, so the connection no longer declares it. As an identifier, the
|
|
53
|
+
per-socket `LiveCable::Connection` became part of the connection's identity,
|
|
54
|
+
which `ActionCable.server.remote_connections` has to match in full, so an
|
|
55
|
+
application could never disconnect its users' sockets on sign-out. See
|
|
56
|
+
*Upgrading from 0.2* above (gem).
|
|
57
|
+
|
|
58
|
+
### Removed
|
|
59
|
+
|
|
60
|
+
- The per-message CSRF token check, and with it the `_csrf_token` field the
|
|
61
|
+
client sent with every batch. A WebSocket is protected at its handshake by
|
|
62
|
+
ActionCable's origin check and the `SameSite=Lax` session cookie, and the
|
|
63
|
+
check added nothing on top of those except a way to wedge a socket: it ran
|
|
64
|
+
against the session captured at the handshake, and a socket never sees
|
|
65
|
+
cookies set afterwards, so once the session's token rotated — Devise does
|
|
66
|
+
this on every sign-in — every message on that socket was refused until the
|
|
67
|
+
socket reconnected. A socket that outlives a sign-in is handled as for any
|
|
68
|
+
other channel, by the application disconnecting it; see the architecture
|
|
69
|
+
guide (gem + npm).
|
|
70
|
+
|
|
9
71
|
## 0.2.1 - 2026-08-13
|
|
10
72
|
|
|
11
73
|
### Removed
|
package/README.md
CHANGED
|
@@ -30,21 +30,19 @@ bundle install
|
|
|
30
30
|
|
|
31
31
|
## Configuration
|
|
32
32
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
end
|
|
47
|
-
```
|
|
33
|
+
There is nothing to configure on the cable side. LiveCable attaches itself to
|
|
34
|
+
`ActionCable::Connection::Base`, so your `ApplicationCable::Connection` stays as
|
|
35
|
+
it is, with whatever `identified_by` it declares or none at all. LiveCable needs
|
|
36
|
+
no identifiers of its own.
|
|
37
|
+
|
|
38
|
+
If you followed an earlier version of this guide, remove the
|
|
39
|
+
`identified_by :live_connection` line and the `connect` override that went with
|
|
40
|
+
it. Remove both at once, since either one on its own breaks every connection.
|
|
41
|
+
Together they keep working, but they make a per-socket object part of the
|
|
42
|
+
connection's identity, which stops `ActionCable.server.remote_connections` from
|
|
43
|
+
ever finding your users' sockets. See the
|
|
44
|
+
[architecture guide](https://livecable.io/guide/architecture#sign-in-and-sign-out)
|
|
45
|
+
for what to do about sockets when a user signs in or out.
|
|
48
46
|
|
|
49
47
|
## JavaScript Setup
|
|
50
48
|
|
|
@@ -166,20 +166,17 @@ export default class extends Controller {
|
|
|
166
166
|
}
|
|
167
167
|
}
|
|
168
168
|
|
|
169
|
+
// Batch any pending debounced messages ahead of this one so they are sent
|
|
170
|
+
// in the order they were triggered
|
|
169
171
|
#flushDebounced(message) {
|
|
170
172
|
const messages = [message]
|
|
171
173
|
|
|
172
|
-
// Add all pending debounced messages to be sent immediately
|
|
173
174
|
for (const [source, { timeout, message: debouncedMessage }] of this.#debounces) {
|
|
174
175
|
clearTimeout(timeout)
|
|
175
176
|
messages.unshift(debouncedMessage)
|
|
176
177
|
}
|
|
177
178
|
this.#debounces.clear()
|
|
178
179
|
|
|
179
|
-
return { messages
|
|
180
|
-
}
|
|
181
|
-
|
|
182
|
-
get #csrfToken() {
|
|
183
|
-
return document.querySelector("meta[name='csrf-token']")?.getAttribute("content")
|
|
180
|
+
return { messages }
|
|
184
181
|
}
|
|
185
182
|
}
|