services 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29308e17d5df01f543e985f8aeeb933a0e22e66f
-  data.tar.gz: 8ccb2f4ca9d250a98a9b78e87d2a5291078a1e00
+  metadata.gz: 6f4299a00ac5d36b3ca4eb252b7d389a0b11b36f
+  data.tar.gz: 1ddd50f90a9bbda3abea088edc727173ddba9c13
 SHA512:
-  metadata.gz: 54d37715aaea3ffbc50852d8ceff00374d58443f3b67a93ee686ec9b88223904ee22fe49cb3ce6d2a36bdc1831f6b490c40ee542f0eca0f5b29634169a237c33
-  data.tar.gz: c324202d7c4311b6d549f1c764fe817ec1540cd0a3ab02dc9aeacc4493bf479621282aed5dfd8f447c35be7c86a27b2d324714b8a5937d85c29045a6a4a0a1ac
+  metadata.gz: 848c4ee5ee12f5e5f0830716d49a16d4f9733620faf5be6dc1623d8ead6bfffbdbcb296d540f69ce1484efa9a83ab9ab504f388b8a9e56e7c5d15a8125ecba85
+  data.tar.gz: a53a702dc0f76feffc578e28488f0d10857854f9d13beaecf2702a362be31ba77410b0c3ba52e2292e6cb9536db96cb9b76007d5d220eeaa4a2a81c403f26b51

data/lib/services/modules/uniqueness_checker.rb

@@ -1,35 +1,43 @@
 module Services
   class Base
     module UniquenessChecker
+      KEY_PREFIX = %w(
+        services
+        uniqueness
+      ).join(':')
+
       def self.prepended(mod)
         mod.const_set :NotUniqueError, Class.new(mod::Error)
       end
 
       def check_uniqueness!(*args)
-        raise 'A variable named @uniqueness_key is already defined. Have you called `check_uniqueness!` twice?' if defined?(@uniqueness_key)
-        raise 'Could not find @uniqueness_all_args' unless defined?(@uniqueness_all_args)
-        args = @uniqueness_all_args if args.empty?
-        @uniqueness_key = uniqueness_key(args)
-        if similar_service_id = Services.configuration.redis.get(@uniqueness_key)
-          raise self.class::NotUniqueError, "Service #{self.class} with args #{args} is not unique, a similar service is already running: #{similar_service_id}"
+        if args.empty?
+          raise 'Could not find uniqueness args' unless defined?(@uniqueness_args)
+          args = @uniqueness_args
+        end
+        @uniqueness_keys ||= []
+        new_uniqueness_key = uniqueness_key(args)
+        raise "A uniqueness key with args #{args.inspect} already exists." if @uniqueness_keys.include?(new_uniqueness_key)
+        @uniqueness_keys << new_uniqueness_key
+        if similar_service_id = Services.configuration.redis.get(new_uniqueness_key)
+          raise self.class::NotUniqueError, "Service #{self.class} with uniqueness args #{args} is not unique, a similar service is already running: #{similar_service_id}"
         else
-          Services.configuration.redis.setex @uniqueness_key, 60 * 60, @id
+          Services.configuration.redis.setex new_uniqueness_key, 60 * 60, @id
         end
       end
 
       def call(*args)
-        @uniqueness_all_args = args
+        @uniqueness_args = args
         super
       ensure
-        Services.configuration.redis.del @uniqueness_key if defined?(@uniqueness_key)
+        Services.configuration.redis.del @uniqueness_keys if defined?(@uniqueness_keys)
       end
 
       private
 
       def uniqueness_key(args)
         [
-          'services',
-          'uniqueness',
+          KEY_PREFIX,
           self.class.to_s
         ].tap do |key|
           key << Digest::MD5.hexdigest(args.to_s) unless args.empty?

data/lib/services/version.rb

@@ -1,3 +1,3 @@
 module Services
-  VERSION = '0.2.5'
+  VERSION = '0.2.6'
 end

data/spec/services/base_spec.rb

@@ -118,25 +118,54 @@ describe Services::Base do
   end
 
   context 'checking for uniqueness' do
