anycable-rails 1.0.0.preview2 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93c88ec3ccf3eb9d145474e43aa8a851e32768de9b7c8ce1e6eb44cc0b24b0e9
-  data.tar.gz: b12bc69aa43afc035038ee85c80bce57b9beabe36d9d0b93f261125f3af32876
+  metadata.gz: 36b6e47a498bfc2d1156e4635a5c30f60258c925142c59ad837c1b6708f1ff73
+  data.tar.gz: f27c94856df0db9d178537e8ac75598f8a355b338e725a80a5cb06a6e0ac610c
 SHA512:
-  metadata.gz: 387d765e0d5f15c38d211e206eccc04982c4d20c4855539de49caefa58caffd0dd7a949f73817d576fc19b97a1e6359d0dd194520a3e9538b18aee987a5aa99e
-  data.tar.gz: c75876c69f2655296cefd54b3ac9cba5fdefcdabbea206c526d9ddb502fcb61095e2855582d5ca17884fdadf70e6e4406a43b5e21470b7ade8b6027064903c1e
+  metadata.gz: 28b72e3f6a9950d3a95eb8d4f1c6a59f24a704ff63ac50384ffb2d22aa97c9f6b6e1f0c882a89cc6a0fd9ac22ea553a381514d56885f6f1cce41e7146153ab24
+  data.tar.gz: ac7c402d2b57a332ced9372a4546709d6b41a0fb082c823d292b87c8b11e4bf741047cbc10258f68acd228712f0ca974b6723246bd3ddc689920f656b1488974

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 # Change log
 
-## 🚧 1.0.0 (_coming soon_)
+## 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.
+
+- Add `Channel#stop_stream_from` support. ([@palkan][])
+
+- Add `RemoteConnections` support. ([@palkan][])
+
+- Add `AnyCable::Rails.enabled?` method which returns true if Action Cable uses AnyCable adapter. ([@palkan][])
+
+- Add `anycable:download` generator to download `anycable-go` binary. ([@palkan][])
 
 - **Ruby 2.5+ is required**. ([@palkan][])
 
@@ -23,130 +35,7 @@ You must turn this feature on by setting `persistent_session_enabled: true` in t
 
 - Add ability to develop the gem with Docker. ([@bibendi][])
 
-## 0.6.4 (2019-06-26) 👶
-
-- Fix Compatibility bug when using with AnyCable. ([@palkan][])
-
-  Compatibility patching (with `prepend` + `super`) conflicted with
-  the `ActionCable::Channel::Base` patching in the core functionality (which uses `alias`).
-
-  See [#95](https://github.com/anycable/anycable-rails/issues/95).
-
-## 0.6.3 (2019-03-26)
-
-- Fix connection factory reloading for development sake. ([@sponomarev][])
-
-- Add `:anycable` subscription adapter alias. ([@sponomarev][])
-
-- Don't set AnyCable connection factory for incompatible adapter ([@sponomarev][])
-
-  `anycable` server won't start with unpatched vanilla `ApplicationCable::Connection`.
-
-  Motivation in [#74](https://github.com/anycable/anycable-rails/issues/74).
-
-- Fix instance detection inside complex cases in compatibility cops ([@sponomarev][])
-
-## 0.6.2 (2019-01-10)
-
-- Fixed `anycable` 0.6.1 compatibility. ([@palkan][])
-
-- Broadcast logs to STDOUT in development only when server is running. ([@palkan][])
-
-  Fixes #59.
-
-## 0.6.1 (2018-11-15)
-
-- Fix regression introduced in [e64a366e](https://github.com/anycable/anycable-rails/commit/e64a366ea21293925e0c5c0b8e6595d65d5d0981#diff-fd0e56a6e825002eac978507c3581af7R14) ([@palkan][])
-
-`Connection` patch could be loaded after `identify_by` is called, thus breaking
-identifiers.
-
-## 0.6.0 (2018-11-15)
-
-**NOTE**: this version has been yanked from RubyGems due to the regression bug. Use 0.6.1.
-
-- [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

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/#/ruby/rails)
+[![Documentation](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://docs.anycable.io/v1/#/ruby/rails)
 
 # AnyCable Rails
 
@@ -10,10 +12,11 @@ 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>
@@ -21,12 +24,8 @@ You can even use Action Cable in development and not be afraid of [compatibility
 ## Requirements
 
 - Ruby >= 2.5
-- 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" />
+- Rails >= 5.2
+- Redis (see [other options](https://github.com/anycable/anycable/issues/2) for broadcasting)
 
 ## Usage
 
@@ -39,14 +38,12 @@ gem "anycable-rails"
 gem "redis", ">= 4.0"
 ```
 
-(and don't forget to run `bundle install`).
-
 ### Interactive set up
 
 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
-bin/rails g anycable:setup
+bundle exec rails g anycable:setup
 ```
 
 ### Manual set up
@@ -86,38 +83,21 @@ $ bundle exec anycable
 $ RAILS_ENV=production bundle exec anycable
 ```
 
-And, finally, run AnyCable WebSocket server, e.g. [anycable-go](https://docs.anycable.io/#/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/#/ruby/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/#/ruby/compatibility).
-
-## Links
-
-- [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
-
-- 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)
-
-- 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)
-
-## Compatible WebSocket servers
-
-- [AnyCable Go](https://github.com/anycable/anycable-go)
-- [ErlyCable](https://github.com/anycable/erlycable)
+See [documentation](https://docs.anycable.io/v1/#/ruby/compatibility).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/anycable/anycable-rails.
+Bug reports and pull requests are welcome on GitHub at [https://github.com/anycable/anycable-rails](https://github.com/anycable/anycable-rails).
 
 ## Development
 

data/lib/anycable/rails.rb

@@ -5,6 +5,8 @@ require "anycable/rails/version"
 require "anycable/rails/config"
 require "anycable/rails/rack"
 
+require "globalid"
+
 module AnyCable
   # Rails handler for AnyCable
   module Rails
@@ -12,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

@@ -28,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,8 +1,10 @@
 # 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
@@ -15,26 +17,26 @@ module ActionCable
 
       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 = socket.cstate.read(LOG_TAGS_IDENTIFIER).yield_self do |raw_tags|
@@ -51,6 +53,18 @@ 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?
 
@@ -107,31 +121,6 @@ module ActionCable
         socket.transmit encode(cable_message)
       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] = 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

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

@@ -0,0 +1,42 @@
+# 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