chewy_kiqqer 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bc9b696f63dde10676ef37db9dcc950ddf4cc89
-  data.tar.gz: 5a65a9c36ded236ddd6d4b76f3711afad2750b8d
+  metadata.gz: 69fa520fad10a08f620c667e91f1b133ac7e8adf
+  data.tar.gz: 6d8ab912f3eb918570395081cc4e89720e286b7e
 SHA512:
-  metadata.gz: e8188028f5fff23bf9dc931b5ab5bcb1488ae030140d373a0f14890990720e4cc664d593ed37a1b16084c5fceb51de7e7a935fc6a020eff477e73532944f305b
-  data.tar.gz: 979a88a89572420ebda2b9f07efe464ff78d3dd7430b02414705e3297c062053d16c1fb1472ab0443370b1b4c64e6cb62db956df35486eb9540a552362f112e5
+  metadata.gz: 7459fef7cf824e5d833636876c4e09c6ad3c44ebb26e2c99e9bf7e96e775eff5845076f2ba55d4574cd75cb6b235190504e93b6547612fa204c1bc6bebbf56f1
+  data.tar.gz: fdf22831d0609f93fa8fc23b1d69ded783baf684af20507b708867784ae9003800db5352bc58a77e08cf7a1254a9dcc3ee17474cd914b8cc1c2b78cc1bcef0ae

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
+services:
+  - redis
 rvm:
   - 2.0.0
   - 2.1.2

data/README.md

@@ -51,6 +51,19 @@ which will be indexed. The default is to use the current record.
 
 ## Update handling
 
+The kiqqer does *not* use Chewy's `atomic` update, since that functionality is deeply linked with Chewy's syncronous update mechanism.
+
+Instead, ChewyKiqqer will bind itself to the `#after_commit` callback, which means that it will only trigger a new job after a complete database transaction. This behaviour also ensures that only one job is enqueued per transaction.
+
+However, if you have multiple database transactions, the kiqqer will still queue multiple jobs. The same is true when you enqueue jobs manually.
+
+ChewyKiqqer uses locking via redis to ensure that all updates for one database record are run sequentially. This prevents race conditions which could lead to outdated data being written to the index otherwise.
+
+## Logging
+
+Logging is disabled by default, but you can set `ChewyKiqqer.logger` if you need log output (e.g. `ChewyKiqqer.logger = Rails.logger`). ChewyKiqqer uses ActiveSupport notifications, which you can also subscribe to.
+See `log_subscriber.rb` for more info.
+
 ## Contributing
 
 1. Fork it

data/chewy_kiqqer.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'sidekiq'
   spec.add_dependency 'chewy'
-  spec.add_dependency 'sidekiq-lock'
+  spec.add_dependency 'mlanett-redis-lock'
   spec.add_dependency 'activesupport', '>= 3.2.0'
 
   spec.add_development_dependency "bundler", "~> 1.3"

data/lib/chewy_kiqqer/log_subscriber.rb

@@ -3,7 +3,11 @@ module ChewyKiqqer
   class LogSubscriber < ActiveSupport::LogSubscriber
 
     def perform(event)
-      info "ChewyKiqqer performed on #{event.payload[:index_name]} with ids #{event.payload[:ids]} - duration #{event.duration}"
+      info "ChewyKiqqer job ran on #{event.payload[:index_name]} with ids #{event.payload[:ids]} - duration #{event.duration}"
+    end
+
+    def index(event)
+      debug "ChewyKiqqer index updated on #{event.payload[:index_name]} with ids #{event.payload[:ids]} - duration #{event.duration}"
     end
 
     def queue_jobs(event)

data/lib/chewy_kiqqer/version.rb

@@ -1,3 +1,3 @@
 module ChewyKiqqer
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/chewy_kiqqer/worker.rb

@@ -1,27 +1,33 @@
 require 'sidekiq'
-require 'sidekiq-lock'
+require 'redis-lock'
 
 module ChewyKiqqer
   class Worker
 
-    class LockError < StandardError ; end
-
     include Sidekiq::Worker
-    include Sidekiq::Lock::Worker
-
-    sidekiq_options lock: {
-      timeout: 3000,
-      name:    ->(index_name, ids) { "lock:chewy_kiqqer:#{index_name}-#{[ids].flatten.sort.join('-')}" }
-    }
 
 
     def perform(index_name, ids)
-      lock.acquire! or raise LockError
       ActiveSupport::Notifications.instrument('perform.chewy_kiqqer', index_name: index_name, ids: ids) do
+        with_lock(index_name, ids)
+      end
+    end
+
+    private
+
+    def with_lock(index_name, ids)
+      Sidekiq.redis do |redis|
+        lock_name = "#{index_name}-#{ids.join('-')}"
+        redis.lock(lock_name, life: 60, acquire: 5) { index(index_name, ids) }
+      end
+    end
+
+    def index(index_name, ids)
+      ActiveSupport::Notifications.instrument('index.chewy_kiqqer', index_name: index_name, ids: ids) do
         Chewy.derive_type(index_name).import ids
       end
-    ensure
-      lock.release!
     end
+
+
   end
 end

data/spec/log_subscriber_spec.rb

@@ -19,6 +19,14 @@ describe ChewyKiqqer::LogSubscriber do
     }.to_not raise_error
   end
 
+  it 'logs an index event' do
+    allow(subscriber).to receive(:logger).and_return(logger)
+    expect(logger).to receive(:debug)
+    expect {
+      subscriber.index(double(payload: { index_name: 'foo', ids: [1,2] }, duration: 0.2))
+    }.to_not raise_error
+  end
+
   it 'log a queue_jobs event' do
     allow(subscriber).to receive(:logger).and_return(logger)
     expect(logger).to receive(:debug)

data/spec/worker_spec.rb

@@ -15,11 +15,4 @@ describe ChewyKiqqer::Worker do
     worker.perform('foo#bar', [17])
   end
 
-  it 'raises a lock error if the lock cannot be acquired' do
-    allow(lock).to receive(:acquire!).and_return(false)
-    expect {
-      worker.perform('foo#bar', [17])
-    }.to raise_error(ChewyKiqqer::Worker::LockError)
-  end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chewy_kiqqer
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Daniel Hahn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-29 00:00:00.000000000 Z
+date: 2014-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sidekiq-lock
+  name: mlanett-redis-lock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='