anycable 0.6.3 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 982192dbe84e0576b13033aadf3ead0238e28bf4c30b6dec2d08228cd2093f3c
-  data.tar.gz: 9af924544238340e0c5b171a738b9bec99ebe25c13cc398d279318f6c9cbef12
+  metadata.gz: deebe94f2e541a9d14ccf4a56df910cdb5a2fb17ae6815ffaaa2f761fdcd07ad
+  data.tar.gz: e96c5b0d28dd7617c2cfa1249fde5bd357465be7596915720c27718f486c4f16
 SHA512:
-  metadata.gz: ba03a684ddce90df929c469deb4b219a494578ab9c203321e9c9f900810f98132eb74d8fc16aa1b79c6042c28bd5b3da2ac83d39bd4e25944127191dc4b2f8b7
-  data.tar.gz: 77a874ad448dff0cca9d8ada4259c8c48ab4fdb87d1df1f3c6bee1dab50f23335f1fc390ee60fb96483a89cc0071700945bdffa73f908745987de2c2e7877c91
+  metadata.gz: b585f2797184d7bc78cc761707b741dcfa8a6b796df91cccd7ac1e44c9210a84852daba838adaaa6b2f1548d2d0f82cf57713b32a4a86d0ffa671f64321b9df1
+  data.tar.gz: dccd27127eaafc5b7821ba18404546269e9aaf3163faccffaba864e166cb1c19cdc914ccf9de87da963cac447541058e0d7ba906674298f9dda8573ca4e917c8

data/CHANGELOG.md

@@ -1,246 +1,47 @@
 # Change log
 
-## master
+## 1.0.0.rc1 (2020-06-10)
 
-## 0.6.3 (2019-03-26)
+- Add `Env#istate` and `EnvResponse#istate` to store channel state. ([@palkan][])
 
-- Relax `redis` gem version requirement. ([@palkan][])
+That would allow to mimic instance variables usage in Action Cable channels.
 
-Use the same restriction as Action Cable does (`>= 3`).
+- Add `CommandResponse#stopped_streams` to support unsubscribing from particular broadcastings. ([@palkan])
 
-## 0.6.2 (2019-03-15)
+`Socket#unsubscribe` is now implemented as well.
 
-- Add GRPC service method name and message content to exception notifications ([@sponomarev][])
+- Add `AnyCable.broadcast_adapter#broadcast_command` method. ([@palkan][])
 
-`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.
+It could be used to send commands to WS server (e.g., remote disconnect).
 
-Example:
+- Add `:http` broadcasting adapter. ([@palkan][])
 
-```ruby
-AnyCable.capture_exception do |ex, method, message|
-  Honeybadger.notify(ex, component: "any_cable", action: method, params: message)
-end
-```
+- **RPC schema has changed**. ([@palkan][])
 
-Usage of a handler proc with just a single argument is preserved for the sake of compatibility.
+Using `anycable-go` v1.x is required.
 
-- Add deprecation warning to default host usage ([@sponomarev][])
+- **Ruby 2.5+ is required**. ([@palkan][])
 
-Exposing AnyCable publicly is considered to be harmful and planned to be changed
-in future versions.
+- Added RPC proto version check. ([@palkan][])
 
-- Allow running the server as a detachable daemon ([@sponomarev][])
+Server must sent `protov` metadata with the supported versions (comma-separated list). If there is no matching version an exception is raised.
 
-Server is fully managed by the binary itself.
+Current RPC proto version is **v1**.
 
-```
-# Start anycable daemon
-$ bundle exec anycabled start
+- Added `request` support to channels. ([@palkan][])
 
-# 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
+Now you can access `request` object in channels, too (e.g., to read headers/cookies/URL/etc).
 
-# Stop anycable daemon
-$ bundle exec anycabled stop
+- Change default server address from `[::]:50051` to `127.0.0.1:50051`. ([@palkan][])
 
