anycable-rails 1.1.2 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 685b7383d4271b532926db2d03a03d5601ee3e17d0b3215a61a675fcbe88b04f
-  data.tar.gz: b7472589e36cff91a90cd0a8735aebcc50d269c52a357e6ac39a22a1cd6f90b3
+  metadata.gz: d21ee870a0caaeed44d71d571303e0e9ab835457360ee1b205279f38379716e2
+  data.tar.gz: 0e1f4c986782474601d40228ae272ab795bd038ad837420b9a689f74c91edfcf
 SHA512:
-  metadata.gz: df90a5b6cbde849fe23765fb8b42632d891d849b0cd8a6d867c0fcfcaa0e11d9504859b6842ffeb600eaec429cf6551a2e14546628f1786ca8f0cc0bccebb55c
-  data.tar.gz: cbf7b61205381c41c6556a32916f30c2d2beb24af62fe742cd151b314b0209393278fa229a1c84fd6484e0584b53f32a0d238d2a3bbe23cdd422e09c41bb31d0
+  metadata.gz: 7cd248fd53e2f09632a9fec2e3439c788f70b96b40270480b0b519ac70738740df783afc7bf7d107bf718dfe08cf31e8880796beace87cc87b20b5aa69cf90e2
+  data.tar.gz: 6c8e6cedcdd61b58e0dcfd82dfa72a4f3f1e0591bb90e27ef7b8b5c10bbe51a37163f83b12daba720f64f9519cbeadb9fbcb24e9d9af5ec84e988faa1cc54ad0

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 ## master
 
