anycable-core 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 215d37d67fe10f536e6eb2a9b8ae5e53603d4653fb2034aff9abece234da7097
-  data.tar.gz: 50457dfd126925e875f3bb1ab323df90a0381f13de399f07e20a8cd4f2cab5d7
+  metadata.gz: 5eaf888f4c9312a81bbadf980e5279efa1a0403760569b0465a537e6bd2ed291
+  data.tar.gz: 85206aa6fb8aac5faa0641c889deb9f4c61d40a27211feffb20ab23590313469
 SHA512:
-  metadata.gz: 43eac0f870ba33726095d8801772d3b18dd2a909a937c9c03177aab163d2ee93f92979bcfcf4cb3eb2039e80e3f28ec123d9e215ee07fe4b87fb152510f7b87d
-  data.tar.gz: be1a5de79d480aa5d0b081354103f325cb3f997d8d134ba325b92d233408696236afedd600c7133ccb307ac7ceb9b16c60e284588942aa83886007384002a372
+  metadata.gz: 8eb1685bd731c6904126e0ea75a5f4489f268e97f080df60a6eec9ce3ae79cf7c3477ff5cf4add6541a7b09c21455c1d97ababcc1ad818f119e79ac6faf97e56
+  data.tar.gz: 9d5c9882b1eb73901e253f64915c3647c38453357560d9ec836a29163aa3b6f24a10b485b1007751e3600f81a4e4a9cb8eb0a37204af35d87cc216934b7530c2

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## master
 
