anycable-rails 1.0.7 → 1.3.4

data/lib/anycable/rails/connections/persistent_session.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "anycable/rails/connections/session_proxy"
+
+module AnyCable
+  module Rails
+    module Connections
+      module PersistentSession
+        def handle_open
+          super.tap { commit_session! }
+        end
+
+        def handle_channel_command(*)
+          super.tap { commit_session! }
+        end
+
+        def build_rack_request(env)
+          return super unless socket.session
+
+          super.tap do |req|
+            req.env[::Rack::RACK_SESSION] =
+              SessionProxy.new(req.env[::Rack::RACK_SESSION], socket.session)
+          end
+        end
+
+        private
+
+        def commit_session!
+          return unless request_loaded? && request.session.respond_to?(:loaded?) && request.session.loaded?
+
+          socket.session = request.session.to_json
+        end
+      end
+    end
+  end
+end
+
+AnyCable::Rails::Connection.prepend(
+  AnyCable::Rails::Connections::PersistentSession
+)

data/lib/anycable/rails/connections/serializable_identification.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module AnyCable
+  module Rails
+    module Connections
+      module SerializableIdentification
+        extend ActiveSupport::Concern
+
+        class_methods do
+          def identified_by(*identifiers)
+            super
+            Array(identifiers).each do |identifier|
+              define_method(identifier) do
+                instance_variable_get(:"@#{identifier}") || fetch_identifier(identifier)
+              end
+            end
+          end
+        end
+
+        # Generate identifiers info.
+        # Converts GlobalID compatible vars to corresponding global IDs params.
+        def identifiers_hash
+          identifiers.each_with_object({}) do |id, acc|
+            obj = instance_variable_get("@#{id}")
+            next unless obj
+
+            acc[id] = AnyCable::Rails.serialize(obj)
+          end.compact
+        end
+
+        def identifiers_json
+          identifiers_hash.to_json
+        end
+
+        # Fetch identifier and deserialize if neccessary
+        def fetch_identifier(name)
+          return unless @cached_ids
+
+          @cached_ids[name] ||= @cached_ids.fetch(name) do
+            AnyCable::Rails.deserialize(@serialized_ids[name.to_s])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/anycable/rails/connections/session_proxy.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module AnyCable
+  module Rails
+    module Connections
+      # Wrap `request.session` to lazily load values provided
+      # in the RPC call (set by the previous calls)
+      class SessionProxy
+        attr_reader :rack_session, :socket_session
+
+        def initialize(rack_session, socket_session)
+          @rack_session = rack_session
+          @socket_session = JSON.parse(socket_session).with_indifferent_access
+        end
+
+        %i[has_key? [] []= fetch delete dig].each do |mid|
+          class_eval <<~CODE, __FILE__, __LINE__ + 1
+            def #{mid}(*args, **kwargs, &block)
+              restore_key! args.first
+              rack_session.#{mid}(*args, **kwargs, &block)
+            end
+          CODE
+        end
+
+        alias_method :include?, :has_key?
+        alias_method :key?, :has_key?
+
+        %i[update merge! to_hash].each do |mid|
+          class_eval <<~CODE, __FILE__, __LINE__ + 1
+            def #{mid}(*args, **kwargs, &block)
+              restore!
+              rack_session.#{mid}(*args, **kwargs, &block)
+            end
+          CODE
+        end
+
+        alias_method :to_h, :to_hash
+
+        def keys
+          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!
+          socket_session.keys.each(&method(:restore_key!))
+        end
+
+        def restore_key!(key)
+          return unless socket_session.key?(key)
+          val = socket_session.delete(key)
+          rack_session[key] =
+            if val.is_a?(String)
+              GlobalID::Locator.locate(val) || val
+            else
+              val
+            end
+        end
+      end
+    end
+  end
+end

data/lib/anycable/rails/middlewares/log_tagging.rb

@@ -9,8 +9,8 @@ module AnyCable
       #
       # See https://github.com/grpc/grpc-go/blob/master/Documentation/grpc-metadata.md
       class LogTagging < AnyCable::Middleware
-        def call(_request, call, _method)
-          sid = call.metadata["sid"]
+        def call(_method, _request, metadata)
+          sid = metadata["sid"]
           return yield unless sid
 
           AnyCable.logger.tagged("AnyCable sid=#{sid}") { yield }

data/lib/anycable/rails/railtie.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
+require "anycable/rails/action_cable_ext/connection"
+require "anycable/rails/action_cable_ext/channel"
+require "anycable/rails/action_cable_ext/remote_connections"
+
 require "anycable/rails/channel_state"
+require "anycable/rails/connection_factory"
 
 module AnyCable
   module Rails
@@ -15,13 +20,14 @@ module AnyCable
         AnyCable.logger = ::ActionCable.server.config.logger
 
         AnyCable.configure_server do
