anycable-rails 1.0.0.preview2 → 1.0.0.rc1

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "action_cable/remote_connections"
+
+ActionCable::RemoteConnections::RemoteConnection.include(ActionCable::Connection::SerializableIdentification)
+
+ActionCable::RemoteConnections::RemoteConnection.prepend(Module.new do
+  def disconnect(reconnect: true)
+    ::AnyCable.broadcast_adapter.broadcast_command("disconnect", identifier: identifiers_json, reconnect: reconnect)
+  end
+end)

data/lib/anycable/rails/channel_state.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module AnyCable
+  module Rails
+    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)
+              end
+
+              def #{name}=(val)
+                connection.socket.istate["#{name}"] = AnyCable::Rails.serialize(val, json: true)
+                instance_variable_set(:@#{name}, val)
+              end
+            RUBY
+          end
+        end
+
+        def channel_state_attributes
+          return @channel_state_attributes if instance_variable_defined?(:@channel_state_attributes)
+
+          @channel_state_attributes =
+            if superclass.respond_to?(:channel_state_attributes)
+              superclass.channel_state_attributes.dup
+            else
+              []
+            end
+        end
+      end
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:action_cable) do
+  # `state_attr_accessor` must be available in Action Cable
+  ::ActionCable::Channel::Base.include(AnyCable::Rails::ChannelState)
+end

data/lib/anycable/rails/compatibility.rb

@@ -33,6 +33,10 @@ module AnyCable
         res = yield
         diff = instance_variables - was_ivars
 
+        if self.class.respond_to?(:channel_state_attributes)
+          diff.delete_if { |ivar| self.class.channel_state_attributes.include?(:"#{ivar.to_s.sub(/^@/, "")}") }
+        end
+
         unless diff.empty?
           raise AnyCable::CompatibilityError,
             "Channel instance variables are not supported by AnyCable, " \
@@ -48,12 +52,5 @@ module AnyCable
         raise AnyCable::CompatibilityError, "Periodical timers are not supported by AnyCable"
       end
     end)
-
-    ActionCable::RemoteConnections::RemoteConnection.prepend(Module.new do
-      def disconnect
-        raise AnyCable::CompatibilityError,
-          "Disconnecting remote clients is not supported by AnyCable yet"
-      end
-    end)
   end
 end

data/lib/anycable/rails/compatibility/rubocop.rb

@@ -4,7 +4,6 @@ require "rubocop"
 require "pathname"
 
 require_relative "rubocop/cops/anycable/stream_from"
-require_relative "rubocop/cops/anycable/remote_disconnect"
 require_relative "rubocop/cops/anycable/periodical_timers"
 require_relative "rubocop/cops/anycable/instance_vars"
 

data/lib/anycable/rails/compatibility/rubocop/config/default.yml

@@ -1,11 +1,14 @@
 AnyCable/InstanceVars:
+  Enabled: true
   Include:
     - "**/channels/**/*.rb"
 
 AnyCable/StreamFrom:
+  Enabled: true
   Include:
     - "**/channels/**/*.rb"
 
 AnyCable/PeriodicalTimers:
+  Enabled: true
   Include:
     - "**/channels/**/*.rb"

data/lib/anycable/rails/compatibility/rubocop/cops/anycable/instance_vars.rb

@@ -25,7 +25,7 @@ module RuboCop
       #   end
       #
       class InstanceVars < RuboCop::Cop::Cop
-        MSG = "Channel instance variables are not supported in AnyCable"
+        MSG = "Channel instance variables are not supported in AnyCable. Use `state_attr_accessor` instead"
 
         def on_class(node)
           find_nested_ivars(node) do |nested_ivar|

data/lib/anycable/rails/compatibility/rubocop/cops/anycable/stream_from.rb

@@ -11,7 +11,7 @@ module RuboCop
       #   # bad
       #   class MyChannel < ApplicationCable::Channel
       #     def follow
-      #       stream_from("all") {}
+      #       stream_for(room) {}
       #     end
       #   end
       #
@@ -36,15 +36,15 @@ module RuboCop
       #
       class StreamFrom < RuboCop::Cop::Cop
         def_node_matcher :stream_from_with_block?, <<-PATTERN
-          (block (send _ :stream_from ...) ...)
+          (block {(send _ :stream_from ...) (send _ :stream_for ...)} ...)
         PATTERN
 
         def_node_matcher :stream_from_with_callback?, <<-PATTERN
