Module: SidekiqUniqueJobs::Script::Caller

Included in:
Locksmith, OnConflict::Strategy, Orphans::Reaper, Redis::Entity
Defined in:
lib/sidekiq_unique_jobs/script/caller.rb

Overview

Module Caller provides the convenience method #call_script

Author:

Class Method Summary collapse

Class Method Details

.call_script(file_name, keys, argv, conn) ⇒ true, ... .call_script(file_name, conn, keys: , argv: ) ⇒ true, ...

Convenience method to reduce typing,

calls redis lua scripts.

Overloads:

  • .call_script(file_name, keys, argv, conn) ⇒ true, ...

    Call script without options hash

    Parameters:

    • file_name (Symbol) —

      the name of the file

    • keys (Array<String>) —

      to pass to the the script

    • argv (Array<String>) —

      arguments to pass to the script

    • conn (Redis) —

      a redis connection

  • .call_script(file_name, conn, keys: , argv: ) ⇒ true, ...

    Call script with options hash

    Parameters:

    • file_name (Symbol) —

      the name of the file

    • conn (Redis) —

      a redis connection

    • options (Hash) —

      arguments to pass to the script file

Returns:

  • (true, false, String, Integer, Float, nil) —

    returns the return value of the lua script



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/sidekiq_unique_jobs/script/caller.rb', line 41

def call_script(file_name, *args)
  conn, keys, argv = extract_args(*args)
  return do_call(file_name, conn, keys, argv) if conn

  pool = defined?(redis_pool) ? redis_pool : nil

  redis(pool) do |new_conn|
    result = do_call(file_name, new_conn, keys, argv)
    yield result if block_given?
    result
  end
end

.debug_lua ⇒ Object

See Also:

  • Config#debug_lua


108
109
110
 
# File 'lib/sidekiq_unique_jobs/script/caller.rb', line 108

def debug_lua
  SidekiqUniqueJobs.config.debug_lua
end

.do_call(file_name, conn, keys, argv) ⇒ Object

Only used to reduce a little bit of duplication

See Also:



56
57
58
59
60
61
62
63
64
65
 
# File 'lib/sidekiq_unique_jobs/script/caller.rb', line 56

def do_call(file_name, conn, keys, argv)
  argv = argv.dup.concat([
                           now_f,
                           debug_lua,
                           max_history,
                           file_name,
                           redis_version,
                         ])
  Script.execute(file_name, conn, keys: keys, argv: argv)
end

.call_script(file_name, keys, argv, conn) ⇒ Array<Redis, Array, Array> .call_script(file_name, conn, keys: , argv: ) ⇒ Array<Redis, Array, Array>

Utility method to allow both symbol keys and arguments

Overloads:

  • .call_script(file_name, keys, argv, conn) ⇒ Array<Redis, Array, Array>

    Call script without options hash

    Parameters:

    • file_name (Symbol) —

      the name of the file

    • keys (Array<String>) —

      to pass to the the script

    • argv (Array<String>) —

      arguments to pass to the script

    • conn (Redis) —

      a redis connection

  • .call_script(file_name, conn, keys: , argv: ) ⇒ Array<Redis, Array, Array>

    Call script with options hash

    Parameters:

    • file_name (Symbol) —

      the name of the file

    • conn (Redis) —

      a redis connection

    • options (Hash) —

      arguments to pass to the script file

Returns:



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/sidekiq_unique_jobs/script/caller.rb', line 86

def extract_args(*args)
  options = args.extract_options!
  if options.length.positive?
    [args.pop, options.fetch(:keys) { [] }, options.fetch(:argv) { [] }]
  else
    keys, argv = args.shift(2)
    keys ||= []
    argv ||= []
    [args.pop, keys, argv]
  end
end

.max_history ⇒ Object

See Also:

  • Config#max_history


115
116
117
 
# File 'lib/sidekiq_unique_jobs/script/caller.rb', line 115

def max_history
  SidekiqUniqueJobs.config.max_history
end

.now_f ⇒ Object

See Also:

  • SidekiqUniqueJobs#now_f


101
102
103
 
# File 'lib/sidekiq_unique_jobs/script/caller.rb', line 101

def now_f
  SidekiqUniqueJobs.now_f
end

.redis_version ⇒ Object

See Also:

  • Config#max_history


122
123
124
 
# File 'lib/sidekiq_unique_jobs/script/caller.rb', line 122

def redis_version
  SidekiqUniqueJobs.config.redis_version
end