sidekiq-unique-jobs 6.0.25 → 7.0.0.beta2

data/lib/sidekiq_unique_jobs/lua/lock.lua

@@ -0,0 +1,91 @@
+-------- BEGIN keys ---------
+local digest    = KEYS[1]
+local queued    = KEYS[2]
+local primed    = KEYS[3]
+local locked    = KEYS[4]
+local info      = KEYS[5]
+local changelog = KEYS[6]
+local digests   = KEYS[7]
+-------- END keys ---------
+
+-------- BEGIN lock arguments ---------
+local job_id       = ARGV[1]
+local pttl         = tonumber(ARGV[2])
+local lock_type    = ARGV[3]
+local limit        = tonumber(ARGV[4])
+-------- END lock arguments -----------
+
+--------  BEGIN injected arguments --------
+local current_time = tonumber(ARGV[5])
+local debug_lua    = ARGV[6] == "true"
+local max_history  = tonumber(ARGV[7])
+local script_name  = tostring(ARGV[8]) .. ".lua"
+local redisversion = ARGV[9]
+---------  END injected arguments ---------
+
+--------  BEGIN local functions --------
+<%= include_partial "shared/_common.lua" %>
+----------  END local functions ----------
+
+
+---------  BEGIN lock.lua ---------
+log_debug("BEGIN lock digest:", digest, "job_id:", job_id)
+
+if redis.call("HEXISTS", locked, job_id) == 1 then
+  log_debug(locked, "already locked with job_id:", job_id)
+  log("Duplicate")
+
+  log_debug("LREM", queued, -1, job_id)
+  redis.call("LREM", queued, -1, job_id)
+
+  log_debug("LREM", primed, 1, job_id)
+  redis.call("LREM", primed, 1, job_id)
+
+  return job_id
+end
+
+local locked_count   = redis.call("HLEN", locked)
+local within_limit   = limit > locked_count
+local limit_exceeded = not within_limit
+
+if limit_exceeded then
+  log_debug("Limit exceeded:", digest, "(",  locked_count, "of", limit, ")")
+  log("Limited")
+  return nil
+end
+
+log_debug("ZADD", digests, current_time, digest)
+redis.call("ZADD", digests, current_time, digest)
+
+log_debug("HSET", locked, job_id, current_time)
+redis.call("HSET", locked, job_id, current_time)
+
+log_debug("LREM", queued, -1, job_id)
+redis.call("LREM", queued, -1, job_id)
+
+log_debug("LREM", primed, 1, job_id)
+redis.call("LREM", primed, 1, job_id)
+
+-- The Sidekiq client should only set pttl for until_expired
+-- The Sidekiq server should set pttl for all other jobs
+if lock_type == "until_expired" and pttl and pttl > 0 then
+  log_debug("PEXPIRE", digest, pttl)
+  redis.call("PEXPIRE", digest, pttl)
+
+  log_debug("PEXPIRE", queued, pttl)
+  redis.call("PEXPIRE", queued, pttl)
+
+  log_debug("PEXPIRE", primed, pttl)
+  redis.call("PEXPIRE", primed, pttl)
+
+  log_debug("PEXPIRE", locked, pttl)
+  redis.call("PEXPIRE", locked, pttl)
+
+  log_debug("PEXPIRE", info, pttl)
+  redis.call("PEXPIRE", info, pttl)
+end
+
+log("Locked")
+log_debug("END lock digest:", digest, "job_id:", job_id)
+return job_id
+----------  END lock.lua  ----------

data/lib/sidekiq_unique_jobs/lua/locked.lua

@@ -0,0 +1,35 @@
+-------- BEGIN keys ---------
+local digest    = KEYS[1]
+local queued    = KEYS[2]
+local primed    = KEYS[3]
+local locked    = KEYS[4]
+local info      = KEYS[5]
+local changelog = KEYS[6]
+local digests   = KEYS[7]
+-------- END keys ---------
+
+-------- BEGIN lock arguments ---------
+local job_id = ARGV[1]
+-------- END lock arguments -----------
+
+--------  BEGIN injected arguments --------
+local current_time = tonumber(ARGV[2])
+local debug_lua    = ARGV[3] == "true"
+local max_history  = tonumber(ARGV[4])
+local script_name  = tostring(ARGV[5]) .. ".lua"
+---------  END injected arguments ---------
+
+--------  BEGIN local functions --------
+<%= include_partial "shared/_common.lua" %>
+---------  END local functions ---------
+
+
+--------  BEGIN locked.lua --------
+if redis.call("HEXISTS", locked, job_id) == 1 then
+  log_debug("Locked", digest, "job_id:", job_id)
+  return 1
+else
+  log_debug("NOT Locked", digest, "job_id:", job_id)
+  return -1
+end
+---------  END locked.lua ---------