-          (send _ :stream_from str_type? (block (send nil? :lambda) ...))
+          {(send _ :stream_from str_type? (block (send nil? :lambda) ...)) (send _ :stream_for ... (block (send nil? :lambda) ...))}
         PATTERN
 
         def_node_matcher :args_of_stream_from, <<-PATTERN
-          (send _ :stream_from str_type? $...)
+          {(send _ :stream_from str_type? $...)  (send _ :stream_for $...)}
         PATTERN
 
         def_node_matcher :coder_symbol?, "(pair (sym :coder) ...)"

data/lib/anycable/rails/railtie.rb

@@ -1,23 +1,24 @@
 # frozen_string_literal: true
 
+require "anycable/rails/channel_state"
+
 module AnyCable
   module Rails
     class Railtie < ::Rails::Railtie # :nodoc:
       initializer "anycable.disable_action_cable_mount", after: "action_cable.set_configs" do |app|
-        # Disable Action Cable default route when AnyCable adapter is used
-        adapter = ::ActionCable.server.config.cable&.fetch("adapter", nil)
-        next unless AnyCable::Rails.compatible_adapter?(adapter)
+        next unless AnyCable::Rails.enabled?
 
         app.config.action_cable.mount_path = nil
       end
 
       initializer "anycable.logger", after: "action_cable.logger" do |_app|
-        AnyCable.logger = ActiveSupport::TaggedLogging.new(::ActionCable.server.config.logger)
+        AnyCable.logger = ::ActionCable.server.config.logger
 
-        # Broadcast server logs to STDOUT in development
-        if ::Rails.env.development? &&
-            !ActiveSupport::Logger.logger_outputs_to?(::Rails.logger, STDOUT)
-          AnyCable.configure_server do
+        AnyCable.configure_server do
+          AnyCable.logger = ActiveSupport::TaggedLogging.new(::ActionCable.server.config.logger)
+          # Broadcast server logs to STDOUT in development
+          if ::Rails.env.development? &&
+              !ActiveSupport::Logger.logger_outputs_to?(::Rails.logger, STDOUT)
             console = ActiveSupport::Logger.new(STDOUT)
             console.formatter = ::Rails.logger.formatter
             console.level = ::Rails.logger.level
@@ -42,8 +43,7 @@ module AnyCable
 
       initializer "anycable.connection_factory", after: "action_cable.set_configs" do |app|
         ActiveSupport.on_load(:action_cable) do
-          adapter = ::ActionCable.server.config.cable&.fetch("adapter", nil)
-          if AnyCable::Rails.compatible_adapter?(adapter)
+          if AnyCable::Rails.enabled?
             require "anycable/rails/actioncable/connection"
 
             if AnyCable.config.persistent_session_enabled

data/lib/anycable/rails/refinements/subscriptions.rb

@@ -7,6 +7,11 @@ module AnyCable
         # Find or add a subscription to the list
         def fetch(identifier)
           add("identifier" => identifier) unless subscriptions[identifier]
+
+          unless subscriptions[identifier]
+            raise "Channel not found: #{ActiveSupport::JSON.decode(identifier).fetch("channel")}"
+          end
+
           subscriptions[identifier]
         end
       end

data/lib/anycable/rails/session_proxy.rb

@@ -5,8 +5,6 @@ module AnyCable
     # Wrap `request.session` to lazily load values provided
     # in the RPC call (set by the previous calls)
     class SessionProxy
-      delegate_missing_to :@rack_session
-
       attr_reader :rack_session, :socket_session
 
       def initialize(rack_session, socket_session)
@@ -41,6 +39,25 @@ module AnyCable
         rack_session.keys + socket_session.keys
       end
 
+      # Delegate both publuc and private methods to rack_session
+      def respond_to_missing?(name, include_private = false)
+        return false if name == :marshal_dump || name == :_dump
+        rack_session.respond_to?(name, include_private) || super
+      end
+
+      def method_missing(method, *args, &block)
+        if rack_session.respond_to?(method, true)
+          rack_session.send(method, *args, &block)
+        else
+          super
+        end
+      end
+
+      # This method is used by StimulusReflex to obtain `@by`
+      def instance_variable_get(name)
+        super || rack_session.instance_variable_get(name)
+      end
+
       private
 
       def restore!

data/lib/anycable/rails/version.rb

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

