anycable-rails 0.6.3 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12096ddf13bcb4893853e537017bc5478c8c65c7f8aea4a21af221d5e4cf1ce3
-  data.tar.gz: 252d1fc76c09a902229b192afd61c020503a78bf773d53a8dc2e409e1a984310
+  metadata.gz: 36b6e47a498bfc2d1156e4635a5c30f60258c925142c59ad837c1b6708f1ff73
+  data.tar.gz: f27c94856df0db9d178537e8ac75598f8a355b338e725a80a5cb06a6e0ac610c
 SHA512:
-  metadata.gz: 951b2d8c75b50dd632c7e7e49b36bf8c233d5c9d7335e0213aa5c291d4cf17bb7c9999f9bdf54bcdd2a29753d471b5b6ed3397e3403b07f7e7dba7f2d3e32a37
-  data.tar.gz: e1df94db573c5557784937b2a44152e2e1cb59f0fd00d8532bd539e5fe8cf80a1abbf2dd605cb3025e622fddd23f59bdeb652256859d6f41b7b4462967e190c7
+  metadata.gz: 28b72e3f6a9950d3a95eb8d4f1c6a59f24a704ff63ac50384ffb2d22aa97c9f6b6e1f0c882a89cc6a0fd9ac22ea553a381514d56885f6f1cce41e7146153ab24
+  data.tar.gz: ac7c402d2b57a332ced9372a4546709d6b41a0fb082c823d292b87c8b11e4bf741047cbc10258f68acd228712f0ca974b6723246bd3ddc689920f656b1488974

data/CHANGELOG.md

@@ -1,124 +1,44 @@
 # Change log
 
-## master
+## 1.0.0.rc1 (2020-06-10)
 
-## 0.6.3 (2019-03-26)
+- Add `state_attr_accessor` for channels. ([@palkan][])
 
-- Fix connection factory reloading for development sake. ([@sponomarev][])
+Just like `attr_accessor` but "persists" the state between RPC calls.
 
-- Add `:anycable` subscription adapter alias. ([@sponomarev][])
+- Add `Channel#stop_stream_from` support. ([@palkan][])
 
-- Don't set AnyCable connection factory for incompatible adapter ([@sponomarev][])
+- Add `RemoteConnections` support. ([@palkan][])
 
-  `anycable` server won't start with unpatched vanilla `ApplicationCable::Connection`.
+- Add `AnyCable::Rails.enabled?` method which returns true if Action Cable uses AnyCable adapter. ([@palkan][])
 
