queue-bus 0.10.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 315c7263eb40e8d6165b96b8f50738ff5861127f35f1ce282f7b1d8a20914290
-  data.tar.gz: 067034c67ce6232de23fe552c1fc3bac50ca64dd898dec9b4958009ce6067fe9
+  metadata.gz: 5383fd5290386ad57b383532a59406032e960ee344dc218db4c6c2e83a8fc8df
+  data.tar.gz: 6e695fc97a76265c6fa98984278e517b5e21dc7142c7d7b9ff646e02e52af5ef
 SHA512:
-  metadata.gz: dfea248252d2b17eca07eb5dae5e7feb4e32ac8673f154f959f0a622221dd466470f0b243f2e8c07191c951897b646c8341e5df3933556361dc1fd831de483a6
-  data.tar.gz: 6585cc65f3bb494161fc18e45d421203278db133b3471747caa8d526da7a551b524a6ba6289320f4a6f7fe80566f6bb7436dadda267d69d96497c7e2f14e64a2
+  metadata.gz: 7a238383614d2505facac1c2003d8b55cff3d3c68c1bd0a136ce5444cbae92377df9fd9316feb912180bc2a9272f30257dcc028c345178cc56c18f6c9fee8aa5
+  data.tar.gz: 507b3514db5c2290e4c2cedf60d77cfed61f8fc9b4b0ae1c647de40350fdd52342144b4bdba32ad94fc5f734fd4413d80f7517ff083ebda0d8f1b28984c28421

data/CHANGELOG.md

@@ -6,6 +6,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.13.1]
+
+### Fixes
+
+- Allows matching on 0 via the `on_heartbeat` subscription
+
+### Added
+
+- Allows matching on `wday` via the `on_heartbeat` subscription
+
+## [0.13.0]
+
+### Added
+
+- Adds `Dispatch#on_heartbeat` which is a helper function for specifying heartbeat subscriptions.
+
+## [0.12.0]
+
+### Changed
+- Pipelines fetching all queue subscriptions when using `QueueBus::Application.all`
+
+## [0.11.0]
+
+### Added
+
+- Adds `QueueBus.in_context` method. Useful when working with a multithreaded environment to add a description for all events published within this scope.
+
 ## [0.10.0]
 
 ### Added

data/README.mdown

@@ -63,6 +63,16 @@ QueueBus.dispatch("app_b") do
   subscribe "my_key", { "user_id" => :present, "page" => "homepage"} do
     Mixpanel.homepage_action!(attributes["action"])
   end
+
+  # You may also declare a subscription to heartbeat events. This is a helper function
+  # that works along with subscribe to make scheduling regular events easier.
+  #
+  #   minute_interval: Executes every n minutes
+  #   hour_interval:   Executes every n hours
+  #   minute:          Executes on this minute
+  #   hour:            Executes on this hour
+  on_heartbeat "my_heartbeat_event", minute_interval: 5 do |attributes|
+  end
 end
 ```
 
@@ -141,13 +151,16 @@ event to the appropriate code block.
 You can also say `QueueBus.local_mode = :suppress` to turn off publishing altogether.
 This can be helpful inside some sort of migration, for example.
 
-#### Thread Safe Local Modes
+#### Thread Safe Options
 
 **!! This is important if you are using workers that utilize multiple threads, such as Sidekiq !!**
 
 The above setting is global to the ruby process and modifying it will impact all threads that are
 currently using QueueBus. If you want to isolate a thread or block of code from QueueBus, you can
-use the method `with_local_mode`:
+use the methods `with_local_mode` or `in_context`:
+
+
+With local mode
 
 ```ruby
 QueueBus.with_local_mode(:suppress) do
