sidekiq_lockable_job 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f55d67805fbdfb7c7dab6270ed0b74620e59ba5ac3022a1c5cb97e5ebc2dad20
-  data.tar.gz: c47ff60f8342d3d4432a8afddcb4b4bae330e08e43ef3573a3d6e175c9c9bad8
+  metadata.gz: 5ce3896784973f4d6fab5917fc1dc383e12d8cb9bff157bcb5d91f3f2eaa755f
+  data.tar.gz: 5d44e4d73e36875421feaa8140e5deb888a23a4de95964f7638c0c23df93cc1c
 SHA512:
-  metadata.gz: abeb924fe55362a5cfc2ee4f2e4b904d8c8f18f07f9bea6ad02b09b5d946bf4f34eb0355917ac2ab0fb593ba969323820840284186b3630b738da07ebb44db4d
-  data.tar.gz: 4a7855f124c9b2b5e4a6cb4a8ade26aac03d00527d300f8b764ee97487d9f82019de823f5f2f1a3874d9e4edb9604ac404a7493f453eec01a05db55c6c23426b
+  metadata.gz: 26f1401accb8cd4b0b592472e2f99edd78db38079884034ce2acac0823d27af14b86fe8daa997f58a09d9e573a356946497628001d0256cd66284ce5aa70019f
+  data.tar.gz: ec29d4842da09003a7951367b80c03bf5e694e5601103375bed90f67308bcc691f651a812a31fefa90b336848d8fad529c6758888f41c1ec476cc706cf66ae1c

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+demo.txt

data/Gemfile.lock

@@ -1,20 +1,25 @@
 PATH
   remote: .
   specs:
