anycable-core 1.4.0.pre.rc.1 → 1.4.0.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ffabf719d153bb5390a13125389bf92b8d11a1b0a0f500774a95f50fd3cee14
-  data.tar.gz: 9db169beafb99939716eca55267c0b1df57fd1a91dd6f98edc156070b5809b6f
+  metadata.gz: 25b7f4021fa0e158fbd28f5213545756750ab8222ed43c25e770bb4031083f9e
+  data.tar.gz: a2f5760a88c80ed483d1de2b953558f2ac4f66b71d55a2e1745b52f1ce359f3d
 SHA512:
-  metadata.gz: bbfa0d23d3fcd4d395b66845169f286edf5c087303581c83f5163d647b8e5955fb3902139592e2ad15a469a00d619c99e70d3213195e1a52d08cb52c528a1520
-  data.tar.gz: dd417c36b177f39aa2c8ac0ce72d0f5fe56197dfa3432d8242f074733c3d6fe8fd4085334c39df14f5afb71937acab1e12d96b5dbf2105a45177698d795d0f4b
+  metadata.gz: f18b8269a526c7cebedcd0146f12a3dc43e1aa3c0af23e3bbe147f632758bfc1b3102e972f6416b1a1b7228cfcc9a9c8f90ba1b22a0d173a8f46ce392777d93f
+  data.tar.gz: 36a767ee9034deefbecc0696843e65c1c1773ce8e58cf5898a4a4fd4bd44784fbf7cd8a4a7ba5d6bcb84767b1466df465d8c26b2ac634aaa55aa311f2e84734b

data/CHANGELOG.md

@@ -2,7 +2,11 @@
 
 ## master
 
-## 1.4.0-rc.1 (2023-06-01)
+## 1.4.0.rc.2 (2023-07-03)
+
+- Add HTTP RPC support. ([@palkan][])
+
+## 1.4.0.rc.1 (2023-06-01)
 
 - Add `redisx` broadcast adapter. ([@palkan][])
 

data/lib/anycable/config.rb

@@ -53,6 +53,9 @@ module AnyCable
       http_health_port: nil,
       http_health_path: "/health",
 
+      ### HTTP RPC options
+      http_rpc_secret: nil,
+
       ### Misc options
       version_check_enabled: true,
       sid_header_enabled: true
@@ -110,6 +113,9 @@ module AnyCable
       HTTP PUB/SUB
           --http-broadcast-url              HTTP pub/sub endpoint URL, default: "http://localhost:8090/_broadcast"
           --http-broadcast-secret           HTTP pub/sub authorization secret, default: <none> (disabled)
+
+      HTTP RPC
+          --http-rpc-secret                 HTTP RPC authorization secret, default: <none> (disabled)
     TXT
 
     # Build Redis parameters

data/lib/anycable/httrpc/server.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module AnyCable
+  module HTTRPC
+    class Server
+      def initialize(token: AnyCable.config.http_rpc_secret)
+        @token = token
+      end
+
+      def call(env)
+        if env["REQUEST_METHOD"] != "POST"
+          return [404, {}, ["Not found"]]
+        end
+
+        if token && env["HTTP_AUTHORIZATION"] != "Bearer #{token}"
+          return [401, {}, ["Unauthorized"]]
+        end
+
+        rpc_command = env["PATH_INFO"].sub(%r{^/}, "").to_sym
+
+        # check if command is supported and return 404 if not
+        return [404, {}, ["Not found"]] unless AnyCable.rpc_handler.supported?(rpc_command)
+
+        # read request body and it's empty, return 422
+        request_body = env["rack.input"].read
+        return [422, {}, ["Empty request body"]] if request_body.empty?
+
+        payload =
+          case rpc_command
+          when :connect then AnyCable::ConnectionRequest.decode_json(request_body)
+          when :disconnect then AnyCable::DisconnectRequest.decode_json(request_body)
+          when :command then AnyCable::CommandMessage.decode_json(request_body)
+          end
+
+        return [422, {}, ["Invalid request body"]] if payload.nil?
+
+        response = AnyCable.rpc_handler.handle(rpc_command, payload, build_meta(env))
+
+        [200, {}, [response.to_json({format_enums_as_integers: true})]]
+      rescue JSON::ParserError, ArgumentError => e
+        [422, {}, ["Invalid request body: #{e.message}"]]
+      end
+
+      private
+
+      attr_reader :token
+
+      def build_meta(env)
+        # `x-anycable-meta-var` -> `meta["var"]`
+        env.each_with_object({}) do |(k, v), meta|
+          next unless k.start_with?("HTTP_X_ANYCABLE_META_")
+          meta[k.sub(%r{^HTTP_X_ANYCABLE_META_}, "").downcase] = v
+          meta
+        end
+      end
+    end
+  end
+end