data/lib/sidekiq_unique_jobs/lua/queue.lua

@@ -0,0 +1,83 @@
+-------- BEGIN keys ---------
+local digest    = KEYS[1]
+local queued    = KEYS[2]
+local primed    = KEYS[3]
+local locked    = KEYS[4]
+local info      = KEYS[5]
+local changelog = KEYS[6]
+local digests   = KEYS[7]
+-------- END keys ---------
+
+-------- BEGIN lock arguments ---------
+local job_id       = ARGV[1]      -- The job_id that was previously primed
+local pttl         = tonumber(ARGV[2])
+local lock_type    = ARGV[3]
+local limit        = tonumber(ARGV[4])
+-------- END lock arguments -----------
+
+--------  BEGIN injected arguments --------
+local current_time = tonumber(ARGV[5])
+local debug_lua    = ARGV[6] == "true"
+local max_history  = tonumber(ARGV[7])
+local script_name  = tostring(ARGV[8]) .. ".lua"
+---------  END injected arguments ---------
+
+--------  BEGIN Variables --------
+local queued_count = redis.call("LLEN", queued)
+local locked_count = redis.call("HLEN", locked)
+local within_limit = limit > locked_count
+local limit_exceeded = not within_limit
+--------   END Variables  --------
+
+--------  BEGIN local functions --------
+<%= include_partial "shared/_common.lua" %>
+----------  END local functions ----------
+
+
+--------  BEGIN queue.lua --------
+log_debug("BEGIN queue with key:", digest, "for job:", job_id)
+
+if redis.call("HEXISTS", locked, job_id) == 1 then
+  log_debug("HEXISTS", locked, job_id, "== 1")
+  log("Duplicate")
+  return job_id
+end
+
+local prev_jid = redis.call("GET", digest)
+log_debug("job_id:", job_id, "prev_jid:", prev_jid)
+if not prev_jid or prev_jid == false then
+  log_debug("SET", digest, job_id)
+  redis.call("SET", digest, job_id)
+elseif prev_jid == job_id then
+  log_debug(digest, "already queued with job_id:", job_id)
+  log("Duplicate")
+  return job_id
+else
+  -- TODO: Consider constraining the total count of both locked and queued?
+  if within_limit and queued_count < limit then
+    log_debug("Within limit:", digest, "(",  locked_count, "of", limit, ")", "queued (", queued_count, "of", limit, ")")
+    log_debug("SET", digest, job_id, "(was", prev_jid, ")")
+    redis.call("SET", digest, job_id)
+  else
+    log_debug("Limit exceeded:", digest, "(",  locked_count, "of", limit, ")")
+    log("Limit exceeded", prev_jid)
+    return prev_jid
+  end
+end
+
+log_debug("LPUSH", queued, job_id)
+redis.call("LPUSH", queued, job_id)
+
+-- The Sidekiq client should only set pttl for until_expired
+-- The Sidekiq server should set pttl for all other jobs
+if lock_type == "until_expired" and pttl > 0 then
+  log_debug("PEXPIRE", digest, pttl)
+  redis.call("PEXPIRE", digest, pttl)
+  log_debug("PEXPIRE", queued, pttl)
+  redis.call("PEXPIRE", queued, pttl)
+end
+
+log("Queued")
+log_debug("END queue with key:", digest, "for job:", job_id)
+return job_id
+--------  END queue.lua --------

data/lib/sidekiq_unique_jobs/lua/reap_orphans.lua