+## 1.3.1 (2023-05-12)
+
+- Fix gRPC health check response for an empty service. ([@palkan][])
+
+As per [docs](https://github.com/grpc/grpc/blob/master/doc/health-checking.md), an empty service is used as the key for server's overall health status. So, if we serve any services, we should return `SERVING` status.
+
+- Add gRPC health check when using grpc_kit. ([@palkan][])
+
 ## 1.3.0 (2023-02-28)
 
 - Add configuration presets. ([@palkan][])

data/README.md

@@ -28,6 +28,8 @@ Check out our 📑 [Documentation](https://docs.anycable.io/v1).
 
 ## Links
 
+- [AnyCable off Rails: connecting Twilio streams with Hanami](https://evilmartians.com/chronicles/anycable-goes-off-rails-connecting-twilio-streams-with-hanami)
+
 - [AnyCable 1.0: Four years of real-time web with Ruby and Go](https://evilmartians.com/chronicles/anycable-1-0-four-years-of-real-time-web-with-ruby-and-go)
 
 - [AnyCable: Action Cable on steroids!](https://evilmartians.com/chronicles/anycable-actioncable-on-steroids)

data/lib/anycable/broadcast_adapters/http.rb

@@ -118,7 +118,7 @@ module AnyCable
           yield http
         rescue Timeout::Error, *RECOVERABLE_EXCEPTIONS => e
           retry_count += 1
-          if MAX_ATTEMPTS < retry_count
+          if retry_count > MAX_ATTEMPTS
             logger.error("Broadcast request failed: #{e.message}")
             return
           end

data/lib/anycable/broadcast_adapters/nats.rb

@@ -31,6 +31,7 @@ module AnyCable
       )
         options = AnyCable.config.to_nats_params.merge(options)
         @nats_conn = ::NATS.connect(nil, options)
+        setup_listeners(nats_conn)
         @channel = channel
       end
 
@@ -41,6 +42,19 @@ module AnyCable
       def announce!
         logger.info "Broadcasting NATS channel: #{channel}"
       end
+
+      private
+
+      def setup_listeners(nats_client)
+        nats_client.on_disconnect { logger.info "NATS client disconnected" }
+        nats_client.on_reconnect do
+          info = nats_client.server_info
+          logger.info "NATS client reconnected: host=#{info[:host]}:#{info[:port]} cluster=#{info[:cluster]}"
+        end
+        nats_client.on_error do |err|
+          logger.warn "NATS client error: #{err.message}"
+        end
+      end
     end
   end
 end

data/lib/anycable/broadcast_adapters/redis.rb

@@ -21,7 +21,7 @@ module AnyCable
     #
     # You can override these params:
     #
-    #   AnyCable.broadcast_adapter = :redis, url: "redis://my_redis", channel: "_any_cable_"
+    #   AnyCable.broadcast_adapter = :redis, { url: "redis://my_redis", channel: "_any_cable_" }
     class Redis < Base
       attr_reader :redis_conn, :channel
 

data/lib/anycable/grpc/server.rb

@@ -98,7 +98,7 @@ module AnyCable
         )
         health_checker.add_status(
           "",
-          Grpc::Health::V1::HealthCheckResponse::ServingStatus::NOT_SERVING
+          Grpc::Health::V1::HealthCheckResponse::ServingStatus::SERVING
         )
         health_checker
       end

data/lib/anycable/grpc_kit/health_checker.rb

@@ -0,0 +1,72 @@
+# Copyright 2015 gRPC authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Grpc
+  # Health contains classes and modules that support providing a health check
+  # service.
+  module Health
+    # Checker is implementation of the schema-specified health checking service.
+    class Checker < V1::Health::Service
+      StatusCodes = GRPC::Core::StatusCodes
+      HealthCheckResponse = V1::HealthCheckResponse
+
+      # Initializes the statuses of participating services
+      def initialize
+        @statuses = {}
+        @status_mutex = Mutex.new  # guards access to @statuses
+      end
+
+      # Implements the rpc IDL API method
+      def check(req, _call)
+        status = nil
+        @status_mutex.synchronize do
+          status = @statuses["#{req.service}"]
+        end
+        if status.nil?
+          fail GRPC::NotFound.new("Service is not found: #{req.service}")
+        end
+        HealthCheckResponse.new(status: status)
+      end
+
+      # Adds the health status for a given service.
+      def add_status(service, status)
+        @status_mutex.synchronize { @statuses["#{service}"] = status }
+      end
+
+      # Adds given health status for all given services
+      def set_status_for_services(status, *services)
+        @status_mutex.synchronize do
+          services.each { |service| @statuses["#{service}"] = status }
+        end
+      end
+
+      # Adds health status for each service given within hash
+      def add_statuses(service_statuses = {})
+        @status_mutex.synchronize do
+          service_statuses.each_pair { |service, status| @statuses["#{service}"] = status }
+        end
+      end
+
+      # Clears the status for the given service.
+      def clear_status(service)
+        @status_mutex.synchronize { @statuses.delete("#{service}") }
+      end
+
+      # Clears alls the statuses.
+      def clear_all
+        @status_mutex.synchronize { @statuses = {} }
+      end
+    end
+  end
+end

data/lib/anycable/grpc_kit/health_pb.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: grpc/health/v1/health.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "grpc.health.v1.HealthCheckRequest" do
+    optional :service, :string, 1
+  end
+  add_message "grpc.health.v1.HealthCheckResponse" do
+    optional :status, :enum, 1, "grpc.health.v1.HealthCheckResponse.ServingStatus"
+  end
+  add_enum "grpc.health.v1.HealthCheckResponse.ServingStatus" do
+    value :UNKNOWN, 0
+    value :SERVING, 1
+    value :NOT_SERVING, 2
+  end
+end
+
+module Grpc
+  module Health
+    module V1
+      HealthCheckRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("grpc.health.v1.HealthCheckRequest").msgclass
+      HealthCheckResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("grpc.health.v1.HealthCheckResponse").msgclass
+      HealthCheckResponse::ServingStatus = Google::Protobuf::DescriptorPool.generated_pool.lookup("grpc.health.v1.HealthCheckResponse.ServingStatus").enummodule
+    end
+  end
+end

data/lib/anycable/grpc_kit/health_services_pb.rb

@@ -0,0 +1,41 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: grpc/health/v1/health.proto for package 'grpc.health.v1'
+# Original file comments:
+# Copyright 2015 The gRPC Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# The canonical version of this proto can be found at
+# https://github.com/grpc/grpc-proto/blob/master/grpc/health/v1/health.proto
+#
+
+module Grpc
+  module Health
+    module V1
+      module Health
+        class Service
+
+          include GRPC::GenericService
+
+          self.marshal_class_method = :encode
+          self.unmarshal_class_method = :decode
+          self.service_name = 'grpc.health.v1.Health'
+
+          rpc :Check, HealthCheckRequest, HealthCheckResponse
+        end
+
+        Stub = Service.rpc_stub_class
+      end
+    end
+  end
+end

data/lib/anycable/grpc_kit/server.rb

@@ -2,6 +2,10 @@
 
 require "anycable/grpc/handler"
 
+require_relative "./health_pb"
+require_relative "./health_services_pb"
+require_relative "./health_checker"
+
 module AnyCable
   module GRPC
     raise LoadError, "AnyCable::GRPC::Server has been already loaded!" if defined?(AnyCable::GRPC::Server)
@@ -77,8 +81,8 @@ module AnyCable
 
         loop do
           sock = TCPSocket.new(hostname, port, connect_timeout: 1)
-          stub = AnyCable::GRPC::Stub.new(sock)
-          stub.connect(AnyCable::ConnectionRequest.new(env: {}))
+          stub = ::Grpc::Health::V1::Health::Stub.new(sock)
+          stub.check(::Grpc::Health::V1::HealthCheckRequest.new)
           sock.close
           break
         rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, SocketError
@@ -126,8 +130,22 @@ module AnyCable
 
         ::GrpcKit::Server.new(min_pool_size: pool_size, max_pool_size: pool_size).tap do |server|
           server.handle(AnyCable::GRPC::Handler)
+          server.handle(build_health_checker)
         end
       end
+
+      def build_health_checker
+        health_checker = ::Grpc::Health::Checker.new
+        health_checker.add_status(
+          "anycable.RPC",
+          ::Grpc::Health::V1::HealthCheckResponse::ServingStatus::SERVING
+        )
+        health_checker.add_status(
+          "",
+          ::Grpc::Health::V1::HealthCheckResponse::ServingStatus::SERVING
+        )
+        health_checker
+      end
     end
   end
 end

data/lib/anycable/version.rb

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

data/sig/anycable/broadcast_adapters/nats.rbs

@@ -5,6 +5,10 @@ module AnyCable
       attr_reader channel: String
 
       def initialize: (?channel: String channel, **untyped options) -> void
+
+      private
+
+      def setup_listeners: (untyped nats_conn) -> void
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anycable-core
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - palkan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-01 00:00:00.000000000 Z
+date: 2023-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -210,6 +210,9 @@ files:
 - lib/anycable/grpc/rpc_services_pb.rb
 - lib/anycable/grpc/server.rb
 - lib/anycable/grpc_kit.rb
+- lib/anycable/grpc_kit/health_checker.rb
+- lib/anycable/grpc_kit/health_pb.rb
+- lib/anycable/grpc_kit/health_services_pb.rb
 - lib/anycable/grpc_kit/server.rb
 - lib/anycable/health_server.rb
 - lib/anycable/middleware.rb
@@ -278,7 +281,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.8
 signing_key:
 specification_version: 4
 summary: AnyCable core RPC implementation