queue-bus 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 315c7263eb40e8d6165b96b8f50738ff5861127f35f1ce282f7b1d8a20914290
-  data.tar.gz: 067034c67ce6232de23fe552c1fc3bac50ca64dd898dec9b4958009ce6067fe9
+  metadata.gz: 139511a2de01b9ffb7e58b63ecf62cbc01ae94fe38896282de2ae0dbb13178de
+  data.tar.gz: 0e481639105b4dceff9991ee448f378923fdb3ae5820294f954602e96a177243
 SHA512:
-  metadata.gz: dfea248252d2b17eca07eb5dae5e7feb4e32ac8673f154f959f0a622221dd466470f0b243f2e8c07191c951897b646c8341e5df3933556361dc1fd831de483a6
-  data.tar.gz: 6585cc65f3bb494161fc18e45d421203278db133b3471747caa8d526da7a551b524a6ba6289320f4a6f7fe80566f6bb7436dadda267d69d96497c7e2f14e64a2
+  metadata.gz: 3ce3ebbeee0e6be7513af1ed093f5612877a6293a78bad68da502817c10f205ddf69bbc3071ef497f48baef2e66f2823311ef80e579805dbeedccec9b0794bef
+  data.tar.gz: 8b93e84ff4b5d6801d6b490560af46532c729eb7ff2b32b0d88e565bd620388d029f1a010027b9032e56731aef936945922bf7afc642453aeb9db9cbeacd0bcd

data/CHANGELOG.md

@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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

@@ -141,13 +141,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 +158,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/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/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.11.0'
 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/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.11.0
 platform: ruby
 authors:
 - Brian Leonard
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-04 00:00:00.000000000 Z
+date: 2021-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -159,7 +159,7 @@ files:
 homepage: ''
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -174,8 +174,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubyforge_project: queue-bus
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 summary: A simple event bus on top of background queues
 test_files: