broadcaster 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 90a6948f7efefca09f7a8dae08c85402844b7cdc
-  data.tar.gz: 27d4e8d9c47555c9b0a2e5153702eb96486e6a87
+SHA256:
+  metadata.gz: ceb2fcd033b6405112a208cc1feed602dce814168f445235e07a1274848b66ff
+  data.tar.gz: 767ecb5b8008dcd2d4de5d7da5a194535212005acab53f29e70211658041dc36
 SHA512:
-  metadata.gz: 201f6d54a4208e4c30456102d6bcd39bc07e5769976957eeee807372939e6d48cb66cbb6a7df3028ea25fc8b05af0a2aa7748b98a2a3d11ee1df40147e2f0ab9
-  data.tar.gz: ae3d206cee7a2517e48dd1af011ba8f7db7a2d6bebf2cd41bea69a75b27402a0a9da1ad15f32d0362a8a0928f72ad9648fb9c7426304c4a6c73902d008a7c8d5
+  metadata.gz: 61c646e1eef1b4a3ae2a393b53c0432ae5607497799280b8f99aaa8a63206d868874082665aa5c070fff674d51816cd9445377aeed36553968421ca97ad5df78
+  data.tar.gz: 312d25d807de4f462f6c87cfe63ffac69de515db14be52c18603781051557d99ea3e94d2d0cb509c974e9e1558d2f1f7faa18cc604d6b6a6916b99deb7cc9378

data/.travis.yml

@@ -4,12 +4,12 @@ rvm:
   - 2.0
   - 2.1
   - 2.2
-  - 2.3.0
-  - 2.4.0
-  - 2.5.0
-  - 2.6.0
-  - jruby-9.1.17.0
-  - jruby-9.2.7.0
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - jruby-9.2.9.0
   - ruby-head
   - jruby-head
 
@@ -19,9 +19,5 @@ matrix:
     - rvm: ruby-head
     - rvm: jruby-head
 
-before_install:
-  - rvm all-gemsets do gem uninstall bundler -ax || true
-  - gem install bundler -v "< 2"
-
 services:
   - redis-server

data/README.md

