anycable 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eafc0ee0da24cde74dd95034c6e2021f30baefd6
-  data.tar.gz: a72505c9ce7e11651bade19e3bd078c10faec624
+  metadata.gz: 925d630d73669095c73fb2c1cfe55a9e87eb3f96
+  data.tar.gz: 0314e4c2a10909275c91e5cc813eaa9fb8b98999
 SHA512:
-  metadata.gz: e9ecf0ee0cd599092cf3ea4b1ff46688c3e4ed6551f03f3ec6e3eb37e79e6652f4df027c5e1a41aefb94c498584b2a4553fb5c4d3995b596b0c9c550f8718c39
-  data.tar.gz: d729762ead17bfff76c8d9b287d8b2b06d63d7efe8383b22c0ec439b4b079379ad9713b53b161b6344adcb05341a3c0ed5f8bb79df2565c286596514f79dc311
+  metadata.gz: 0d31377f132589da64214429fdeac9e3332ec66294869631d5a3d2ab33ed58dd496dc094734c23c07457eea2884ce21b5cb33542866e455394e4df516c76f0f9
+  data.tar.gz: c13beb8e1f441b420b859523aa8545ee8997a63e4ec6b21095dc8d469cc8a4934e512c854e943d031d5d96b91b5c048c1833261c184f8745a3d46db63f43c420

data/.travis.yml

@@ -1,4 +1,11 @@
 language: ruby
 cache: bundler
 
-rvm: 2.3.1
+rvm: 2.3.3
+
+matrix:
+  include:
+    - gemfile: gemfiles/rails5.gemfile
+    - gemfile: gemfiles/railsmaster.gemfile
+  allow_failures:
+    - gemfile: gemfiles/railsmaster.gemfile

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change log
+
+## 0.3.0 (2016-12-28)
+
+- Handle `Disconnect` requests. ([@palkan][])
+
+Implement `Disconnect` handler, which invokes `Connection#disconnect` (along with `Channel#unsubscribed` for each subscription).
+
+[@palkan]: https://github.com/palkan

data/PITCHME.md