@@ -0,0 +1,86 @@
+redis.replicate_commands()
+
+-------- BEGIN keys ---------
+local digests_set  = KEYS[1]
+local schedule_set = KEYS[2]
+local retry_set    = KEYS[3]
+--------  END keys  ---------
+
+-------- BEGIN argv ---------
+local reaper_count  = tonumber(ARGV[1])
+--------  END argv  ---------
+
+--------  BEGIN injected arguments --------
+local current_time = tonumber(ARGV[2])
+local debug_lua    = ARGV[3] == "true"
+local max_history  = tonumber(ARGV[4])
+local script_name  = ARGV[5] .. ".lua"
+local redisversion = ARGV[6]
+---------  END injected arguments ---------
+
+
+--------  BEGIN local functions --------
+<%= include_partial "shared/_common.lua" %>
+<%= include_partial "shared/_find_digest_in_queues.lua" %>
+<%= include_partial "shared/_find_digest_in_sorted_set.lua" %>
+----------  END local functions ----------
+
+
+--------  BEGIN delete_orphaned.lua --------
+log_debug("BEGIN")
+local found     = false
+local per       = 50
+local total     = redis.call("ZCARD", digests_set)
+local index     = 0
+local del_count = 0
+local redis_ver = toversion(redisversion)
+local del_cmd   = "DEL"
+
+if tonumber(redis_ver["major"]) >= 4 then del_cmd = "UNLINK"; end
+
+repeat
+  log_debug("Interating through:", digests_set, "for orphaned locks")
+  local digests  = redis.call("ZREVRANGE", digests_set, index, index + per -1)
+
+  for _, digest in pairs(digests) do
+    log_debug("Searching for digest:", digest, "in", schedule_set)
+    found = find_digest_in_sorted_set(schedule_set, digest)
+
+    if found ~= true then
+      log_debug("Searching for digest:", digest, "in", retry_set)
+      found = find_digest_in_sorted_set(retry_set, digest)
+    end
+
+    if found ~= true then
+      log_debug("Searching for digest:", digest, "in all queues")
+      local queue = find_digest_in_queues(digest)
+
+      if queue then
+        log_debug("found digest:", digest, "in queue:", queue)
+        found = true
+      end
+    end
+
+    if found ~= true then
+      local queued     = digest .. ":QUEUED"
+      local primed     = digest .. ":PRIMED"
+      local locked     = digest .. ":LOCKED"
+      local info       = digest .. ":INFO"
+      local run_digest = digest .. ":RUN"
+      local run_queued = digest .. ":RUN:QUEUED"
+      local run_primed = digest .. ":RUN:PRIMED"
+      local run_locked = digest .. ":RUN:LOCKED"
+      local run_info   = digest .. ":RUN:INFO"
+
+      redis.call(del_cmd, digest, queued, primed, locked, info, run_digest, run_queued, run_primed, run_locked, run_info)
+
+      redis.call("ZREM", digests_set, digest)
+      del_count = del_count + 1
+    end
+  end
+
+  index = index + per
+until index >= total or del_count >= reaper_count
+
+log_debug("END")
+return del_count

data/lib/sidekiq_unique_jobs/lua/shared/_common.lua

@@ -0,0 +1,40 @@
+local function toversion(version)
+  local _, _, maj, min, pat = string.find(version, "(%d+)%.(%d+)%.(%d+)")
+
+  return {
+    ["version"] = version,
+    ["major"]   = tonumber(maj),
+    ["minor"]   = tonumber(min),
+    ["patch"]   = tonumber(pat)
+  }
+end
+
+local function toboolean(val)
+  val = tostring(val)
+  return val == "1" or val == "true"
+end
+
+local function log_debug( ... )
+  if debug_lua ~= true then return end
+
+  local result = ""
+  for _,v in ipairs(arg) do
+    result = result .. " " .. tostring(v)
+  end
+  redis.log(redis.LOG_DEBUG, script_name .. " -" ..  result)
+end
+
+local function log(message, prev_jid)
+  if not max_history or max_history == 0 then return end
+  local entry = cjson.encode({digest = digest, job_id = job_id, script = script_name, message = message, time = current_time, prev_jid = prev_jid })
+
+  log_debug("ZADD", changelog, current_time, entry);
+  redis.call("ZADD", changelog, current_time, entry);
+  local total_entries = redis.call("ZCARD", changelog)
+  local removed_entries = redis.call("ZREMRANGEBYRANK", changelog, max_history, -1)
+  if removed_entries > 0 then
+    log_debug("Removing", removed_entries , "entries from changelog (total entries", total_entries, "exceeds max_history:", max_history ..")");
+  end
+  log_debug("PUBLISH", changelog, entry);
+  redis.call("PUBLISH", changelog, entry);
+end