-    context 'when the service was set to check for uniqueness with the default args' do
+    context 'when the service checks for uniqueness with the default args' do
       it 'raises an error when the same job is executed twice' do
-        wait_for_job_to_run UniqueService.perform_async
-        expect { UniqueService.call }.to raise_error(UniqueService::NotUniqueError)
+        wait_for_job_to_run UniqueService do
+          expect { UniqueService.call }.to raise_error(UniqueService::NotUniqueError)
+        end
       end
     end
 
-    context 'when the service was set to check for uniqueness with custom args' do
+    context 'when the service checks for uniqueness with custom args' do
       it 'raises an error when a job with the same custom args is executed twice' do
-        wait_for_job_to_run UniqueWithCustomArgsService.perform_async('foo', 'bar', 'baz')
-        expect { UniqueWithCustomArgsService.call('foo', 'bar', 'pelle') }.to raise_error(UniqueWithCustomArgsService::NotUniqueError)
-        expect { UniqueWithCustomArgsService.call('foo', 'baz', 'pelle') }.to_not raise_error
+        wait_for_job_to_run UniqueWithCustomArgsService, 'foo', 'bar', 'baz' do
+          expect { UniqueWithCustomArgsService.call('foo', 'bar', 'pelle') }.to raise_error(UniqueWithCustomArgsService::NotUniqueError)
+          expect { UniqueWithCustomArgsService.call('foo', 'baz', 'pelle') }.to_not raise_error
+        end
+      end
+    end
+
+    context 'when the service checks for uniqueness multiple times' do
+      let(:args) { %w(foo bar baz) }
+
+      it 'raises an error when one of the checks fails' do
+        wait_for_job_to_run UniqueMultipleService, *args do
+          args.each do |arg|
+            expect { UniqueMultipleService.call(arg) }.to raise_error(UniqueMultipleService::NotUniqueError)
+          end
+          expect { UniqueMultipleService.call('pelle') }.to_not raise_error
+        end
+      end
+
+      it 'does not leave any Redis keys behind' do
+        expect do
+          wait_for_job_to_run_and_finish UniqueMultipleService, *args do
+            args.each do |arg|
+              UniqueMultipleService.call(arg) rescue nil
+            end
+            UniqueMultipleService.call('pelle')
+          end
+        end.to_not change {
+          Services.configuration.redis.keys("*#{Services::Base::UniquenessChecker::KEY_PREFIX}*").count
+        }
       end
     end
 
     context 'when the service was not set to check for uniqueness' do
       it 'does not raise an error when the same job is executed twice' do
-        wait_for_job_to_run NonUniqueService.perform_async
-        expect { NonUniqueService.call }.to_not raise_error
+        wait_for_job_to_run NonUniqueService do
+          expect { NonUniqueService.call }.to_not raise_error
+        end
       end
     end
   end

data/spec/support/helpers.rb

@@ -8,10 +8,21 @@ def wait_for(&block)
   end
 end
 
-def wait_for_job_to_run(jid)
-  wait_for do
-    Sidekiq::Workers.new.any? do |_, _, work|
-      work['payload']['jid'] == jid
-    end
+def worker_with_jid(jid)
+  Sidekiq::Workers.new.detect do |_, _, work|
+    work['payload']['jid'] == jid
+  end
+end
+
+def wait_for_job_to_run(job_class, *args, &block)
+  job_class.perform_async(*args).tap do |jid|
+    wait_for { worker_with_jid(jid) }
+    block.call if block_given?
+  end
+end
+
+def wait_for_job_to_run_and_finish(job_class, *args, &block)
+  wait_for_job_to_run(job_class, *args, &block).tap do |jid|
+    wait_for { worker_with_jid(jid).nil? }
   end
 end

data/spec/support/test_services.rb

@@ -67,6 +67,15 @@ class UniqueWithCustomArgsService < Services::Base
   end
 end
 
+class UniqueMultipleService < Services::Base
+  def call(*args)
+    args.each do |arg|
+      check_uniqueness! arg
+    end
+    sleep 0.5
+  end
+end
+
 class NonUniqueService < Services::Base
   def call
     sleep 0.5

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: services
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Manuel Meurer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-11 00:00:00.000000000 Z
+date: 2014-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake