anycable 0.5.2 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '079d557557d69550f4a490d8fcbcd35b922df102af44c076ea14bc92bff5dda3'
-  data.tar.gz: 29339983ff86ec5f52959397b566926c00d7116fa8dd56dc4933bac4bd526689
+  metadata.gz: 6b624b0695335efdb861cfdb90b16caa0b2ddd67698a0ac813a81e9ae98a52eb
+  data.tar.gz: b70e2b622120da3ae2df10049e6145d958d84d78ab8a080943a8e50aab4cf983
 SHA512:
-  metadata.gz: a4fdb1f8ccbb3c633996c4aae85ce60263ab5c8f68f13909d93ef2ebe390e5124901b2832221b7fdd809fef1e3ae04628e4e5437aa6f262da51248041b5d0030
-  data.tar.gz: ba3d770e79aa4775e894d2f568787f62d96f1e699828549e0dba1880a85597e01e565fe0781a51b1da42f7cd359cc7580846c7c01f297ee498e4cbfacfba8329
+  metadata.gz: 97619fd72a53a84608f47b9a99504b080731a0b8915667007d9cf3240feda2a880b0cdcb67acddefec14c34fbbd169c812a4dc310ef4d0b3757c818471ae019c
+  data.tar.gz: efb598ebbd08e0de7574f0de3690b0c7caf11812f3b2afcde26aee5c8bff8a4607cd3a9b791cc978df458d00c37155d23d520118ffc38af98f1e7c9e66760d88

data/CHANGELOG.md

@@ -2,6 +2,169 @@
 
 ## master
 
