anycable-rails 1.0.0 → 1.0.5
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +24 -0
- data/MIT-LICENSE +1 -1
- data/README.md +6 -6
- data/lib/anycable/rails/actioncable/channel.rb +1 -1
- data/lib/anycable/rails/actioncable/connection.rb +14 -5
- data/lib/anycable/rails/actioncable/testing.rb +0 -2
- data/lib/anycable/rails/channel_state.rb +9 -2
- data/lib/anycable/rails/compatibility.rb +3 -0
- data/lib/anycable/rails/rack.rb +5 -5
- data/lib/anycable/rails/railtie.rb +2 -10
- data/lib/anycable/rails/session_proxy.rb +3 -3
- data/lib/anycable/rails/version.rb +1 -1
- data/lib/generators/anycable/setup/setup_generator.rb +3 -3
- data/lib/generators/anycable/setup/templates/config/initializers/anycable.rb.tt +1 -1
- metadata +31 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1459676363d0523338a496163a296330e1bfbe363cc95b7e4433122163402a06
|
4
|
+
data.tar.gz: d3c074189aa5858f2b7ffbc455c68b7bf96885e493cc8ed6bfce86c9a870a375
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 51ab9db5efba8e737e6608d958e550933c7ddc20e9cee8a9a830bce94403d2895a158a643f27a026fd9cb1ff486ece078f823158f2ac2fabe6cabe33fc9948ea
|
7
|
+
data.tar.gz: 61b4563345b1e26ee1da6a7b61325040dca72942165f3508d1615dd06912fc2ab6ffbd8732fe9b9ebf04076a15707f51ae028d6479d90d97bc9f9590ff7c4929
|
data/CHANGELOG.md
CHANGED
@@ -2,6 +2,30 @@
|
|
2
2
|
|
3
3
|
## master
|
4
4
|
|
5
|
+
## 1.0.5 (2021-02-24)
|
6
|
+
|
7
|
+
- Fixed bug with compatibility false negatives in development. ([@palkan][])
|
8
|
+
|
9
|
+
See [#151](https://github.com/anycable/anycable-rails/issues/151).
|
10
|
+
|
11
|
+
## 1.0.4 (2020-10-02)
|
12
|
+
|
13
|
+
- Relax Rails dependencies. ([@palkan][])
|
14
|
+
|
15
|
+
Only add `actioncable` and `globalid` as runtime dependencies, not the whole `rails`.
|
16
|
+
|
17
|
+
## 1.0.3 (2020-09-16)
|
18
|
+
|
19
|
+
- Fixed bug with building a request object when session store is absent. ([@palkan][])
|
20
|
+
|
21
|
+
## 1.0.2 (2020-09-08)
|
22
|
+
|
23
|
+
- Added missing channel state support to `#unsubscribed` callbacks. ([@palkan][])
|
24
|
+
|
25
|
+
## 1.0.1 (2020-07-07)
|
26
|
+
|
27
|
+
- Fixed patching Action Cable testing classes. ([@palkan][])
|
28
|
+
|
5
29
|
## 1.0.0 (2020-07-01)
|
6
30
|
|
7
31
|
- Support `rescue_from` in connections (Rails 6.1). ([@palkan][])
|
data/MIT-LICENSE
CHANGED
data/README.md
CHANGED
@@ -2,7 +2,7 @@
|
|
2
2
|
[](https://rubygems.org/gems/anycable-rails)
|
3
3
|
[](https://github.com/anycable/anycable-rails/actions)
|
4
4
|
[](https://gitter.im/anycable/Lobby)
|
5
|
-
[](https://docs.anycable.io
|
5
|
+
[](https://docs.anycable.io/#/rails/getting_started)
|
6
6
|
|
7
7
|
# AnyCable Rails
|
8
8
|
|
@@ -14,9 +14,9 @@ You can even use Action Cable in development and not be afraid of [compatibility
|
|
14
14
|
|
15
15
|
**Important** This is a readme for the upcoming v1.0 release. For v0.6.x see the readme from the [0-6-stable](https://github.com/anycable/anycable-rails/tree/0-6-stable) branch.
|
16
16
|
|
17
|
-
|
17
|
+
💾 [Example Application](https://github.com/anycable/anycable_rails_demo)
|
18
18
|
|
19
|
-
📑 [Documentation](https://docs.anycable.io
|
19
|
+
📑 [Documentation](https://docs.anycable.io/#/rails/getting_started).
|
20
20
|
|
21
21
|
<a href="https://evilmartians.com/">
|
22
22
|
<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
|
@@ -83,17 +83,17 @@ $ bundle exec anycable
|
|
83
83
|
$ RAILS_ENV=production bundle exec anycable
|
84
84
|
```
|
85
85
|
|
86
|
-
And, finally, run AnyCable WebSocket server, e.g. [anycable-go](https://docs.anycable.io/
|
86
|
+
And, finally, run AnyCable WebSocket server, e.g. [anycable-go](https://docs.anycable.io/#/v1/anycable-go/getting_started):
|
87
87
|
|
88
88
|
```sh
|
89
89
|
anycable-go --host=localhost --port=3334
|
90
90
|
```
|
91
91
|
|
92
|
-
See [documentation](https://docs.anycable.io
|
92
|
+
See [documentation](https://docs.anycable.io/#/rails/getting_started) for more information on AnyCable + Rails usage.
|
93
93
|
|
94
94
|
## Action Cable Compatibility
|
95
95
|
|
96
|
-
See [documentation](https://docs.anycable.io
|
96
|
+
See [documentation](https://docs.anycable.io/#/rails/compatibility).
|
97
97
|
|
98
98
|
## Contributing
|
99
99
|
|
@@ -21,7 +21,7 @@ module ActionCable
|
|
21
21
|
|
22
22
|
attr_reader :socket
|
23
23
|
|
24
|
-
|
24
|
+
alias_method :anycable_socket, :socket
|
25
25
|
|
26
26
|
delegate :env, :session, to: :request
|
27
27
|
|
@@ -31,7 +31,7 @@ module ActionCable
|
|
31
31
|
end
|
32
32
|
end
|
33
33
|
|
34
|
-
def initialize(socket, env, identifiers: "{}", subscriptions:
|
34
|
+
def initialize(socket, env, identifiers: "{}", subscriptions: nil)
|
35
35
|
if env
|
36
36
|
# If env is set, then somehow we're in the context of Action Cable
|
37
37
|
# Return and print a warning in #process
|
@@ -51,8 +51,15 @@ module ActionCable
|
|
51
51
|
@socket = socket
|
52
52
|
@subscriptions = ActionCable::Connection::Subscriptions.new(self)
|
53
53
|
|
54
|
-
|
55
|
-
|
54
|
+
return unless subscriptions
|
55
|
+
|
56
|
+
# Initialize channels (for disconnect)
|
57
|
+
subscriptions.each do |id|
|
58
|
+
channel = @subscriptions.fetch(id)
|
59
|
+
next unless socket.istate[id]
|
60
|
+
|
61
|
+
channel.__istate__ = ActiveSupport::JSON.decode(socket.istate[id])
|
62
|
+
end
|
56
63
|
end
|
57
64
|
|
58
65
|
def process
|
@@ -64,7 +71,7 @@ module ActionCable
|
|
64
71
|
|
65
72
|
def invalid_request_message
|
66
73
|
"You're trying to connect to Action Cable server while using AnyCable. " \
|
67
|
-
"See https://docs.anycable.io
|
74
|
+
"See https://docs.anycable.io/#/troubleshooting?id=server-raises-an-argumenterror-exception-when-client-tries-to-connect"
|
68
75
|
end
|
69
76
|
|
70
77
|
def handle_open
|
@@ -211,3 +218,5 @@ if ActionCable::Connection::Base.respond_to?(:rescue_from)
|
|
211
218
|
end
|
212
219
|
end)
|
213
220
|
end
|
221
|
+
|
222
|
+
require "anycable/rails/actioncable/testing" if ::Rails.env.test?
|
@@ -10,11 +10,11 @@ module AnyCable
|
|
10
10
|
class_eval <<~RUBY, __FILE__, __LINE__ + 1
|
11
11
|
def #{name}
|
12
12
|
return @#{name} if instance_variable_defined?(:@#{name})
|
13
|
-
@#{name} = AnyCable::Rails.deserialize(
|
13
|
+
@#{name} = AnyCable::Rails.deserialize(__istate__["#{name}"], json: true) if connection.anycable_socket
|
14
14
|
end
|
15
15
|
|
16
16
|
def #{name}=(val)
|
17
|
-
|
17
|
+
__istate__["#{name}"] = AnyCable::Rails.serialize(val, json: true) if connection.anycable_socket
|
18
18
|
instance_variable_set(:@#{name}, val)
|
19
19
|
end
|
20
20
|
RUBY
|
@@ -36,6 +36,13 @@ module AnyCable
|
|
36
36
|
def self.included(base)
|
37
37
|
base.extend ClassMethods
|
38
38
|
end
|
39
|
+
|
40
|
+
# Make it possible to provide istate explicitly for a channel instance
|
41
|
+
attr_writer :__istate__
|
42
|
+
|
43
|
+
def __istate__
|
44
|
+
@__istate__ ||= connection.socket.istate
|
45
|
+
end
|
39
46
|
end
|
40
47
|
end
|
41
48
|
end
|
@@ -23,6 +23,8 @@ module AnyCable
|
|
23
23
|
%w[run_callbacks perform_action].each do |mid|
|
24
24
|
module_eval <<~CODE, __FILE__, __LINE__ + 1
|
25
25
|
def #{mid}(*)
|
26
|
+
# allocate @_streams
|
27
|
+
streams
|
26
28
|
__anycable_check_ivars__ { super }
|
27
29
|
end
|
28
30
|
CODE
|
@@ -34,6 +36,7 @@ module AnyCable
|
|
34
36
|
diff = instance_variables - was_ivars
|
35
37
|
|
36
38
|
if self.class.respond_to?(:channel_state_attributes)
|
39
|
+
diff.delete(:@__istate__)
|
37
40
|
diff.delete_if { |ivar| self.class.channel_state_attributes.include?(:"#{ivar.to_s.sub(/^@/, "")}") }
|
38
41
|
end
|
39
42
|
|
data/lib/anycable/rails/rack.rb
CHANGED
@@ -38,16 +38,16 @@ module AnyCable
|
|
38
38
|
config = ::Rails.application.config
|
39
39
|
|
40
40
|
ActionDispatch::MiddlewareStack.new do |middleware|
|
41
|
-
middleware.use(config.session_store, config.session_options)
|
41
|
+
middleware.use(config.session_store, config.session_options) if config.session_store
|
42
42
|
end
|
43
43
|
end
|
44
44
|
|
45
45
|
def self.app
|
46
46
|
@rack_app || app_build_lock.synchronize do
|
47
|
-
@rack_app ||=
|
48
|
-
|
49
|
-
|
50
|
-
|
47
|
+
@rack_app ||= default_middleware_stack.yield_self do |stack|
|
48
|
+
middleware.merge_into(stack)
|
49
|
+
end.yield_self do |stack|
|
50
|
+
stack.build { [-1, {}, []] }
|
51
51
|
end
|
52
52
|
end
|
53
53
|
end
|
@@ -18,8 +18,8 @@ module AnyCable
|
|
18
18
|
AnyCable.logger = ActiveSupport::TaggedLogging.new(::ActionCable.server.config.logger)
|
19
19
|
# Broadcast server logs to STDOUT in development
|
20
20
|
if ::Rails.env.development? &&
|
21
|
-
!ActiveSupport::Logger.logger_outputs_to?(::Rails.logger,
|
22
|
-
console = ActiveSupport::Logger.new(
|
21
|
+
!ActiveSupport::Logger.logger_outputs_to?(::Rails.logger, $stdout)
|
22
|
+
console = ActiveSupport::Logger.new($stdout)
|
23
23
|
console.formatter = ::Rails.logger.formatter
|
24
24
|
console.level = ::Rails.logger.level
|
25
25
|
AnyCable.logger.extend(ActiveSupport::Logger.broadcast(console))
|
@@ -59,14 +59,6 @@ module AnyCable
|
|
59
59
|
end
|
60
60
|
end
|
61
61
|
end
|
62
|
-
|
63
|
-
initializer "anycable.testing" do |app|
|
64
|
-
next unless ::Rails.env.test?
|
65
|
-
|
66
|
-
ActiveSupport.on_load(:action_cable) do
|
67
|
-
require "anycable/rails/actioncable/testing"
|
68
|
-
end
|
69
|
-
end
|
70
62
|
end
|
71
63
|
end
|
72
64
|
end
|
@@ -21,8 +21,8 @@ module AnyCable
|
|
21
21
|
CODE
|
22
22
|
end
|
23
23
|
|
24
|
-
|
25
|
-
|
24
|
+
alias_method :include?, :has_key?
|
25
|
+
alias_method :key?, :has_key?
|
26
26
|
|
27
27
|
%i[update merge! to_hash].each do |mid|
|
28
28
|
class_eval <<~CODE, __FILE__, __LINE__ + 1
|
@@ -33,7 +33,7 @@ module AnyCable
|
|
33
33
|
CODE
|
34
34
|
end
|
35
35
|
|
36
|
-
|
36
|
+
alias_method :to_h, :to_hash
|
37
37
|
|
38
38
|
def keys
|
39
39
|
rack_session.keys + socket_session.keys
|
@@ -8,7 +8,7 @@ module AnyCableRailsGenerators
|
|
8
8
|
namespace "anycable:setup"
|
9
9
|
source_root File.expand_path("templates", __dir__)
|
10
10
|
|
11
|
-
DOCS_ROOT = "https://docs.anycable.io
|
11
|
+
DOCS_ROOT = "https://docs.anycable.io/#"
|
12
12
|
DEVELOPMENT_METHODS = %w[skip local docker].freeze
|
13
13
|
SERVER_SOURCES = %w[skip brew binary].freeze
|
14
14
|
|
@@ -118,7 +118,7 @@ module AnyCableRailsGenerators
|
|
118
118
|
def stimulus_reflex
|
119
119
|
return unless stimulus_reflex?
|
120
120
|
|
121
|
-
say_status :help, "⚠️ Please, check out the documentation on using AnyCable with Stimulus Reflex: https://docs.anycable.io
|
121
|
+
say_status :help, "⚠️ Please, check out the documentation on using AnyCable with Stimulus Reflex: https://docs.anycable.io/#/rails/stimulus_reflex"
|
122
122
|
end
|
123
123
|
|
124
124
|
def rubocop_compatibility
|
@@ -126,7 +126,7 @@ module AnyCableRailsGenerators
|
|
126
126
|
|
127
127
|
say_status :info, "🤖 Running static compatibility checks with RuboCop"
|
128
128
|
res = run "bundle exec rubocop -r 'anycable/rails/compatibility/rubocop' --only AnyCable/InstanceVars,AnyCable/PeriodicalTimers,AnyCable/InstanceVars"
|
129
|
-
say_status :help, "⚠️ Please, take a look at the icompatibilities above and fix them. See https://docs.anycable.io
|
129
|
+
say_status :help, "⚠️ Please, take a look at the icompatibilities above and fix them. See https://docs.anycable.io/#/rails/compatibility" unless res
|
130
130
|
end
|
131
131
|
|
132
132
|
def finish
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: anycable-rails
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.
|
4
|
+
version: 1.0.5
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- palkan
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2021-02-24 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: anycable
|
@@ -25,7 +25,7 @@ dependencies:
|
|
25
25
|
- !ruby/object:Gem::Version
|
26
26
|
version: 1.0.0
|
27
27
|
- !ruby/object:Gem::Dependency
|
28
|
-
name:
|
28
|
+
name: actioncable
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
30
30
|
requirements:
|
31
31
|
- - ">="
|
@@ -38,6 +38,34 @@ dependencies:
|
|
38
38
|
- - ">="
|
39
39
|
- !ruby/object:Gem::Version
|
40
40
|
version: '5'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: globalid
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :runtime
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: activerecord
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
41
69
|
- !ruby/object:Gem::Dependency
|
42
70
|
name: ammeter
|
43
71
|
requirement: !ruby/object:Gem::Requirement
|