-          AnyCable.logger = ActiveSupport::TaggedLogging.new(::ActionCable.server.config.logger)
+          server_logger = AnyCable.logger = ::ActionCable.server.config.logger
+          AnyCable.logger = ActiveSupport::TaggedLogging.new(server_logger) if server_logger.is_a?(::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
+            console.formatter = ::Rails.logger.formatter if ::Rails.logger.respond_to?(:formatter)
+            console.level = ::Rails.logger.level if ::Rails.logger.respond_to?(:level)
             AnyCable.logger.extend(ActiveSupport::Logger.broadcast(console))
           end
         end
@@ -43,22 +49,25 @@ 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
+            AnyCable.connection_factory = AnyCable::Rails::ConnectionFactory.new
           end
 
-          if AnyCable::Rails.enabled?
-            require "anycable/rails/actioncable/connection"
-            if AnyCable.config.persistent_session_enabled
-              require "anycable/rails/actioncable/connection/persistent_session"
-            end
+          if AnyCable.config.persistent_session_enabled?
+            require "anycable/rails/connections/persistent_session"
           end
         end
       end
+
+      # Since Rails 6.1
+      if respond_to?(:server)
+        server do
+          next unless AnyCable.config.embedded? && AnyCable::Rails.enabled?
+
+          require "anycable/cli"
+          AnyCable::CLI.embed!
+        end
+      end
     end
   end
 end

data/lib/anycable/rails/version.rb

@@ -2,6 +2,6 @@
 
 module AnyCable
   module Rails
-    VERSION = "1.0.7"
+    VERSION = "1.3.4"
   end
 end

data/lib/anycable/rails.rb

@@ -48,6 +48,17 @@ module AnyCable
           val
         end
       end
+
+      module Extension
+        def broadcast(channel, payload)
+          super
+          ::AnyCable.broadcast(channel, payload)
+        end
+      end
+
+      def extend_adapter!(adapter)
+        adapter.extend(Extension)
+      end
     end
   end
 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/#"
+    DOCS_ROOT = "https://docs.anycable.io"
     DEVELOPMENT_METHODS = %w[skip local docker].freeze
     SERVER_SOURCES = %w[skip brew binary].freeze
 
@@ -24,6 +24,12 @@ module AnyCableRailsGenerators
     class_option :skip_procfile_dev,
       type: :boolean,
       desc: "Do not create Procfile.dev"
+    class_option :skip_jwt,
+      type: :boolean,
+      desc: "Do not install anycable-rails-jwt"
+    class_option :skip_install,
+      type: :boolean,
+      desc: "Do not run bundle install when adding new gems"
 
     include WithOSHelpers
 
@@ -59,7 +65,7 @@ module AnyCableRailsGenerators
         <<~SNIPPET
           # Specify AnyCable WebSocket server URL to use by JS client
           config.after_initialize do
-            config.action_cable.url = ActionCable.server.config.url = ENV.fetch("CABLE_URL") if AnyCable::Rails.enabled?
+            config.action_cable.url = ActionCable.server.config.url = ENV.fetch("CABLE_URL", "/cable") if AnyCable::Rails.enabled?
           end
         SNIPPET
       end
@@ -118,7 +124,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/#/rails/stimulus_reflex"
+      say_status :help, "⚠️  Please, check out the documentation on using AnyCable with Stimulus Reflex: #{DOCS_ROOT}/rails/stimulus_reflex"
     end
 
     def rubocop_compatibility
@@ -126,7 +132,17 @@ 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/#/rails/compatibility" unless res
+      say_status :help, "⚠️  Please, take a look at the icompatibilities above and fix them. See #{DOCS_ROOT}/rails/compatibility" unless res
+    end
+
+    def jwt
+      return if options[:skip_jwt]
+
+      return unless options[:skip_jwt] == false || yes?("Do you want to use JWT for authentication? [Yn]")
+
+      opts = " --skip-install" if options[:skip_install]
+
+      run "bundle add anycable-rails-jwt#{opts}"
     end
 
     def finish
@@ -172,7 +188,7 @@ module AnyCableRailsGenerators
       say <<~YML
         ─────────────────────────────────────────
         ws:
-          image: anycable/anycable-go:1.0
+          image: anycable/anycable-go:1.2
           ports:
             - '8080:8080'
           environment:

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

@@ -28,7 +28,7 @@ default: &default
   broadcast_adapter: http
   <%- end -%>
   # Use the same channel name for WebSocket server, e.g.:
-  #   $ anycable-go --redis-channel="__anycable__"
+  #   $ anycable-go --redis_channel="__anycable__"
   redis_channel: "__anycable__"
   <%- if redis? -%>
   # You can use REDIS_URL env var to configure Redis URL.

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: anycable-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.3.4
 platform: ruby
 authors:
 - palkan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-05 00:00:00.000000000 Z
+date: 2022-06-28 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
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: actioncable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: globalid
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: ammeter
   requirement: !ruby/object:Gem::Requirement
@@ -164,12 +150,9 @@ files:
 - lib/action_cable/subscription_adapter/anycable.rb
 - lib/anycable-rails.rb
 - lib/anycable/rails.rb
-- lib/anycable/rails/actioncable/channel.rb
-- lib/anycable/rails/actioncable/connection.rb
-- 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/action_cable_ext/channel.rb
+- lib/anycable/rails/action_cable_ext/connection.rb
+- lib/anycable/rails/action_cable_ext/remote_connections.rb
 - lib/anycable/rails/channel_state.rb
 - lib/anycable/rails/compatibility.rb
 - lib/anycable/rails/compatibility/rubocop.rb
@@ -178,12 +161,15 @@ files:
 - lib/anycable/rails/compatibility/rubocop/cops/anycable/periodical_timers.rb
 - lib/anycable/rails/compatibility/rubocop/cops/anycable/stream_from.rb
 - lib/anycable/rails/config.rb
+- lib/anycable/rails/connection.rb
+- lib/anycable/rails/connection_factory.rb
+- lib/anycable/rails/connections/persistent_session.rb
+- lib/anycable/rails/connections/serializable_identification.rb
+- lib/anycable/rails/connections/session_proxy.rb
 - lib/anycable/rails/middlewares/executor.rb
 - lib/anycable/rails/middlewares/log_tagging.rb
 - lib/anycable/rails/rack.rb
 - lib/anycable/rails/railtie.rb
-- lib/anycable/rails/refinements/subscriptions.rb
-- lib/anycable/rails/session_proxy.rb
 - lib/anycable/rails/version.rb
 - lib/generators/anycable/download/USAGE
 - lib/generators/anycable/download/download_generator.rb
@@ -203,7 +189,8 @@ metadata:
   documentation_uri: https://docs.anycable.io/#/using_with_rails
   homepage_uri: https://anycable.io/
   source_code_uri: http://github.com/anycable/anycable-rails
-post_install_message: 
+  funding_uri: https://github.com/sponsors/anycable
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -211,15 +198,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Rails adapter for AnyCable
 test_files: []

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

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require "action_cable/channel"
-
-module ActionCable
-  module Channel
-    class Base # :nodoc:
-      alias_method :handle_subscribe, :subscribe_to_channel
-
-      public :handle_subscribe, :subscription_rejected?
-
-      # Action Cable calls this method from inside the Subscriptions#add
-      # method, which we use to initialize the channel instance.
-      # We don't want to invoke `subscribed` callbacks every time we do that.
-      def subscribe_to_channel
-        # noop
-      end
-
-      def start_periodic_timers
-        # noop
-      end
-
-      def stop_periodic_timers
-        # noop
-      end
-
-      def stream_from(broadcasting, _callback = nil, _options = {})
-        connection.socket.subscribe identifier, broadcasting
-      end
-
-      def stop_stream_from(broadcasting)
-        connection.socket.unsubscribe identifier, broadcasting
-      end
-
-      def stop_all_streams
-        connection.socket.unsubscribe_from_all identifier
-      end
-    end
-  end
-end

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

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module ActionCable
-  module Connection
-    module PersistentSession
-      def handle_open
-        super.tap { commit_session! }
-      end
-
-      def handle_channel_command(*)
-        super.tap { commit_session! }
-      end
-
-      def build_rack_request
-        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)
-        end
-      end
-
-      def commit_session!
-        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/connection/serializable_identification.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module ActionCable
-  module Connection
-    module SerializableIdentification
-      extend ActiveSupport::Concern
-
-      class_methods do
-        def identified_by(*identifiers)
-          super
-          Array(identifiers).each do |identifier|
-            define_method(identifier) do
-              instance_variable_get(:"@#{identifier}") || fetch_identifier(identifier)
-            end
-          end
-        end
-      end
-
-      # Generate identifiers info.
-      # Converts GlobalID compatible vars to corresponding global IDs params.
-      def identifiers_hash
-        identifiers.each_with_object({}) do |id, acc|
-          obj = instance_variable_get("@#{id}")
-          next unless obj
-
-          acc[id] = AnyCable::Rails.serialize(obj)
-        end.compact
-      end
-
-      def identifiers_json
-        identifiers_hash.to_json
-      end
-
-      # Fetch identifier and deserialize if neccessary
-      def fetch_identifier(name)
-        @cached_ids[name] ||= @cached_ids.fetch(name) do
-          AnyCable::Rails.deserialize(ids[name.to_s])
-        end
-      end
-    end
-  end
-end