queue-bus 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89735322de0ab91d94ca27b4f58598ef5049f829adfdc4788aa84eccd4d4597e
-  data.tar.gz: b6955c5ac09371018feddf9236f756de49c024ae1ac199b1498c00137761ab6d
+  metadata.gz: 86f211839cfb0c4e6e037abcfd1d73a91bbbe38ae8a08138f2bbad0723e092c7
+  data.tar.gz: d0474b7d0763983dd5bd54759023e0fe017ced93aa8ecee0b3b599b34ab4e5fd
 SHA512:
-  metadata.gz: f4c49c5180981e584fa91e0ba8a185c82b82f9c82533b36a75e2dc57cab75ff327d3585ac109940f234c9414c64ebae33aaa1f54ccbf5ab4b0e16cd1965128bd
-  data.tar.gz: 7486eb2fbd2cb8ede93beb3af7b2046b224e74983986045577997f227d9df4e056aac8f8054bb42f09c1194354b4c0306c45a30c059c6cab099710365ee58a9e
+  metadata.gz: 4c467c372844f04cdb4fd6d8d827fcbc56427936181f4bd08571da0f82c12014e0c9d6db282df17625e1102b7c0cf604af606478affeee51d1b769583a824fe2
+  data.tar.gz: 8d16570fa8441b83288790a052d0e09511039b72d6f44a0f9c9c4578d5668a8af04e49836c580f1a9e750602a11a1b607d8db5844e879249a41378a4c2a512f7

data/CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.8.0]
+
+### Added
+- Adds `QueueBus.with_local_mode` method. Useful when working with a multithreaded environment.
+
 ## [0.7.0]
 
 ### Added

data/README.mdown

@@ -141,6 +141,22 @@ 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
+
+**!! 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`:
+
+```ruby
+QueueBus.with_local_mode(:suppress) do
+  # QueueBus will be suppressed on this thread, within this block.
+end
+```
+
+The previous value of `local_mode` will be restored after the block exits.
+
 ### TODO
 
 * Replace local modes with adapters

data/lib/queue-bus.rb

@@ -34,7 +34,7 @@ module QueueBus
 
     def_delegators :config, :default_app_key=, :default_app_key,
                             :default_queue=, :default_queue,
-                            :local_mode=, :local_mode,
+                            :local_mode=, :local_mode, :with_local_mode,
                             :before_publish=, :before_publish_callback,
                             :logger=, :logger, :log_application, :log_worker,
                             :hostname=, :hostname,

data/lib/queue_bus/config.rb

@@ -6,9 +6,10 @@ require 'logger'
 module QueueBus
   # This class contains all the configuration for a running queue bus application.
   class Config
-    attr_accessor :default_queue, :local_mode, :hostname, :incoming_queue, :logger
+    attr_accessor :default_queue, :hostname, :incoming_queue, :logger
 
     attr_reader :worker_middleware_stack
+    attr_writer :local_mode
 
     def initialize
       @worker_middleware_stack = QueueBus::Middleware::Stack.new
@@ -16,6 +17,35 @@ module QueueBus
       @hostname = Socket.gethostname
     end
 
+    # A wrapper that is always "truthy" but can contain an inner value. This is useful for
+    # checking that a thread local variable is set to a value, even if that value happens to
+    # be nil. This is important because setting a thread local value to nil will cause it to
+    # be deleted.
+    Wrap = Struct.new(:value)
+
+    LOCAL_MODE_VAR = :queue_bus_local_mode
+
+    # Returns the current local mode of QueueBus
+    def local_mode
+      if Thread.current.thread_variable?(LOCAL_MODE_VAR)
+        Thread.current.thread_variable_get(LOCAL_MODE_VAR).value
+      else
+        @local_mode
+      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.
+    #
+    # @param mode [Symbol] the mode to switch to
+    def with_local_mode(mode)
+      previous = Thread.current.thread_variable_get(LOCAL_MODE_VAR)
+      Thread.current.thread_variable_set(LOCAL_MODE_VAR, Wrap.new(mode))
+      yield if block_given?
+    ensure
+      Thread.current.thread_variable_set(LOCAL_MODE_VAR, previous)
+    end
+
     def adapter=(val)
       raise "Adapter already set to #{@adapter_instance.class.name}" if has_adapter?
 

data/lib/queue_bus/version.rb

@@ -1,3 +1,3 @@
 module QueueBus
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/spec/config_spec.rb

@@ -26,6 +26,40 @@ describe 'QueueBus config' do
     expect(QueueBus.local_mode).to eq(:standalone)
   end
 
+  describe '#with_local_mode' do
+    it 'sets the local mode on the thread' do
+      QueueBus.with_local_mode(:suppress) do
+        expect(QueueBus.local_mode).to eq :suppress
+        Thread.new { expect(QueueBus.local_mode).to eq nil }.join
+      end
+    end
+
+    it 'supports nesting' do
+      QueueBus.with_local_mode(:suppress) do
+        expect(QueueBus.local_mode).to eq :suppress
+        QueueBus.with_local_mode(:inline) do
+          expect(QueueBus.local_mode).to eq :inline
+        end
+        expect(QueueBus.local_mode).to eq :suppress
+      end
+    end
+
+    it 'respects an override of nil' do
+      QueueBus.local_mode = :suppress
+      QueueBus.with_local_mode(nil) do
+        expect(QueueBus.local_mode).to eq nil
+      end
+      QueueBus.local_mode = :suppress
+    end
+
+    it 'resets to the original local mode after the block' do
+      QueueBus.with_local_mode(:suppress) do
+        expect(QueueBus.local_mode).to eq :suppress
+      end
+      expect(QueueBus.local_mode).to eq nil
+    end
+  end
+
   it 'sets the hostname' do
     expect(QueueBus.hostname).not_to eq(nil)
     QueueBus.hostname = 'whatever'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: queue-bus
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Brian Leonard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-24 00:00:00.000000000 Z
+date: 2019-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -173,8 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: queue-bus
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A simple event bus on top of background queues