-  Motivation in [#74](https://github.com/anycable/anycable-rails/issues/74).
+- Add `anycable:download` generator to download `anycable-go` binary. ([@palkan][])
 
-- Fix instance detection inside complex cases in compatibility cops ([@sponomarev][])
+- **Ruby 2.5+ is required**. ([@palkan][])
 
-## 0.6.2 (2019-01-10)
+- Support `disconnect` messages. ([@palkan][])
 
-- Fixed `anycable` 0.6.1 compatibility. ([@palkan][])
+Added in Rails 6 (see [PR#34194](https://github.com/rails/rails/pull/34194)).
 
-- Broadcast logs to STDOUT in development only when server is running. ([@palkan][])
+- Add ability to persist _dirty_ `request.session` between RPC calls. ([@palkan][])
 
-  Fixes #59.
+This feature emulates the Action Cable behaviour where it's possible to use `request.session` as a shared Hash-like store.
+This could be used by some applications (e.g., [StimulusReflex](https://github.com/hopsoft/stimulus_reflex)-based).
 
-## 0.6.1 (2018-11-15)
+You must turn this feature on by setting `persistent_session_enabled: true` in the AnyCable configuration.
 
-- Fix regression introduced in [e64a366e](https://github.com/anycable/anycable-rails/commit/e64a366ea21293925e0c5c0b8e6595d65d5d0981#diff-fd0e56a6e825002eac978507c3581af7R14) ([@palkan][])
+- Add ability to use Rack middlewares when build a request for a connection. ([@bibendi][])
 
-`Connection` patch could be loaded after `identify_by` is called, thus breaking
-identifiers.
+- Add set up generator to configure a Rails application by running `bin/rails g anycable:setup`. ([@bibendi][])
 
-## 0.6.0 (2018-11-15)
+- Require a minimum version of Ruby when installing the gem. ([@bibendi][])
 
-**NOTE**: this version has been yanked from RubyGems due to the regression bug. Use 0.6.1.
+- Add ability to develop the gem with Docker. ([@bibendi][])
 
-- [PR #56](https://github.com/anycable/anycable-rails/pull/56) Request verification based on ActionCable config. ([@DmitryTsepelev][])
-
-- Add WS server session ID to log tags if present. ([@palkan][])
-
-- Support tagged logging. ([@palkan][])
-
-- Action Cable monkey-patches are only loaded in the context of AnyCable CLI. ([@palkan][])
-
-  No need to think about `requie` and `group` for `anycable-rails`, just add it to Gemfile.
-
-- Add `:any_cable` subscription adapter for Action Cable. ([@palkan][])
-
-  Use `:any_cable` adapter for Action Cable to broadcast data to AnyCable.
-
-  No more `pubsub` monkey-patches 🎉.
-
-- Added Rails executor/reloader support. ([@palkan][])
-
-- **[Breaking]** No more generators. ([@palkan][])
-
-  No need to generate AnyCable runner script since `anycable` gem ships with
-  the CLI.
-
-- Add dynamic (`AnyCable::CompatibilityError`) compatibility checks. ([@DmitryTsepelev][])
-
-- Added static (RuboCop) compatibility checks. ([@DmitryTsepelev][])
-
-  See https://github.com/anycable/anycable-rails/issues/52
-
-## 0.5.4 (2018-06-13)
-
-- Fix duplicate logs in development. ([@palkan][])
-
-  Fixes https://github.com/anycable/anycable_demo/issues/5.
-
-## 0.5.3
-
-- Fix return value of `Connection#handle_close`. ([@palkan][])
-
-  Should always be `true`, we do not expect a failure here.
-
-## 0.5.2
-
-- Add config/anycable.yml to Rails generator. ([@alekseyl][])
-
-## 0.5.1
-
-- Improve Rails integration. ([@palkan][])
-
-Log to STDOUT in development.
-Make order of initializers more deterministic.
-Show warning if AnyCable is loaded after application initialization.
-
-## 0.5.0
-
-- [#17](https://github.com/anycable/anycable-rails/issues/17) Refactor logging. ([@palkan][])
-
-Use Rails logger everywhere.
-
-Add access logs ([anycable/anycable#20](https://github.com/anycable/anycable/issues/20)).
-
-## 0.4.7
-
-- Minor fixes. ([@palkan][])
-
-## 0.4.6
-
-- Disable mounting default Action Cable server when AnyCable is loaded. ([@palkan][])
-
-## 0.4.5
-
-- Handle tagged logger. ([@palkan][])
-
-Ignore tagged logger features ('cause we do not have _persistent_ logger).
-
-## 0.4.4
-
-- Fix bug with ActiveRecord connections (https://github.com/anycable/anycable/issues/9). ([@palkan][])
-
-## 0.4.0
-
-- Initial version. ([@palkan][])
+See [Changelog](https://github.com/anycable/anycable-rails/blob/0-6-stable/CHANGELOG.md) for versions <1.0.0.
 
 [@palkan]: https://github.com/palkan
 [@alekseyl]: https://github.com/alekseyl
 [@DmitryTsepelev]: https://github.com/DmitryTsepelev
 [@sponomarev]: https://github.com/sponomarev
+[@bibendi]: https://github.com/bibendi

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2017 palkan
+Copyright 2017-2020 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

@@ -1,6 +1,8 @@
-[![GitPitch](https://gitpitch.com/assets/badge.svg)](https://gitpitch.com/anycable/anycable/master?grs=github) [![Gem Version](https://badge.fury.io/rb/anycable-rails.svg)](https://rubygems.org/gems/anycable-rails) [![Build Status](https://travis-ci.org/anycable/anycable-rails.svg?branch=master)](https://travis-ci.org/anycable/anycable-rails)
+[![GitPitch](https://gitpitch.com/assets/badge.svg)](https://gitpitch.com/anycable/anycable/master?grs=github)
+[![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/#using_with_rails)
+[![Documentation](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://docs.anycable.io/v1/#/ruby/rails)
 
 # AnyCable Rails
 
@@ -10,27 +12,23 @@ With AnyCable you can use channels, client-side JS, broadcasting - (almost) all
 
 You can even use Action Cable in development and not be afraid of [compatibility issues](#compatibility).
 
-💾 [Example Application](https://github.com/anycable/anycable_demo)
+**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.
 
-📑 [Documentation](https://docs.anycable.io).
+<!-- 💾 [Example Application](https://github.com/anycable/anycable_demo) -->
 
+📑 [Documentation](https://docs.anycable.io/v1/#/ruby/rails).
 
 <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.4; **NOTE:** for Ruby 2.6 use RC version of `google-protobuf` gem. In your Gemfile: `gem "google-protobuf", '>=3.7.0.rc.2'`
-- Rails ~> 5.0;
-- Redis (see [other options]() for broadcasting)
-
-## How It Works?
-
-<img src="https://trello-attachments.s3.amazonaws.com/5781e0ed48e4679e302833d3/820x987/5b6a305417b04e20e75f49c5816e027c/Anycable_vs_ActionCable_copy.jpg" width="400" />
+- Ruby >= 2.5
+- Rails >= 5.2
+- Redis (see [other options](https://github.com/anycable/anycable/issues/2) for broadcasting)
 
 ## Usage
 
-
 Add `anycable-rails` gem to your Gemfile:
 
 ```ruby
@@ -40,14 +38,25 @@ gem "anycable-rails"
 gem "redis", ">= 4.0"
 ```
 
-(and don't forget to run `bundle install`).
+### Interactive set up
 
-Next, specify AnyCable subscription adapter for Action Cable:
+After the gem was installed, you can run an interactive wizard to configure your Rails application for using with AnyCable by running a generator:
+
+```sh
+bundle exec rails g anycable:setup
+```
+
+### Manual set up
+
+Specify AnyCable subscription adapter for Action Cable:
 
 ```yml
 # config/cable.yml
-production:
+development:
   adapter: any_cable # or anycable
+
+production:
+  adapter: any_cable
 ```
 
 and specify AnyCable WebSocket server URL:
@@ -64,9 +73,9 @@ config.action_cable.url = "ws://localhost:3334/cable"
 config.action_cable.url = "wss://ws.example.com/cable"
 ```
 
-hen, run AnyCable RPC server:
+Then, run AnyCable RPC server:
 
-```ruby
+```sh
 $ bundle exec anycable
 
 # don't forget to provide Rails env
@@ -74,38 +83,30 @@ $ bundle exec anycable
 $ RAILS_ENV=production bundle exec anycable
 ```
 
-And, finally, run AnyCable WebSocket server, e.g. [anycable-go](https://docs.anycable.io/#go_getting_started.md):
+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/#using_with_rails) for more information on AnyCable + Rails usage.
+See [documentation](https://docs.anycable.io/v1/#/ruby/rails) for more information on AnyCable + Rails usage.
 
 ## Action Cable Compatibility
 
-See [documentation](https://docs.anycable.io/#compatibility).
-
-## Links
+See [documentation](https://docs.anycable.io/v1/#/ruby/compatibility).
 
-- [AnyCable: Action Cable on steroids!](https://evilmartians.com/chronicles/anycable-actioncable-on-steroids)
-
-- [From Action to Any](https://medium.com/@leshchuk/from-action-to-any-1e8d863dd4cf) by [@alekseyl](https://github.com/alekseyl)
-
-## Talks
+## Contributing
 
-- One cable to rule them all, RubyKaigi 2018, [slides](https://speakerdeck.com/palkan/rubykaigi-2018-anycable-one-cable-to-rule-them-all) and [video](https://www.youtube.com/watch?v=jXCPuNICT8s) (EN)
+Bug reports and pull requests are welcome on GitHub at [https://github.com/anycable/anycable-rails](https://github.com/anycable/anycable-rails).
 
-- Wroc_Love.rb 2018 [slides](https://speakerdeck.com/palkan/wroc-love-dot-rb-2018-cables-cables-cables) and [video](https://www.youtube.com/watch?v=AUxFFOehiy0) (EN)
+## Development
 
-## Compatible WebSocket servers
+If you are familiar with Docker, you can use [DIP](https://github.com/bibendi/dip) to start developing the gem quickly.
 
-- [AnyCable Go](https://github.com/anycable/anycable-go)
-- [ErlyCable](https://github.com/anycable/erlycable)
+## License
 
-## Contributing
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/anycable/anycable-rails.
+## Security Contact
 
-## License
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+To report a security vulnerability, please contact us at `anycable@evilmartians.com`. We will coordinate the fix and disclosure.

data/lib/action_cable/subscription_adapter/any_cable.rb

@@ -7,7 +7,8 @@ module ActionCable
     # AnyCable subscription adapter delegates broadcasts
     # to AnyCable
     class AnyCable < Base
-      def initialize(*); end
+      def initialize(*)
+      end
 
       def broadcast(channel, payload)
         ::AnyCable.broadcast(channel, payload)

data/lib/anycable/rails.rb

@@ -3,6 +3,9 @@
 require "anycable"
 require "anycable/rails/version"
 require "anycable/rails/config"
+require "anycable/rails/rack"
+
+require "globalid"
 
 module AnyCable
   # Rails handler for AnyCable
@@ -11,8 +14,40 @@ module AnyCable
 
     ADAPTER_ALIASES = %w[any_cable anycable].freeze
 
-    def self.compatible_adapter?(adapter)
-      ADAPTER_ALIASES.include?(adapter)
+    class << self
+      def enabled?
+        adapter = ::ActionCable.server.config.cable&.fetch("adapter", nil)
+        compatible_adapter?(adapter)
+      end
+
+      def compatible_adapter?(adapter)
+        ADAPTER_ALIASES.include?(adapter)
+      end
+
+      # Serialize connection/channel state variable to string
+      # using GlobalID where possible or JSON (if json: true)
+      def serialize(obj, json: false)
+        obj.try(:to_gid_param) || (json ? obj.to_json : obj)
+      end
+
+      # Deserialize previously serialized value from string to
+      # Ruby object.
+      # 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)
+
+          gval = GlobalID::Locator.locate(val)
+          return gval if gval
+
+          next val unless json
+
+          JSON.parse(val)
+        end.yield_self do |val|
+          next val.with_indifferent_access if val.is_a?(Hash)
+          val
+        end
+      end
     end
   end
 end

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

@@ -9,6 +9,9 @@ module ActionCable
 
       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
@@ -25,6 +28,10 @@ module ActionCable
         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

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

@@ -1,43 +1,50 @@
 # frozen_string_literal: true
 
 require "action_cable/connection"
+require "anycable/rails/actioncable/connection/serializable_identification"
 require "anycable/rails/refinements/subscriptions"
 require "anycable/rails/actioncable/channel"
+require "anycable/rails/actioncable/remote_connections"
+require "anycable/rails/session_proxy"
 
 module ActionCable
   module Connection
     # rubocop: disable Metrics/ClassLength
     class Base # :nodoc:
-      # We store logger tags in identifiers to be able
+      # We store logger tags in the connection state to be able
       # to re-use them in the subsequent calls
       LOG_TAGS_IDENTIFIER = "__ltags__"
 
       using AnyCable::Refinements::Subscriptions
 
+      include SerializableIdentification
+
       attr_reader :socket
 
+      delegate :env, :session, to: :request
+
       class << self
         def call(socket, **options)
-          new(socket, options)
+          new(socket, nil, options)
         end
+      end
 
-        def identified_by(*identifiers)
-          super
-          Array(identifiers).each do |identifier|
-            define_method(identifier) do
-              instance_variable_get(:"@#{identifier}") || fetch_identifier(identifier)
-            end
-          end
+      def initialize(socket, env, identifiers: "{}", subscriptions: [])
+        if env
+          # If env is set, then somehow we're in the context of Action Cable
+          # Return and print a warning in #process
+          @request = ActionDispatch::Request.new(env)
+          return
         end
-      end
 
-      def initialize(socket, identifiers: "{}", subscriptions: [])
         @ids = ActiveSupport::JSON.decode(identifiers)
 
-        @ltags = ids.delete(LOG_TAGS_IDENTIFIER)
+        @ltags = socket.cstate.read(LOG_TAGS_IDENTIFIER).yield_self do |raw_tags|
+          next unless raw_tags
+          ActiveSupport::JSON.decode(raw_tags)
+        end
 
         @cached_ids = {}
-        @env = socket.env
         @coder = ActiveSupport::JSON
         @socket = socket
         @subscriptions = ActionCable::Connection::Subscriptions.new(self)
@@ -46,15 +53,32 @@ module ActionCable
         subscriptions.each { |id| @subscriptions.fetch(id) }
       end
 
+      def process
+        # Use Rails logger here to print to stdout in development
+        logger.error invalid_request_message
+        logger.info finished_request_message
+        [404, {"Content-Type" => "text/plain"}, ["Page not found"]]
+      end
+
+      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"
+      end
+
       def handle_open
         logger.info started_request_message if access_logs?
 
-        verify_origin!
+        verify_origin! || return
 
         connect if respond_to?(:connect)
+
+        socket.cstate.write(LOG_TAGS_IDENTIFIER, fetch_ltags.to_json)
+
         send_welcome_message
       rescue ActionCable::Connection::Authorization::UnauthorizedError
-        reject_request
+        reject_request(
+          ActionCable::INTERNAL[:disconnect_reasons]&.[](:unauthorized) || "unauthorized"
+        )
       end
 
       def handle_close
@@ -84,7 +108,12 @@ module ActionCable
       end
       # rubocop:enable Metrics/MethodLength
 
-      def close
+      def close(reason: nil, reconnect: nil)
+        transmit(
+          type: ActionCable::INTERNAL[:message_types].fetch(:disconnect, "disconnect"),
+          reason: reason,
+          reconnect: reconnect
+        )
         socket.close
       end
 
@@ -92,37 +121,14 @@ module ActionCable
         socket.transmit encode(cable_message)
       end
 
-      # Generate identifiers info.
-      # Converts GlobalID compatible vars to corresponding global IDs params.
-      def identifiers_hash
-        obj = { LOG_TAGS_IDENTIFIER => fetch_ltags }
-
-        identifiers.each_with_object(obj) do |id, acc|
-          obj = instance_variable_get("@#{id}")
-          next unless obj
-
-          acc[id] = obj.try(:to_gid_param) || 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
-          val = ids[name.to_s]
-          next val unless val.is_a?(String)
-
-          GlobalID::Locator.locate(val) || val
-        end
-      end
-
       def logger
         @logger ||= TaggedLoggerProxy.new(AnyCable.logger, tags: ltags || [])
       end
 
+      def request
+        @request ||= build_rack_request
+      end
+
       private
 
       attr_reader :ids, :ltags
@@ -158,19 +164,33 @@ module ActionCable
       end
 
       def verify_origin!
-        return unless socket.env.key?("HTTP_ORIGIN")
+        return true unless socket.env.key?("HTTP_ORIGIN")
 
-        return if allow_request_origin?
+        return true if allow_request_origin?
 
-        raise(
-          ActionCable::Connection::Authorization::UnauthorizedError,
-          "Origin is not allowed"
+        reject_request(
+          ActionCable::INTERNAL[:disconnect_reasons]&.[](:invalid_request) || "invalid_request"
         )
+        false
       end
 
-      def reject_request
+      def reject_request(reason, reconnect = false)
         logger.info finished_request_message("Rejected") if access_logs?
-        close
+        close(
+          reason: reason,
+          reconnect: reconnect
+        )
+      end
+
+      def build_rack_request
+        environment = Rails.application.env_config.merge(socket.env)
+        AnyCable::Rails::Rack.app.call(environment)
+
+        ActionDispatch::Request.new(environment)
+      end
+
+      def request_loaded?
+        instance_variable_defined?(:@request)
       end
     end
     # rubocop:enable Metrics/ClassLength