anycable 0.6.0.rc1 → 1.0.0.preview1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f38ac8ce1378f75f5e1b4379c51254a346a2576fdb8326e6e2efb5d1820e857f
-  data.tar.gz: 0fa60623686123be319a92c8548b82ae4c3bf9ddadade0234cb3d69118599cd3
+  metadata.gz: 65d07fe802d850f89351ed8c054d2cba9c393b36f7a5aa318183362f09d53e58
+  data.tar.gz: b4167ba77ce930ddcb77a9e38d205215fb3ec085a93bfd3876f2bf8a5e669373
 SHA512:
-  metadata.gz: 18014f2f1193f3e4f2984e4800b14097e131f9b93e413cada4f29805295c1b8153f75d9e7b00b843feb7e66c34c1ffa3e6c24d5494f3c0e516dc693ed39acb94
-  data.tar.gz: c27a42de1a8b6539a4906e75afe3cea4ac4a5e39c1a006ed06ba106f0b0f99d51b7052a93e54cbfe8ab72114f7b43f34f692214009038a82f7839e614e960b15
+  metadata.gz: 456af4dd28de6d32a8436ce8702ddb3ba5523b25b531bce8dac00c5bf6cd181e79c57e4d4a89d1a2c1ff3e21eda1108be3f023c65edcf1bbf5790594216ae971
+  data.tar.gz: b25fa2a291a6cd6bbf4734c9c59dcf991dead19c0e25c004ac696ec524e6de63bb5ea4251f8d06ce1d21699a44e178a7e445bfedcd4d70179535c6648ed67854

data/CHANGELOG.md

@@ -1,8 +1,95 @@
 # Change log
 
-## master
+## 🚧 1.0.0 (_coming soon_)
 
-## 0.6.0-dev
+- **RPC schema has changed**. ([@palkan][])
+
+Using `anycable-go` v1.x is required.
+
+- **Ruby 2.5+ is required**. ([@palkan][])
+
+- Added RPC proto version check. ([@palkan][])
+
+Server must sent `protov` metadata with the supported versions (comma-separated list). If there is no matching version an exception is raised.
+
+Current RPC proto version is **v1**.
+
+- Added `request` support to channels. ([@palkan][])
+
+Now you can access `request` object in channels, too (e.g., to read headers/cookies/URL/etc).
+
+- Change default server address from `[::]:50051` to `127.0.0.1:50051`. ([@palkan][])
+
+See [#71](https://github.com/anycable/anycable/pull/71).
+
+## 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
 
@@ -13,7 +100,7 @@ AnyCable allows you to use custom broadcasting adapters (Redis is used by defaul
 ```ruby
 # Specify by name (tries to load `AnyCable::BroadcastAdapters::MyAdapter` from
 # "anycable/broadcast_adapters/my_adapter")
-AnyCable.broadcast_adapter = :my_adapter, { option: "value" }
+AnyCable.broadcast_adapter = :my_adapter, {option: "value"}
 # or provide an instance (should respond_to #broadcast)
 AnyCable.broadcast_adapter = MyAdapter.new
 ```
@@ -77,6 +164,10 @@ See [docs](https://docs.anycable.io/#/./middlewares).
 
 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).
@@ -108,7 +199,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][])
 
@@ -122,7 +213,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).
@@ -189,3 +280,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

@@ -9,15 +9,15 @@
 
 AnyCable allows you to use any WebSocket server (written in any language) as a replacement for your Ruby server (such as Faye, ActionCable, etc).
 