data/lib/sidekiq_unique_jobs/lua/shared/_current_time.lua

@@ -0,0 +1,8 @@
+local function current_time()
+  local time = redis.call("time")
+  local s = time[1]
+  local ms = time[2]
+  local number = tonumber((s .. "." .. ms))
+
+  return number
+end

data/lib/sidekiq_unique_jobs/lua/shared/_delete_from_queue.lua

@@ -0,0 +1,19 @@
+local function delete_from_queue(queue, digest)
+  local per    = 50
+  local total  = redis.call("LLEN", queue)
+  local index  = 0
+  local result = nil
+
+  while (index < total) do
+    local items = redis.call("LRANGE", queue, index, index + per -1)
+    for _, item in pairs(items) do
+      if string.find(item, digest) then
+        redis.call("LREM", queue, 1, item)
+        result = item
+        break
+      end
+    end
+    index = index + per
+  end
+  return result
+end

data/lib/sidekiq_unique_jobs/lua/shared/_delete_from_sorted_set.lua

@@ -0,0 +1,18 @@
+local function delete_from_sorted_set(name, digest)
+  local per   = 50
+  local total = redis.call("zcard", name)
+  local index = 0
+  local result
+  while (index < total) do
+    local items = redis.call("ZRANGE", name, index, index + per -1)
+    for _, item in pairs(items) do
+      if string.find(item, digest) then
+        redis.call("ZREM", name, item)
+        result = item
+        break
+      end
+    end
+    index = index + per
+  end
+  return result
+end

data/lib/sidekiq_unique_jobs/lua/shared/_find_digest_in_queues.lua

@@ -0,0 +1,46 @@
+local function find_digest_in_queues(digest)
+  local cursor = "0"
+  local count  = 50
+  local result = nil
+  local found  = false
+
+  repeat
+    log_debug("searching all queues for a matching digest:", digest)
+    local pagination  = redis.call("SCAN", cursor, "MATCH", "*queue:*", "COUNT", count)
+    local next_cursor = pagination[1]
+    local queues      = pagination[2]
+
+    for _, queue in ipairs(queues) do
+      local per    = 50
+      local total  = redis.call("LLEN", queue)
+      local index  = 0
+
+      log_debug("searching in:", queue,
+                "for digest:", digest,
+                "from:", index,
+                "to:", total,
+                "(per: " .. per .. ")",
+                "cursor:", cursor)
+
+      while (index < total) do
+        local items = redis.call("LRANGE", queue, index, index + per -1)
+        for _, item in pairs(items) do
+          if string.find(item, digest) then
+            log_debug("Found digest:", digest, "in queue:", queue)
+            result = cjson.decode(item).queue
+            found = true
+            break
+          end
+        end
+        index = index + per
+      end
+
+      cursor = next_cursor
+      if cursor == "0" then
+        log_debug("Looped through all queues, stopping iteration")
+      end
+    end
+  until found == true or cursor == "0"
+
+  return result
+end

data/lib/sidekiq_unique_jobs/lua/shared/_find_digest_in_sorted_set.lua

@@ -0,0 +1,24 @@
+local function find_digest_in_sorted_set(name, digest)
+  local cursor  = 0
+  local count   = 5
+  local pattern = "*" .. digest .. "*"
+  local found   = false
+
+  log_debug("searching in:", name,
+            "for digest:", digest,
+            "cursor:", cursor)
+  repeat
+    local pagination  = redis.call("ZSCAN", name, cursor, "MATCH", pattern, "COUNT", count)
+    local next_cursor = pagination[1]
+    local items       = pagination[2]
+
+    if #items > 0 then
+      log_debug("Found digest", digest, "in zset:", name)
+      found = true
+    end
+
+    cursor = next_cursor
+  until found == true or cursor == "0"
+
+  return found
+end