@@ -4,7 +4,6 @@
 [![Build Status](https://travis-ci.org/gabynaiman/broadcaster.svg?branch=master)](https://travis-ci.org/gabynaiman/broadcaster)
 [![Coverage Status](https://coveralls.io/repos/gabynaiman/broadcaster/badge.svg?branch=master)](https://coveralls.io/r/gabynaiman/broadcaster?branch=master)
 [![Code Climate](https://codeclimate.com/github/gabynaiman/broadcaster.svg)](https://codeclimate.com/github/gabynaiman/broadcaster)
-[![Dependency Status](https://gemnasium.com/gabynaiman/broadcaster.svg)](https://gemnasium.com/gabynaiman/broadcaster)
 
 Broadcasting based on Redis PubSub
 

data/broadcaster.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'broadcaster'
-  spec.version       = '1.0.1'
+  spec.version       = '1.0.2'
   spec.authors       = ['Gabriel Naiman']
   spec.email         = ['gabynaiman@gmail.com']
   spec.summary       = 'Broadcasting based on Redis PubSub'
@@ -20,8 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'redic',        '~> 1.5'
   spec.add_dependency 'class_config', '~> 0.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.12'
-  spec.add_development_dependency 'rake', '~> 11.0'
+  spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'minitest', '~> 5.0', '< 5.11'
   spec.add_development_dependency 'minitest-colorin', '~> 0.1'
   spec.add_development_dependency 'minitest-line', '~> 0.6'

data/lib/broadcaster.rb

@@ -1,6 +1,7 @@
 require 'redic'
 require 'class_config'
 require 'logger'
+require 'securerandom'
 
 class Broadcaster
 
@@ -9,30 +10,33 @@ class Broadcaster
   attr_config :redis_client, Redic
   attr_config :redis_settings, 'redis://localhost:6379'
   attr_config :logger, Logger.new(STDOUT)
+  attr_config :reconnection_timeout, 10
 
   attr_reader :id
 
   def initialize(options={})
     @id = options.fetch(:id, SecureRandom.uuid)
     @logger = options.fetch(:logger, Broadcaster.logger)
+    @logger_name = "Broadcaster (#{@id})"
     @redis_client = options.fetch(:redis_client, Broadcaster.redis_client)
-    @publisher = @redis_client.new options.fetch(:redis_settings, Broadcaster.redis_settings)
-    @subscriber = @redis_client.new options.fetch(:redis_settings, Broadcaster.redis_settings)
-    @subscriptions = Hash.new { |h,k| h[k] = {} }
+    @redis_settings = options.fetch(:redis_settings, Broadcaster.redis_settings)
+    @publisher = establish_connection
+    @subscriptions = {}
     @mutex = Mutex.new
     listen
   end
 
   def publish(channel, message)
-    logger.debug(self.class) { "Published | #{scoped(channel)} | #{message}" }
-    publisher.call 'PUBLISH', scoped(channel), Marshal.dump(message)
+    publisher.call! 'PUBLISH', scoped(channel), Marshal.dump(message)
+    logger.debug(logger_name) { "Published | #{scoped(channel)} | #{message}" }
   end
 
   def subscribe(channel, callable=nil, &block)
     mutex.synchronize do
       SecureRandom.uuid.tap do |subscription_id|
-        logger.debug(self.class) { "Subscribed | #{scoped(channel)} | #{subscription_id}" }
-        subscriptions[scoped(channel)][subscription_id] = callable || block
+        channel_subscriptions = subscriptions[scoped(channel)] ||= {}
+        channel_subscriptions[subscription_id] = callable || block
+        logger.debug(logger_name) { "Subscribed | #{scoped(channel)} | #{subscription_id}" }
       end
     end
   end
@@ -41,9 +45,9 @@ class Broadcaster
     mutex.synchronize do
       channel, _ = subscriptions.detect { |k,v| v.key? subscription_id }
       if channel
-        logger.debug(self.class) { "Unsubscribed | #{channel} | #{subscription_id}" }
         block = subscriptions[channel].delete subscription_id
         subscriptions.delete_if { |k,v| v.empty? }
+        logger.debug(logger_name) { "Unsubscribed | #{channel} | #{subscription_id}" }
         block
       end
     end
@@ -51,42 +55,69 @@ class Broadcaster
 
   def unsubscribe_all
     mutex.synchronize do
-      logger.debug(self.class) { 'Unsubscribed all' }
+      logger.debug(logger_name) { 'Unsubscribed all' }
       subscriptions.clear
     end
   end
 
   private
 
-  attr_reader :publisher, :subscriber, :subscriptions, :mutex, :logger
+  attr_reader :publisher, :subscriber, :subscriptions, :mutex, :logger, :logger_name, :redis_client, :redis_settings
+
+  def establish_connection
+    redis_client.new(redis_settings).tap { |redis| redis.call! 'PING' }
+  end
 
   def scoped(channel)
     "#{id}:#{channel}"
   end
 
   def listen
-    logger.debug(self.class) { 'Start listening' }
-    subscriber.call 'PSUBSCRIBE', scoped('*')
+    subscriber = establish_connection
+    subscriber.call! 'PSUBSCRIBE', scoped('*')
+
+    logger.info(logger_name) { 'Listener started' }
 
     Thread.new do
       loop do
         begin
           notification = subscriber.client.read
+
           channel = notification[2]
           message = Marshal.load notification[3]
-          logger.debug(self.class) { "Broadcasting (#{subscriptions[channel].count}) | #{channel} | #{message}" }
-          subscriptions[channel].each do |subscription_id, block|
-            begin
-              block.call message
-            rescue => ex
-              logger.error(self.class) { "Failed | #{channel} | #{subscription_id} | #{message}\n#{ex.class}: #{ex.message}\n#{ex.backtrace.join("\n")}" }
+
+          current_subscriptions = mutex.synchronize do
+            subscriptions.key?(channel) ? subscriptions[channel].dup : nil
+          end
+
+          if current_subscriptions
+            logger.debug(logger_name) { "Broadcasting (#{current_subscriptions.count}) | #{channel} | #{message}" }
+
+            current_subscriptions.each do |subscription_id, block|
+              begin
+                block.call message
+              rescue => ex
+                logger.error(logger_name) { "Failed | #{channel} | #{subscription_id} | #{message}\n#{ex.class}: #{ex.message}\n#{ex.backtrace.join("\n")}" }
+              end
             end
           end
-        rescue java.nio.channels.ClosedSelectorException
-          # JRuby - Safe closing thread
+
+        rescue => ex
+          logger.error(logger_name) { ex }
+          break
         end
       end
+
+      logger.warn(logger_name) { 'Listener broken' }
+      listen
     end
+
+  rescue => ex
+    logger.error(logger_name) { ex }
+    sleep Broadcaster.reconnection_timeout
+
+    logger.info(logger_name) { 'Listener reconnectig' }
+    retry
   end
 
 end

data/spec/broadcast_spec.rb

@@ -2,26 +2,14 @@ require 'minitest_helper'
 
 describe Broadcaster do
 
-  class Receiver
-    attr_reader :messages
-
-    def initialize
-      @messages = []
-    end
-
-    def call(message)
-      messages << message
-    end
-  end
-
   def wait_for(&block)
-    Timeout.timeout(3) do
+    Timeout.timeout(1) do
       while !block.call
         sleep 0.001
       end
     end
   end
-  
+
   it 'Multiple channels' do
     broadcaster = Broadcaster.new
 
@@ -40,7 +28,7 @@ describe Broadcaster do
 
     wait_for { received_messages.values.flatten.count == 4 }
 
-    received_messages.must_equal 'channel_1' => ['message 1', 'message 4'], 
+    received_messages.must_equal 'channel_1' => ['message 1', 'message 4'],
                                  'channel_2' => ['message 2', 'message 3']
   end
 
@@ -69,7 +57,7 @@ describe Broadcaster do
 
     subscriptions = 2.times.map do |i|
       broadcaster.subscribe 'channel_1' do |message|
-        received_messages[i] << message 
+        received_messages[i] << message
       end
     end
 
@@ -94,7 +82,7 @@ describe Broadcaster do
 
     2.times.map do
       broadcaster.subscribe 'channel_1' do |message|
-        received_messages << message 
+        received_messages << message
       end
     end
 
@@ -149,7 +137,7 @@ describe Broadcaster do
                                  1 => ['message 1', 'message 2']
   end
 
-  it 'Custom redis connection' do
+  it 'Invalid redis connection' do
     error = proc { Broadcaster.new redis_settings: 'redis://invalid_host:6379' }.must_raise StandardError
     error.message.must_match 'invalid_host'
   end
@@ -170,4 +158,29 @@ describe Broadcaster do
     receiver.messages.must_equal ['message 1', 'message 2', 'message 3']
   end
 
+  it 'Automatic reconnection' do
+    broadcaster = Broadcaster.new redis_client: MockRedis
+
+    received_messages = []
+
+    broadcaster.subscribe 'channel_1' do |message|
+      received_messages << message
+    end
+
+    broadcaster.publish 'channel_1', 'message 1'
+
+    MockRedis.stop
+
+    error = proc { broadcaster.publish 'channel_1', 'message 2' }.must_raise RuntimeError
+    error.message.must_equal 'Redis connection error'
+
+    MockRedis.start
+
+    broadcaster.publish 'channel_1', 'message 3'
+
+    wait_for { received_messages.count == 2 }
+
+    received_messages.must_equal ['message 1', 'message 3']
+  end
+
 end

data/spec/minitest_helper.rb

@@ -12,4 +12,53 @@ require 'timeout'
 
 Broadcaster.configure do |config|
   config.logger = Logger.new '/dev/null'
+  config.reconnection_timeout = 0.001
+end
+
+class Receiver
+  attr_reader :messages
+
+  def initialize
+    @messages = []
+  end
+
+  def call(message)
+    messages << message
+  end
+end
+
+class MockRedis
+
+  class << self
+
+    def start
+      @running = true
+      sleep 0.05
+    end
+
+    def stop
+      @running = false
+      Redic.new.call 'CLIENT', 'KILL', 'TYPE', 'pubsub'
+      sleep 0.05
+    end
+
+    def running?
+      @running.nil? ? true : @running
+    end
+
+  end
+
+  def initialize(*args)
+    @redis = Redic.new(*args)
+  end
+
+  def call!(*args)
+    raise 'Redis connection error' unless self.class.running?
+    @redis.call!(*args)
+  end
+
+  def client
+    @redis.client
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: broadcaster
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Gabriel Naiman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-25 00:00:00.000000000 Z
+date: 2021-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redic
@@ -38,34 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -195,8 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Broadcasting based on Redis PubSub