-    sidekiq_lockable_job (0.1.1)
+    sidekiq_lockable_job (0.1.2)
       redis (= 4.0.1)
       sidekiq (= 5.0.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    concurrent-ruby (1.1.5)
+    concurrent-ruby (1.1.6)
     connection_pool (2.2.2)
     diff-lcs (1.3)
+    equatable (0.6.1)
     fakeredis (0.7.0)
       redis (>= 3.2, < 5.0)
-    rack (2.0.8)
-    rack-protection (2.0.5)
+    necromancer (0.5.1)
+    pastel (0.7.3)
+      equatable (~> 0.6)
+      tty-color (~> 0.5)
+    rack (2.2.2)
+    rack-protection (2.0.8.1)
       rack
     rake (12.3.3)
     redis (4.0.1)
@@ -36,6 +41,18 @@ GEM
       connection_pool (~> 2.2, >= 2.2.0)
       rack-protection (>= 1.5.0)
       redis (>= 3.3.4, < 5)
+    tty-color (0.5.1)
+    tty-cursor (0.7.1)
+    tty-prompt (0.19.0)
+      necromancer (~> 0.5.0)
+      pastel (~> 0.7.0)
+      tty-reader (~> 0.6.0)
+    tty-reader (0.6.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.7)
+      wisper (~> 2.0.0)
+    tty-screen (0.7.1)
+    wisper (2.0.1)
 
 PLATFORMS
   ruby
@@ -46,6 +63,7 @@ DEPENDENCIES
   rake (~> 12.3.3)
   rspec (~> 3.0)
   sidekiq_lockable_job!
+  tty-prompt (= 0.19.0)
 
 BUNDLED WITH
    2.0.2

data/README.md

@@ -38,6 +38,15 @@ Or install it yourself as:
 
     $ gem install sidekiq_lockable_job
 
+
+## Demo
+
+Thanks to [Asciinema](https://asciinema.org)!
+
+    $ rake demo
+
+[![asciicast](https://asciinema.org/a/324095.svg)](https://asciinema.org/a/324095)
+
 ## Usage
 
 The gem is compose of four parts:
@@ -219,7 +228,9 @@ end
 ## Specs
 
 ```
-Sidekiq::LockableJob
+Sidekiq::LockableJob::LockService
+  REDIS_PREFIX_KEY
+    has a prefix
   .lock
     lock
   .unlock
@@ -230,9 +241,9 @@ Sidekiq::LockableJob
   .handle_locked_by
     raise if locked by any key
     raise if locked by single key
-    DOT NOT raise if not locked by
-  .included
-    include middlewares
+    when not locked
+      DOT NOT raise if not locked by
+      return false
 
 Sidekiq::LockableJob::Middleware::Client::SetLocks
   LockableJob
@@ -261,6 +272,8 @@ Sidekiq::LockableJob::Middleware::Server::HandleLockedBy
     with a non lock key
       behaves like perform the job
         example at ./spec/sidekiq/lockable_job/middleware/server/shared.rb:13
+      behaves like it yield
+        is expected to eq true
     with single lock key
       behaves like raise an error
         is expected to raise Sidekiq::LockableJob::LockedJobError
@@ -299,8 +312,43 @@ Sidekiq::LockableJob::Middleware::Server::UnsetLocks
         for another job
           DOES NOT remove the lock
 
+Sidekiq::LockableJob::MultiLockService
+  REDIS_PREFIX_KEY
+    has a prefix
+  .lock
+    lock
+  .unlock
+    unlock
+    with multiple lock
+      don't unlock at first
+      unlock
+  .locked?
+    true if locked
+    false if NOT locked
+  .handle_locked_by
+    raise if locked by any key
+    raise if locked by single key
+    when not locked
+      DOT NOT raise if not locked by
+      return false
+
+Sidekiq::LockableJob
+  .current_lockable_job_lock_service
+    has lock_service by default
+  .lockable_job_lock_service
+    set a custom lock service
+  .included
+    include client middleware
+    include server middleware (PENDING: Temporarily skipped with xit)
+
 SidekiqLockableJob
   has a version number
+
+Pending: (Failures listed here are expected and do not affect your suite's status)
+
+  1) Sidekiq::LockableJob.included include server middleware
+     # Temporarily skipped with xit
+     # ./spec/sidekiq/lockable_job_spec.rb:37
 ```
 
 ## Development

data/Rakefile

@@ -1,6 +1,24 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'tty-prompt'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+
+desc "Play a demo of contextualized_logs"
+task :demo do
+  prompt = TTY::Prompt.new
+  if `which asciinema`.empty?
+    if `which brew`.empty
+      return unless prompt.yes?('Install brew')
+      `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"`
+
+      return unless prompt.yes?('Install asciinema using brew?')
+      `brew install asciinema`
+    end
+  end
+  prompt.warn('press [space] continuesly to play demo line by line, or just press [space] to play')
+  exec('asciinema play -i 1 -s 1 demo.cast')
+end

data/demo.cast

@@ -0,0 +1,101 @@
+{"version": 2, "width": 237, "height": 44, "timestamp": 1587897100, "idle_time_limit": 1.0, "env": {"SHELL": "/bin/bash", "TERM": "xterm-256color"}}
+[0.037941, "o", "\u001b(B\u001b[m"]
+[1.429049, "o", "\u001b[?1034h\u001b]0;~/Developer/sidekiq_lockable_job/demo\u0007\u001b[1m\r\r\n\u001b[38;5;166mhugues\u001b[97m at \u001b[38;5;136mme\u001b[97m in \u001b[38;5;64m~/Developer/sidekiq_lockable_job/demo\u001b[97m on \u001b[38;5;61mmaster\u001b[38;5;33m [?]\r\r\n\u001b[97m$ \u001b(B\u001b[m"]
+[2.693711, "o", "b"]
+[2.861477, "o", "i"]
+[2.909667, "o", "n"]
+[3.15756, "o", "/"]
+[4.181652, "o", "r"]
+[4.229672, "o", "a"]
+[4.373526, "o", "i"]
+[4.581437, "o", "l"]
+[4.669993, "o", "s"]
+[4.765497, "o", " "]
+[4.869453, "o", "c"]
+[4.982059, "o", "o"]
+[5.133435, "o", "n"]
+[5.277517, "o", "s"]
+[5.373362, "o", "o"]
+[5.549523, "o", "l"]
+[5.661744, "o", "e"]
+[6.144158, "o", "\r\n"]
+[6.372237, "o", "Running via Spring preloader in process 79961\r\n"]
+[6.462458, "o", "Loading development environment (Rails 5.2.4.2)\r\n"]
+[6.534371, "o", "2.5.1 :001 > "]
+[10.866142, "o", "require 'sidekiq/api'"]
+[11.197897, "o", "\r\n"]
+[11.213634, "o", " => true \r\n"]
+[11.214044, "o", "2.5.1 :002 > "]
+[13.522775, "o", "# enqueuing a worker (which will lock"]
+[13.710313, "o", " key 123)"]
+[13.933963, "o", "\r\n"]
+[13.934892, "o", " => nil \r\n"]
+[13.935192, "o", "2.5.1 :003 > "]
+[16.434577, "o", "LockingWorker.perform_async(order: {i"]
+[16.622436, "o", "d: 123, some_data: {}})"]
+[16.710056, "o", "\r\n"]
+[16.721799, "o", " => \"1acd47fe45dd661540527a34\" \r\n"]
+[16.722121, "o", "2.5.1 :004 > "]
+[19.818816, "o", "# enqueuing a worker (locked by key 1"]
+[20.007121, "o", "23)"]
+[20.040845, "o", "\r\n"]
+[20.041415, "o", " => nil \r\n"]
+[20.04179, "o", "2.5.1 :005 > "]
+[22.538638, "o", "LockedWorker.perform_async(order: {id"]
+[22.726702, "o", ": 123, some_data: {}})"]
+[22.845971, "o", "\r\n"]
+[22.853816, "o", " => \"a06584cb5b431210acb01115\" \r\n"]
+[22.854692, "o", "2.5.1 :006 > "]
+[25.546689, "o", "# Job failed and is in retry queue"]
+[25.766154, "o", "\r\n"]
+[25.767462, "o", " => nil \r\n"]
+[25.767944, "o", "2.5.1 :007 > "]
+[27.954316, "o", "Sidekiq::RetrySet.new.size"]
+[28.188546, "o", "\r\n"]
+[28.190567, "o", " => 1 \r\n"]
+[28.190903, "o", "2.5.1 :008 > "]
+[30.571693, "o", "Sidekiq::RetrySet.new.map { |job| JSO"]
+[30.75931, "o", "N.parse(job.value) }"]
+[32.053652, "o", "\r\n"]
+[32.058581, "o", " => [{\"class\"=>\"LockedWorker\", \"args\"=>[{\"order\"=>{\"id\"=>123, \"some_data\"=>{}}}], \"retry\"=>true, \"queue\"=>\"default\", \"jid\"=>\"a06584cb5b431210acb01115\", \"created_at\"=>1587897123.6782131, \"enqueued_at\"=>1587897123.6784651, \"error_message\"=>\"Locked by prefix:123\", \"error_class\"=>\"Sidekiq::LockableJob::LockedJobError\", \"failed_at\"=>1587897123.68101, \"retry_count\"=>0}] \r\n"]
+[32.058966, "o", "2.5.1 :009 > "]
+[37.106931, "o", "# enqueuing a worker (which will unlo"]
+[37.294755, "o", "ck key 123)"]
+[37.405951, "o", "\r\n"]
+[37.406885, "o", " => nil \r\n"]
+[37.40748, "o", "2.5.1 :010 > "]
+[40.314847, "o", "UnlockingWorker.perform_async(order: "]
+[40.502682, "o", "{id: 123, some_data: {}})"]
+[40.645814, "o", "\r\n"]
+[40.661027, "o", " => \"5ec6b9561a009212ee4e5dd5\" \r\n"]
+[40.661627, "o", "2.5.1 :011 > "]
+[43.184041, "o", "# will retry after x, but retrying no"]
+[43.372291, "o", "w"]
+[43.397571, "o", "\r\n"]
+[43.398466, "o", " => nil \r\n"]
+[43.399082, "o", "2.5.1 :012 > "]
+[45.463978, "o", "Sidekiq::RetrySet.new.each { |job| jo"]
+[45.652289, "o", "b.retry }"]
+[45.790045, "o", "\r\n"]
+[45.796951, "o", " => nil \r\n"]
+[45.797289, "o", "2.5.1 :013 > "]
+[48.43503, "o", "# Job succeed (retry queue empty)"]
+[48.653806, "o", "\r\n"]
+[48.655128, "o", " => nil \r\n"]
+[48.655888, "o", "2.5.1 :014 > "]
+[51.330909, "o", "Sidekiq::RetrySet.new.size"]
+[51.670463, "o", "\r\n"]
+[51.674847, "o", " => 0 \r\n"]
+[51.675462, "o", "2.5.1 :015 > "]
+[52.878169, "o", "e"]
+[53.09376, "o", "x"]
+[53.317689, "o", "i"]
+[53.469703, "o", "t"]
+[53.694002, "o", "\r\n"]
+[53.806103, "o", "\u001b]0;~/Developer/sidekiq_lockable_job/demo\u0007\u001b[1m\r\r\n\u001b[38;5;166mhugues\u001b[97m at \u001b[38;5;136mme\u001b[97m in \u001b[38;5;64m~/Developer/sidekiq_lockable_job/demo\u001b[97m on \u001b[38;5;61mmaster\u001b[38;5;33m [?]\r\r\n\u001b[97m$ \u001b(B\u001b[m"]
+[54.237871, "o", "e"]
+[54.453613, "o", "x"]
+[54.589842, "o", "i"]
+[54.701678, "o", "t"]
+[54.895101, "o", "\r\n"]
+[54.895568, "o", "exit\r\n"]

data/lib/sidekiq/lockable_job.rb

@@ -25,8 +25,8 @@ module Sidekiq
       # chain is invoked so we're all good.
       #
       Sidekiq.configure_server do |config|
-        unless config.client_middleware.exists? Sidekiq::LockableJob::Middleware::Server::SetLocks
-          config.client_middleware.add Sidekiq::LockableJob::Middleware::Server::SetLocks
+        unless config.server_middleware.exists? Sidekiq::LockableJob::Middleware::Server::SetLocks
+          config.server_middleware.add Sidekiq::LockableJob::Middleware::Server::SetLocks
         end
         unless config.server_middleware.exists? Sidekiq::LockableJob::Middleware::Server::HandleLockedBy
           config.server_middleware.add Sidekiq::LockableJob::Middleware::Server::HandleLockedBy

data/lib/sidekiq_lockable_job/version.rb

@@ -1,3 +1,3 @@
 module SidekiqLockableJob
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/sidekiq_lockable_job.gemspec

@@ -38,4 +38,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "fakeredis", '0.7.0'
+  spec.add_development_dependency 'tty-prompt', '0.19.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_lockable_job
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Hugues Bernet-Rollande
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2020-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -94,6 +94,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.0
 description: |
   Sidekiq includes a jobs dependencies mechanism to prevent a job from running before another one when enqueued.
 
@@ -118,6 +132,7 @@ files:
 - bin/console
 - bin/rspec
 - bin/setup
+- demo.cast
 - lib/sidekiq/lockable_job.rb
 - lib/sidekiq/lockable_job/lock_service.rb
 - lib/sidekiq/lockable_job/middleware/client/set_locks.rb