data/lib/generators/anycable/download/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Install AnyCable-Go web server.
+
+Example:
+    rails generate anycable:download
+
+    This will ask:
+        Where to store a binary file.
+    This will create:
+        `<bin_path>/anycable-go`.
+
+    rails generate anycable:download --bin-path=/usr/local/bin
+
+    rails generate anycable:download --version=1.0.0

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "generators/anycable/with_os_helpers"
+
+module AnyCableRailsGenerators
+  # Downloads anycable-go binary
+  class DownloadGenerator < ::Rails::Generators::Base
+    namespace "anycable:download"
+
+    include WithOSHelpers
+
+    # TODO: change to latest release
+    VERSION = "1.0.0.preview1"
+
+    class_option :bin_path,
+      type: :string,
+      desc: "Where to download AnyCable-Go server binary (default: #{DEFAULT_BIN_PATH})"
+    class_option :version,
+      type: :string,
+      desc: "Specify the AnyCable-Go version (defaults to latest release)"
+
+    def download_bin
+      out = options[:bin_path] || DEFAULT_BIN_PATH
+      version = options[:version] || VERSION
+
+      download_exe(
+        release_url(version),
+        to: out,
+        file_name: "anycable-go"
+      )
+
+      true
+    end
+
+    private
+
+    def release_url(version)
+      if Gem::Version.new(version).segments.first >= 1
+        new_release_url(version)
+      else
+        legacy_release_url(version)
+      end
+    end
+
+    def legacy_release_url(version)
+      "https://github.com/anycable/anycable-go/releases/download/v#{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}/" \
+        "anycable-go-#{os_name}-#{cpu_name}"
+    end
+
+    def download_exe(url, to:, file_name:)
+      file_path = File.join(to, file_name)
+
+      run "#{sudo(to)}curl -L #{url} -o #{file_path}", abort_on_failure: true
+      run "#{sudo(to)}chmod +x #{file_path}", abort_on_failure: true
+      run "#{file_path} -v", abort_on_failure: true
+    end
+
+    def sudo(path)
+      sudo = ""
+      unless File.writable?(path)
+        if yes? "Path is not writable 😕. Do you have sudo privileges?"
+          sudo = "sudo "
+        else
+          say_status :error, "❌ Failed to install AnyCable-Go WebSocket server", :red
+          raise StandardError, "Path #{path} is not writable!"
+        end
+      end
+
+      sudo
+    end
+  end
+end

data/lib/generators/anycable/setup/USAGE

@@ -0,0 +1,2 @@
+Description:
+    Configures your application to work with AnyCable interactively.

data/lib/{rails/generators → generators}/anycable/setup/setup_generator.rb

@@ -1,34 +1,23 @@
 # frozen_string_literal: true
 
+require "generators/anycable/with_os_helpers"
+
 module AnyCableRailsGenerators
   # Entry point for interactive installation
   class SetupGenerator < ::Rails::Generators::Base
     namespace "anycable:setup"
     source_root File.expand_path("templates", __dir__)
 
-    METHODS = %w[skip local docker].freeze
-    # TODO(release): change to latest release
-    SERVER_VERSION = "v1.0.0.preview1"
-    OS_NAMES = %w[linux darwin freebsd win].freeze
-    CPU_NAMES = %w[amd64 arm64 386 arm].freeze
+    DOCS_ROOT = "https://docs.anycable.io/v1/#"
+    DEVELOPMENT_METHODS = %w[skip local docker].freeze
     SERVER_SOURCES = %w[skip brew binary].freeze
-    DEFAULT_BIN_PATH = "/usr/local/bin"
 
-    class_option :method,
+    class_option :devenv,
       type: :string,
-      desc: "Select your development environment (options: #{METHODS.join(", ")})"
+      desc: "Select your development environment (options: #{DEVELOPMENT_METHODS.join(", ")})"
     class_option :source,
       type: :string,
       desc: "Choose a way of installing AnyCable-Go server (options: #{SERVER_SOURCES.join(", ")})"
-    class_option :bin_path,
-      type: :string,
-      desc: "Where to download AnyCable-Go server binary (default: #{DEFAULT_BIN_PATH})"
-    class_option :os,
-      type: :string,
-      desc: "Specify the OS for AnyCable-Go server binary (options: #{OS_NAMES.join(", ")})"
-    class_option :cpu,
-      type: :string,
-      desc: "Specify the CPU architecturefor AnyCable-Go server binary (options: #{CPU_NAMES.join(", ")})"
     class_option :skip_heroku,
       type: :boolean,
       desc: "Do not copy Heroku configs"