@@ -0,0 +1,139 @@
+#HSLIDE
+
+## AnyCable
+### A polyglot replacement for <span style="color:#e49436">ActionCable</span> server
+
+#HSLIDE
+
+## ActionCable
+
+#### Easy to use <!-- .element: class="fragment" -->
+
+#### Allows you to access business logic  <!-- .element: class="fragment" -->
+
+#### Has JS client that just works <!-- .element: class="fragment" -->
+
+#HSLIDE
+
+## ActionCable
+
+### is good for [designing live features](http://weblog.rubyonrails.org/2016/6/30/Rails-5-0-final/)
+
+
+#HSLIDE
+
+## But...
+### is it ready for <span style="color:#e49436">production</span>?
+
+#HSLIDE
+
+## Benchmarks
+
+#### Unfortunately, <span style="color:#e49436">ActionCable</span> leaves much to be desired
+
+<span style="font-size:0.6em; color:gray">Press Down key to see charts and gifs</span>
+
+#VSLIDE
+
+## Memory
+
+![memory](assets/Memory3.png)
+
+#VSLIDE
+
+## CPU
+
+![cpu](assets/cpu_chart.gif)
+
+#VSLIDE
+
+## Broadcast Round Trip Time
+
+![rtt](assets/RTT3.png)
+
+#HSLIDE
+
+### Let's extract <span style="color:#e49436">WebSockets</span> somewhere else!
+
+#HSLIDE
+
+## AnyCable
+
+#### Combines the good parts from <span style="color:#e49436">ActionCable</span> with the power of your favorite language for concurrent applications
+
+<span style="font-size:0.6em; color:gray">How it works? See below</span>
+
+#VSLIDE
+
+## How AnyCable Works
+
+![diagram](assets/Scheme2.png)
+
+#VSLIDE
+
+## [gRPC](http://grpc.io)
+
+### Makes AnyCable to be a <span style="color:#e49436">polyglot</span>
+
+#VSLIDE
+
+## AnyCable
+
+#### [Compatible](https://github.com/anycable/anycable#actioncable-compatibility) with ActionCable (channels, javascript, broadcasting)
+
+#### You can still use ActionCable for <span style="color:#e49436">development</span> and <span style="color:#e49436">testing</span>
+
+#VSLIDE
+
+## AnyCable Servers
+
+- [anycable-go](https://github.com/anycable/anycable-go)
+
+- [erlycable](https://github.com/anycable/erlycable)
+
+#VSLIDE
+
+## AnyCable
+
+### [Demo Application](https://github.com/anycable/anycable_demo)
+
+#HSLIDE
+
+## Benchmarks Again
+
+#### AnyCable shows much more better performance.
+
+<span style="font-size:0.6em; color:gray">Press Down key to see charts and gifs</span>
+
+#VSLIDE
+
+## Memory
+
+![memory](assets/Memory5.png)
+
+#VSLIDE
+
+## CPU
+
+![cpu](assets/cpu_chart2.gif)
+
+#VSLIDE
+
+## Broadcast Round Trip Time
+
+![rtt](assets/RTT5.png)
+
+
+#HSLIDE
+
+## Let's Make ActionCable Not Suck!
+
+[anycable.evilmartians.io](http://anycable.evilmartians.io/)
+
+Vladimir Dementyev [@palkan_tula](http://twitter.com/palkan_tula)
+
+[Evil Martians](http://evilmartians.com)
+
+Twitter [@any_cable](http://twitter.com/any_cable)
+
+GitHub [@anycable](http://github.com/anycable)

data/PITCHME.yaml

@@ -0,0 +1 @@
+theme : moon

data/README.md

@@ -1,4 +1,5 @@
-[![Gem Version](https://badge.fury.io/rb/anycable.svg)](https://rubygems.org/gems/anycable) [![Build Status](https://travis-ci.org/anycable/anycable.svg?branch=master)](https://travis-ci.org/anycable/anycable) [![Circle CI](https://circleci.com/gh/anycable/anycable/tree/master.svg?style=svg)](https://circleci.com/gh/anycable/anycable/tree/master)
+[![GitPitch](https://gitpitch.com/assets/badge.svg)](https://gitpitch.com/anycable/anycable/master?grs=github) [![Gem Version](https://badge.fury.io/rb/anycable.svg)](https://rubygems.org/gems/anycable) [![Build Status](https://travis-ci.org/anycable/anycable.svg?branch=master)](https://travis-ci.org/anycable/anycable) [![Circle CI](https://circleci.com/gh/anycable/anycable/tree/master.svg?style=svg)](https://circleci.com/gh/anycable/anycable/tree/master)
+[![Gitter](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/anycable/Lobby)
 
 # Anycable
 
@@ -10,6 +11,9 @@ You can even use ActionCable in development and not be afraid of compatibility i
 
 [Example Application](https://github.com/anycable/anycable_demo)
 
+**NOTE**: MacOS users, please, beware of [Sierra-related bug](
+https://github.com/grpc/grpc/issues/8403).
+
 <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>
 
@@ -23,10 +27,17 @@ You can even use ActionCable in development and not be afraid of compatibility i
 
 <img src="https://trello-attachments.s3.amazonaws.com/5781e0ed48e4679e302833d3/820x987/5b6a305417b04e20e75f49c5816e027c/Anycable_vs_ActionCable_copy.jpg" width="400" />
 
+## Links
+
+- [GitPitch Slides](https://gitpitch.com/anycable/anycable/master?grs=github)
+
+- RailsClub Moscow 2016 [slides](https://speakerdeck.com/palkan/railsclub-moscow-2016-anycable) and [video](https://www.youtube.com/watch?v=-k7GQKuBevY&list=PLiWUIs1hSNeOXZhotgDX7Y7qBsr24cu7o&index=4) (RU)
+
+
 ## Compatible WebSocket servers
 
 - [Anycable Go](https://github.com/anycable/anycable-go)
-- coming soon ...
+- [ErlyCable](https://github.com/anycable/erlycable)
 
 
 ## Installation
@@ -66,22 +77,35 @@ Anycable uses [anyway_config](https://github.com/palkan/anyway_config), thus it
 
 ## Usage
 
-Run Anycable server:
+Run Anycable RPC server:
 
 ```ruby
 ./bin/anycable
 ```
 
+and also run AnyCable-compatible WebSocket server, e.g. [anycable-go](https://github.com/anycable/anycable-go):
+
+```sh
+anycable-go -addr='localhost:3334'
+```
+
+Don't forget to set cable url in your `config/environments/production.rb`:
+
+```ruby
+config.action_cable.url = "ws://localhost:3334/cable"
+```
+
 ## ActionCable Compatibility
 
+This is the compatibility list for the AnyCable gem, not for AnyCable servers (which may not support some of the features yet).
 
 Feature                  | Status 
 -------------------------|--------
 Connection Identifiers   | +
 Connection Request (cookies, params) | +
-Disconnect Handling | coming soon
+Disconnect Handling | +
 Subscribe to channels | +
-Parameterized subscriptions | coming soon
+Parameterized subscriptions | +
 Unsubscribe from channels | +
 [Subscription Instance Variables](http://edgeapi.rubyonrails.org/classes/ActionCable/Channel/Streams.html) | -
 Performing Channel Actions | +

data/gemfiles/rails5.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.0.0'
+gem 'rspec-rails', '~> 3.5.0'
+
+gemspec path: '..'

data/gemfiles/railsmaster.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'rails', github: 'rails/rails'
+gem 'rspec-rails', '~> 3.5.0'
+
+gemspec path: '..'

data/lib/anycable/actioncable/connection.rb

@@ -1,19 +1,42 @@
 # frozen_string_literal: true
 require "action_cable"
+require "anycable/refinements/subscriptions"
 
 module ActionCable
   module Connection
     class Base # :nodoc:
+      using Anycable::Refinements::Subscriptions
+
       attr_reader :transmissions
 
-      def initialize(env: {}, identifiers_json: '{}')
+      class << self
+        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
+
+      def initialize(env: {}, identifiers_json: '{}', subscriptions: [])
         @ids = ActiveSupport::JSON.decode(identifiers_json)
+
         @cached_ids = {}
         @env = env
         @coder = ActiveSupport::JSON
         @closed = false
         @transmissions = []
         @subscriptions = ActionCable::Connection::Subscriptions.new(self)
+
+        # Initialize channels if any
+        subscriptions.each { |id| @subscriptions.fetch(id) }
+      end
+
+      # Create a channel instance from identifier for the connection
+      def channel_for(identifier)
+        subscriptions.fetch(identifier)
       end
 
       def handle_open
@@ -24,7 +47,7 @@ module ActionCable
       end
 
       def handle_close
-        # subscriptions.unsubscribe_from_all
+        subscriptions.unsubscribe_from_all
         disconnect if respond_to?(:disconnect)
       end
 

data/lib/anycable/refinements/subscriptions.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module Anycable
+  module Refinements
+    module Subscriptions # :nodoc:
+      refine ActionCable::Connection::Subscriptions do
+        # Find or add a subscription to the list
+        def fetch(identifier)
+          add("identifier" => identifier) unless subscriptions[identifier]
+          subscriptions[identifier]
+        end
+      end
+    end
+  end
+end

data/lib/anycable/rpc/rpc.rb

@@ -29,6 +29,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "anycable.DisconnectRequest" do
     optional :identifiers, :string, 1
     repeated :subscriptions, :string, 2
+    optional :path, :string, 3
+    map :headers, :string, :string, 4
   end
   add_message "anycable.DisconnectResponse" do
     optional :status, :enum, 1, "anycable.Status"

data/lib/anycable/rpc_handler.rb

@@ -36,19 +36,27 @@ module Anycable
 
     def disconnect(request, _unused_call)
       logger.debug("RPC Disonnect: #{request}")
-      # TODO: implement disconnect logic
-      Anycable::DisconnectResponse.new(status: Anycable::Status::SUCCESS)
-    end
 
-    def subscribe(message, _unused_call)
-      logger.debug("RPC Subscribe: #{message}")
       connection = ApplicationCable::Connection.new(
-        identifiers_json: message.connection_identifiers
+        env:
+          path_env(request.path).merge(
+            'HTTP_COOKIE' => request.headers['Cookie']
+          ),
+        identifiers_json: request.identifiers,
+        subscriptions: request.subscriptions
       )
 
-      channel = channel_for(connection, message)
+      if connection.handle_close
+        Anycable::DisconnectResponse.new(status: Anycable::Status::SUCCESS)
+      else
+        Anycable::ConnectionResponse.new(status: Anycable::Status::ERROR)
+      end
+    end
 
-      if channel.present?
+    def subscribe(message, _unused_call)
+      logger.debug("RPC Subscribe: #{message}")
+
+      run_command(message) do |connection, channel|
         channel.do_subscribe
         if channel.subscription_rejected?
           Anycable::CommandResponse.new(
@@ -65,31 +73,27 @@ module Anycable
             transmissions: connection.transmissions
           )
         end
-      else
-        Anycable::CommandResponse.new(
-          status: Anycable::Status::ERROR
-        )
       end
     end
 
     def unsubscribe(message, _unused_call)
       logger.debug("RPC Unsubscribe: #{message}")
-      Anycable::CommandResponse.new(
-        status: Anycable::Status::SUCCESS,
-        disconnect: false,
-        stop_streams: true
-      )
+
+      run_command(message) do |connection, channel|
+        connection.subscriptions.remove_subscription(channel)
+
+        Anycable::CommandResponse.new(
+          status: Anycable::Status::SUCCESS,
+          disconnect: false,
+          stop_streams: true
+        )
+      end
     end
 
     def perform(message, _unused_call)
       logger.debug("RPC Perform: #{message}")
-      connection = ApplicationCable::Connection.new(
-        identifiers_json: message.connection_identifiers
-      )
 
-      channel = channel_for(connection, message)
-
-      if channel.present?
+      run_command(message) do |connection, channel|
         channel.perform_action(ActiveSupport::JSON.decode(message.data))
         Anycable::CommandResponse.new(
           status: Anycable::Status::SUCCESS,
@@ -98,6 +102,20 @@ module Anycable
           streams: channel.streams,
           transmissions: connection.transmissions
         )
+      end
+    end
+
+    private
+
+    def run_command(message)
+      connection = ApplicationCable::Connection.new(
+        identifiers_json: message.connection_identifiers
+      )
+
+      channel = connection.channel_for(message.identifier)
+
+      if channel.present?
+        yield connection, channel
       else
         Anycable::CommandResponse.new(
           status: Anycable::Status::ERROR
@@ -105,8 +123,6 @@ module Anycable
       end
     end
 
-    private
-
     # Build env from path
     def path_env(path)
       uri = URI.parse(path)
@@ -123,20 +139,6 @@ module Anycable
       }
     end
 
-    def channel_for(connection, message)
-      id_key = message.identifier
-      id_options = ActiveSupport::JSON.decode(id_key).with_indifferent_access
-
-      subscription_klass = id_options[:channel].safe_constantize
-
-      if subscription_klass
-        subscription_klass.new(connection, id_key, id_options)
-      else
-        logger.error "Subscription class not found (#{message.inspect})"
-        nil
-      end
-    end
-
     def logger
       Anycable.logger
     end

data/lib/anycable/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Anycable
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/generators/anycable/templates/script

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 require ::File.expand_path('../../config/environment', __FILE__)
-Rails.application.eager_load!
-
 require 'anycable/server'
 
+Rails.application.eager_load!
+
 Anycable::Server.start

data/protos/rpc.proto

@@ -44,6 +44,8 @@ message CommandResponse {
 message DisconnectRequest {
   string identifiers = 1;
   repeated string subscriptions = 2;
+  string path = 3;
+  map<string,string> headers = 4;
 }
 
 message DisconnectResponse {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anycable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-11 00:00:00.000000000 Z
+date: 2016-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -151,18 +151,32 @@ files:
 - Gemfile
 - MIT-LICENSE
 - Makefile
+- PITCHME.md
+- PITCHME.yaml
 - README.md
 - Rakefile
 - anycable.gemspec
+- assets/Memory3.png
+- assets/Memory5.png
+- assets/RTT3.png
+- assets/RTT5.png
+- assets/Scheme1.png
+- assets/Scheme2.png
+- assets/cpu_chart.gif
+- assets/cpu_chart2.gif
+- assets/evlms.png
 - bin/console
 - bin/setup
 - circle.yml
+- gemfiles/rails5.gemfile
+- gemfiles/railsmaster.gemfile
 - lib/anycable.rb
 - lib/anycable/actioncable/channel.rb
 - lib/anycable/actioncable/connection.rb
 - lib/anycable/actioncable/server.rb
 - lib/anycable/config.rb
 - lib/anycable/pubsub.rb
+- lib/anycable/refinements/subscriptions.rb
 - lib/anycable/rpc/rpc.rb
 - lib/anycable/rpc/rpc_services.rb
 - lib/anycable/rpc_handler.rb