anycable-rails 1.0.0.rc1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36b6e47a498bfc2d1156e4635a5c30f60258c925142c59ad837c1b6708f1ff73
-  data.tar.gz: f27c94856df0db9d178537e8ac75598f8a355b338e725a80a5cb06a6e0ac610c
+  metadata.gz: d2c1f822cbb79135290b3c404544d937f0f083751657057b7bdd4445a33a95f1
+  data.tar.gz: ae4f5e42da49c8f668ee2cf56a434e30872d04cee9bc3596f914fb2e48404ac1
 SHA512:
-  metadata.gz: 28b72e3f6a9950d3a95eb8d4f1c6a59f24a704ff63ac50384ffb2d22aa97c9f6b6e1f0c882a89cc6a0fd9ac22ea553a381514d56885f6f1cce41e7146153ab24
-  data.tar.gz: ac7c402d2b57a332ced9372a4546709d6b41a0fb082c823d292b87c8b11e4bf741047cbc10258f68acd228712f0ca974b6723246bd3ddc689920f656b1488974
+  metadata.gz: 55bb99bacfdbd2b29120e29598aedc467f56325096602c7713bc2bfee9c4c40f826089ee4dd4d76e80d7171bdd1989db0d21c002edae0e429174509d24f8d836
+  data.tar.gz: 2ee8318ebd5c27dd95b21bd784c75d0d78da08538f1dd466235b889485d2229a4f35202b036a422466f38422905fbda16f84a028ecb3772e0669ce2bfc203dda

data/CHANGELOG.md

@@ -1,6 +1,27 @@
 # Change log
 
-## 1.0.0.rc1 (2020-06-10)
+## master
+
+## 1.0.1 (2020-07-07)
+
+- Fixed patching Action Cable testing classes. ([@palkan][])
+
+## 1.0.0 (2020-07-01)
+
+- Support `rescue_from` in connections (Rails 6.1). ([@palkan][])
+
+- Make AnyCable patches compatible with Action Cable testing. ([@palkan][])
+
+- Do not add localhost `redis_url` to `anycable.yml` when Docker development method is chosen in `anycable:setup`. ([@palkan][])
+
+- Fix connection identifiers deserialization regression. ([@palkan][])
+
+Using non-strings or non-GlobalId-encoded objects was broken.
+
+- Improve `anycable:setup` generator. ([@palkan][])
+
+Update Docker snippet, do not enable persistent sessions automatically,
+fix setting `config.action_cable.url` in environment configuration.
 
 - Add `state_attr_accessor` for channels. ([@palkan][])
 

data/lib/anycable/rails.rb

@@ -35,7 +35,7 @@ module AnyCable
       # If the resulting object is a Hash, make it indifferent
       def deserialize(str, json: false)
         str.yield_self do |val|
-          next unless val.is_a?(String)
+          next val unless val.is_a?(String)
 
           gval = GlobalID::Locator.locate(val)
           return gval if gval

data/lib/anycable/rails/actioncable/connection.rb

@@ -21,6 +21,8 @@ module ActionCable
 
       attr_reader :socket
 
+      alias anycable_socket socket
+
       delegate :env, :session, to: :request
 
       class << self
@@ -196,3 +198,18 @@ module ActionCable
     # rubocop:enable Metrics/ClassLength
   end
 end
+
+# Support rescue_from
+# https://github.com/rails/rails/commit/d2571e560c62116f60429c933d0c41a0e249b58b
+if ActionCable::Connection::Base.respond_to?(:rescue_from)
+  ActionCable::Connection::Base.prepend(Module.new do
+    def handle_channel_command(*)
+      super
+    rescue Exception => e # rubocop:disable Lint/RescueException
+      rescue_with_handler(e) || raise
+      false
+    end
+  end)
+end
+
+require "anycable/rails/actioncable/testing" if ::Rails.env.test?

data/lib/anycable/rails/actioncable/connection/persistent_session.rb

@@ -15,16 +15,20 @@ module ActionCable
         return super unless socket.session
 
         super.tap do |req|
-          req.env[Rack::RACK_SESSION] =
-            AnyCable::Rails::SessionProxy.new(req.env[Rack::RACK_SESSION], socket.session)
+          req.env[::Rack::RACK_SESSION] =
+            AnyCable::Rails::SessionProxy.new(req.env[::Rack::RACK_SESSION], socket.session)
         end
       end
 
       def commit_session!
