Class: Faktory::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/faktory/client.rb,
lib/faktory/testing.rb

Overview

Faktory::Client provides a low-level connection to a Faktory server and APIs which map to Faktory commands.

Most APIs will return ‘true` if the operation succeeded or raise a Faktory::BaseError if there was an unexpected error.

Constant Summary collapse

DEFAULT_TIMEOUT = 
5.0
HASHER = 
proc do |iter, pwd, salt|
  sha = Digest::SHA256.new
  hashing = pwd + salt
  iter.times do
    hashing = sha.digest(hashing)
  end
  Digest.hexencode(hashing)
end
@@random_process_wid = 
""

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(url: uri_from_env || 'tcp://localhost:7419', debug: false, timeout: DEFAULT_TIMEOUT) ⇒ Client

Best practice is to rely on the localhost default for development and configure the environment variables for non-development environments.

FAKTORY_PROVIDER=MY_FAKTORY_URL MY_FAKTORY_URL=tcp://:[email protected]:7419

Note above, the URL can contain the password for secure installations.



47
48
49
50
51
52
53
 
# File 'lib/faktory/client.rb', line 47

def initialize(url: uri_from_env || 'tcp://localhost:7419', debug: false, timeout: DEFAULT_TIMEOUT)
  @debug = debug
  @location = URI(url)
  @timeout = timeout

  open(@timeout)
end

Instance Attribute Details

#middleware ⇒ Object

Returns the value of attribute middleware.



38
39
40
 
# File 'lib/faktory/client.rb', line 38

def middleware
  @middleware
end

Class Method Details

.worker! ⇒ Object

Called when booting the worker process to signal that this process will consume jobs and send BEAT.



34
35
36
 
# File 'lib/faktory/client.rb', line 34

def self.worker!
  @@random_process_wid = SecureRandom.hex(8)
end

Instance Method Details

#ack(jid) ⇒ Object 



159
160
161
162
163
164
 
# File 'lib/faktory/client.rb', line 159

def ack(jid)
  transaction do
    command("ACK", %Q[{"jid":"#{jid}"}])
    ok
  end
end

#batch_status(bid) ⇒ Object 



94
95
96
97
98
99
 
# File 'lib/faktory/client.rb', line 94

def batch_status(bid)
  transaction do
    command "BATCH STATUS", bid
    Faktory.load_json result!
  end
end

#beat(current_state = nil) ⇒ Object

Sends a heartbeat to the server, in order to prove this worker process is still alive.

You can pass in the current_state of the process, for example during shutdown quiet and/or terminate can be supplied.

Return a string signal to process, legal values are “quiet” or “terminate”. The quiet signal is informative: the server won’t allow this process to FETCH any more jobs anyways.



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/faktory/client.rb', line 185

def beat(current_state = nil)
  transaction do
    if current_state.nil?
      command("BEAT", %Q[{"wid":"#{@@random_process_wid}"}])
    else
      command("BEAT", %Q[{"wid":"#{@@random_process_wid}", "current_state":"#{current_state}"}])
    end

    str = result!
    if str == "OK"
      str
    else
      hash = Faktory.load_json(str)
      hash["state"]
    end
  end
end

#close ⇒ Object 



55
56
57
58
59
60
 
# File 'lib/faktory/client.rb', line 55

def close
  return unless @sock
  command "END"
  @sock.close
  @sock = nil
end

#create_batch(batch, &block) ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/faktory/client.rb', line 70

def create_batch(batch, &block)
  bid = transaction do
    command "BATCH NEW", Faktory.dump_json(batch.to_h)
    result!
  end
  batch.instance_variable_set(:@bid, bid)

  old = Thread.current["faktory_batch"]
  Thread.current["faktory_batch"] = batch
  begin
    # any jobs pushed in this block will implicitly have
    # their `bid` attribute set so they are associated
    # with the current batch.
    yield batch
  ensure
    Thread.current[:faktory_batch] = old
  end
  transaction do
    command "BATCH COMMIT", bid
    ok
  end
  bid
end

#fail(jid, ex) ⇒ Object 



166
167
168
169
170
171
172
173
174
 
# File 'lib/faktory/client.rb', line 166

def fail(jid, ex)
  transaction do
    command("FAIL", Faktory.dump_json({ message: ex.message[0...1000],
                      errtype: ex.class.name,
                      jid: jid,
                      backtrace: ex.backtrace}))
    ok
  end
end

#fetch(*queues) ⇒ Object

Returns either a job hash or falsy.



150
151
152
153
154
155
156
157
 
# File 'lib/faktory/client.rb', line 150

def fetch(*queues)
  job = nil
  transaction do
    command("FETCH", *queues)
    job = result!
  end
  JSON.parse(job) if job
end

#flush ⇒ Object

Warning: this clears all job data in Faktory



63
64
65
66
67
68
 
# File 'lib/faktory/client.rb', line 63

def flush
  transaction do
    command "FLUSH"
    ok
  end
end

#get_track(jid) ⇒ Object 



122
123
124
125
126
127
128
 
# File 'lib/faktory/client.rb', line 122

def get_track(jid)
  transaction do
    command "TRACK GET", jid
    hashstr = result!
    JSON.parse(hashstr)
  end
end

#info ⇒ Object 



203
204
205
206
207
208
209
 
# File 'lib/faktory/client.rb', line 203

def info
  transaction do
    command("INFO")
    str = result!
    Faktory.load_json(str) if str
  end
end

#open(*args) ⇒ Object 



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/faktory/client.rb', line 222

def open(timeout = DEFAULT_TIMEOUT)
  # this is the read/write timeout, not open.
  secs = Integer(timeout)
  usecs = Integer((timeout - secs) * 1_000_000)
  optval = [secs, usecs].pack("l_2")
  if tls?
    sock = TCPSocket.new(@location.hostname, @location.port)
    sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
    sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_RCVTIMEO, optval)
    sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_SNDTIMEO, optval)

    ctx = OpenSSL::SSL::SSLContext.new
    ctx.set_params(verify_mode: OpenSSL::SSL::VERIFY_PEER)
    ctx.ssl_version = :TLSv1_2

    @sock = OpenSSL::SSL::SSLSocket.new(sock, ctx).tap do |socket|
      socket.sync_close = true
      socket.connect
    end
  else
    @sock = TCPSocket.new(@location.hostname, @location.port)
    @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
    @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_RCVTIMEO, optval)
    @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_SNDTIMEO, optval)
  end

  payload = {
    "wid": @@random_process_wid,
    "hostname": Socket.gethostname,
    "pid": $$,
    "labels": Faktory.options[:labels] || ["ruby-#{RUBY_VERSION}"],
    "v": 2,
  }

  hi = result

  if hi =~ /\AHI (.*)/
    hash = JSON.parse($1)
    ver = hash["v"].to_i
    if ver > 2
      puts "Warning: Faktory server protocol #{ver} in use, this worker doesn't speak that version."
      puts "We recommend you upgrade this gem with `bundle up faktory_worker_ruby`."
    end

    salt = hash["s"]
    if salt
      pwd = @location.password
      if !pwd
        raise ArgumentError, "Server requires password, but none has been configured"
      end
      iter = (hash["i"] || 1).to_i
      raise ArgumentError, "Invalid hashing" if iter < 1

      payload["pwdhash"] = HASHER.(iter, pwd, salt)
    end
  end

  command("HELLO", Faktory.dump_json(payload))
  ok
end

#push(job) ⇒ Object

Push a hash corresponding to a job payload to Faktory. Hash must contain “jid”, “jobtype” and “args” elements at minimum. Returned value will either be the JID String if successful OR a symbol corresponding to an error.



142
143
144
145
146
147
 
# File 'lib/faktory/client.rb', line 142

def push(job)
  transaction do
    command "PUSH", Faktory.dump_json(job)
    ok(job["jid"])
  end
end

#real_open ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/faktory/testing.rb', line 79

def open(timeout = DEFAULT_TIMEOUT)
  # this is the read/write timeout, not open.
  secs = Integer(timeout)
  usecs = Integer((timeout - secs) * 1_000_000)
  optval = [secs, usecs].pack("l_2")
  if tls?
    sock = TCPSocket.new(@location.hostname, @location.port)
    sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
    sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_RCVTIMEO, optval)
    sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_SNDTIMEO, optval)

    ctx = OpenSSL::SSL::SSLContext.new
    ctx.set_params(verify_mode: OpenSSL::SSL::VERIFY_PEER)
    ctx.ssl_version = :TLSv1_2

    @sock = OpenSSL::SSL::SSLSocket.new(sock, ctx).tap do |socket|
      socket.sync_close = true
      socket.connect
    end
  else
    @sock = TCPSocket.new(@location.hostname, @location.port)
    @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
    @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_RCVTIMEO, optval)
    @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_SNDTIMEO, optval)
  end

  payload = {
    "wid": @@random_process_wid,
    "hostname": Socket.gethostname,
    "pid": $$,
    "labels": Faktory.options[:labels] || ["ruby-#{RUBY_VERSION}"],
    "v": 2,
  }

  hi = result

  if hi =~ /\AHI (.*)/
    hash = JSON.parse($1)
    ver = hash["v"].to_i
    if ver > 2
      puts "Warning: Faktory server protocol #{ver} in use, this worker doesn't speak that version."
      puts "We recommend you upgrade this gem with `bundle up faktory_worker_ruby`."
    end

    salt = hash["s"]
    if salt
      pwd = @location.password
      if !pwd
        raise ArgumentError, "Server requires password, but none has been configured"
      end
      iter = (hash["i"] || 1).to_i
      raise ArgumentError, "Invalid hashing" if iter < 1

      payload["pwdhash"] = HASHER.(iter, pwd, salt)
    end
  end

  command("HELLO", Faktory.dump_json(payload))
  ok
end

#real_push ⇒ Object

Push a hash corresponding to a job payload to Faktory. Hash must contain “jid”, “jobtype” and “args” elements at minimum. Returned value will either be the JID String if successful OR a symbol corresponding to an error.



78
79
80
81
82
83
 
# File 'lib/faktory/testing.rb', line 78

def push(job)
  transaction do
    command "PUSH", Faktory.dump_json(job)
    ok(job["jid"])
  end
end

#reopen_batch(b) ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/faktory/client.rb', line 101

def reopen_batch(b)
  transaction do
    command "BATCH OPEN", b.bid
    ok
  end
  old = Thread.current[:faktory_batch]
  Thread.current[:faktory_batch] = b
  begin
    # any jobs pushed in this block will implicitly have
    # their `bid` attribute set so they are associated
    # with the current batch.
    yield b
  ensure
    Thread.current[:faktory_batch] = old
  end
  transaction do
    command "BATCH COMMIT", b.bid
    ok
  end
end

#set_track(hash) ⇒ Object

hash must include a ‘jid’ element



131
132
133
134
135
136
 
# File 'lib/faktory/client.rb', line 131

def set_track(hash)
  transaction do
    command("TRACK SET", Faktory.dump_json(hash))
    ok
  end
end