anycable-rails 1.0.0.rc2 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0de4d95da59574a14f3f56219154cf3e12513a74e677520acf0cffbbf566e49
-  data.tar.gz: c6a4e9b87c3c59aac495663f8acc9f3150a8de5f43d5ab55d19c265039ba2af1
+  metadata.gz: 1c58ca24c6710071b8a90eee6a0d84ba9ec3069d0fb86fecebdab3cfba9fe1d3
+  data.tar.gz: f6ca1937e8cf821d3ded458db84cbfc83840ad45af266c04f32388e2ecec621d
 SHA512:
-  metadata.gz: 93f85efbfa20cffe71b3b52115b98321158577a36439b9875e6bbfb18ecee32c44fd31376a05f8883b8eff7d8b06b4d2d5abf762f86f6765248e3051869f3b17
-  data.tar.gz: 2ca2cd646321b0ed567af383847e4ae5f5cab116be0a7c410ea18d91f43378c024c47e3002c0aa70ddd0970a4e2bad50fd173c0b1fdf9088f229bad3ea53a05d
+  metadata.gz: 2ffbcc289fe4be6092c67b9953074f57a976f4375b1ac91408723043e9140e041f2fae83d7c3ac7234aa05651db48be4a663a2812b8a6bf2919fa9fc3c127494
+  data.tar.gz: b22cc5e90dfdc39369efef3feb46628635397313b203e645a042e810342bdbbe7da85ad900f3626a1d99ee85da8b4e9629be398aa68970758aeea78ff8fa95b5

data/CHANGELOG.md

@@ -2,7 +2,21 @@
 
 ## master
 
-## 1.0.0.rc2 (2020-06-16)
+## 1.0.2 (2020-09-08)
+
+- Added missing channel state support to `#unsubscribed` callbacks. ([@palkan][])
+
+## 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][])
 
@@ -13,8 +27,6 @@ Using non-strings or non-GlobalId-encoded objects was broken.
 Update Docker snippet, do not enable persistent sessions automatically,
 fix setting `config.action_cable.url` in environment configuration.
 
-## 1.0.0.rc1 (2020-06-10)
-
 - Add `state_attr_accessor` for channels. ([@palkan][])
 
 Just like `attr_accessor` but "persists" the state between RPC calls.

data/README.md

