Class: Tina4::QueueBackends::LiteBackend

Inherits:
Object
  • Object
show all
Defined in:
lib/tina4/queue_backends/lite_backend.rb

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ LiteBackend

Returns a new instance of LiteBackend.



9
10
11
12
13
14
15
 
# File 'lib/tina4/queue_backends/lite_backend.rb', line 9

def initialize(options = {})
  @dir = options[:dir] || File.join(Dir.pwd, ".queue")
  @dead_letter_dir = File.join(@dir, "dead_letter")
  FileUtils.mkdir_p(@dir)
  FileUtils.mkdir_p(@dead_letter_dir)
  @mutex = Mutex.new
end

Instance Method Details

#acknowledge(message) ⇒ Object 



105
106
107
 
# File 'lib/tina4/queue_backends/lite_backend.rb', line 105

def acknowledge(message)
  # File already deleted on dequeue
end

#clear(topic) ⇒ Object

Remove all pending jobs from a topic. Returns count removed.



234
235
236
237
238
239
240
241
242
243
 
# File 'lib/tina4/queue_backends/lite_backend.rb', line 234

def clear(topic)
  dir = topic_path(topic)
  return 0 unless Dir.exist?(dir)
  count = 0
  Dir.glob(File.join(dir, "*.json")).each do |file|
    File.delete(file)
    count += 1
  end
  count
end

#dead_letter(message) ⇒ Object 



113
114
115
116
 
# File 'lib/tina4/queue_backends/lite_backend.rb', line 113

def dead_letter(message)
  path = File.join(@dead_letter_dir, "#{message.id}.json")
  File.write(path, message.to_json)
end

#dead_letter_count(topic) ⇒ Object

Count dead-letter / failed messages for a topic.



125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/tina4/queue_backends/lite_backend.rb', line 125

def dead_letter_count(topic)
  return 0 unless Dir.exist?(@dead_letter_dir)

  count = 0
  Dir.glob(File.join(@dead_letter_dir, "*.json")).each do |file|
    data = JSON.parse(File.read(file))
    count += 1 if data["topic"] == topic.to_s
  rescue JSON::ParserError
    next
  end
  count
end

#dead_letters(topic, max_retries: 3) ⇒ Object

Get dead letter jobs for a topic — messages that exceeded max retries.



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/tina4/queue_backends/lite_backend.rb', line 146

def dead_letters(topic, max_retries: 3)
  return [] unless Dir.exist?(@dead_letter_dir)

  files = Dir.glob(File.join(@dead_letter_dir, "*.json")).sort_by { |f| File.mtime(f) }
  jobs = []

  files.each do |file|
    data = JSON.parse(File.read(file))
    next unless data["topic"] == topic.to_s
    data["status"] = "dead"
    jobs << data
  rescue JSON::ParserError
    next
  end

  jobs
end

#dequeue(topic) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/tina4/queue_backends/lite_backend.rb', line 26

def dequeue(topic)
  @mutex.synchronize do
    dir = topic_path(topic)
    return nil unless Dir.exist?(dir)

    now = Time.now
    candidates = []

    Dir.glob(File.join(dir, "*.json")).each do |f|
      data = JSON.parse(File.read(f))
      # Skip messages that are not yet available (delayed)
      if data["available_at"]
        available_at = Time.parse(data["available_at"])
        next if available_at > now
      end
      candidates << { file: f, data: data, priority: data["priority"] || 0, mtime: File.mtime(f) }
    rescue JSON::ParserError
      next
    end

    return nil if candidates.empty?

    # Sort by priority descending (higher first), then by mtime ascending (oldest first)
    candidates.sort_by! { |c| [-c[:priority], c[:mtime]] }

    chosen = candidates.first
    File.delete(chosen[:file])
    data = chosen[:data]

    Tina4::Job.new(
      topic: data["topic"] || topic.to_s,
      payload: data["payload"],
      id: data["id"],
      priority: data["priority"] || 0,
      available_at: data["available_at"] ? Time.parse(data["available_at"]) : nil,
      attempts: data["attempts"] || 0
    )
  end
end

#dequeue_batch(topic, count) ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
78
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
 
# File 'lib/tina4/queue_backends/lite_backend.rb', line 66

def dequeue_batch(topic, count)
  @mutex.synchronize do
    dir = topic_path(topic)
    return [] unless Dir.exist?(dir)

    now = Time.now
    candidates = []

    Dir.glob(File.join(dir, "*.json")).each do |f|
      data = JSON.parse(File.read(f))
      if data["available_at"]
        available_at = Time.parse(data["available_at"])
        next if available_at > now
      end
      candidates << { file: f, data: data, priority: data["priority"] || 0, mtime: File.mtime(f) }
    rescue JSON::ParserError
      next
    end

    return [] if candidates.empty?

    candidates.sort_by! { |c| [-c[:priority], c[:mtime]] }
    chosen = candidates.first(count)

    chosen.map do |c|
      File.delete(c[:file])
      data = c[:data]
      Tina4::Job.new(
        topic: data["topic"] || topic.to_s,
        payload: data["payload"],
        id: data["id"],
        priority: data["priority"] || 0,
        available_at: data["available_at"] ? Time.parse(data["available_at"]) : nil,
        attempts: data["attempts"] || 0
      )
    end
  end
