anycable 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cff0f2d872c485fc15f3046b2fdacbb9cfce2d3e7e312b8f0461dc20f2e52a41
-  data.tar.gz: 586fe6c97d6063512020bde66aaf3a0d8c2dc4a33ca508beb67295a18f121618
+  metadata.gz: 9044b4ce81ea84415ac896ea46c96ad55da523edc3251aa07d7e2490c3a4745e
+  data.tar.gz: 1bfe649fe5bfac2276496668f7fa3e588f38a6c1b0e603d16a3b3695f08a8363
 SHA512:
-  metadata.gz: f055860a0a5a10eb3954bc6dd5088e66cc948eefe3b853a6fee63ea9ed5e7fafa2827e4fda6f67eeca3efe6efccc2d69eb59f6e8ee11d969be4ef027e73727a8
-  data.tar.gz: c53d21ea1beb3443451839ceb69e318c840b04564e35379adebd65ccfc4f708666c8c78514a805f16e564508aa190ad81a27329334826016f2bc08bc5aa16fde
+  metadata.gz: 415117187f998d7704e9a2d1a305b0fb8cc55b2cdaf58a37292043675bc499e32b806cd2a5a574210f54f16ea91fa7f072cc87d37afec860f13c1abbc9978813
+  data.tar.gz: 5ed3809fe24065e2d029e4cfd92f794112ed1b08cf3ed312e56f5a97cd5e23b51be4f9425303e55b18d9cb41d9143ce639ab60556c34511746994ba9c4d78027

data/CHANGELOG.md

@@ -2,6 +2,47 @@
 
 ## master
 
+## 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][])
@@ -116,7 +157,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][])
 
@@ -130,7 +171,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).

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/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)

data/lib/anycable/config.rb

@@ -8,10 +8,12 @@ module AnyCable
   class Config < Anyway::Config
     config_name :anycable
 