@@ -2,7 +2,7 @@
 [![Gem Version](https://badge.fury.io/rb/anycable-rails.svg)](https://rubygems.org/gems/anycable-rails)
 [![Build](https://github.com/anycable/anycable-rails/workflows/Build/badge.svg)](https://github.com/anycable/anycable-rails/actions)
 [![Gitter](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/anycable/Lobby)
-[![Documentation](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://docs.anycable.io/v1/#/ruby/rails)
+[![Documentation](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://docs.anycable.io/#/rails/getting_started)
 
 # AnyCable Rails
 
@@ -14,9 +14,9 @@ You can even use Action Cable in development and not be afraid of [compatibility
 
 **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.
 
-<!-- 💾 [Example Application](https://github.com/anycable/anycable_demo) -->
+💾 [Example Application](https://github.com/anycable/anycable_rails_demo)
 
-📑 [Documentation](https://docs.anycable.io/v1/#/ruby/rails).
+📑 [Documentation](https://docs.anycable.io/#/rails/getting_started).
 
 <a href="https://evilmartians.com/">
 <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
 $ RAILS_ENV=production bundle exec anycable
 ```
 
-And, finally, run AnyCable WebSocket server, e.g. [anycable-go](https://docs.anycable.io/v1/#/anycable-go/getting_started):
+And, finally, run AnyCable WebSocket server, e.g. [anycable-go](https://docs.anycable.io/#/v1/anycable-go/getting_started):
 
 ```sh
 anycable-go --host=localhost --port=3334
 ```
 
-See [documentation](https://docs.anycable.io/v1/#/ruby/rails) for more information on AnyCable + Rails usage.
+See [documentation](https://docs.anycable.io/#/rails/getting_started) for more information on AnyCable + Rails usage.
 
 ## Action Cable Compatibility
 
-See [documentation](https://docs.anycable.io/v1/#/ruby/compatibility).
+See [documentation](https://docs.anycable.io/#/rails/compatibility).
 
 ## Contributing
 

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
@@ -29,7 +31,7 @@ module ActionCable
         end
       end
 
-      def initialize(socket, env, identifiers: "{}", subscriptions: [])
+      def initialize(socket, env, identifiers: "{}", subscriptions: nil)
         if env
           # If env is set, then somehow we're in the context of Action Cable
           # Return and print a warning in #process
@@ -49,8 +51,15 @@ module ActionCable
         @socket = socket
         @subscriptions = ActionCable::Connection::Subscriptions.new(self)
 
-        # Initialize channels if any
-        subscriptions.each { |id| @subscriptions.fetch(id) }
+        return unless subscriptions
+
+        # Initialize channels (for disconnect)
+        subscriptions.each do |id|
+          channel = @subscriptions.fetch(id)
+          next unless socket.istate[id]
+
+          channel.__istate__ = ActiveSupport::JSON.decode(socket.istate[id])
+        end
       end
 
       def process
@@ -62,7 +71,7 @@ module ActionCable
 
       def invalid_request_message
         "You're trying to connect to Action Cable server while using AnyCable. " \
-        "See https://docs.anycable.io/v1/#/troubleshooting?id=server-raises-an-argumenterror-exception-when-client-tries-to-connect"
+        "See https://docs.anycable.io/#/troubleshooting?id=server-raises-an-argumenterror-exception-when-client-tries-to-connect"
       end
 
       def handle_open
@@ -196,3 +205,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,8 +15,8 @@ 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
 
@@ -28,3 +28,7 @@ module ActionCable
     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(__istate__["#{name}"], json: true) if connection.anycable_socket
               end
 
               def #{name}=(val)
-                connection.socket.istate["#{name}"] = AnyCable::Rails.serialize(val, json: true)
+                __istate__["#{name}"] = AnyCable::Rails.serialize(val, json: true) if connection.anycable_socket
                 instance_variable_set(:@#{name}, val)
               end
             RUBY
@@ -38,6 +36,13 @@ module AnyCable
       def self.included(base)
         base.extend ClassMethods
       end
+
+      # Make it possible to provide istate explicitly for a channel instance
+      attr_writer :__istate__
+
+      def __istate__
+        @__istate__ ||= connection.socket.istate
+      end
     end
   end
 end

data/lib/anycable/rails/compatibility.rb

@@ -34,6 +34,7 @@ module AnyCable
         diff = instance_variables - was_ivars
 
         if self.class.respond_to?(:channel_state_attributes)
+          diff.delete(:@__istate__)
           diff.delete_if { |ivar| self.class.channel_state_attributes.include?(:"#{ivar.to_s.sub(/^@/, "")}") }
         end
 

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.rc2"
+    VERSION = "1.0.2"
   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

@@ -8,7 +8,7 @@ module AnyCableRailsGenerators
     namespace "anycable:setup"
     source_root File.expand_path("templates", __dir__)
 
-    DOCS_ROOT = "https://docs.anycable.io/v1/#"
+    DOCS_ROOT = "https://docs.anycable.io/#"
     DEVELOPMENT_METHODS = %w[skip local docker].freeze
     SERVER_SOURCES = %w[skip brew binary].freeze
 
@@ -118,7 +118,7 @@ module AnyCableRailsGenerators
     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"
+      say_status :help, "⚠️  Please, check out the documentation on using AnyCable with Stimulus Reflex: https://docs.anycable.io/#/rails/stimulus_reflex"
     end
 
     def rubocop_compatibility
@@ -126,7 +126,7 @@ module AnyCableRailsGenerators
 
       say_status :info, "🤖 Running static compatibility checks with RuboCop"
       res = run "bundle exec rubocop -r 'anycable/rails/compatibility/rubocop' --only AnyCable/InstanceVars,AnyCable/PeriodicalTimers,AnyCable/InstanceVars"
-      say_status :help, "⚠️  Please, take a look at the icompatibilities above and fix them. See https://docs.anycable.io/v1/#/ruby/compatibility" unless res
+      say_status :help, "⚠️  Please, take a look at the icompatibilities above and fix them. See https://docs.anycable.io/#/rails/compatibility" unless res
     end
 
     def finish
@@ -143,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
@@ -159,6 +163,9 @@ 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:"
@@ -174,8 +181,8 @@ module AnyCableRailsGenerators
             ANYCABLE_RPC_HOST: anycable:50051
             ANYCABLE_DEBUG: 1
           depends_on:
-            - anycable
-            - redis
+            redis:
+              condition: service_healthy
 
         anycable:
           <<: *backend
@@ -184,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
@@ -216,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
 
@@ -254,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

@@ -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.rc2
+  version: 1.0.2
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-16 00:00:00.000000000 Z
+date: 2020-09-08 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"