exel-sidekiq 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a32d28307810ce39c5e22962bd27e9e7cd7bc8d
-  data.tar.gz: c20243b2f7d01719984e9370c87b00ff5b77913e
+  metadata.gz: a363f2b4dc4efe7a4d0becc57e82f38b069af9bc
+  data.tar.gz: 5d14b0bbea5e9434c4c21d5e920fcabb4f3e2b37
 SHA512:
-  metadata.gz: d4a66a8bdbcc85f3dfb3d952ba6825ceda812fd99aa7e8b4f35ee16232f47395b2248fae859dd5caa6dae554406fe290dff7fb444a7f8e34c78833c0e9e7e18e
-  data.tar.gz: cd339ab53034b3403cadf860b13dc084d77d6161298a2d3a665d31d2a92dff27e948dabb6b8504f897f8580fa97834593c8c3abddaad83dde43389b888a7cae4
+  metadata.gz: c44ac7cfeedbbea7d37599e10d7b9456951e97bd2e5d4246c1ae109db1f5590573843f3cf1fa89d64e7a3d2107454496b95304c56396173fbce13018a20a724a
+  data.tar.gz: 68170035d52b843fdc52cfe41bd4f2bca77973c477533d65062d303f45f2c8800aecb230f26789c6330eed17883d458dfcd97246edc1c1227bcb8b631aa50375

data/README.md

@@ -27,6 +27,8 @@ By requiring this gem, Sidekiq support will automatically be added to [EXEL](htt
         process with: MyProcessor
     end
 
+You can optionally provide a string in ```context[:async_label]``` which will be passed to the Sidekiq worker. This is intended to be a human readable label that will be visible on the Sidekiq admin pages to assist in debugging and monitoring your jobs.
+
 ## Contributing
 
 1. Fork it ( https://github.com/47colborne/exel-sidekiq )

data/lib/exel/sidekiq/execution_worker.rb

@@ -5,7 +5,9 @@ module EXEL
     class ExecutionWorker
       include ::Sidekiq::Worker
 
-      def perform(context_uri)
+      def perform(context_uri, label = nil)
+        EXEL.logger.debug("[#{label}] Worker starting")
+
         context = Context.deserialize(context_uri)
         block = context[:_block]
         block.start(context)

data/lib/exel/sidekiq/sidekiq_provider.rb

@@ -11,7 +11,10 @@ module EXEL
       def do_async(block)
         @context[:_block] = block
 
-        push_args = {'class' => EXEL::Sidekiq::ExecutionWorker, 'args' => [@context.serialize]}
+        worker_args = [@context.serialize, @context[:async_label]].compact
+
+        # noinspection RubyStringKeysInHashInspection
+        push_args = {'class' => EXEL::Sidekiq::ExecutionWorker, 'args' => worker_args}
         push_args['queue'] = @context[:queue] if @context[:queue]
         push_args['retry'] = @context[:retry] if @context[:retry]
 

data/lib/exel/sidekiq/version.rb

@@ -1,5 +1,5 @@
 module EXEL
   module Sidekiq
-    VERSION = '1.0.1'
+    VERSION = '1.0.2'.freeze
   end
 end

data/spec/exel/sidekiq/sidekiq_provider_spec.rb

@@ -17,20 +17,34 @@ module EXEL
           provider.do_async(callback)
         end
 
+        it 'passes the serialized context URI to the worker' do
+          expect(::Sidekiq::Client).to receive(:push).with(hash_including('class' => ExecutionWorker,
+                                                                          'args' => [serialized_context_uri]))
+          provider.do_async(callback)
+        end
+
+        context 'when label is present in the context' do
+          let(:context) { EXEL::Context.new(async_label: 'label') }
+
+          it 'includes the label in the args' do
+            args = [serialized_context_uri, 'label']
+            expect(::Sidekiq::Client).to receive(:push).with(hash_including('class' => ExecutionWorker, 'args' => args))
+            provider.do_async(callback)
+          end
+        end
+
         context 'with queue name' do
           let(:context) { EXEL::Context.new(queue: 'import_processor') }
 
-          it 'pushes the execution worker to the given queue' do
-            expect(::Sidekiq::Client).to receive(:push).with(
-              'queue' => context[:queue], 'class' => ExecutionWorker, 'args' => [serialized_context_uri])
+          it 'pushes to the given queue' do
+            expect(::Sidekiq::Client).to receive(:push).with(hash_including('queue' => context[:queue]))
             provider.do_async(callback)
           end
         end
 
         context 'without queue name' do
-          it 'pushes the execution worker to the default queue' do
-            expect(::Sidekiq::Client).to receive(:push).with(
-              'class' => ExecutionWorker, 'args' => [serialized_context_uri])
+          it 'pushes to the default queue' do
+            expect(::Sidekiq::Client).to receive(:push).with(hash_not_including('queue'))
             provider.do_async(callback)
           end
         end
@@ -38,17 +52,15 @@ module EXEL
         context 'with retries specified' do
           let(:context) { EXEL::Context.new(retry: 1) }
 
-          it 'pushes the execution worker with a specified number of retries' do
-            expect(::Sidekiq::Client).to receive(:push).with(
-              'retry' => context[:retry], 'class' => ExecutionWorker, 'args' => [serialized_context_uri])
+          it 'pushes the worker with a specified number of retries' do
+            expect(::Sidekiq::Client).to receive(:push).with(hash_including('retry' => context[:retry]))
             provider.do_async(callback)
           end
         end
 
         context 'with no retries specified' do
-          it 'pushes the execution worker with no specified number of retries' do
-            expect(::Sidekiq::Client).to receive(:push).with(
-              'class' => ExecutionWorker, 'args' => [serialized_context_uri])
+          it 'pushes the worker with no specified number of retries' do
+            expect(::Sidekiq::Client).to receive(:push).with(hash_not_including('retry'))
             provider.do_async(callback)
           end
         end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'exel'
+require 'sidekiq/testing'
 
 Dir[File.expand_path('../../lib/**/*.rb', __FILE__)].each { |f| require f }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exel-sidekiq
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - yroo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-05 00:00:00.000000000 Z
+date: 2016-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: exel