+    DefaultHostWrapper = Class.new(String)
+
     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: DefaultHostWrapper.new("[::]: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,

data/lib/anycable/exceptions_handling.rb

@@ -4,15 +4,15 @@ module AnyCable
   module ExceptionsHandling # :nodoc:
     class << self
       def add_handler(block)
-        handlers << block
+        handlers << procify(block)
       end
 
       alias << add_handler
 
-      def notify(exp)
+      def notify(exp, method_name, message)
         handlers.each do |handler|
           begin
-            handler.call(exp)
+            handler.call(exp, method_name, message)
           rescue StandardError => exp
             AnyCable.logger.error "!!! EXCEPTION HANDLER THREW AN ERROR !!!"
             AnyCable.logger.error exp
@@ -23,6 +23,12 @@ module AnyCable
 
       private
 
+      def procify(block)
+        return block unless block.lambda?
+
+        proc { |*args| block.call(*args.take(block.arity)) }
+      end
+
       def handlers
         @handlers ||= []
       end

data/lib/anycable/handler/capture_exceptions.rb

@@ -18,16 +18,16 @@ module AnyCable
 
       RESPONSE_CLASS.keys.each do |mid|
         module_eval <<~CODE, __FILE__, __LINE__ + 1
-          def #{mid}(*)
-            capture_exceptions(:#{mid}) { super }
+          def #{mid}(message, *)
+            capture_exceptions(:#{mid}, message) { super }
           end
         CODE
       end
 
-      def capture_exceptions(method_name)
+      def capture_exceptions(method_name, message)
         yield
       rescue StandardError => exp
-        AnyCable::ExceptionsHandling.notify(exp)
+        AnyCable::ExceptionsHandling.notify(exp, method_name.to_s, message.to_h)
 
         RESPONSE_CLASS.fetch(method_name).new(
           status: AnyCable::Status::ERROR,

data/lib/anycable/server.rb

@@ -12,8 +12,8 @@ module AnyCable
   #
   # Basic example:
   #
-  #   # create new server listening on [::]:50051 (default host)
-  #   server = AnyCable::Server.new(host: "[::]:50051")
+  #   # create new server listening on the loopback interface with 50051 port
+  #   server = AnyCable::Server.new(host: "127.0.0.1:50051")
   #
   #   # run gRPC server in bakground
   #   server.start
@@ -25,7 +25,7 @@ module AnyCable
       # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       def start(**options)
         warn <<~DEPRECATION
-          Using AnyCable::Server.start is deprecated!
+          DEPRECATION WARNING: Using AnyCable::Server.start is deprecated!
           Please, use anycable CLI instead.
 
           See https://docs.anycable.io/#upgrade_to_0_6_0
@@ -63,11 +63,9 @@ module AnyCable
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
     end
 
-    DEFAULT_HOST = "0.0.0.0:50051"
-
     attr_reader :grpc_server, :host
 
-    def initialize(host: DEFAULT_HOST, logger: AnyCable.logger, **options)
+    def initialize(host:, logger: AnyCable.logger, **options)
       @logger = logger
       @host = host
       @grpc_server = build_server(options)
@@ -80,6 +78,8 @@ module AnyCable
 
       raise "Cannot re-start stopped server" if stopped?
 
+      check_default_host
+
       logger.info "RPC server is starting..."
 
       @start_thread = Thread.new { grpc_server.run }
@@ -132,5 +132,21 @@ module AnyCable
       )
       health_checker
     end
+
+    def check_default_host
+      return unless host.is_a?(Anycable::Config::DefaultHostWrapper)
+
+      warn <<~DEPRECATION
+        DEPRECATION WARNING: You're using default rpc_host configuration which starts AnyCable RPC
+        server on all available interfaces including external IPv4 and IPv6.
+        This is about to be changed to loopback interface only in future versions.
+
+        Please, consider switching to the loopback interface or set "[::]:50051"
+        explicitly in your configuration, if you want to continue with the current
+        behavior and supress this message.
+
+        See https://docs.anycable.io/#/configuration
+      DEPRECATION
+    end
   end
 end

data/lib/anycable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AnyCable
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anycable
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-06 00:00:00.000000000 Z
+date: 2019-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -155,63 +155,17 @@ email:
 - dementiev.vm@gmail.com
 executables:
 - anycable
+- anycabled
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/ISSUE_TEMPLATE.md"
-- ".github/PULL_REQUEST_TEMPLATE.md"
-- ".gitignore"
-- ".hound.yml"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- 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
-- benchmarks/.gitignore
-- benchmarks/2017-02-12.md
-- benchmarks/2018-03-04.md
-- benchmarks/2018-05-27-rpc-bench.md
-- benchmarks/2018-10-27.md
-- benchmarks/HowTo.md
-- benchmarks/ansible.cfg
-- benchmarks/assets/2018-10-27-action-cable-rss.png
-- benchmarks/assets/2018-10-27-action-cable-rtt.png
-- benchmarks/assets/2018-10-27-anycable-rss.png
-- benchmarks/assets/2018-10-27-anycable-rtt.png
-- benchmarks/assets/2018-10-27-async-rss.png
-- benchmarks/assets/2018-10-27-async-rtt.png
-- benchmarks/assets/2018-10-27-falcon-cable-rss.png
-- benchmarks/assets/2018-10-27-falcon-cable-rtt.png
-- benchmarks/assets/2018-10-27-iodine-cable-rss.png
-- benchmarks/assets/2018-10-27-iodine-cable-rtt.png
-- benchmarks/assets/2018-10-27-plezi-rss.png
-- benchmarks/assets/2018-10-27-plezi-rtt.png
-- benchmarks/bench.png
-- benchmarks/benchmark.yml
-- benchmarks/hosts
-- benchmarks/rtt_plot.py
-- benchmarks/rtt_plot_test.py
-- benchmarks/servers.yml
 - bin/anycable
+- bin/anycabled
 - bin/console
 - bin/setup
-- circle.yml
-- etc/bug_report_template.rb
 - lib/anycable.rb
 - lib/anycable/broadcast_adapters.rb
 - lib/anycable/broadcast_adapters/redis.rb
@@ -228,7 +182,6 @@ files:
 - lib/anycable/server.rb
 - lib/anycable/socket.rb
 - lib/anycable/version.rb
-- protos/rpc.proto
 homepage: http://github.com/anycable/anycable
 licenses:
 - MIT
@@ -248,8 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: AnyCable is a polyglot replacement for ActionCable-compatible servers

data/.github/ISSUE_TEMPLATE.md

@@ -1,25 +0,0 @@
-<!--
-  First of all, thanks for your report/suggestion/whatever!
-
-  This template is for bug reports. If you are reporting a bug, please continue on. If you are here for another reason, 
-  feel free to skip the rest of this template.
--->
-
-### Tell us about your environment
-
-**Ruby version:**
-
-**`anycable` gem version:**
-
-**`grpc` gem version:**
-
-### What did you do?
-
-### What did you expect to happen?
-
-### What actually happened?
-
-<!--
-  Please, provide reproduction script (using this template (https://github.com/anycable/anycable/blob/master/etc/bug_report_template.rb)
-  when submitting bugs if possible.
--->

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,31 +0,0 @@
-<!--
-  First of all, thanks for contributing!
-
-  If it's a typo fix or minor documentation update feel free to skip the rest of this template!
--->
-
-<!--
-  If it's a bug fix, then link it to the issue, for example:
-
-  Fixes #xxx
--->
-
-
-<!--
-  Otherwise, describe the changes: 
-
-### What is the purpose of this pull request?
-
-### What changes did you make? (overview)
-
-### Is there anything you'd like reviewers to focus on?
-
--->
-
-<!--
-    Please ensure your PR is ready:
-
-    - Include tests for this change
-    - Add Changelog entry
-    - Update documentation for this change (if appropriate)
--->

data/.gitignore

@@ -1,40 +0,0 @@
-# Numerous always-ignore extensions
-*.diff
-*.err
-*.orig
-*.log
-*.rej
-*.swo
-*.swp
-*.vi
-*~
-*.sass-cache
-*.iml
-.idea/
-
-# Sublime
-*.sublime-project
-*.sublime-workspace
-
-# OS or Editor folders
-.DS_Store
-.cache
-.project
-.settings
-.tmproj
-Thumbs.db
-
-.bundle/
-log/*.log
-*.gz
-pkg/
-spec/dummy/db/*.sqlite3
-spec/dummy/db/*.sqlite3-journal
-spec/dummy/tmp/
-
-Gemfile.lock
-Gemfile.local
-.rspec
-*.gem
-tmp/
-coverage/