-# See more anycable daemon options
-$ bundle exec anycabled
-```
+See [#71](https://github.com/anycable/anycable/pull/71).
 
-## 0.6.1 (2019-01-05)
+- Fix building Redis Sentinel config. ([@palkan][])
 
-- [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][])
-
-## 0.5.1 (2018-06-13)
-
-Minor fixes.
-
-## 0.5.0 (2017-10-21)
-
-- [#2](https://github.com/anycable/anycable/issues/2) Add support for [Redis Sentinel](https://redis.io/topics/sentinel). ([@accessd][])
-
-- [#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.
-
-- [#27](https://github.com/anycable/anycable/issues/27) Add `error_msg` to RPC responses. ([@palkan][])
-
-Now RPC responses has 3 statuses:
-
-  - `SUCCESS` – successful request, operation succeed
-  - `FAILURE` – successful request, operation failed (e.g. authentication failed)
-  - `ERROR` – request failed (exception raised).
-
-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
-any severity.
-
-GRPC logging is turned off by default (can be turned on through `log_grpc` configuration parameter).
-
-`ANYCABLE_DEBUG=1` acts as a shortcut to set `debug` level and turn on GRPC logging.
-
-Now it's possible to add custom exception handlers (e.g. to notify external exception tracking services).
-
-More on [Wiki](https://github.com/anycable/anycable/wiki/Logging-&-Exceptions-Handling).
-
-## 0.4.6 (2017-05-20)
-
-- Add `Anycable::Server#stop` method. ([@sadovnik][])
-
-## 0.4.5 (2017-03-17)
-
-- Fixed #11. ([@palkan][])
-
-## 0.4.4 (2017-03-06)
-
-- Handle `StandardError` gracefully in RPC calls. ([@palkan][])
-
-## 0.4.3 (2017-02-18)
-
-- Update `grpc` version dependency to support Ruby 2.4. ([@palkan][])
-
-## 0.4.2 (2017-01-28)
-
-- Change socket streaming API. ([@palkan][])
-
-Add `Socket#subscribe`, `unsubscribe` and `unsubscribe_from_all` methods.
-
-## 0.4.1 (2017-01-24)
-
-- Introduce _fake_ socket instance to handle transmissions and streams. ([@palkan][])
-
-- Make commands handling more abstract. ([@palkan][])
-
-We now do not explicitly call channels action but use the only one entrypoing for all commands:
-
-```ruby
-connection.handle_channel_command(identifier, command, data)
-```
-
-This method should return `true` if command was successful and `false` otherwise.
-
-## 0.4.0 (2017-01-22)
-
-- Refactor RPC API. ([@palkan][])
-
-Replace `Subscribe`, `Unsubscribe` and `Perform` methods with `Command` method.
-
-- Extract Rails functionality to separate gem. ([@palkan][])
-
-All Rails specifics now live here https://github.com/anycable/anycable-rails.
-
-## 0.3.0 (2016-12-28)
-
-- Handle `Disconnect` requests. ([@palkan][])
-
-Implement `Disconnect` handler, which invokes `Connection#disconnect` (along with `Channel#unsubscribed` for each subscription).
+See [Changelog](https://github.com/anycable/anycable/blob/0-6-stable/CHANGELOG.md) for versions <1.0.0.
 
 [@palkan]: https://github.com/palkan
-[@sadovnik]: https://github.com/sadovnik
-[@accessd]: https://github.com/accessd
-[@DarthSim]: https://github.com/DarthSim
+[@sponomarev]: https://github.com/sponomarev
+[@bibendi]: https://github.com/bibendi

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2017-2019 Vladimir Dementyev
+Copyright 2017-2020 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,27 +1,31 @@
-[![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)
+[![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](https://github.com/anycable/anycable/workflows/Build/badge.svg)](https://github.com/anycable/anycable/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)
+[![Documentation](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://docs.anycable.io/v1)
 
 # AnyCable
 
 <img align="right" height="150" width="129"
      title="AnyCable logo" src="https://docs.anycable.io/assets/images/logo.svg">
 
-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 allows you to use any WebSocket server (written in any language) as a replacement for your Ruby server (such as Faye, Action Cable, 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.
+
+**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/tree/0-6-stable) branch.
 
 <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 **in production**, [discuss other options](https://github.com/anycable/anycable/issues/2) with us!)
 
 ## Usage
 
-Check out our 📑 [Documentation](https://docs.anycable.io).
+Check out our 📑 [Documentation](https://docs.anycable.io/v1).
 
 ## Links
 
@@ -43,31 +47,33 @@ Check out our 📑 [Documentation](https://docs.anycable.io).
 
 - 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)
-- [ErlyCable](https://github.com/anycable/erlycable)
+## Building
 
-## Build
+### Generating gRPC files from `.proto`
 
 - 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 contact us at `anycable@evilmartians.com`. We will coordinate the fix and disclosure.

data/lib/anycable.rb

@@ -56,14 +56,6 @@ module AnyCable
       ExceptionsHandling << block
     end
 
-    def 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)
@@ -75,7 +67,7 @@ module AnyCable
     end
 
     def broadcast_adapter
-      self.broadcast_adapter = :redis unless instance_variable_defined?(:@broadcast_adapter)
+      self.broadcast_adapter = AnyCable.config.broadcast_adapter.to_sym unless instance_variable_defined?(:@broadcast_adapter)
       @broadcast_adapter
     end
 
@@ -103,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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "anycable/broadcast_adapters/base"
+
 module AnyCable
   module BroadcastAdapters # :nodoc:
     module_function
@@ -17,16 +19,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/base.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module AnyCable
+  module BroadcastAdapters
+    class Base
+      def raw_broadcast(_data)
+        raise NotImplementedError
+      end
+
+      def broadcast(stream, payload)
+        raw_broadcast({stream: stream, data: payload}.to_json)
+      end
+
+      def broadcast_command(command, **payload)
+        raw_broadcast({command: command, payload: payload}.to_json)
+      end
+
+      def announce!
+        logger.info "Broadcasting via #{self.class.name}"
+      end
+
+      private
+
+      def logger
+        AnyCable.logger
+      end
+    end
+  end
+end