data/lib/anycable/rpc/handler.rb

@@ -23,6 +23,10 @@ module AnyCable
         end
       end
 
+      def supported?(cmd)
+        %i[connect disconnect command].include?(cmd)
+      end
+
       private
 
       attr_reader :commands, :middleware

data/lib/anycable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AnyCable
-  VERSION = "1.4.0-rc.1"
+  VERSION = "1.4.0.rc.2"
 end

data/lib/anycable.rb

@@ -16,6 +16,8 @@ require "anycable/socket"
 require "anycable/rpc"
 require "anycable/health_server"
 
+require "anycable/httrpc/server"
+
 # AnyCable allows to use any websocket service (written in any language) as a replacement
 # for ActionCable server.
 #

data/sig/anycable/config.rbs

@@ -41,6 +41,8 @@ module AnyCable
     def http_health_port=: (Integer) -> void
     def http_health_path: () -> String
     def http_health_path=: (String) -> void
+    def http_rpc_secret: () -> String
+    def http_rpc_secret=: (String) -> void
     def version_check_enabled: () -> bool
     def version_check_enabled=: (bool) -> void
     def version_check_enabled?: () -> bool

data/sig/anycable/httrpc/server.rbs

@@ -0,0 +1,11 @@
+module AnyCable
+  module HTTRPC
+    class Server
+      def initialize: (?token: String?) -> void
+      def call: (Hash[String, untyped] env) -> [Integer, Hash[String, String], Array[String]]
+      private
+      attr_reader token: String?
+      def build_meta: (Hash[String, untyped] env) -> Hash[String, String]
+    end
+  end
+end

data/sig/anycable/rpc/handler.rbs

@@ -15,6 +15,7 @@ module AnyCable
 
       def initialize: (?middleware: MiddlewareChain) -> void
       def handle: (Symbol cmd, rpcRequest data, ?rpcMetadata meta) -> rpcResponse
+      def supported?: (Symbol cmd) -> bool
 
       private
 

data/sig/anycable/rpc.rbs

@@ -73,6 +73,7 @@ module AnyCable
   class ConnectionRequest
     include _WithEnv
 
+    def self.decode_json: (String) -> instance
     %a{rbs:test:skip} def initialize: (?env: Env) -> void
     def to_h: () -> Hash[Symbol, untyped]
   end
@@ -95,11 +96,14 @@ module AnyCable
     ) -> void
 
     def to_h: () -> Hash[Symbol, untyped]
+    def to_json: (?Hash[Symbol, untyped] options) -> String
   end
 
   class CommandMessage
     include _WithEnv
 
+    def self.decode_json: (String) -> instance
+
     attr_accessor command: String
     attr_accessor identifier: String
     attr_accessor connection_identifiers: String
@@ -139,11 +143,14 @@ module AnyCable
     ) -> void
 
     def to_h: () -> Hash[Symbol, untyped]
+    def to_json: (?Hash[Symbol, untyped] options) -> String
   end
 
   class DisconnectRequest
     include _WithEnv
 
+    def self.decode_json: (String) -> instance
+
     attr_accessor identifiers: String
     attr_accessor subscriptions: Array[String]
 
@@ -159,6 +166,7 @@ module AnyCable
 
     %a{rbs:test:skip} def initialize: (status: rpcStatus, ?error_msg: String) -> void
     def to_h: () -> Hash[Symbol, untyped]
+    def to_json: (?Hash[Symbol, untyped] options) -> String
   end
 
   type rpcRequest = ConnectionRequest | DisconnectRequest | CommandMessage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anycable-core
 version: !ruby/object:Gem::Version
-  version: 1.4.0.pre.rc.1
+  version: 1.4.0.rc.2
 platform: ruby
 authors:
 - palkan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-01 00:00:00.000000000 Z
+date: 2023-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -216,6 +216,7 @@ files:
 - lib/anycable/grpc_kit/health_services_pb.rb
 - lib/anycable/grpc_kit/server.rb
 - lib/anycable/health_server.rb
+- lib/anycable/httrpc/server.rb
 - lib/anycable/middleware.rb
 - lib/anycable/middleware_chain.rb
 - lib/anycable/middlewares/check_version.rb
@@ -246,6 +247,7 @@ files:
 - sig/anycable/grpc/rpc_services_pb.rbs
 - sig/anycable/grpc/server.rbs
 - sig/anycable/health_server.rbs
+- sig/anycable/httrpc/server.rbs
 - sig/anycable/middleware.rbs
 - sig/anycable/middleware_chain.rbs
 - sig/anycable/middlewares/check_version.rbs