rasti-web-broadcaster 1.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e5290c1fe92680bd88bd05f57f91b1d49a6848516865a6da8cfdb8d47cf6f44
-  data.tar.gz: eef7f1069f999eddd07fe89a7d6059e95bd669fbae2030f75d2fef0b180bf2b5
+  metadata.gz: bee6440950bad244f76deef7e4685575da162bc540699b69b638e78c3eefd131
+  data.tar.gz: e84320050ffb17592a5b58f2957a1f1e75727a0200916a8beadd5795a0840ebe
 SHA512:
-  metadata.gz: db5ca61f44dcb3ebaab5557cca6c245a8e7bccca22833b2aaa0aa38428a0baa5e0c9b0f7c8133ac7fb7e132a2ee173d39e4135a486b747209ed90cadd2d71b60
-  data.tar.gz: 06bebe40478194b3dceea7fd7a2b670cd75997630170d7ab54b72f7142c57bcdaf3b94a2d6969bf26de1f3c3eeddd581a2bbe338fe205cf251fe14c6cc6db313
+  metadata.gz: 4f4b557db3d69f416a6e89a6ba665a6c18c1b9ba1da9332861fac73eb14cc2acfde9336a4d4013a6a0208bb4688dbc3b9f5c59fbad0d6510dd16848df68b7d0f
+  data.tar.gz: d4e9d49f0e703e1087bb5fe3d2d9cfc4369ca8ca123af6f0e4b48e6d02d851c8782b5871bbcdd4ed5b37cb1edd3b998e19bb765a9a31d85527bbfa3194fe25b1

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 
 rvm:
-  - 2.0
   - 2.1
   - 2.2
   - 2.3
@@ -9,6 +8,7 @@ rvm:
   - 2.5
   - 2.6
   - 2.7
+  - 3.0
   - jruby-9.2.9.0
   - ruby-head
   - jruby-head

data/README.md