end

#enqueue(message) ⇒ Object 



17
18
19
20
21
22
23
24
 
# File 'lib/tina4/queue_backends/lite_backend.rb', line 17

def enqueue(message)
  @mutex.synchronize do
    topic_dir = topic_path(message.topic)
    FileUtils.mkdir_p(topic_dir)
    path = File.join(topic_dir, "#{message.id}.json")
    File.write(path, message.to_json)
  end
end

#failed(topic, max_retries: 3) ⇒ Object

Get jobs that failed but are still eligible for retry (under max_retries).



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/tina4/queue_backends/lite_backend.rb', line 246

def failed(topic, max_retries: 3)
  return [] unless Dir.exist?(@dead_letter_dir)
  jobs = []
  Dir.glob(File.join(@dead_letter_dir, "*.json")).sort_by { |f| File.mtime(f) }.each do |file|
    data = JSON.parse(File.read(file))
    next unless data["topic"] == topic.to_s
    next if (data["attempts"] || 0) >= max_retries
    jobs << data
  rescue JSON::ParserError
    next
  end
  jobs
end

#purge(topic, status) ⇒ Object

Delete messages by status (completed, failed, dead). For ‘dead’, removes from the dead_letter directory. For ‘failed’, removes from the topic directory (re-queued failed messages). Returns the number of jobs purged.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/tina4/queue_backends/lite_backend.rb', line 168

def purge(topic, status)
  count = 0

  if status.to_s == "dead"
    return 0 unless Dir.exist?(@dead_letter_dir)

    Dir.glob(File.join(@dead_letter_dir, "*.json")).each do |file|
      data = JSON.parse(File.read(file))
      if data["topic"] == topic.to_s
        File.delete(file)
        count += 1
      end
    rescue JSON::ParserError
      next
    end
  elsif status.to_s == "failed" || status.to_s == "completed" || status.to_s == "pending"
    dir = topic_path(topic)
    return 0 unless Dir.exist?(dir)

    Dir.glob(File.join(dir, "*.json")).each do |file|
      data = JSON.parse(File.read(file))
      if data["status"] == status.to_s
        File.delete(file)
        count += 1
      end
    rescue JSON::ParserError
      next
    end
  end

  count
end

#requeue(message) ⇒ Object 



109
110
111
 
# File 'lib/tina4/queue_backends/lite_backend.rb', line 109

def requeue(message)
  enqueue(message)
end

#retry_failed(topic, max_retries: 3) ⇒ Object

Re-queue failed messages (under max_retries) back to pending. Returns the number of jobs re-queued.



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/tina4/queue_backends/lite_backend.rb', line 203

def retry_failed(topic, max_retries: 3)
  return 0 unless Dir.exist?(@dead_letter_dir)

  dir = topic_path(topic)
  FileUtils.mkdir_p(dir)
  count = 0

  # Dead letter directory contains messages that the Consumer moved there.
  # Only retry those whose attempts are under max_retries.
  Dir.glob(File.join(@dead_letter_dir, "*.json")).each do |file|
    data = JSON.parse(File.read(file))
    next unless data["topic"] == topic.to_s
    next if (data["attempts"] || 0) >= max_retries

    data["status"] = "pending"
    msg = Tina4::Job.new(
      topic: data["topic"],
      payload: data["payload"],
      id: data["id"]
    )
    enqueue(msg)
    File.delete(file)
    count += 1
  rescue JSON::ParserError
    next
  end

  count
end

#retry_job(topic, job_id: nil, delay_seconds: 0) ⇒ Object

Retry all dead letter jobs for this topic. Returns true if any were re-queued.



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/tina4/queue_backends/lite_backend.rb', line 261

def retry_job(topic, job_id: nil, delay_seconds: 0)
  return false unless Dir.exist?(@dead_letter_dir)

  available_at = delay_seconds > 0 ? Time.now + delay_seconds : nil
  count = 0

  Dir.glob(File.join(@dead_letter_dir, "*.json")).each do |file|
    data = JSON.parse(File.read(file))
    next unless data["topic"] == topic.to_s
    next if job_id && data["id"] != job_id.to_s

    msg = Tina4::Job.new(
      topic: data["topic"],
      payload: data["payload"],
      id: data["id"],
      attempts: (data["attempts"] || 0) + 1,
      available_at: available_at
    )
    enqueue(msg)
    File.delete(file)
    count += 1
    break if job_id  # found the specific job, stop scanning
  rescue JSON::ParserError
    next
  end

  count > 0
end

#size(topic) ⇒ Object 



118
119
120
121
122
 
# File 'lib/tina4/queue_backends/lite_backend.rb', line 118

def size(topic)
  dir = topic_path(topic)
  return 0 unless Dir.exist?(dir)
  Dir.glob(File.join(dir, "*.json")).length
end

#topics ⇒ Object 



138
139
140
141
142
143
 
# File 'lib/tina4/queue_backends/lite_backend.rb', line 138

def topics
  return [] unless Dir.exist?(@dir)
  Dir.children(@dir)
     .reject { |d| d == "dead_letter" }
     .select { |d| File.directory?(File.join(@dir, d)) }
end