@@ -36,6 +25,15 @@ module AnyCableRailsGenerators
       type: :boolean,
       desc: "Do not create Procfile.dev"
 
+    include WithOSHelpers
+
+    class_option :bin_path,
+      type: :string,
+      desc: "Where to download AnyCable-Go server binary (default: #{DEFAULT_BIN_PATH})"
+    class_option :version,
+      type: :string,
+      desc: "Specify the AnyCable-Go version (defaults to latest release)"
+
     def welcome
       say "👋 Welcome to AnyCable interactive installer."
     end
@@ -51,32 +49,32 @@ 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:3334/cable").presence
+          config.action_cable.url = ENV.fetch("CABLE_URL", "ws://localhost:8080/cable") if AnyCable::Rails.enabled?
         SNIPPET
       end
 
       environment(nil, env: :production) do
         <<~SNIPPET
           # Specify AnyCable WebSocket server URL to use by JS client
-          config.action_cable.url = ENV["CABLE_URL"].presence
+          config.action_cable.url = ENV.fetch("CABLE_URL") if AnyCable::Rails.enabled?
         SNIPPET
       end
 
       say_status :info, "✅ 'config.action_cable.url' has been configured"
-      say_status :help, "⚠️ If you're using JS client make sure you have " \
+      say_status :help, "⚠️  If you're using JS client make sure you have " \
                         "`action_cable_meta_tag` included before any <script> tag in your application.html"
     end
 
     def development_method
-      answer = METHODS.index(options[:method]) || 99
+      answer = DEVELOPMENT_METHODS.index(options[:devenv]) || 99
 
-      until METHODS[answer.to_i]
+      until DEVELOPMENT_METHODS[answer.to_i]
         answer = ask "Which environment do you use for development? (1) Local, (2) Docker, (0) Skip"
       end
 
-      case env = METHODS[answer.to_i]
+      case env = DEVELOPMENT_METHODS[answer.to_i]
       when "skip"
-        say_status :help, "⚠️ Please, read this guide on how to install AnyCable-Go server 👉 https://docs.anycable.io/#/anycable-go/getting_started", :yellow
+        say_status :help, "⚠️  Please, read this guide on how to install AnyCable-Go server 👉 #{DOCS_ROOT}/anycable-go/getting_started", :yellow
       else
         send "install_for_#{env}"
       end
@@ -84,15 +82,21 @@ module AnyCableRailsGenerators
 
     def heroku
       if options[:skip_heroku].nil?
-        return unless yes? "Do you use Heroku for deployment?"
+        return unless yes? "Do you use Heroku for deployment? [Yn]"
       elsif options[:skip_heroku]
         return
       end
 
-      template "Procfile"
-      inside("bin") { template "heroku-web" }
+      in_root do
+        next unless File.file?("Procfile")
+
+        contents = File.read("Procfile")
+        contents.sub!(/^web: (.*)$/, %q(web: [[ "$ANYCABLE_DEPLOYMENT" == "true" ]] && bundle exec anycable --server-command="anycable-go" || \1))
+        File.write("Procfile", contents)
+        say_status :info, "✅ Procfile updated"
+      end
 
-      say_status :help, "️️⚠️ Please, read the required steps to configure Heroku applications 👉 https://docs.anycable.io/#/deployment/heroku", :yellow
+      say_status :help, "️️⚠️  Please, read the required steps to configure Heroku applications 👉 #{DOCS_ROOT}/deployment/heroku", :yellow
     end
 
     def devise
@@ -107,6 +111,14 @@ module AnyCableRailsGenerators
       say_status :info, "✅ config/initializers/anycable.rb with Devise configuration has been added"
     end
 
+    def rubocop_compatibility
+      return unless rubocop?
+
+      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
+    end
+
     def finish
       say_status :info, "✅ AnyCable has been configured successfully!"
     end
@@ -114,7 +126,15 @@ module AnyCableRailsGenerators
     private
 
     def stimulus_reflex?
-      !gemfile_lock&.match?(/^\s+stimulus_reflex\b/).nil?
+      !!gemfile_lock&.match?(/^\s+stimulus_reflex\b/)
+    end
+
+    def redis?
+      !!gemfile_lock&.match?(/^\s+redis\b/)
+    end
+
+    def rubocop?
+      !!gemfile_lock&.match?(/^\s+rubocop\b/)
     end
 
     def gemfile_lock
@@ -129,24 +149,23 @@ module AnyCableRailsGenerators
     end
 
     def install_for_docker
