anycable-rack-server 0.2.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0515017e6e7f746e09105d2feb3fdbbcad873c406ad0e4c3d11ae109eb952b26
-  data.tar.gz: fda34861fae7508fc64a1321d2346bd1ed47f5cce1d71044b4ef3b2d2d36e06b
+  metadata.gz: 1e0fb06453d826cf3c314edb0dbb6ab1f1ab8774760b40985b105aaf87ca1316
+  data.tar.gz: a6fc8f21bf0944cf1cacb58b779b222782e485af7fe8dcec1bf719b31e05d38f
 SHA512:
-  metadata.gz: 8e82a0ddf031e13515d9d8df0a645f8aea5ab1c59241ffd3b9202906cca1c6c4b05393a2e51685e28da1e27a702d41f26a14fdb8d32bcf5ec42e9773b404348d
-  data.tar.gz: 1e0d334e324695a6b583be61da56bc28a40dd030aef7f8c35941085c0dea7cbb963fdd2da115adafac6d2459b3dc4951909c417433371577343d28c609928fb5
+  metadata.gz: cba311e11d372c3c6b42f530350bd81729102814a24209c63ae37460fc810b638db350afc82b930b5f8623acdc9423182e70489e220247f82c7c89f09efb8b74
+  data.tar.gz: a8541982f21133340285977c16852f3bbc41c18f4ce431e5b0261f4d3509f8bdf7f9d3816f500c8401eeac3de7223da39b8f5e008fd9c28e131322d4ab8588ad

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2020 Yulia Oletskaya, Vladimir Dementyev
+Copyright (c) 2019-2022 Yulia Oletskaya, Vladimir Dementyev
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -74,7 +74,8 @@ config.any_cable_rack.rpc_port = 50051
 
 ## Broadcast adapters
 