-        return unless request_loaded? && request.session.loaded?
+        return unless request_loaded? && request.session.respond_to?(:loaded?) && request.session.loaded?
 
         socket.session = request.session.to_json
       end
     end
   end
 end
+
+::ActionCable::Connection::Base.prepend(
+  ::ActionCable::Connection::PersistentSession
+)

data/lib/anycable/rails/actioncable/testing.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# This file contains patches to Action Cable testing modules
+
+# Trigger autoload (if constant is defined)
+begin
+  ActionCable::Channel::TestCase # rubocop:disable Lint/Void
+  ActionCable::Connection::TestCase # rubocop:disable Lint/Void
+rescue NameError
+  return
+end
+
+ActionCable::Channel::ChannelStub.prepend(Module.new do
+  def subscribe_to_channel
+    # allocate @streams
+    streams
+    handle_subscribe
+  end
+end)
+
+ActionCable::Channel::ConnectionStub.prepend(Module.new do
+  def socket
+    @socket ||= AnyCable::Socket.new(env: {})
+  end
+
+  alias_method :anycable_socket, :socket
+end)
+
+ActionCable::Connection::TestConnection.prepend(Module.new do
+  def initialize(request)
+    @request = request
+    @cached_ids = {}
+    super
+  end
+end)

data/lib/anycable/rails/channel_state.rb

@@ -5,18 +5,16 @@ module AnyCable
     module ChannelState
       module ClassMethods
         def state_attr_accessor(*names)
-          return attr_accessor(*names) unless AnyCable::Rails.enabled?
-
           names.each do |name|
             channel_state_attributes << name
             class_eval <<~RUBY, __FILE__, __LINE__ + 1
               def #{name}
                 return @#{name} if instance_variable_defined?(:@#{name})
-                @#{name} = AnyCable::Rails.deserialize(connection.socket.istate["#{name}"], json: true)
+                @#{name} = AnyCable::Rails.deserialize(connection.socket.istate["#{name}"], json: true) if connection.anycable_socket
               end
 
               def #{name}=(val)