+## 1.2.1 (2021-01-31)
+
+- Add a temporary fix to be compatible with `sentry-rails`. ([@palkan][])
+
+See [#165](https://github.com/anycable/anycable-rails/issues/165).
+
+- Run embedded RPC server only if `any_cable` adapter is used for Action Cable. ([@palkan][])
+
+## 1.2.0 (2021-12-21) 🎄
+
+- Drop Rails 5 support.
+
+- Drop Ruby 2.6 support.
+
+## 1.1.4 (2021-11-11)
+
+- Added `Connection#state_attr_accessor`. ([@palkan][])
+
+## 1.1.3 (2021-10-11)
+
+- Relax Action Cable dependency. ([@palkan][])
+
+Action Cable 5.1 is allowed (though not recommended).
+
 ## 1.1.2 (2021-06-23)
 
 - Bring back dependency on `anycable` (instead of `anycable-core`). ([@palkan][])

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2017-2021 palkan
+Copyright 2017-2022 palkan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -15,13 +15,15 @@ You can even use Action Cable in development and not be afraid of [compatibility
 
 📑 [Documentation](https://docs.anycable.io/rails/getting_started).
 
+> [AnyCable Pro](https://docs.anycable.io/pro) has been launched 🚀
+
 <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>
 
 ## Requirements
 
 - Ruby >= 2.6
-- Rails >= 6.0
+- Rails >= 6.0 (Rails 5.1 could work but we're no longer enforce compatibility on CI)
 - Redis (see [other options](https://github.com/anycable/anycable/issues/2) for broadcasting)
 
 ## Usage

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

@@ -9,7 +9,6 @@ require "anycable/rails/session_proxy"
 
 module ActionCable
   module Connection
-    # rubocop: disable Metrics/ClassLength
     class Base # :nodoc:
       # We store logger tags in the connection state to be able
       # to re-use them in the subsequent calls
@@ -98,7 +97,6 @@ module ActionCable
         true
       end
 
-      # rubocop:disable Metrics/MethodLength
       def handle_channel_command(identifier, command, data)
         channel = subscriptions.fetch(identifier)
         case command

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

@@ -5,7 +5,7 @@
 # Trigger autoload (if constant is defined)
 begin
   ActionCable::Channel::TestCase # rubocop:disable Lint/Void
-  ActionCable::Connection::TestCase # rubocop:disable Lint/Void
+  ActionCable::Connection::TestCase
 rescue NameError
   return
 end

data/lib/anycable/rails/channel_state.rb

@@ -44,10 +44,65 @@ module AnyCable
         @__istate__ ||= connection.socket.istate
       end
     end
+
+    module ConnectionState
+      module ClassMethods
+        def state_attr_accessor(*names)
+          names.each do |name|
+            connection_state_attributes << name
+            class_eval <<~RUBY, __FILE__, __LINE__ + 1
+              def #{name}
+                return @#{name} if instance_variable_defined?(:@#{name})
+                @#{name} = AnyCable::Rails.deserialize(__cstate__["#{name}"], json: true) if anycable_socket
+              end
+
+              def #{name}=(val)
+                __cstate__["#{name}"] = AnyCable::Rails.serialize(val, json: true) if anycable_socket
+                instance_variable_set(:@#{name}, val)
+              end
+            RUBY
+          end
+        end
+
+        def connection_state_attributes
+          return @connection_state_attributes if instance_variable_defined?(:@connection_state_attributes)
+
+          @connection_state_attributes =
+            if superclass.respond_to?(:connection_state_attributes)
+              superclass.connection_state_attributes.dup
+            else
+              []
+            end
+        end
+      end
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      # Make it possible to provide istate explicitly for a connection instance
+      attr_writer :__cstate__
+
+      def __cstate__
+        @__cstate__ ||= socket.cstate
+      end
+    end
   end
 end
 
-ActiveSupport.on_load(:action_cable) do
+if ActiveSupport::VERSION::MAJOR < 6
+  # `state_attr_accessor` must be available in Action Cable
+  ActiveSupport.on_load(:action_cable) do
+    ::ActionCable::Connection::Base.include(AnyCable::Rails::ConnectionState)
+    ::ActionCable::Channel::Base.include(AnyCable::Rails::ChannelState)
+  end
+else
   # `state_attr_accessor` must be available in Action Cable
-  ::ActionCable::Channel::Base.include(AnyCable::Rails::ChannelState)
+  ActiveSupport.on_load(:action_cable_connection) do
+    ::ActionCable::Connection::Base.include(AnyCable::Rails::ConnectionState)
+  end
+
+  ActiveSupport.on_load(:action_cable_channel) do
+    ::ActionCable::Channel::Base.include(AnyCable::Rails::ChannelState)
+  end
 end

data/lib/anycable/rails/railtie.rb

@@ -60,10 +60,17 @@ module AnyCable
         end
       end
 
+      # Temp hack to fix Sentry vs AnyCable incompatibility
+      # See https://github.com/anycable/anycable-rails/issues/165
+      initializer "anycable.sentry_hack", after: :"sentry.extend_action_cable" do
+        next unless defined?(::Sentry::Rails::ActionCableExtensions::Connection)
+        Sentry::Rails::ActionCableExtensions::Connection.send :public, :handle_open, :handle_close
+      end
+
       # Since Rails 6.1
       if respond_to?(:server)
         server do
-          next unless AnyCable.config.embedded?
+          next unless AnyCable.config.embedded? && AnyCable::Rails.enabled?
 
           require "anycable/cli"
           AnyCable::CLI.embed!

data/lib/anycable/rails/version.rb

@@ -2,6 +2,6 @@
 
 module AnyCable
   module Rails
-    VERSION = "1.1.2"
+    VERSION = "1.2.1"
   end
 end

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

@@ -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
@@ -129,6 +135,16 @@ module AnyCableRailsGenerators
       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
       say_status :info, "✅ AnyCable has been configured successfully!"
     end
@@ -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:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anycable-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.1
 platform: ruby
 authors:
 - palkan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-23 00:00:00.000000000 Z
+date: 2022-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anycable
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: actioncable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: globalid
   requirement: !ruby/object:Gem::Requirement
@@ -198,14 +198,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Rails adapter for AnyCable