@@ -155,7 +168,16 @@ QueueBus.with_local_mode(:suppress) do
 end
 ```
 
-The previous value of `local_mode` will be restored after the block exits.
+In context
+
+```ruby
+QueueBus.in_context('some_context') do
+  # Context attribute will be set for all events published within this scope.
+end
+```
+
+
+The previous values will be restored after the block exits.
 
 ### TODO
 

data/lib/queue-bus.rb

@@ -43,7 +43,8 @@ module QueueBus
                    :hostname=, :hostname,
                    :adapter=, :adapter, :has_adapter?,
                    :incoming_queue=, :incoming_queue,
-                   :redis, :worker_middleware_stack
+                   :redis, :worker_middleware_stack,
+                   :context=, :context, :in_context
 
     def_delegators :_dispatchers, :dispatch, :dispatchers, :dispatcher_by_key, :dispatcher_execute
 

data/lib/queue_bus/application.rb

@@ -7,7 +7,22 @@ module QueueBus
     class << self
       def all
         # note the names arent the same as we started with
-        ::QueueBus.redis { |redis| redis.smembers(app_list_key).collect { |val| new(val) } }
+        ::QueueBus.redis do |redis|
+          app_keys = redis.smembers(app_list_key)
+          apps = app_keys.collect { |val| new(val) }
+
+          hashes = redis.pipelined do
+            apps.each do |app|
+              redis.hgetall(app.redis_key)
+            end
+          end
+
+          apps.zip(hashes).each do |app, hash|
+            app._hydrate_redis_hash(hash)
+          end
+
+          apps
+        end
       end
     end
 
@@ -90,6 +105,10 @@ module QueueBus
       out
     end
 
+    def _hydrate_redis_hash(hash)
+      @raw_redis_hash = hash
+    end
+
     protected
 
     def self.normalize(val)
@@ -114,16 +133,24 @@ module QueueBus
 
     def read_redis_hash
       out = {}
-      ::QueueBus.redis do |redis|
-        redis.hgetall(redis_key).each do |key, val|
-          begin
-            out[key] = ::QueueBus::Util.decode(val)
-          rescue ::QueueBus::Util::DecodeException
-            out[key] = val
-          end
+      raw_redis_hash.each do |key, val|
+        begin
+          out[key] = ::QueueBus::Util.decode(val)
+        rescue ::QueueBus::Util::DecodeException
+          out[key] = val
         end
       end
       out
     end
+
+    private
+
+    def raw_redis_hash
+      return @raw_redis_hash if @raw_redis_hash
+
+      ::QueueBus.redis do |redis|
+        redis.hgetall(redis_key)
+      end
+    end
   end
 end

data/lib/queue_bus/config.rb

@@ -9,7 +9,7 @@ module QueueBus
     attr_accessor :default_queue, :hostname, :incoming_queue, :logger
 
     attr_reader :worker_middleware_stack
-    attr_writer :local_mode
+    attr_writer :local_mode, :context
 
     def initialize
       @worker_middleware_stack = QueueBus::Middleware::Stack.new
@@ -24,6 +24,7 @@ module QueueBus
     Wrap = Struct.new(:value)
 
     LOCAL_MODE_VAR = :queue_bus_local_mode
+    CONTEXT_VAR = :queue_bus_context
 
     # Returns the current local mode of QueueBus
     def local_mode
@@ -34,6 +35,15 @@ module QueueBus
       end
     end
 
+    # Returns the current context of QueueBus
+    def context
+      if Thread.current.thread_variable_get(CONTEXT_VAR).is_a?(Wrap)
+        Thread.current.thread_variable_get(CONTEXT_VAR).value
+      else
+        @context
+      end
+    end
+
     # Overrides the current local mode for the duration of a block. This is a threadsafe
     # implementation. After, the global setting will be resumed.
     #
@@ -46,6 +56,17 @@ module QueueBus
       Thread.current.thread_variable_set(LOCAL_MODE_VAR, previous)
     end
 
+    # Overrides the current bus context (if any) for the duration of a block, adding a
+    # `bus_context` attribute set to this value for all events published in this scope. 
+    # This is a threadsafe implementation. After, the global setting will be resumed.
+    def in_context(context)
+      previous = Thread.current.thread_variable_get(CONTEXT_VAR)
+      Thread.current.thread_variable_set(CONTEXT_VAR, Wrap.new(context))
+      yield if block_given?
+    ensure
+      Thread.current.thread_variable_set(CONTEXT_VAR, previous)
+    end
+
     def adapter=(val)
       raise "Adapter already set to #{@adapter_instance.class.name}" if has_adapter?
 

data/lib/queue_bus/dispatch.rb

@@ -16,6 +16,45 @@ module QueueBus
       @subscriptions.size
     end
 
+    def on_heartbeat(key, minute: nil, hour: nil, wday: nil, minute_interval: nil, hour_interval: nil, &block) # rubocop:disable Metrics/PerceivedComplexity, Metrics/MethodLength, Metrics/ParameterLists, Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/LineLength
+      if minute_interval && !minute_interval.positive?
+        raise ArgumentError, 'minute_interval must be a positive integer'
+      end
+
+      if hour_interval && !hour_interval.positive?
+        raise ArgumentError, 'hour_interval must be a positive integer'
+      end
+
+      matcher = { bus_event_type: :heartbeat_minutes }
+
+      if minute
+        raise ArgumentError, 'minute must not be negative' if minute.negative?
+
+        matcher['minute'] = minute
+      end
+
+      if hour
+        raise ArgumentError, 'hour must not be negative' if hour.negative?
+
+        matcher['hour'] = hour
+      end
+
+      if wday
+        raise ArgumentError, 'wday must not be negative' if wday.negative?
+
+        matcher['wday'] = wday
+      end
+
+      subscribe(key, matcher) do |event|
+        if (minute_interval.nil? || (event['minute'] % minute_interval).zero?) &&
+           (hour_interval.nil? || (event['hour'] % hour_interval).zero?)
+
+          # Yield the block passed in.
+          block.call
+        end
+      end
+    end
+
     def subscribe(key, matcher_hash = nil, &block)
       dispatch_event('default', key, matcher_hash, block)
     end

data/lib/queue_bus/publishing.rb

@@ -30,6 +30,7 @@ module QueueBus
       bus_attr = { 'bus_published_at' => Time.now.to_i, 'bus_event_type' => event_type }
       bus_attr['bus_id']           = "#{Time.now.to_i}-#{generate_uuid}"
       bus_attr['bus_app_hostname'] = ::QueueBus.hostname
+      bus_attr['bus_context'] = ::QueueBus.context unless ::QueueBus.context.nil?
       if defined?(I18n) && I18n.respond_to?(:locale) && I18n.locale
         bus_attr['bus_locale']       = I18n.locale.to_s
       end

data/lib/queue_bus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module QueueBus
-  VERSION = '0.10.0'
+  VERSION = '0.13.1'
 end

data/spec/config_spec.rb

@@ -61,6 +61,41 @@ describe 'QueueBus config' do
     end
   end
 
+  describe '#in_context' do
+    it 'sets the context on the thread' do
+      QueueBus.in_context(:batch_processing) do
+        expect(QueueBus.context).to eq(:batch_processing)
+        Thread.new { expect(QueueBus.context).to eq nil }.join
+      end
+    end
+
+    it 'supports nesting' do
+      QueueBus.in_context(:batch_processing) do
+        expect(QueueBus.context).to eq :batch_processing
+        QueueBus.in_context(:processing) do
+          expect(QueueBus.context).to eq :processing
+        end
+        expect(QueueBus.context).to eq :batch_processing
+      end
+    end
+
+    it 'respects an override of nil' do
+      QueueBus.context = :batch_processing
+      QueueBus.in_context(nil) do
+        expect(QueueBus.context).to eq nil
+      end
+      QueueBus.context = :batch_processing
+    end
+
+    it 'resets to the original context after the block' do
+      expect(QueueBus.context).to eq nil
+      QueueBus.in_context(:batch_processing) do
+        expect(QueueBus.context).to eq :batch_processing
+      end
+      expect(QueueBus.context).to eq nil
+    end
+  end
+
   it 'sets the hostname' do
     expect(QueueBus.hostname).not_to eq(nil)
     QueueBus.hostname = 'whatever'

data/spec/dispatch_spec.rb

@@ -28,6 +28,152 @@ module QueueBus
       end.not_to raise_error
     end
 
+    describe '#on_heartbeat' do
+      let(:dispatch) { Dispatch.new('heartbeat') }
+      let(:event) { { bus_event_type: :heartbeat_minutes } }
+      let(:event_name) { 'my-event' }
+
+      context 'when not declaring anything' do
+        before do
+          dispatch.on_heartbeat event_name do |_event|
+            Runner2.run({})
+          end
+        end
+
+        it 'runs on every heart beat' do
+          (0..24).each do |hour|
+            (0..60).each do |minute|
+              expect do
+                dispatch.execute(
+                  event_name, event.merge('hour' => hour, 'minute' => minute)
+                )
+              end.to change(Runner2, :value).by(1)
+            end
+          end
+        end
+      end
+
+      context 'when running on hour 8' do
+        before do
+          dispatch.on_heartbeat event_name, hour: 8 do |_event|
+            Runner2.run({})
+          end
+        end
+
+        it 'subscribes to hour 8' do
+          expect(dispatch.subscriptions.all.first.matcher.filters)
+            .to eq('bus_event_type' => 'heartbeat_minutes', 'hour' => '8')
+        end
+      end
+
+      context 'when running on minute 4' do
+        before do
+          dispatch.on_heartbeat event_name, minute: 4 do |_event|
+            Runner2.run({})
+          end
+        end
+
+        it 'subscribes to minute 4' do
+          expect(dispatch.subscriptions.all.first.matcher.filters)
+            .to eq('bus_event_type' => 'heartbeat_minutes', 'minute' => '4')
+        end
+      end
+
+      context 'when running on minute 4 and hour 8' do
+        before do
+          dispatch.on_heartbeat event_name, hour: 8, minute: 4 do |_event|
+            Runner2.run({})
+          end
+        end
+
+        it 'subscribes to minute 4 and hour 8' do
+          expect(dispatch.subscriptions.all.first.matcher.filters)
+            .to eq('bus_event_type' => 'heartbeat_minutes', 'minute' => '4', 'hour' => '8')
+        end
+      end
+
+      context 'when running on wday 2' do
+        before do
+          dispatch.on_heartbeat event_name, wday: 2 do |_event|
+            Runner2.run({})
+          end
+        end
+
+        it 'subscribes to wday 2' do
+          expect(dispatch.subscriptions.all.first.matcher.filters)
+            .to eq('bus_event_type' => 'heartbeat_minutes', 'wday' => '2')
+        end
+      end
+
+      context 'when declaring minute intervals' do
+        before do
+          dispatch.on_heartbeat event_name, minute_interval: 5 do |_event|
+            Runner2.run({})
+          end
+        end
+
+        it 'runs the runner when the minute buzzes (modulos to 5)' do
+          (0..60).each do |minute|
+            if minute % 5 == 0
+              expect { dispatch.execute(event_name, event.merge('minute' => minute)) }
+                .to change(Runner2, :value).by(1)
+            else
+              expect { dispatch.execute(event_name, event.merge('minute' => minute)) }
+                .not_to change(Runner2, :value)
+            end
+          end
+        end
+      end
+
+      context 'when declaring hour intervals' do
+        before do
+          dispatch.on_heartbeat event_name, hour_interval: 3 do |_event|
+            Runner2.run({})
+          end
+        end
+
+        it 'runs the runner when the hour fizzes (modulos to 3)' do
+          (0..60).each do |hour|
+            if hour % 3 == 0
+              expect { dispatch.execute(event_name, event.merge('hour' => hour)) }
+                .to change(Runner2, :value).by(1)
+            else
+              expect { dispatch.execute(event_name, event.merge('hour' => hour)) }
+                .not_to change(Runner2, :value)
+            end
+          end
+        end
+      end
+
+      context 'when declaring hour and minute intervals' do
+        before do
+          dispatch.on_heartbeat event_name, minute_interval: 5, hour_interval: 3 do |_event|
+            Runner2.run({})
+          end
+        end
+
+        it 'runs the runner when the time fizzbuzzes (modulos to 3 and 5)' do
+          (0..24).each do |hour|
+            (0..60).each do |minute|
+              if hour % 3 == 0 && minute % 5 == 0
+                expect do
+                  dispatch.execute(
+                    event_name, event.merge('hour' => hour, 'minute' => minute)
+                  )
+                end.to change(Runner2, :value).by(1)
+              else
+                expect do
+                  dispatch.execute(
+                    event_name, event.merge('hour' => hour, 'minute' => minute)
+                  )
+                end.not_to change(Runner2, :value)
+              end
+            end
+          end
+        end
+      end
+    end
+
     describe 'Top Level' do
       before(:each) do
         QueueBus.dispatch('testit') do

data/spec/publish_spec.rb

@@ -71,6 +71,28 @@ describe 'Publishing an event' do
     expect(myval).to eq(1)
   end
 
+  it 'should add context metadata if wrapping publisher with in_context' do
+    expect(QueueBus.context).to be_nil
+
+    bus_context = 'batch_processing'
+    hash = { :one => 1, 'two' => 'here', 'bus_id' => 'app-given' }
+
+    event_name = 'event_name'
+    
+    QueueBus.in_context(:batch_processing) do
+      QueueBus.publish(event_name, hash)
+    end
+    
+    val = QueueBus.redis { |redis| redis.lpop('queue:bus_incoming') }
+    hash = JSON.parse(val)
+
+    att = JSON.parse(hash['args'].first)
+    expect(att['bus_context']).to eq(bus_context)
+
+    expect(QueueBus.context).to be_nil
+
+  end
+
   it 'should set the timezone and locale if available' do
     expect(defined?(I18n)).to be_nil
     expect(Time.respond_to?(:zone)).to eq(false)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: queue-bus
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.13.1
 platform: ruby
 authors:
 - Brian Leonard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-04 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json