+## 0.6.4 (2020-01-24)
+
+- Fix Ruby 2.7 warnings. ([@palkan])
+
+– Add `REMOTE_ADDR` socket env variable using a synthetic header passed from a websocket
+server. ([@sponomarev][])
+
+Recreating a request object in your custom connection factory using `Rack::Request` or
+`ActionDispatch::Request` (already implemented in [anycable-rails](https://github.com/anycable/anycable-rails))
+gives you an access to `request.ip` with the properly set IP address.
+
+- Align socket env to be more compatibile with Rack Spec ([@sponomarev][])
+
+Provide as much env details as possible to be able to reconstruct the full
+request object in a custom connection factory.
+
+## 0.6.3 (2019-03-26)
+
+- Relax `redis` gem version requirement. ([@palkan][])
+
+Use the same restriction as Action Cable does (`>= 3`).
+
+## 0.6.2 (2019-03-15)
+
+- Add GRPC service method name and message content to exception notifications ([@sponomarev][])
+
+`Anycable.capture_exception` allows accessing GRPC service method name and message content
+on which an exception was captured. It can be used for exceptions grouping in your tracker and
+providing additional data to investigate a root of a problem.
+
+Example:
+
+```ruby
+AnyCable.capture_exception do |ex, method, message|
+  Honeybadger.notify(ex, component: "any_cable", action: method, params: message)
+end
+```
+
+Usage of a handler proc with just a single argument is preserved for the sake of compatibility.
+
+- Add deprecation warning to default host usage ([@sponomarev][])
+
+Exposing AnyCable publicly is considered to be harmful and planned to be changed
+in future versions.
+
+- Allow running the server as a detachable daemon ([@sponomarev][])
+
+Server is fully managed by the binary itself.
+
+```
+# Start anycable daemon
+$ bundle exec anycabled start
+
+# Pass cli options to anycable through daemon. Separate daemon options and anycable options with `--`
+$ bundle exec anycabled start -- --rpc-host 127.0.0.1:31337
+
+# Stop anycable daemon
+$ bundle exec anycabled stop
+
+# See more anycable daemon options
+$ bundle exec anycabled
+```
+
+## 0.6.1 (2019-01-05)
+
+- [Fix #63](https://github.com/anycable/anycable-rails/issues/63) Load `anyway_config` after application boot to make sure that all frameworks dependent functionality is loaded. ([@palkan][])
+
+## 0.6.0 (2018-11-15)
+
+### Features
+
+#### Broadcast adapters
+
+AnyCable allows you to use custom broadcasting adapters (Redis is used by default):
+
+```ruby
+# Specify by name (tries to load `AnyCable::BroadcastAdapters::MyAdapter` from
+# "anycable/broadcast_adapters/my_adapter")
+AnyCable.broadcast_adapter = :my_adapter, { option: "value" }
+# or provide an instance (should respond_to #broadcast)
+AnyCable.broadcast_adapter = MyAdapter.new
+```
+
+**Breaking:** to use Redis adapter you must ensure that it is present in your Gemfile; AnyCable gem doesn't have `redis` as a dependency anymore.
+
+#### CLI
+
+AnyCable now ships with a CLI–`anycable`.
+
+Use it to run a gRPC server:
+
+```sh
+# run anycable and load app from app.rb
+bundle exec anycable -r app.rb
+# or
+bundle exec anycable --require app.rb
+```
+
+All configuration options are also supported as CLI options (see `anycable -h` for more information).
+
+The only required options is the application file to load (`-r/--require`).
+
+You can omit it if you want to load an app form `./config/environment.rb` (e.g. with Rails) or `./config/anycable.rb`.
+
+AnyCable CLI also allows you to run a separate command (process) from within a RPC server:
+
+```sh
+$ bundle exec anycable --server-command "anycable-go -p 3334"
+```
+
+#### Configuration
+
+- Default server host is changed from `localhost:50051` to `0.0.0.0:50051`
+- Expose gRPC server parameters via `rpc_*` config params:
+
+```ruby
+AnyCable.configure do |config|
+  config.rpc_pool_size = 120
+  config.rpc_max_waiting_requests = 10
+  # etc
+end
+```
+- `REDIS_URL` env is used by default if present (and no `ANYCABLE_REDIS_URL` specified)
+- Make HTTP health check url configurable
+- Add ability to pass Redis Sentinel config as array of string.
+
+Now it's possible to pass Sentinel configuration via env vars:
+
+```sh
+ANYCABLE_REDIS_SENTINELS=127.0.0.1:26380,127.0.0.1:26381 bundle exec anycable
+```
+
+#### Other
+
+- Added middlewares support
+
+See [docs](https://docs.anycable.io/#/./middlewares).
+
+- Added gRPC health checker.
+
+See [docs](https://docs.anycable.io/#/./health_checking).
+
+- Added hook to run code only within RPC server context.
+
+Use `AnyCable.configure_server { ... }` to run code only when RPC server is running.
+
+### API changes
+
+**NOTE**: the old API is still working but deprecated (you'll see a notice).
+
+- Use `AnyCable` instead of `Anycable`
+
+- New API for registering error handlers:
+
+```ruby
+AnyCable.capture_exception do |ex|
+  Honeybadger.notify(ex)
+end
+```
+
+- `AnyCable::Server.start` is deprecated
+
+
 ## 0.5.2 (2018-09-06)
 
 - [#48](https://github.com/anycable/anycable/pull/48) Add HTTP health server ([@DarthSim][])
@@ -16,7 +179,7 @@ Minor fixes.
 
 - [#28](https://github.com/anycable/anycable/issues/28) Support arbitrary headers. ([@palkan][])
 
-Previously we hardcoded only "Cookie" header. Now we add all passed headers by WebSocket server to request env. 
+Previously we hardcoded only "Cookie" header. Now we add all passed headers by WebSocket server to request env.
 
 - [#27](https://github.com/anycable/anycable/issues/27) Add `error_msg` to RPC responses. ([@palkan][])
 
@@ -30,7 +193,7 @@ We provide `error_msg` only when request status is `ERROR`.
 
 - [#25](https://github.com/anycable/anycable/issues/25) Improve logging and exceptions handling. ([@palkan][])
 
-Default logger logs to STDOUT with `info` level by default but can be configured to log to file with 
+Default logger logs to STDOUT with `info` level by default but can be configured to log to file with
 any severity.
 
 GRPC logging is turned off by default (can be turned on through `log_grpc` configuration parameter).
@@ -97,3 +260,4 @@ Implement `Disconnect` handler, which invokes `Connection#disconnect` (along wit
 [@sadovnik]: https://github.com/sadovnik
 [@accessd]: https://github.com/accessd
 [@DarthSim]: https://github.com/DarthSim
+[@sponomarev]: https://github.com/sponomarev

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2017 palkan
+Copyright 2017-2019 Vladimir Dementyev
 
 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,40 +1,27 @@
-[![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)
+[![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)
 [![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)
 
-# Anycable
+# AnyCable
 
-AnyCable allows you to use any WebSocket server (written in any language) as a replacement for your Ruby server (such as Faye, ActionCable, etc).
+<img align="right" height="150" width="129"
+     title="AnyCable logo" src="https://docs.anycable.io/assets/images/logo.svg">
 
-AnyCable uses ActionCable protocol, so you can use ActionCable [JavaScript client](https://www.npmjs.com/package/actioncable) without any monkey-patching.
+AnyCable allows you to use any WebSocket server (written in any language) as a replacement for your Ruby server (such as Faye, ActionCable, etc).
 
-**NOTE**: Since version 0.4.0 this repository contains only core functionality and cannot be used separately as is.
-Rails plug-n-play integration has been extracted to [anycable-rails](https://github.com/anycable/anycable-rails) gem.
+AnyCable uses the same protocol as ActionCable, so you can use its [JavaScript client](https://www.npmjs.com/package/actioncable) without any monkey-patching.
 
 <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.3, <= 2.5
-- Redis (for brodcasting, [discuss other options](https://github.com/anycable/anycable/issues/2) with us!)
-
-Or you can try to [build it from source](https://github.com/grpc/grpc/blob/master/INSTALL.md#build-from-source).
+- Ruby >= 2.4
+- Redis (for broadcasting, [discuss other options](https://github.com/anycable/anycable/issues/2) with us!)
 
-For MacOS there is also [the same problem](https://github.com/google/protobuf/issues/4098) with `google-protobuf` that can be solved
-the following way:
-
-```ruby
-# Gemfile
-git 'https://github.com/google/protobuf' do
-  gem 'google-protobuf'
-end
-```
+## Usage
 
-## How It Works?
-
-![](https://s3.amazonaws.com/anycable/Scheme.png)
-
-Read our [Wiki](https://github.com/anycable/anycable/wiki) for more.
+Check out our 📑 [Documentation](https://docs.anycable.io).
 
 ## Links
 
@@ -46,6 +33,8 @@ Read our [Wiki](https://github.com/anycable/anycable/wiki) for more.
 
 ## Talks
 
+- High-speed cables for Ruby, RubyConf 2018, [slides](https://speakerdeck.com/palkan/rubyconf-2018-high-speed-cables-for-ruby) and [video](https://www.youtube.com/watch?v=8XRcOZXOzV4) (EN)
+
 - 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)
@@ -54,46 +43,11 @@ Read our [Wiki](https://github.com/anycable/anycable/wiki) for more.
 
 - 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)
+- [AnyCable Go](https://github.com/anycable/anycable-go)
 - [ErlyCable](https://github.com/anycable/erlycable)
 
-## Configuration
-
-Anycable uses [anyway_config](https://github.com/palkan/anyway_config), thus it is also possible to set configuration variables through `secrets.yml` or environment vars.
-
-### Example with redis sentinel
-
-```yaml
-  rpc_host: "localhost:50123"
-  redis_url: "redis://redis-1-1:6379/2"
-  redis_sentinels:
-    - { host: 'redis-1-1', port: 26379 }
-    - { host: 'redis-1-2', port: 26379 }
-    - { host: 'redis-1-3', port: 26379 }
-```
-
-## 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 | +
-Subscribe to channels | +
-Parameterized subscriptions | +
-Unsubscribe from channels | +
-[Subscription Instance Variables](http://edgeapi.rubyonrails.org/classes/ActionCable/Channel/Streams.html) | -
-Performing Channel Actions | +
-Streaming | +
-[Custom stream callbacks](http://edgeapi.rubyonrails.org/classes/ActionCable/Channel/Streams.html) | -
-Broadcasting | +
-Custom pubsub adapter | Only redis
-
 ## Build
 
 - Install required GRPC gems:
@@ -117,3 +71,8 @@ Please, provide reproduction script (using [this template](https://github.com/an
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Security Contact
+
+To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.
+

data/bin/anycable

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "anycable/cli"
+
+begin
+  cli = AnyCable::CLI.new
+  cli.run(ARGV)
+rescue => e
+  raise e if $DEBUG
+  STDERR.puts e.message
+  STDERR.puts e.backtrace.join("\n")
+  exit 1
+end

data/bin/anycabled

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require "anycable/cli"
+
+begin
+  require "daemons"
+rescue LoadError
+  raise <<~MSG
+    You need to add gem 'daemons' to your Gemfile if you want to use `anycabled`:
+
+      # Gemfile
+      gem "daemons", "~> 1.3", require: false
+  MSG
+end
+
+options = {
+  dir: "tmp/pids",
+  log_output: false
+}
+
+# Preserve current directory. We need it inside the server.
+current_dir = Dir.pwd
+
+# Clean ARGV from daemon command and args
+_, _, args = Daemons::Controller.split_argv(ARGV)
+
+Daemons.run_proc("anycable", options) do
+  Dir.chdir current_dir
+  AnyCable::CLI.new.run(args)
+end

data/lib/anycable.rb

@@ -1,59 +1,110 @@
 # frozen_string_literal: true
 
 require "anycable/version"
-require "anycable/config"
 require "logger"
 
-# Anycable allows to use any websocket service (written in any language) as a replacement
+require "anycable/exceptions_handling"
+require "anycable/broadcast_adapters"
+
+require "anycable/middleware_chain"
+
+require "anycable/server"
+
+# AnyCable allows to use any websocket service (written in any language) as a replacement
 # for ActionCable server.
 #
-# Anycable includes a gRPC server, which is used by external WS server to execute commands
+# AnyCable includes a gRPC server, which is used by external WS server to execute commands
 # (authentication, subscription authorization, client-to-server messages).
 #
-# Broadcasting messages to WS is done through Redis Pub/Sub.
-module Anycable
+# Broadcasting messages to WS is done through _broadcast adapter_ (Redis Pub/Sub by default).
+module AnyCable
   class << self
     # Provide connection factory which
     # is a callable object with build
     # a Connection object
     attr_accessor :connection_factory
 
-    def logger=(logger)
-      @logger = logger
-    end
+    attr_writer :logger
+
+    attr_reader :middleware
 
     def logger
       return @logger if instance_variable_defined?(:@logger)
-      log_output = Anycable.config.log_file || STDOUT
+
+      log_output = AnyCable.config.log_file || STDOUT
       @logger = Logger.new(log_output).tap do |logger|
-        logger.level = Anycable.config.log_level
+        logger.level = AnyCable.config.log_level
       end
     end
 
     def config
-      @config ||= Config.new
+      @config ||= begin
+        # Load anyway_config as later as possible
+        # to make sure all framework-dependent patches are loaded
+        require "anycable/config"
+        Config.new
+      end
     end
 
     def configure
       yield(config) if block_given?
     end
 
+    # Register a custom block that will be called
+    # when an exception is raised during gRPC call
+    def capture_exception(&block)
+      ExceptionsHandling << block
+    end
+
     def error_handlers
-      return @error_handlers if instance_variable_defined?(:@error_handlers)
-      @error_handlers = []
+      warn <<~DEPRECATION
+        Using `AnyCable.error_handlers` is deprecated!
+        Please, use `AnyCable.capture_exception` instead.
+      DEPRECATION
+      ExceptionsHandling
+    end
+
+    # Register a callback to be invoked before
+    # the server starts
+    def configure_server(&block)
+      server_callbacks << block
     end
 
-    def pubsub
-      @pubsub ||= PubSub.new
+    def server_callbacks
+      @server_callbacks ||= []
+    end
+
+    def broadcast_adapter
+      self.broadcast_adapter = :redis unless instance_variable_defined?(:@broadcast_adapter)
+      @broadcast_adapter
+    end
+
+    def broadcast_adapter=(adapter)
+      if adapter.is_a?(Symbol) || adapter.is_a?(Array)
+        adapter = BroadcastAdapters.lookup_adapter(adapter)
+      end
+
+      unless adapter.respond_to?(:broadcast)
+        raise ArgumentError, "BroadcastAdapter must implement #broadcast method. " \
+                             "#{adapter.class} doesn't implement it."
+      end
+
+      @broadcast_adapter = adapter
     end
 
     # Raw broadcast message to the channel, sends only string!
     # To send hash or object use ActionCable.server.broadcast instead!
     def broadcast(channel, payload)
-      pubsub.broadcast(channel, payload)
+      broadcast_adapter.broadcast(channel, payload)
     end
+
+    private
+
+    attr_writer :middleware
   end
+
+  self.middleware = MiddlewareChain.new
 end
 
-require "anycable/server"
-require "anycable/pubsub"
+# Backward compatibility
+Anycable = AnyCable