sidekiq-unique-jobs 6.0.23 → 7.1.12

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of sidekiq-unique-jobs might be problematic. Click here for more details.

Files changed (127) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +922 -41
  3. data/README.md +821 -284
  4. data/lib/sidekiq_unique_jobs/batch_delete.rb +123 -0
  5. data/lib/sidekiq_unique_jobs/changelog.rb +78 -0
  6. data/lib/sidekiq_unique_jobs/cli.rb +34 -31
  7. data/lib/sidekiq_unique_jobs/config.rb +314 -0
  8. data/lib/sidekiq_unique_jobs/connection.rb +6 -5
  9. data/lib/sidekiq_unique_jobs/constants.rb +45 -24
  10. data/lib/sidekiq_unique_jobs/core_ext.rb +80 -0
  11. data/lib/sidekiq_unique_jobs/deprecation.rb +65 -0
  12. data/lib/sidekiq_unique_jobs/digests.rb +70 -102
  13. data/lib/sidekiq_unique_jobs/exceptions.rb +88 -12
  14. data/lib/sidekiq_unique_jobs/job.rb +41 -12
  15. data/lib/sidekiq_unique_jobs/json.rb +47 -0
  16. data/lib/sidekiq_unique_jobs/key.rb +93 -0
  17. data/lib/sidekiq_unique_jobs/lock/base_lock.rb +111 -82
  18. data/lib/sidekiq_unique_jobs/lock/client_validator.rb +28 -0
  19. data/lib/sidekiq_unique_jobs/lock/server_validator.rb +27 -0
  20. data/lib/sidekiq_unique_jobs/lock/until_and_while_executing.rb +40 -15
  21. data/lib/sidekiq_unique_jobs/lock/until_executed.rb +25 -7
  22. data/lib/sidekiq_unique_jobs/lock/until_executing.rb +22 -2
  23. data/lib/sidekiq_unique_jobs/lock/until_expired.rb +26 -16
  24. data/lib/sidekiq_unique_jobs/lock/validator.rb +96 -0
  25. data/lib/sidekiq_unique_jobs/lock/while_executing.rb +23 -12
  26. data/lib/sidekiq_unique_jobs/lock/while_executing_reject.rb +3 -3
  27. data/lib/sidekiq_unique_jobs/lock.rb +325 -0
  28. data/lib/sidekiq_unique_jobs/lock_args.rb +123 -0
  29. data/lib/sidekiq_unique_jobs/lock_config.rb +126 -0
  30. data/lib/sidekiq_unique_jobs/lock_digest.rb +79 -0
  31. data/lib/sidekiq_unique_jobs/lock_info.rb +68 -0
  32. data/lib/sidekiq_unique_jobs/lock_timeout.rb +62 -0
  33. data/lib/sidekiq_unique_jobs/lock_ttl.rb +77 -0
  34. data/lib/sidekiq_unique_jobs/locksmith.rb +275 -102
  35. data/lib/sidekiq_unique_jobs/logging/middleware_context.rb +44 -0
  36. data/lib/sidekiq_unique_jobs/logging.rb +188 -33
  37. data/lib/sidekiq_unique_jobs/lua/delete.lua +51 -0
  38. data/lib/sidekiq_unique_jobs/lua/delete_by_digest.lua +42 -0
  39. data/lib/sidekiq_unique_jobs/lua/delete_job_by_digest.lua +38 -0
  40. data/lib/sidekiq_unique_jobs/lua/find_digest_in_queues.lua +26 -0
  41. data/lib/sidekiq_unique_jobs/lua/lock.lua +93 -0
  42. data/lib/sidekiq_unique_jobs/lua/locked.lua +35 -0
  43. data/lib/sidekiq_unique_jobs/lua/queue.lua +87 -0
  44. data/lib/sidekiq_unique_jobs/lua/reap_orphans.lua +94 -0
  45. data/lib/sidekiq_unique_jobs/lua/shared/_common.lua +40 -0
  46. data/lib/sidekiq_unique_jobs/lua/shared/_current_time.lua +8 -0
  47. data/lib/sidekiq_unique_jobs/lua/shared/_delete_from_queue.lua +22 -0
  48. data/lib/sidekiq_unique_jobs/lua/shared/_delete_from_sorted_set.lua +18 -0
  49. data/lib/sidekiq_unique_jobs/lua/shared/_find_digest_in_process_set.lua +53 -0
  50. data/lib/sidekiq_unique_jobs/lua/shared/_find_digest_in_queues.lua +43 -0
  51. data/lib/sidekiq_unique_jobs/lua/shared/_find_digest_in_sorted_set.lua +24 -0
  52. data/lib/sidekiq_unique_jobs/lua/shared/_hgetall.lua +13 -0
  53. data/lib/sidekiq_unique_jobs/lua/shared/_upgrades.lua +3 -0
  54. data/lib/sidekiq_unique_jobs/lua/unlock.lua +102 -0
  55. data/lib/sidekiq_unique_jobs/lua/update_version.lua +40 -0
  56. data/lib/sidekiq_unique_jobs/lua/upgrade.lua +68 -0
  57. data/lib/sidekiq_unique_jobs/middleware/client.rb +40 -0
  58. data/lib/sidekiq_unique_jobs/middleware/server.rb +29 -0
  59. data/lib/sidekiq_unique_jobs/middleware.rb +29 -31
  60. data/lib/sidekiq_unique_jobs/normalizer.rb +4 -4
  61. data/lib/sidekiq_unique_jobs/on_conflict/log.rb +9 -5
  62. data/lib/sidekiq_unique_jobs/on_conflict/null_strategy.rb +1 -1
  63. data/lib/sidekiq_unique_jobs/on_conflict/raise.rb +1 -1
  64. data/lib/sidekiq_unique_jobs/on_conflict/reject.rb +61 -15
  65. data/lib/sidekiq_unique_jobs/on_conflict/replace.rb +54 -14
  66. data/lib/sidekiq_unique_jobs/on_conflict/reschedule.rb +16 -5
  67. data/lib/sidekiq_unique_jobs/on_conflict/strategy.rb +25 -6
  68. data/lib/sidekiq_unique_jobs/on_conflict.rb +23 -10
  69. data/lib/sidekiq_unique_jobs/options_with_fallback.rb +35 -32
  70. data/lib/sidekiq_unique_jobs/orphans/lua_reaper.rb +29 -0
  71. data/lib/sidekiq_unique_jobs/orphans/manager.rb +248 -0
  72. data/lib/sidekiq_unique_jobs/orphans/null_reaper.rb +24 -0
  73. data/lib/sidekiq_unique_jobs/orphans/observer.rb +42 -0
  74. data/lib/sidekiq_unique_jobs/orphans/reaper.rb +114 -0
  75. data/lib/sidekiq_unique_jobs/orphans/reaper_resurrector.rb +170 -0
  76. data/lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb +231 -0
  77. data/lib/sidekiq_unique_jobs/redis/entity.rb +112 -0
  78. data/lib/sidekiq_unique_jobs/redis/hash.rb +56 -0
  79. data/lib/sidekiq_unique_jobs/redis/list.rb +32 -0
  80. data/lib/sidekiq_unique_jobs/redis/set.rb +32 -0
  81. data/lib/sidekiq_unique_jobs/redis/sorted_set.rb +86 -0
  82. data/lib/sidekiq_unique_jobs/redis/string.rb +49 -0
  83. data/lib/sidekiq_unique_jobs/redis.rb +11 -0
  84. data/lib/sidekiq_unique_jobs/reflectable.rb +26 -0
  85. data/lib/sidekiq_unique_jobs/reflections.rb +79 -0
  86. data/lib/sidekiq_unique_jobs/rspec/matchers/have_valid_sidekiq_options.rb +51 -0
  87. data/lib/sidekiq_unique_jobs/rspec/matchers.rb +26 -0
  88. data/lib/sidekiq_unique_jobs/script/caller.rb +127 -0
  89. data/lib/sidekiq_unique_jobs/script.rb +15 -0
  90. data/lib/sidekiq_unique_jobs/server.rb +61 -0
  91. data/lib/sidekiq_unique_jobs/sidekiq_unique_ext.rb +114 -65
  92. data/lib/sidekiq_unique_jobs/sidekiq_unique_jobs.rb +241 -35
  93. data/lib/sidekiq_unique_jobs/sidekiq_worker_methods.rb +18 -16
  94. data/lib/sidekiq_unique_jobs/testing.rb +62 -21
  95. data/lib/sidekiq_unique_jobs/timer_task.rb +78 -0
  96. data/lib/sidekiq_unique_jobs/timing.rb +58 -0
  97. data/lib/sidekiq_unique_jobs/unlockable.rb +20 -4
  98. data/lib/sidekiq_unique_jobs/update_version.rb +25 -0
  99. data/lib/sidekiq_unique_jobs/upgrade_locks.rb +155 -0
  100. data/lib/sidekiq_unique_jobs/version.rb +3 -1
  101. data/lib/sidekiq_unique_jobs/version_check.rb +23 -4
  102. data/lib/sidekiq_unique_jobs/web/helpers.rb +128 -13
  103. data/lib/sidekiq_unique_jobs/web/views/_paging.erb +4 -4
  104. data/lib/sidekiq_unique_jobs/web/views/changelogs.erb +54 -0
  105. data/lib/sidekiq_unique_jobs/web/views/lock.erb +108 -0
  106. data/lib/sidekiq_unique_jobs/web/views/locks.erb +54 -0
  107. data/lib/sidekiq_unique_jobs/web.rb +57 -27
  108. data/lib/sidekiq_unique_jobs.rb +52 -7
  109. data/lib/tasks/changelog.rake +15 -15
  110. metadata +124 -184
  111. data/lib/sidekiq_unique_jobs/client/middleware.rb +0 -56
  112. data/lib/sidekiq_unique_jobs/scripts.rb +0 -118
  113. data/lib/sidekiq_unique_jobs/server/middleware.rb +0 -46
  114. data/lib/sidekiq_unique_jobs/timeout/calculator.rb +0 -63
  115. data/lib/sidekiq_unique_jobs/timeout.rb +0 -8
  116. data/lib/sidekiq_unique_jobs/unique_args.rb +0 -150
  117. data/lib/sidekiq_unique_jobs/util.rb +0 -103
  118. data/lib/sidekiq_unique_jobs/web/views/unique_digest.erb +0 -28
  119. data/lib/sidekiq_unique_jobs/web/views/unique_digests.erb +0 -46
  120. data/redis/acquire_lock.lua +0 -21
  121. data/redis/convert_legacy_lock.lua +0 -13
  122. data/redis/delete.lua +0 -14
  123. data/redis/delete_by_digest.lua +0 -23
  124. data/redis/delete_job_by_digest.lua +0 -60
  125. data/redis/lock.lua +0 -62
  126. data/redis/release_stale_locks.lua +0 -90
  127. data/redis/unlock.lua +0 -35