-                connection.socket.istate["#{name}"] = AnyCable::Rails.serialize(val, json: true)
+                connection.socket.istate["#{name}"] = AnyCable::Rails.serialize(val, json: true) if connection.anycable_socket
                 instance_variable_set(:@#{name}, val)
               end
             RUBY

data/lib/anycable/rails/railtie.rb

@@ -43,18 +43,18 @@ module AnyCable
 
       initializer "anycable.connection_factory", after: "action_cable.set_configs" do |app|
         ActiveSupport.on_load(:action_cable) do
+          # Add AnyCable patch method stub (we use it in ChannelState to distinguish between Action Cable and AnyCable)
+          # NOTE: Method could be already defined if patch was loaded manually
+          ActionCable::Connection::Base.attr_reader(:anycable_socket) unless ActionCable::Connection::Base.method_defined?(:anycable_socket)
+
+          app.config.to_prepare do
+            AnyCable.connection_factory = ActionCable.server.config.connection_class.call
+          end
+
           if AnyCable::Rails.enabled?
             require "anycable/rails/actioncable/connection"
-
             if AnyCable.config.persistent_session_enabled
               require "anycable/rails/actioncable/connection/persistent_session"
-              ::ActionCable::Connection::Base.prepend(
-                ::ActionCable::Connection::PersistentSession
-              )
-            end
-
-            app.config.to_prepare do
-              AnyCable.connection_factory = ActionCable.server.config.connection_class.call
             end
           end
         end

data/lib/anycable/rails/version.rb

@@ -2,6 +2,6 @@
 
 module AnyCable
   module Rails
-    VERSION = "1.0.0.rc1"
+    VERSION = "1.0.1"
   end
 end

data/lib/generators/anycable/download/USAGE

@@ -1,5 +1,5 @@
 Description:
-    Install AnyCable-Go web server.
+    Install AnyCable-Go web server locally (the latest version by default).
 
 Example:
     rails generate anycable:download

data/lib/generators/anycable/download/download_generator.rb

@@ -9,8 +9,7 @@ module AnyCableRailsGenerators
 
     include WithOSHelpers
 
-    # TODO: change to latest release
-    VERSION = "1.0.0.preview1"
+    VERSION = "latest"
 
     class_option :bin_path,
       type: :string,
@@ -35,20 +34,27 @@ module AnyCableRailsGenerators
     private
 
     def release_url(version)
+      return latest_release_url(version) if version == "latest"
+
       if Gem::Version.new(version).segments.first >= 1
-        new_release_url(version)
+        new_release_url("v#{version}")
       else
-        legacy_release_url(version)
+        legacy_release_url("v#{version}")
       end
     end
 
     def legacy_release_url(version)
-      "https://github.com/anycable/anycable-go/releases/download/v#{version}/" \
+      "https://github.com/anycable/anycable-go/releases/download/#{version}/" \
         "anycable-go-v#{version}-#{os_name}-#{cpu_name}"
     end
 
     def new_release_url(version)
-      "https://github.com/anycable/anycable-go/releases/download/v#{version}/" \
+      "https://github.com/anycable/anycable-go/releases/download/#{version}/" \
+        "anycable-go-#{os_name}-#{cpu_name}"
+    end
+
+    def latest_release_url(version)
+      "https://github.com/anycable/anycable-go/releases/latest/download/" \
         "anycable-go-#{os_name}-#{cpu_name}"
     end
 

data/lib/generators/anycable/setup/setup_generator.rb

@@ -49,14 +49,18 @@ module AnyCableRailsGenerators
       environment(nil, env: :development) do
         <<~SNIPPET
           # Specify AnyCable WebSocket server URL to use by JS client
-          config.action_cable.url = ENV.fetch("CABLE_URL", "ws://localhost:8080/cable") if AnyCable::Rails.enabled?
+          config.after_initialize do
+            config.action_cable.url = ActionCable.server.config.url = ENV.fetch("CABLE_URL", "ws://localhost:8080/cable") if AnyCable::Rails.enabled?
+          end
         SNIPPET
       end
 
       environment(nil, env: :production) do
         <<~SNIPPET
           # Specify AnyCable WebSocket server URL to use by JS client
-          config.action_cable.url = ENV.fetch("CABLE_URL") if AnyCable::Rails.enabled?
+          config.after_initialize do
+            config.action_cable.url = ActionCable.server.config.url = ENV.fetch("CABLE_URL") if AnyCable::Rails.enabled?
+          end
         SNIPPET
       end
 
@@ -111,6 +115,12 @@ module AnyCableRailsGenerators
       say_status :info, "✅ config/initializers/anycable.rb with Devise configuration has been added"
     end
 
+    def stimulus_reflex
+      return unless stimulus_reflex?
+
+      say_status :help, "⚠️  Please, check out the documentation on using AnyCable with Stimulus Reflex: https://docs.anycable.io/v1/#/ruby/stimulus_reflex"
+    end
+
     def rubocop_compatibility
       return unless rubocop?
 
@@ -133,6 +143,10 @@ module AnyCableRailsGenerators
       !!gemfile_lock&.match?(/^\s+redis\b/)
     end
 
+    def webpacker?
+      !!gemfile_lock&.match?(/^\s+webpacker\b/)
+    end
+
     def rubocop?
       !!gemfile_lock&.match?(/^\s+rubocop\b/)
     end
@@ -149,21 +163,26 @@ module AnyCableRailsGenerators
     end
 
     def install_for_docker
+      # Remove localhost from configuraiton
+      gsub_file "config/anycable.yml", /^.*redis_url:.*localhost[^\n]+\n/, ""
+
       say_status :help, "️️⚠️  Docker development configuration could vary", :yellow
 
       say "Here is an example snippet for docker-compose.yml:"
       say <<~YML
         ─────────────────────────────────────────
         ws:
-          image: anycable/anycable-go:1.0.0.preview1
+          image: anycable/anycable-go:1.0
           ports:
             - '8080:8080'
           environment:
+            ANYCABLE_HOST: "0.0.0.0"
             ANYCABLE_REDIS_URL: redis://redis:6379/0
             ANYCABLE_RPC_HOST: anycable:50051
+            ANYCABLE_DEBUG: 1
           depends_on:
-            - anycable-rpc
-            - redis
+            redis:
+              condition: service_healthy
 
         anycable:
           <<: *backend
@@ -172,8 +191,13 @@ module AnyCableRailsGenerators
             <<: *backend_environment
             ANYCABLE_REDIS_URL: redis://redis:6379/0
             ANYCABLE_RPC_HOST: 0.0.0.0:50051
+            ANYCABLE_DEBUG: 1
           ports:
             - '50051'
+          depends_on:
+            <<: *backend_depends_on
+            ws:
+              condition: service_started
         ─────────────────────────────────────────
       YML
     end
@@ -204,8 +228,8 @@ module AnyCableRailsGenerators
     def template_proc_files
       file_name = "Procfile.dev"
 
-      if File.exist?(file_name)
-        append_file file_name, 'anycable: bundle exec anycable --server-command "anycable-go --port 3334"'
+      if file_exists?(file_name)
+        append_file file_name, "anycable: bundle exec anycable\nws: anycable-go#{anycable_go_options}", force: true
       else
         say_status :help, "💡 We recommend using Hivemind to manage multiple processes in development 👉 https://github.com/DarthSim/hivemind", :yellow
 
@@ -242,5 +266,15 @@ module AnyCableRailsGenerators
         args << "--version #{opts[:version]}" if opts[:version]
       end.join(" ")
     end
+
+    def anycable_go_options
+      redis? ? " --port=8080" : " --port=8080 --broadcast_adapter=http"
+    end
+
+    def file_exists?(name)
+      in_root do
+        return File.file?(name)
+      end
+    end
   end
 end

data/lib/generators/anycable/setup/templates/Procfile.dev.tt

@@ -0,0 +1,6 @@
+server: bundle exec rails s
+<%- if webpacker? -%>
+assets: bundle exec bin/webpack-dev-server
+<%- end -%>
+anycable: bundle exec anycable
+ws: anycable-go<%= anycable_go_options %>

data/lib/generators/anycable/setup/templates/config/anycable.yml.tt

@@ -12,8 +12,8 @@
 default: &default
   # Turn on/off access logs ("Started..." and "Finished...")
   access_logs_disabled: false
-  # Persist "dirty" session between RPC calls (might be required for StimulusReflex apps)
-  persistent_session_enabled: <%= stimulus_reflex? %>
+  # Persist "dirty" session between RPC calls (might be required for apps using stimulus_reflex <3.0)
+  # persistent_session_enabled: true
   # This is the host and the port to run AnyCable RPC server on.
   # You must configure your WebSocket server to connect to it, e.g.:
   #   $ anycable-go --rpc-host="<rpc hostname>:50051"
@@ -30,10 +30,17 @@ default: &default
   # Use the same channel name for WebSocket server, e.g.:
   #   $ anycable-go --redis-channel="__anycable__"
   redis_channel: "__anycable__"
+  <%- if redis? -%>
+  # You can use REDIS_URL env var to configure Redis URL.
+  # Localhost is used by default.
+  # redis_url: "redis://localhost:6379/1"
+  <%- end -%>
 
 development:
   <<: *default
-  redis_url: "redis://localhost:6379/1"
+
+test:
+  <<: *default
 
 production:
   <<: *default

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: anycable-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.1
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anycable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -81,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -141,6 +141,7 @@ files:
 - lib/anycable/rails/actioncable/connection/persistent_session.rb
 - lib/anycable/rails/actioncable/connection/serializable_identification.rb
 - lib/anycable/rails/actioncable/remote_connections.rb
+- lib/anycable/rails/actioncable/testing.rb
 - lib/anycable/rails/channel_state.rb
 - lib/anycable/rails/compatibility.rb
 - lib/anycable/rails/compatibility/rubocop.rb
@@ -160,7 +161,7 @@ files:
 - lib/generators/anycable/download/download_generator.rb
 - lib/generators/anycable/setup/USAGE
 - lib/generators/anycable/setup/setup_generator.rb
-- lib/generators/anycable/setup/templates/Procfile.dev
+- lib/generators/anycable/setup/templates/Procfile.dev.tt
 - lib/generators/anycable/setup/templates/config/anycable.yml.tt
 - lib/generators/anycable/setup/templates/config/cable.yml.tt
 - lib/generators/anycable/setup/templates/config/initializers/anycable.rb.tt
@@ -185,9 +186,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.6
 signing_key: 

data/lib/generators/anycable/setup/templates/Procfile.dev

@@ -1,3 +0,0 @@
-server: bin/rails server
-assets: bin/webpack-dev-server
-anycable: bundle exec anycable --server-command "anycable-go --port 3334"