-AnyCable Rack supports Redis (default) and HTTP broadcast adapters (see [the documentation](https://docs.anycable.io/#/ruby/broadcast_adapters)).
+AnyCable Rack supports Redis (default) and HTTP broadcast adapters
+(see [the documentation](https://docs.anycable.io/ruby/broadcast_adapters)).
 
 Broadcast adapter is inherited from AnyCable configuration (so, you don't need to configure it twice).
 
@@ -110,24 +111,6 @@ config.any_cable_rack.http_broadcast_path = "/_my_broadcast"
 
 **NOTE:** Don't forget to configure `http_broadcast_url` for AnyCable pointing to your web server and the specified broadcast path.
 
-## Running RPC from the same process
-
-The goal of the Rack server is to simplify the development/testing process. But we still have to run the RPC server.
-
-This gem also provides a way to run RPC server within the same process.
-All you need to do is set `run_rpc = true` in the configuration:
-
-```ruby
-# in Rack app
-AnyCable::Rack.config.run_rpc = true
-
-# and only after that
-ws_server.start!
-
-# in Rails
-config.any_cable_rack.run_rpc = true
-```
-
 ## Testing
 
 Run units with `bundle exec rake`.

data/lib/anycable/rack/broadcast_subscribers/base_subscriber.rb

@@ -32,7 +32,7 @@ module AnyCable
           if data["stream"]
             hub.broadcast(data["stream"], data["data"], coder)
           elsif data["command"] == "disconnect"
-            hub.disconnect(data["payload"]["identifier"], data["payload"]["reconnect"])
+            hub.disconnect(data["payload"]["identifier"], data["payload"]["reconnect"], coder)
           end
         end
       end

data/lib/anycable/rack/coders/json.rb

@@ -5,7 +5,7 @@ require "json"
 module AnyCable
   module Rack
     module Coders
-      module JSON # :nodoc:
+      module Json # :nodoc:
         class << self
           def decode(json_str)
             ::JSON.parse(json_str)

data/lib/anycable/rack/coders/msgpack.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+gem "msgpack", "~> 1.4"
+require "msgpack"
+
+module AnyCable
+  module Rack
+    module Coders
+      module Msgpack # :nodoc:
+        class << self
+          def decode(bin)
+            MessagePack.unpack(bin)
+          end
+
+          def encode(ruby_obj, binary_frame_wrap: true)
+            message_packed = MessagePack.pack(ruby_obj)
+
+            return message_packed unless binary_frame_wrap
+
+            BinaryFrame.new(message_packed)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/anycable/rack/coders/proto/message_pb.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "google/protobuf"
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "action_cable.Message" do
+    optional :type, :enum, 1, "action_cable.Type"
+    optional :command, :enum, 2, "action_cable.Command"
+    optional :identifier, :string, 3
+    optional :data, :string, 4
+    optional :message, :bytes, 5
+    optional :reason, :string, 6
+    optional :reconnect, :bool, 7
+  end
+  add_enum "action_cable.Type" do
+    value :no_type, 0
+    value :welcome, 1
+    value :disconnect, 2
+    value :ping, 3
+    value :confirm_subscription, 4
+    value :reject_subscription, 5
+  end
+  add_enum "action_cable.Command" do
+    value :unknown_command, 0
+    value :subscribe, 1
+    value :unsubscribe, 2
+    value :message, 3
+  end
+end
+
+module ActionCable
+  Message = Google::Protobuf::DescriptorPool.generated_pool.lookup("action_cable.Message").msgclass
+  Type = Google::Protobuf::DescriptorPool.generated_pool.lookup("action_cable.Type").enummodule
+  Command = Google::Protobuf::DescriptorPool.generated_pool.lookup("action_cable.Command").enummodule
+end

data/lib/anycable/rack/coders/protobuf.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+gem "google-protobuf", "~> 3.19", ">= 3.19.1"
+require_relative "./proto/message_pb"
+require_relative "./msgpack"
+
+module AnyCable
+  module Rack
+    module Coders
+      module Protobuf # :nodoc:
+        class << self
+          def decode(bin)
+            decoded_message = ActionCable::Message.decode(bin).to_h
+
+            decoded_message[:command] = decoded_message[:command].to_s
+            if decoded_message[:message].present?
+              decoded_message[:message] = Msgpack.decode(decoded_message[:message])
+            end
+
+            decoded_message.each_with_object({}) { |(k, v), h| h[k.to_s] = v }
+          end
+
+          def encode(ruby_obj)
+            message = ruby_obj.delete(:message)
+
+            data = ActionCable::Message.new(ruby_obj)
+
+            if message
+              data.message = Msgpack.encode(message, binary_frame_wrap: false)
+            end
+
+            BinaryFrame.new(ActionCable::Message.encode(data))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/anycable/rack/config.rb

@@ -12,11 +12,11 @@ module AnyCable
 
       attr_config mount_path: "/cable",
                   headers: DEFAULT_HEADERS,
+                  coder: :json,
                   rpc_addr: "localhost:50051",
                   rpc_client_pool_size: 5,
                   rpc_client_timeout: 5,
-                  http_broadcast_path: "/_anycable_rack_broadcast",
-                  run_rpc: false
+                  http_broadcast_path: "/_anycable_rack_broadcast"
     end
   end
 end

data/lib/anycable/rack/connection.rb

@@ -67,7 +67,8 @@ module AnyCable
       private
 
       def transmit(cable_message)
-        socket.transmit(encode(cable_message))
+        encoded = encode(cable_message)
+        socket.transmit(encoded)
       end
 
       def close
@@ -133,7 +134,7 @@ module AnyCable
       end
 
       def process_command(response, identifier)
-        response.transmissions.each { |transmission| transmit(decode(transmission)) }
+        response.transmissions.each { |transmission| transmit(decode_transmission(transmission)) }
         hub.remove_channel(socket, identifier) if response.stop_streams
         response.streams.each { |stream| hub.add_subscriber(stream, socket, identifier) }
         response.stopped_streams.each { |stream| hub.remove_subscriber(stream, socket, identifier) }
@@ -145,7 +146,7 @@ module AnyCable
       end
 
       def process_open(response)
-        response.transmissions&.each { |transmission| transmit(decode(transmission)) }
+        response.transmissions&.each { |transmission| transmit(decode_transmission(transmission)) }
         if response.status == :SUCCESS
           @_identifiers = response.identifiers
           @_cstate = response.env.cstate&.to_h || {}
@@ -181,6 +182,10 @@ module AnyCable
         coder.encode(cable_message)
       end
 
+      def decode_transmission(json_message)
+        JSON.parse(json_message)
+      end
+
       def decode(websocket_message)
         coder.decode(websocket_message)
       end

data/lib/anycable/rack/hub.rb

@@ -71,7 +71,7 @@ module AnyCable
         end
 
         list.each do |(channel_id, sockets)|
-          decoded = coder.decode(message)
+          decoded = JSON.parse(message)
           cmessage = channel_message(channel_id, decoded, coder)
           sockets.each { |socket| socket.transmit(cmessage) }
         end
@@ -81,14 +81,14 @@ module AnyCable
         sockets.each_key { |socket| socket.transmit(message) }
       end
 
-      def disconnect(identifier, reconnect)
+      def disconnect(identifier, reconnect, coder)
         sockets = @sync.synchronize do
           return unless @streams[INTERNAL_STREAM].key?(identifier)
 
           @streams[INTERNAL_STREAM][identifier].to_a
         end
 
-        msg = disconnect_message("remote", reconnect)
+        msg = disconnect_message("remote", reconnect, coder)
 
         sockets.each do |socket|
           socket.transmit(msg)
@@ -115,9 +115,8 @@ module AnyCable
         coder.encode(identifier: channel_id, message: message)
       end
 
-      # FIXME: coder support?
-      def disconnect_message(reason, reconnect)
-        {type: :disconnect, reason: reason, reconnect: reconnect}.to_json
+      def disconnect_message(reason, reconnect, coder)
+        coder.encode({type: :disconnect, reason: reason, reconnect: reconnect})
       end
     end
   end

data/lib/anycable/rack/middleware.rb

@@ -9,7 +9,8 @@ require "anycable/rack/socket"
 module AnyCable
   module Rack
     class Middleware # :nodoc:
-      PROTOCOLS = ["actioncable-v1-json", "actioncable-unsupported"].freeze
+      PROTOCOLS = %w[actioncable-v1-json actioncable-v1-msgpack actioncable-unsupported actioncable-v1-protobuf].freeze
+
       attr_reader :pinger,
         :hub,
         :coder,

data/lib/anycable/rack/pinger.rb

@@ -8,7 +8,10 @@ module AnyCable
     class Pinger
       INTERVAL = 3
 
-      def initialize
+      attr_reader :coder
+
+      def initialize(coder)
+        @coder = coder
         @_sockets = []
         @_stopped = false
       end
@@ -45,7 +48,7 @@ module AnyCable
       private
 
       def ping_message(time)
-        {type: :ping, message: time}.to_json
+        coder.encode({type: :ping, message: time})
       end
     end
   end

data/lib/anycable/rack/rpc/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "connection_pool"
-require "grpc"
+require "anycable/grpc"
 
 module AnyCable
   module Rack
@@ -12,7 +12,7 @@ module AnyCable
 
         def initialize(host:, size:, timeout:)
           @pool = ConnectionPool.new(size: size, timeout: timeout) do
-            AnyCable::RPC::Service.rpc_stub_class.new(host, :this_channel_is_insecure)
+            AnyCable::GRPC::Service.rpc_stub_class.new(host, :this_channel_is_insecure)
           end
           @metadata = {metadata: {"protov" => "v1"}}.freeze
         end

data/lib/anycable/rack/server.rb

@@ -8,7 +8,6 @@ require "anycable/rack/errors"
 require "anycable/rack/middleware"
 require "anycable/rack/logging"
 require "anycable/rack/broadcast_subscribers/base_subscriber"
-require "anycable/rack/coders/json"
 
 module AnyCable # :nodoc: all
   module Rack
@@ -28,9 +27,8 @@ module AnyCable # :nodoc: all
       def initialize(config: AnyCable::Rack.config)
         @config = config
         @hub = Hub.new
-        @pinger = Pinger.new
-        # TODO: Support other coders
-        @coder = Coders::JSON
+        @coder = resolve_coder(config.coder)
+        @pinger = Pinger.new(coder)
 
         @broadcast = resolve_broadcast_adapter
         @rpc_client = RPC::Client.new(
@@ -58,8 +56,6 @@ module AnyCable # :nodoc: all
 
         broadcast.start
 
-        Rack.rpc_server.run if config.run_rpc
-
         @_started = true
       end
 
@@ -114,6 +110,11 @@ module AnyCable # :nodoc: all
           raise ArgumentError, "Unsupported broadcast adatper: #{adapter}. AnyCable Rack server only supports: redis, http"
         end
       end
+
+      def resolve_coder(name)
+        require "anycable/rack/coders/#{name}"
+        AnyCable::Rack::Coders.const_get(name.capitalize)
+      end
     end
   end
 end

data/lib/anycable/rack/socket.rb

@@ -4,6 +4,17 @@ require "anycable/rack/logging"
 
 module AnyCable
   module Rack
+    # Wrapper for outgoing data used to correctly set the WS frame type
+    class BinaryFrame
+      def initialize(data)
+        @data = data
+      end
+
+      def to_s
+        @data.to_s
+      end
+    end
+
     # Socket wrapper
     class Socket
       include Logging
@@ -22,7 +33,9 @@ module AnyCable
         @_active = true
       end
 
-      def transmit(data, type: :text)
+      def transmit(data, type: nil)
+        # p "DATA: #{data.class} — #{data.to_s}"
+        type ||= data.is_a?(BinaryFrame) ? :binary : :text
         frame = WebSocket::Frame::Outgoing::Server.new(
           version: version,
           data: data,
@@ -144,7 +157,7 @@ module AnyCable
           end
         end
       rescue Exception => e # rubocop:disable Lint/RescueException
-        log(:error, "Socket frame error: #{e}")
+        log(:error, "Socket frame error: #{e}\n #{e.backtrace.take(4).join("\n")}")
         nil # client disconnected or timed out
       end
     end

data/lib/anycable/rack/version.rb

@@ -2,6 +2,6 @@
 
 module AnyCable
   module Rack
-    VERSION = "0.2.1"
+    VERSION = "0.5.0"
   end
 end

data/lib/anycable-rack-server.rb

@@ -10,13 +10,6 @@ module AnyCable
       def config
         @config ||= Config.new
       end
-
-      def rpc_server
-        return @rpc_server if instance_variable_defined?(:@rpc_server)
-
-        require "anycable/cli"
-        @rpc_server = AnyCable::CLI.new(embedded: true)
-      end
     end
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: anycable-rack-server
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Yulia Oletskaya
 - Vladimir Dementyev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-08 00:00:00.000000000 Z
+date: 2022-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -17,28 +17,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: anycable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.0.99
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.0.99
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +170,9 @@ files:
 - lib/anycable/rack/broadcast_subscribers/http_subscriber.rb
 - lib/anycable/rack/broadcast_subscribers/redis_subscriber.rb
 - lib/anycable/rack/coders/json.rb
+- lib/anycable/rack/coders/msgpack.rb
+- lib/anycable/rack/coders/proto/message_pb.rb
+- lib/anycable/rack/coders/protobuf.rb
 - lib/anycable/rack/config.rb
 - lib/anycable/rack/connection.rb
 - lib/anycable/rack/errors.rb
@@ -177,11 +186,11 @@ files:
 - lib/anycable/rack/server.rb
 - lib/anycable/rack/socket.rb
 - lib/anycable/rack/version.rb
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -196,8 +205,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: AnyCable Rack Server
 test_files: []