-AnyCable uses ActionCable protocol, so you can use ActionCable [JavaScript client](https://www.npmjs.com/package/actioncable) without any monkey-patching.
+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.4
-- Redis (for brodcasting, [discuss other options](https://github.com/anycable/anycable/issues/2) with us!)
+- Ruby >= 2.5
+- Redis (for broadcasting, [discuss other options](https://github.com/anycable/anycable/issues/2) with us!)
 
 ## Usage
 
@@ -33,6 +33,8 @@ Check out our 📑 [Documentation](https://docs.anycable.io).
 
 ## 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)
@@ -50,22 +52,27 @@ Check out our 📑 [Documentation](https://docs.anycable.io).
 
 - Install required GRPC gems:
 
-```
+```sh
 gem install grpc
 gem install grpc-tools
 ```
 
 - Re-generate GRPC files (if necessary):
 
-```
+```sh
 make
 ```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/anycable/anycable.
+Bug reports and pull requests are welcome on GitHub at [https://github.com/anycable/anycable](https://github.com/anycable/anycable).
 
 Please, provide reproduction script (using [this template](https://github.com/anycable/anycable/blob/master/etc/bug_report_template.rb)) when submitting bugs if possible.
 
 ## 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

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require_relative "../lib/anycable/cli"
+require "anycable/cli"
 
 begin
   cli = AnyCable::CLI.new

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,7 +1,6 @@
 # frozen_string_literal: true
 
 require "anycable/version"
-require "anycable/config"
 require "logger"
 
 require "anycable/exceptions_handling"
@@ -39,7 +38,12 @@ module AnyCable
     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
@@ -52,12 +56,14 @@ module AnyCable
       ExceptionsHandling << block
     end
 
-    def error_handlers
-      warn <<~DEPRECATION
-        Using `AnyCable.error_handlers` is deprecated!
-        Please, use `AnyCable.capture_exception` instead.
-      DEPRECATION
-      ExceptionsHandling
+    # Register a callback to be invoked before
+    # the server starts
+    def configure_server(&block)
+      server_callbacks << block
+    end
+
+    def server_callbacks
+      @server_callbacks ||= []
     end
 
     def broadcast_adapter
@@ -89,8 +95,7 @@ module AnyCable
     attr_writer :middleware
   end
 
+  require "anycable/middlewares/check_version"
+
   self.middleware = MiddlewareChain.new
 end
-
-# Backward compatibility
-Anycable = AnyCable

data/lib/anycable/broadcast_adapters.rb

@@ -17,16 +17,16 @@ module AnyCable
           # We couldn't require the adapter itself.
           if e.path == path_to_adapter
             raise e.class, "Couldn't load the '#{adapter}' broadcast adapter for AnyCable",
-                  e.backtrace
+              e.backtrace
           # Bubbled up from the adapter require.
           else
             raise e.class, "Error loading the '#{adapter}' broadcast adapter for AnyCable",
-                  e.backtrace
+              e.backtrace
           end
         end
       end
 
-      BroadcastAdapters.const_get(adapter_class_name, false).new(options || {})
+      BroadcastAdapters.const_get(adapter_class_name, false).new(**(options || {}))
     end
     # rubocop: enable Metrics/AbcSize, Metrics/MethodLength
   end

data/lib/anycable/broadcast_adapters/redis.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-gem "redis", ">= 4.0"
+gem "redis", ">= 3"
 
 require "redis"
 require "json"
@@ -34,7 +34,7 @@ module AnyCable
       def broadcast(stream, payload)
         redis_conn.publish(
           channel,
-          { stream: stream, data: payload }.to_json
+          {stream: stream, data: payload}.to_json
         )
       end
     end

data/lib/anycable/cli.rb

@@ -23,7 +23,7 @@ module AnyCable
     attr_reader :server, :health_server
 
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-    def run(args)
+    def run(args = {})
       @at_stop = []
 
       extra_options = parse_cli_options!(args)
@@ -34,11 +34,13 @@ module AnyCable
 
       parse_gem_options!(extra_options)
 
-      logger.info "Starting AnyCable gRPC server (pid: #{Process.pid})"
+      configure_server!
+
+      logger.info "Starting AnyCable gRPC server (pid: #{Process.pid}, workers_num: #{config.rpc_pool_size})"
 
       print_versions!
 
-      logger.info "Serving #{defined?(::Rails) ? 'Rails ' : ''}application from #{boot_file}"
+      logger.info "Serving #{defined?(::Rails) ? "Rails " : ""}application from #{boot_file}"
 
       verify_connection_factory!
 
@@ -46,6 +48,8 @@ module AnyCable
 
       log_errors!
 
+      use_version_check! if config.version_check_enabled?
+
       @server = AnyCable::Server.new(
         host: config.rpc_host,
         **config.to_grpc_params,
@@ -122,7 +126,7 @@ module AnyCable
     end
 
     def print_versions!
-      logger.info "AnyCable version: #{AnyCable::VERSION}"
+      logger.info "AnyCable version: #{AnyCable::VERSION} (proto_version: #{AnyCable::PROTO_VERSION})"
       logger.info "gRPC version: #{GRPC::VERSION}"
     end
 
@@ -156,6 +160,18 @@ module AnyCable
       APP_CANDIDATES.detect { |path| File.exist?(path) }
     end
 
+    def configure_server!
+      AnyCable.server_callbacks.each(&:call)
+    end
+
+    def use_version_check!
+      require "anycable/middlewares/check_version"
+
+      AnyCable.middleware.use(
+        AnyCable::Middlewares::CheckVersion.new(AnyCable::PROTO_VERSION)
+      )
+    end
+
     def start_health_server!
       @health_server = AnyCable::HealthServer.new(
         server,

data/lib/anycable/config.rb

@@ -10,8 +10,8 @@ module AnyCable
 
     attr_config(
       ### gRPC options
-      rpc_host: "[::]:50051",
-      # For defaults see https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/generic/rpc_server.rb#L162-L170
+      rpc_host: "127.0.0.1:50051",
+      # For defaults see https://github.com/grpc/grpc/blob/51f0d35509bcdaba572d422c4f856208162022de/src/ruby/lib/grpc/generic/rpc_server.rb#L186-L216
       rpc_pool_size: GRPC::RpcServer::DEFAULT_POOL_SIZE,
       rpc_max_waiting_requests: GRPC::RpcServer::DEFAULT_MAX_WAITING_REQUESTS,
       rpc_poll_period: GRPC::RpcServer::DEFAULT_POLL_PERIOD,
@@ -32,9 +32,14 @@ module AnyCable
 
       ### Health check options
       http_health_port: nil,
-      http_health_path: "/health"
+      http_health_path: "/health",
+
+      ### Misc options
+      version_check_enabled: true
     )
 
+    alias version_check_enabled? version_check_enabled
+
     ignore_options :rpc_server_args
     flag_options :log_grpc, :debug
 
@@ -69,7 +74,7 @@ module AnyCable
 
     # Build Redis parameters
     def to_redis_params
-      { url: redis_url }.tap do |params|
+      {url: redis_url}.tap do |params|
         next if redis_sentinels.nil?
 
         raise ArgumentError, "redis_sentinels must be an array; got #{redis_sentinels}" unless
@@ -100,7 +105,7 @@ module AnyCable
 
       raise ArgumentError, "Invalid Sentinel value: #{sentinel}" if matches.nil?
 
-      { "host" => matches[1], "port" => matches[2].to_i }
+      {"host" => matches[1], "port" => matches[2].to_i}
     end
   end
 end