@@ -1,7 +1,7 @@
 # Rasti::Web::Broadcaster
 
 [![Gem Version](https://badge.fury.io/rb/rasti-web-broadcaster.svg)](https://rubygems.org/gems/rasti-web-broadcaster)
-[![Build Status](https://travis-ci.org/gabynaiman/rasti-web-broadcaster.svg?branch=master)](https://travis-ci.org/gabynaiman/rasti-web-broadcaster)
+[![Build Status](https://app.travis-ci.com/gabynaiman/rasti-web-broadcaster.svg?branch=master)](https://app.travis-ci.com/gabynaiman/rasti-web-broadcaster)
 [![Coverage Status](https://coveralls.io/repos/gabynaiman/rasti-web-broadcaster/badge.svg?branch=master)](https://coveralls.io/r/gabynaiman/rasti-web-broadcaster?branch=master)
 [![Code Climate](https://codeclimate.com/github/gabynaiman/rasti-web-broadcaster.svg)](https://codeclimate.com/github/gabynaiman/rasti-web-broadcaster)
 
@@ -30,6 +30,7 @@ Or install it yourself as:
 Rasti::Web::Broadcaster.configure do |config|
   config.id = 'AppName'
   config.redis_settings = "redis://#{ENV['REDIS_HOST']}:#{ENV['REDIS_PORT']}"
+  config.keep_alive_interval = 30
   config.logger = Logger.new "/log/#{ENV['RACK_ENV']}.log"
 end
 ```

data/lib/rasti/web/broadcaster/timer.rb

@@ -0,0 +1,37 @@
+module Rasti
+  module Web
+    class Broadcaster
+      class Timer
+        class << self
+
+          def every(interval, &block)
+            Thread.new do
+              loop do
+                execute_using_time_slot(interval, &block)
+              end
+            end
+          end
+
+          private
+
+          def execute_using_time_slot(interval)
+            started_at = Time.now
+            yield
+
+          rescue => ex
+            Broadcaster.logger.error(self) { ex }
+
+          ensure
+            elapsed_time = Time.now - started_at
+            if elapsed_time > interval
+              Broadcaster.logger.warn(self) { "Elapsed time #{elapsed_time}s for interval of #{interval}s" }
+            else
+              sleep interval - elapsed_time
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/rasti/web/broadcaster/version.rb

@@ -1,7 +1,7 @@
 module Rasti
   module Web
     class Broadcaster
-      VERSION = '1.1.2'
+      VERSION = '2.0.0'
     end
   end
 end

data/lib/rasti/web/broadcaster.rb

@@ -4,18 +4,22 @@ require 'class_config'
 
 require_relative 'broadcaster/safe_event_machine'
 require_relative 'broadcaster/safe_rack_lint'
+require_relative 'broadcaster/timer'
 require_relative 'broadcaster/version'
 
 module Rasti
   module Web
     class Broadcaster
 
+      KEEP_ALIVE_EVENT = 'keepAlive'
+
       extend ClassConfig
 
-      attr_config :id,             'rasti.web.broadcaster'
-      attr_config :redis_client,   Redic
-      attr_config :redis_settings, 'redis://localhost:6379'
-      attr_config :logger,         Logger.new(STDOUT)
+      attr_config :id,                  'rasti.web.broadcaster'
+      attr_config :redis_client,        Redic
+      attr_config :redis_settings,      'redis://localhost:6379'
+      attr_config :logger,              Logger.new(STDOUT)
+      attr_config :keep_alive_interval
 
       @mutex = Mutex.new
 
@@ -23,8 +27,8 @@ module Rasti
 
         extend Forwardable
 
-        def_delegators :broadcaster, :subscribe, 
-                                     :unsubscribe, 
+        def_delegators :broadcaster, :subscribe,
+                                     :unsubscribe,
                                      :publish
 
         private
@@ -40,20 +44,20 @@ module Rasti
       def initialize(app, headers={})
         @app = app
         @headers = headers
+        @mutex = Mutex.new
+        @subscriptions = {}
+
+        start_sending_keep_alive_messages
       end
 
       def call(env)
         if Faye::EventSource.eventsource? env
-          event_source = Faye::EventSource.new env, headers: @headers
-          channel = env['PATH_INFO'][1..-1]
+          event_source = Faye::EventSource.new env, headers: headers
 
-          subscription_id = self.class.subscribe channel do |message|
-            event_source.send message[:data], event: message[:event], 
-                                              id:    message[:id]
-          end
+          subscription_id = subscribe channel_from(env), event_source
 
           event_source.on :close do
-            self.class.unsubscribe subscription_id
+            unsubscribe subscription_id
             event_source = nil
           end
 
@@ -65,7 +69,41 @@ module Rasti
 
       private
 
-      attr_reader :app
+      attr_reader :app, :headers, :mutex, :subscriptions
+
+      def subscribe(channel, event_source)
+        subscription_id = self.class.subscribe channel do |message|
+          send_message(event_source, **message)
+        end
+
+        mutex.synchronize { subscriptions[subscription_id] = event_source }
+
+        subscription_id
+      end
+
+      def unsubscribe(subscription_id)
+        self.class.unsubscribe subscription_id
+        mutex.synchronize { subscriptions.delete subscription_id }
+      end
+
+      def send_message(event_source, data:, event: nil, id: nil)
+        event_source.send data, event: event, id: id
+      end
+
+      def start_sending_keep_alive_messages
+        if self.class.keep_alive_interval
+          Timer.every self.class.keep_alive_interval do
+            subscriptions.each do |subscription_id, event_source|
+              self.class.logger.debug(self.class) { "Sending keep alive to #{subscription_id}" }
+              send_message event_source, data: '', event: KEEP_ALIVE_EVENT
+            end
+          end
+        end
+      end
+
+      def channel_from(env)
+        env['PATH_INFO'][1..-1]
+      end
 
     end
   end

data/spec/middleware_spec.rb

@@ -47,7 +47,7 @@ describe Rasti::Web::Broadcaster do
     event_source = nil
     events = []
 
-    env['async.callback'] = proc do |(status, headers, body)|
+    env['async.callback'] = proc do |(_status, _headers, body)|
       event_source = body.instance_variable_get(:@socket_object)
       body.each { |e| events << e }
     end
@@ -60,14 +60,15 @@ describe Rasti::Web::Broadcaster do
     Rasti::Web::Broadcaster.publish 'channel_2', data: 'message 2'
     Rasti::Web::Broadcaster.publish 'channel_1', data: 'message 3'
 
-    wait_for { events.count == 3 }
+    wait_for { events.count == 4 }
 
     event_source.close
 
     events.must_equal [
       event_headers,
       event_for(data: 'message 1', event: 'event_1', id: 1),
-      event_for(data: 'message 3')
+      event_for(data: 'message 3'),
+      event_for(event: Rasti::Web::Broadcaster::KEEP_ALIVE_EVENT)
     ]
   end
 

data/spec/minitest_helper.rb

@@ -5,4 +5,7 @@ require 'pry-nav'
 require 'rasti-web-broadcaster'
 require 'rack/test'
 
-Rasti::Web::Broadcaster.logger.level = Logger::ERROR
+Rasti::Web::Broadcaster.configure do |config|
+  config.logger = Logger.new '/dev/null'
+  config.keep_alive_interval = 0.1
+end

data/spec/timer_spec.rb

@@ -0,0 +1,48 @@
+require 'minitest_helper'
+
+describe Rasti::Web::Broadcaster::Timer do
+
+  let(:timer) { Rasti::Web::Broadcaster::Timer }
+
+  it 'Tick' do
+    count = 0
+
+    thread = timer.every(0.02) do
+      count += 1
+    end
+
+    sleep 0.07
+    thread.exit
+
+    count.must_equal 4
+  end
+
+  it 'Interval exceded' do
+    count = 0
+
+    thread = timer.every(0.02) do
+      sleep 0.04 if count == 1
+      count += 1
+    end
+
+    sleep 0.07
+    thread.exit
+
+    count.must_equal 3
+  end
+
+  it 'Error safe' do
+    count = 0
+
+    thread = timer.every(0.02) do
+      count += 1
+      raise 'Unexpected error' if count == 2
+    end
+
+    sleep 0.05
+    thread.exit
+
+    count.must_equal 3
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rasti-web-broadcaster
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Gabriel Naiman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-26 00:00:00.000000000 Z
+date: 2022-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket
@@ -197,11 +197,13 @@ files:
 - lib/rasti/web/broadcaster.rb
 - lib/rasti/web/broadcaster/safe_event_machine.rb
 - lib/rasti/web/broadcaster/safe_rack_lint.rb
+- lib/rasti/web/broadcaster/timer.rb
 - lib/rasti/web/broadcaster/version.rb
 - rasti-web-broadcaster.gemspec
 - spec/coverage_helper.rb
 - spec/middleware_spec.rb
 - spec/minitest_helper.rb
+- spec/timer_spec.rb
 homepage: https://github.com/gabynaiman/rasti-web-broadcaster
 licenses:
 - MIT
@@ -221,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Rack middleware for server sent events
@@ -229,3 +231,4 @@ test_files:
 - spec/coverage_helper.rb
 - spec/middleware_spec.rb
 - spec/minitest_helper.rb
+- spec/timer_spec.rb