anycable-core 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 231e6b2d9faf7e35f2362e174c1440791268238e872a4c454b64e164deefd612
-  data.tar.gz: 3f915b4c9c40b0b0b6b611051aa34d1ad5868fbd2aff7738b372d35ed0fe89ee
+  metadata.gz: 3ae8ddced1365e350a744545ed12da6e42fffbaa3f58d40b0f9d83598077a88a
+  data.tar.gz: 6637778d168c99c19a760a635455496ee121dfbbe0fd2472a3a29c4311ce3f7d
 SHA512:
-  metadata.gz: 2f4abf1cc380e9228b5928498474bcd045d0f50719f9ddc9d522f7b17946ae4d8488259dda27982770327e26674f75ec4ca2d406fe248f7c6320c9e6f01a6662
-  data.tar.gz: 134d88ea2c47c69240823dc8f75f184f65ac036a41b618479b039b76e985c9cdc0905bf723294d6255b243e0989e4d455e4fb5bd545557536be90bead542e944
+  metadata.gz: 3446218216fc8c7b76a0ddd249a8976afe8f9ddf83cdd4714bc29a94a2037caa066c5cae02bcb4a8109fd64555f80b871a4c718d059ec6382e814e9b7cc11ff0
+  data.tar.gz: 3711df758ce8d1963f158371f5c80a06757ffd3b392acf28cbec79652abe6d61e821800ddd6f2054310d2082a651263bcbe56bfb56a5af11dfc1bbdbe40044e8

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 1.2.3 (2022-04-20)
+
+- Pass unique connection id (_session id_) in the `anycable.sid` Rack env field. ([@palkan][])
+
 ## 1.2.2 (2022-03-04)
 
 - Allow Ruby 2.6.

data/lib/anycable/cli.rb

@@ -65,6 +65,8 @@ module AnyCable
 
       check_version!
 
+      configure_middleware!
+
       @server = AnyCable.server_builder.call(config)
 
       # Make sure middlewares are not adding after server has started
@@ -265,6 +267,12 @@ module AnyCable
       )
     end
 
+    def configure_middleware!
+      if config.sid_header_enabled?
+        AnyCable.middleware.use(AnyCable::Middlewares::EnvSid)
+      end
+    end
+
     def parse_gem_options!(args)
       config.parse_options!(args)
     rescue OptionParser::InvalidOption => e

data/lib/anycable/config.rb

@@ -43,7 +43,8 @@ module AnyCable
       http_health_path: "/health",
 
       ### Misc options
-      version_check_enabled: true
+      version_check_enabled: true,
+      sid_header_enabled: true
     )
 
     if respond_to?(:coerce_types)

data/lib/anycable/middlewares/env_sid.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module AnyCable
+  module Middlewares
+    # Set sid for request.env from metadata
+    class EnvSid < AnyCable::Middleware
+      def call(_method, request, meta)
+        return yield unless meta["sid"]
+        request.env.sid = meta["sid"]
+
+        yield
+      end
+    end
+  end
+end

data/lib/anycable/rpc.rb

@@ -88,4 +88,11 @@ module AnyCable
   class DisconnectResponse
     include StatusPredicates
   end
+
+  # TODO: Move sid to env in the future version of RPC proto
+  unless Env.instance_methods(false).include?(:sid)
+    class Env
+      attr_accessor :sid
+    end
+  end
 end

data/lib/anycable/socket.rb

@@ -129,7 +129,8 @@ module AnyCable
         "rack.url_scheme" => uri.scheme&.sub(/^ws/, "http"),
         # AnyCable specific fields
         "anycable.raw_cstate" => request_env.cstate&.to_h,
-        "anycable.raw_istate" => request_env.istate&.to_h
+        "anycable.raw_istate" => request_env.istate&.to_h,
+        "anycable.sid" => request_env.sid
       }.delete_if { |_k, v| v.nil? })
 
       env.merge!(build_headers(headers))

data/lib/anycable/version.rb

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

data/lib/anycable.rb

@@ -10,6 +10,7 @@ require "anycable/broadcast_adapters"
 require "anycable/middleware_chain"
 require "anycable/middlewares/exceptions"
 require "anycable/middlewares/check_version"
+require "anycable/middlewares/env_sid"
 
 require "anycable/socket"
 require "anycable/rpc"

data/sig/anycable/middlewares/env_sid.rbs

@@ -0,0 +1,6 @@
+module AnyCable
+  module Middlewares
+    class EnvSid < AnyCable::Middleware
+    end
+  end
+end

data/sig/anycable/rpc.rbs

@@ -24,6 +24,7 @@ module AnyCable
 
     attr_accessor url: String
     attr_accessor headers: protoMap
+    attr_accessor sid: String?
 
     def initialize: (?url: String, ?headers: protoMap, ?cstate: protoMap?, ?istate: protoMap?) -> void
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anycable-core
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - palkan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-04 00:00:00.000000000 Z
+date: 2022-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -170,6 +170,7 @@ files:
 - lib/anycable/middleware.rb
 - lib/anycable/middleware_chain.rb
 - lib/anycable/middlewares/check_version.rb
+- lib/anycable/middlewares/env_sid.rb
 - lib/anycable/middlewares/exceptions.rb
 - lib/anycable/protos/rpc_pb.rb
 - lib/anycable/rpc.rb
@@ -197,6 +198,7 @@ files:
 - sig/anycable/middleware.rbs
 - sig/anycable/middleware_chain.rbs
 - sig/anycable/middlewares/check_version.rbs
+- sig/anycable/middlewares/env_sid.rbs
 - sig/anycable/middlewares/exceptions.rbs
 - sig/anycable/rpc.rbs
 - sig/anycable/rpc/handler.rbs
@@ -230,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: AnyCable core RPC implementation