rasti-web-broadcaster 1.1.2 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e5290c1fe92680bd88bd05f57f91b1d49a6848516865a6da8cfdb8d47cf6f44
-  data.tar.gz: eef7f1069f999eddd07fe89a7d6059e95bd669fbae2030f75d2fef0b180bf2b5
+  metadata.gz: b4274cbf5d65945a27bddcaa7372223972319791e59d74cf87a44b3782ccfd8c
+  data.tar.gz: 1ae384e5c92f88234341f3c7c610409ae0c16aff25d0c1df42fac452f615f85a
 SHA512:
-  metadata.gz: db5ca61f44dcb3ebaab5557cca6c245a8e7bccca22833b2aaa0aa38428a0baa5e0c9b0f7c8133ac7fb7e132a2ee173d39e4135a486b747209ed90cadd2d71b60
-  data.tar.gz: 06bebe40478194b3dceea7fd7a2b670cd75997630170d7ab54b72f7142c57bcdaf3b94a2d6969bf26de1f3c3eeddd581a2bbe338fe205cf251fe14c6cc6db313
+  metadata.gz: fcc2e8c4646744d1016bc3e17e63f5dcf6ebf95703efbe8f0c0434cf2ac9c262266e6b1cbc3e2a6b86a726b448162c97d8d723a6dccfe48618de7e657eb248df
+  data.tar.gz: fadc9eeb6b0633864fd6c418a0194a603d8495e627e631fabb16db8ca7ad7d4b615787626de55eb89897ecff264ff0cb247197c03304aefd3c8ea03644926e75

data/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches: [ '**' ]
+  pull_request:
+    branches: [ '**' ]
+
+jobs:
+  test:
+
+    name: Tests
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        ruby-version: ['2.3', '2.4', '2.5', '2.6', '2.7', '3.0', 'jruby-9.2.9.0']
+
+    services:
+      redis:
+        image: redis:7
+        ports:
+          - 6379:6379
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 3
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/README.md

@@ -1,9 +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)
-[![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)
+[![CI](https://github.com/gabynaiman/rasti-web-broadcaster/actions/workflows/ci.yml/badge.svg)](https://github.com/gabynaiman/rasti-web-broadcaster/actions/workflows/ci.yml)
 
 Enable server sent events with rack middleware implemented over Faye and Broadcaster (Redis Pub/Sub)
 
@@ -30,6 +28,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.1'
     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,42 @@ 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|
+          self.class.logger.info(self.class) { "Sending message to #{subscription_id} | Channel: #{channel} | Message: #{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/rasti-web-broadcaster.gemspec

@@ -27,11 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest-colorin', '~> 0.1'
   spec.add_development_dependency 'minitest-line', '~> 0.6'
   spec.add_development_dependency 'simplecov', '~> 0.12'
-  spec.add_development_dependency 'coveralls', '~> 0.8'
   spec.add_development_dependency 'pry-nav', '~> 0.2'
   spec.add_development_dependency 'rack-test', '~> 0.6'
-
-  if RUBY_VERSION < '2.2.2'
-    spec.add_development_dependency 'rack', '< 2'
-  end
 end

data/spec/coverage_helper.rb

@@ -1,5 +1,4 @@
 require 'simplecov'
-require 'coveralls'
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new [SimpleCov::Formatter::HTMLFormatter, Coveralls::SimpleCov::Formatter]
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new [SimpleCov::Formatter::HTMLFormatter]
 SimpleCov.start

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.1
 platform: ruby
 authors:
 - Gabriel Naiman
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-26 00:00:00.000000000 Z
+date: 2025-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket
@@ -134,20 +134,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
@@ -184,11 +170,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -197,16 +182,18 @@ 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
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -221,11 +208,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Rack middleware for server sent events
 test_files:
 - spec/coverage_helper.rb
 - spec/middleware_spec.rb
 - spec/minitest_helper.rb
+- spec/timer_spec.rb

data/.coveralls.yml

@@ -1,2 +0,0 @@
-service_name: travis-ci
-repo_token: lhkQlHPQWvmFvmpjd6kU3IWd9Zo2veQkw

data/.travis.yml

@@ -1,23 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - jruby-9.2.9.0
-  - ruby-head
-  - jruby-head
-
-matrix:
-  fast_finish: true
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-
-services:
-  - redis-server