@@ -1,23 +0,0 @@
1
- -- redis.replicate_commands();
2
- local unique_keys = KEYS[1]
3
- local unique_digest = KEYS[2]
4
- local exists_key = KEYS[3]
5
- local grabbed_key = KEYS[4]
6
- local available_key = KEYS[5]
7
- local version_key = KEYS[6]
8
- local run_exists_key = KEYS[7]
9
- local run_grabbed_key = KEYS[8]
10
- local run_available_key = KEYS[9]
11
- local run_version_key = KEYS[10]
12
-
13
- local count = redis.call('SREM', unique_keys, unique_digest)
14
- redis.call('DEL', exists_key)
15
- redis.call('DEL', grabbed_key)
16
- redis.call('DEL', available_key)
17
- redis.call('DEL', version_key)
18
- redis.call('DEL', run_exists_key)
19
- redis.call('DEL', run_grabbed_key)
20
- redis.call('DEL', run_available_key)
21
- redis.call('DEL', run_version_key)
22
-
23
- return count
@@ -1,60 +0,0 @@
1
- local queue = KEYS[1]
2
- local schedule_set = KEYS[2]
3
- local retry_set = KEYS[3]
4
- local unique_digest = ARGV[1]
5
-
6
- local function delete_from_sorted_set(name, digest)
7
- local per = 50
8
- local total = redis.call('zcard', name)
9
- local index = 0
10
- local result
11
- -- redis.log(redis.LOG_DEBUG, "delete_from_sorted_set("..name..","..digest..")")
12
- while (index < total) do
13
- -- redis.log(redis.LOG_DEBUG, "delete_from_sorted_set("..name..","..digest..") - "..index.."-"..per)
14
- local items = redis.call('ZRANGE', name, index, index + per -1)
15
- for _, item in pairs(items) do
16
- -- redis.log(redis.LOG_DEBUG, "delete_from_sorted_set("..name..","..digest..") - current item: " .. item)
17
- if string.find(item, digest) then
18
- -- redis.log(redis.LOG_DEBUG, "delete_from_sorted_set("..name..","..digest..") - deleting item")
19
- redis.call('ZREM', name, item)
20
- result = item
21
- break
22
- end
23
- end
24
- index = index + per
25
- end
26
- return result
27
- end
28
-
29
- local per = 50
30
- local total = redis.call('LLEN', queue)
31
- local index = 0
32
- local result = nil
33
-
34
- -- redis.log(redis.LOG_DEBUG, "delete_job_by_digest.lua - looping through: " .. queue)
35
- while (index < total) do
36
- -- redis.log(redis.LOG_DEBUG, "delete_job_by_digest.lua - " .. index .. "-" .. per)
37
- local items = redis.call('LRANGE', queue, index, index + per -1)
38
- for _, item in pairs(items) do
39
- -- redis.log(redis.LOG_DEBUG, "delete_job_by_digest.lua - item: " .. item)
40
- if string.find(item, unique_digest) then
41
- -- redis.log(redis.LOG_DEBUG, "delete_job_by_digest.lua - found item with digest: " .. unique_digest .. " in: " ..queue)
42
- redis.call('LREM', queue, 1, item)
43
- result = item
44
- break
45
- end
46
- end
47
- index = index + per
48
- end
49
-
50
- if result then
51
- return result
52
- end
53
-
54
- result = delete_from_sorted_set(schedule_set, unique_digest)
55
- if result then
56
- return result
57
- end
58
-
59
- result = delete_from_sorted_set(retry_set, unique_digest)
60
- return result
data/redis/lock.lua DELETED
@@ -1,62 +0,0 @@
1
- -- redis.replicate_commands();
2
-
3
- local exists_key = KEYS[1]
4
- local grabbed_key = KEYS[2]
5
- local available_key = KEYS[3]
6
- local unique_keys = KEYS[4]
7
- local unique_digest = KEYS[5]
8
-
9
- local job_id = ARGV[1]
10
- local ttl = tonumber(ARGV[2])
11
- local lock = ARGV[3]
12
-
13
- local function current_time()
14
- local time = redis.call('time')
15
- local s = time[1]
16
- local ms = time[2]
17
- local number = tonumber((s .. '.' .. ms))
18
-
19
- return number
20
- end
21
-
22
- local stored_token = redis.call('GET', exists_key)
23
- if stored_token and stored_token ~= job_id then
24
- return stored_token
25
- end
26
-
27
- redis.call('SET', exists_key, job_id)
28
-
29
- ----------------------------------------------------------------
30
- -- TODO: Legacy support (Remove in v6.1)
31
- local old_token = redis.call('GET', unique_digest)
32
- if old_token then
33
- if old_token == job_id or old_token == '2' then
34
- -- No need to return, we just delete the old key
35
- redis.call('DEL', unique_digest)
36
- else
37
- return old_token
38
- end
39
- end
40
- ----------------------------------------------------------------
41
-
42
- redis.call('SADD', unique_keys, unique_digest)
43
- redis.call('DEL', grabbed_key)
44
- -- TODO: Move this to LUA when redis 3.2 is the least supported
45
- -- redis.call('HSET', grabbed_key, job_id, current_time())
46
- ---------------------------------------------------------------
47
- redis.call('DEL', available_key)
48
- redis.call('RPUSH', available_key, job_id)
49
-
50
- -- The client should only set ttl for until_expired
51
- -- The server should set ttl for all other jobs
52
- -- redis.log(redis.LOG_WARNING, "lock: " .. lock .. ", ttl: " .. tostring(ttl))
53
- if lock == "until_expired" and ttl and ttl > 0 then
54
- -- We can't keep the key here because it will otherwise never be deleted
55
- redis.call('SREM', unique_keys, unique_digest)
56
-
57
- redis.call('EXPIRE', available_key, ttl)
58
- redis.call('EXPIRE', exists_key, ttl)
59
- redis.call('EXPIRE', unique_digest, ttl)
60
- end
61
-
62
- return job_id
@@ -1,90 +0,0 @@
1
- redis.replicate_commands();
2
-
3
- local exists_key = KEYS[1]
4
- local grabbed_key = KEYS[2]
5
- local available_key = KEYS[3]
6
- local release_key = KEYS[4]
7
- local version_key = KEYS[5]
8
-
9
- local expires_in = tonumber(ARGV[1])
10
- local stale_client_timeout = tonumber(ARGV[2])
11
- local expiration = tonumber(ARGV[3])
12
-
13
- local function current_time()
14
- local time = redis.call('time')
15
- local s = time[1]
16
- local ms = time[2]
17
- local number = tonumber((s .. '.' .. ms))
18
-
19
- return number
20
- end
21
-
22
- local hgetall = function (key)
23
- local bulk = redis.call('HGETALL', key)
24
- local result = {}
25
- local nextkey
26
- for i, v in ipairs(bulk) do
27
- if i % 2 == 1 then
28
- nextkey = v
29
- else
30
- result[nextkey] = v
31
- end
32
- end
33
- return result
34
- end
35
-
36
- local cached_current_time = current_time()
37
- redis.log(redis.LOG_DEBUG, "release_stale_locks.lua - started at : " .. cached_current_time)
38
-
39
- local my_lock_expires_at = cached_current_time + expires_in + 1
40
- redis.log(redis.LOG_DEBUG, "release_stale_locks.lua - my_lock_expires_at: " .. my_lock_expires_at)
41
-
42
- if not redis.call('SETNX', release_key, my_lock_expires_at) then
43
- -- Check if expired
44
- local other_lock_expires_at = tonumber(redis.call('GET', release_key))
45
- redis.log(redis.LOG_DEBUG, "release_stale_locks.lua - other_lock_expires_at: " .. other_lock_expires_at)
46
-
47
- if other_lock_expires_at < cached_current_time then
48
- local old_expires_at = tonumber(redis.call('GETSET', release_key, my_lock_expires_at))
49
- redis.log(redis.LOG_DEBUG, "release_stale_locks.lua - old_expires_at: " .. old_expires_at)
50
-
51
- -- Check if another client started cleanup yet. If not,
52
- -- then we now have the lock.
53
- if not old_expires_at == other_lock_expires_at then
54
- redis.log(redis.LOG_DEBUG, "release_stale_locks.lua -could not retrieve lock: exiting 0")
55
- return 0
56
- end
57
- end
58
- end
59
-
60
- local keys = hgetall(grabbed_key)
61
- for key, locked_at in pairs(keys) do
62
- local timed_out_at = tonumber(locked_at) + stale_client_timeout
63
- redis.log(redis.LOG_DEBUG,
64
- "release_stale_locks.lua - processing: " .. grabbed_key .. " key: " .. key .. " locked_at: " .. locked_at
65
- )
66
-
67
- if timed_out_at < current_time() then
68
- redis.log(redis.LOG_DEBUG, "HDEL " .. grabbed_key .. ":" .. key)
69
- redis.call('HDEL', grabbed_key, key)
70
- redis.log(redis.LOG_DEBUG, "LPUSH " .. available_key .. ":" .. key)
71
- redis.call('LPUSH', available_key, key)
72
-
73
- if expiration then
74
- redis.log(redis.LOG_DEBUG, "release_stale_locks.lua - EXPIRE " .. available_key .. " with " .. expiration)
75
- redis.call('EXPIRE', available_key, expiration)
76
- redis.log(redis.LOG_DEBUG, "release_stale_locks.lua - EXPIRE " .. exists_key .. " with " .. expiration)
77
- redis.call('EXPIRE', exists_key, expiration)
78
- end
79
- end
80
- end
81
-
82
- -- Make sure not to delete the lock in case someone else already expired
83
- -- our lock, with one second in between to account for some lag.
84
- if my_lock_expires_at > (current_time() - 1) then
85
- redis.log(redis.LOG_DEBUG, "release_stale_locks.lua - DEL " .. release_key)
86
- redis.call('DEL', release_key)
87
- end
88
-
89
- redis.log(redis.LOG_DEBUG, "release_stale_locks.lua - comleted at : " .. current_time())
90
- return 1
data/redis/unlock.lua DELETED
@@ -1,35 +0,0 @@
1
- local exists_key = KEYS[1]
2
- local grabbed_key = KEYS[2]
3
- local available_key = KEYS[3]
4
- local version_key = KEYS[4]
5
- local unique_keys = KEYS[5]
6
- local unique_digest = KEYS[6] -- TODO: Legacy support (Remove in v6.1)
7
-
8
- local token = ARGV[1]
9
- local ttl = tonumber(ARGV[2])
10
- local lock = ARGV[3]
11
-
12
- redis.call('SREM', unique_keys, unique_digest)
13
-
14
- if ttl then
15
- redis.call('SREM', unique_keys, unique_digest)
16
- redis.call('EXPIRE', exists_key, ttl)
17
- redis.call('EXPIRE', grabbed_key, ttl)
18
- redis.call('EXPIRE', available_key, ttl)
19
- redis.call('EXPIRE', version_key, ttl) -- TODO: Legacy support (Remove in v6.1)
20
- redis.call('EXPIRE', unique_digest, ttl) -- TODO: Legacy support (Remove in v6.1)
21
- else
22
- redis.call('DEL', exists_key)
23
- redis.call('SREM', unique_keys, unique_digest)
24
- redis.call('DEL', grabbed_key)
25
- redis.call('DEL', available_key)
26
- redis.call('DEL', version_key) -- TODO: Legacy support (Remove in v6.1)
27
- redis.call('DEL', 'uniquejobs') -- TODO: Old job hash, just drop the darn thing (Remove in v6.1)
28
- redis.call('DEL', unique_digest) -- TODO: Legacy support (Remove in v6.1)
29
- end
30
-
31
- redis.call('HDEL', grabbed_key, token)
32
- local count = redis.call('LPUSH', available_key, token)
33
- redis.call('EXPIRE', available_key, 5)
34
- return count
35
-