-      say_status :help, "️️⚠️ Docker development configuration could vary", :yellow
+      say_status :help, "️️⚠️  Docker development configuration could vary", :yellow
 
       say "Here is an example snippet for docker-compose.yml:"
       say <<~YML
         ─────────────────────────────────────────
-        anycable-ws:
-          image: anycable/anycable-go:v0.6.4
+        ws:
+          image: anycable/anycable-go:1.0.0.preview1
           ports:
-            - '3334:3334'
+            - '8080:8080'
           environment:
-            PORT: 3334
             ANYCABLE_REDIS_URL: redis://redis:6379/0
-            ANYCABLE_RPC_HOST: anycable-rpc:50051
+            ANYCABLE_RPC_HOST: anycable:50051
           depends_on:
             - anycable-rpc
             - redis
 
-        anycable-rpc:
+        anycable:
           <<: *backend
           command: bundle exec anycable
           environment:
@@ -173,7 +192,7 @@ module AnyCableRailsGenerators
 
       case answer.to_i
       when 0
-        say_status :help, "⚠️ Please, read this guide on how to install AnyCable-Go server 👉 https://docs.anycable.io/#/anycable-go/getting_started", :yellow
+        say_status :help, "⚠️  Please, read this guide on how to install AnyCable-Go server 👉 #{DOCS_ROOT}/anycable-go/getting_started", :yellow
         return
       else
         return unless send("install_from_#{SERVER_SOURCES[answer.to_i]}")
@@ -206,63 +225,22 @@ module AnyCableRailsGenerators
     end
 
     def install_from_binary
-      out = options[:bin_path] if options[:bin_path]
-      out ||= "/usr/local/bin" if options[:method] # User don't want interactive mode
-      out ||= ask "Please, enter the path to download the AnyCable-Go binary to", default: DEFAULT_BIN_PATH, path: true
+      bin_path ||= DEFAULT_BIN_PATH if options[:devenv] # User don't want interactive mode
+      bin_path ||= ask "Please, enter the path to download the AnyCable-Go binary to", default: DEFAULT_BIN_PATH, path: true
 
-      os_name = options[:os] ||
-        OS_NAMES.find(&Gem::Platform.local.os.method(:==)) ||
-        ask("What is your OS name?", limited_to: OS_NAMES)
-
-      cpu_name = options[:cpu] ||
-        CPU_NAMES.find(&current_cpu.method(:==)) ||
-        ask("What is your CPU architecture?", limited_to: CPU_NAMES)
-
-      download_exe(
-        "https://github.com/anycable/anycable-go/releases/download/#{SERVER_VERSION}/" \
-        "anycable-go-#{os_name}-#{cpu_name}",
-        to: out,
-        file_name: "anycable-go"
-      )
+      generate "anycable:download", download_options(bin_path: bin_path)
 
       true
     end
 
-    def download_exe(url, to:, file_name:)
-      file_path = File.join(to, file_name)
-
-      run "#{sudo(to)}curl -L #{url} -o #{file_path}", abort_on_failure: true
-      run "#{sudo(to)}chmod +x #{file_path}", abort_on_failure: true
-      run "#{file_path} -v", abort_on_failure: true
-    end
-
-    def sudo!(path)
-      sudo = ""
-      unless File.writable?(path)
-        if yes? "Path is not writable 😕. Do you have sudo privileges?"
-          sudo = "sudo "
-        else
-          say_status :error, "❌ Failed to install AnyCable-Go WebSocket server", :red
-          raise StandardError, "Path #{path} is not writable!"
-        end
-      end
-
-      sudo
-    end
-
-    def current_cpu
-      case Gem::Platform.local.cpu
-      when "x86_64", "x64"
-        "amd64"
-      when "x86_32", "x86", "i386", "i486", "i686"
-        "i386"
-      when "aarch64", "aarch64_be", /armv8/
-        "arm64"
-      when "arm", /armv7/, /armv6/
-        "arm"
-      else
-        "unknown"
-      end
+    def download_options(**params)
+      opts = options.merge(params)
+      [].tap do |args|
+        args << "--os #{opts[:os]}" if opts[:os]
+        args << "--cpu #{opts[:cpu]}" if opts[:cpu]
+        args << "--bin-path=#{opts[:bin_path]}" if opts[:bin_path]
+        args << "--version #{opts[:version]}" if opts[:version]
+      end.join(" ")
     end
   end
 end