Class: Mammoth::DeadLetterStore

Inherits:
Object
  • Object
show all
Defined in:
lib/mammoth/dead_letter_store.rb

Overview

Persists failed deliveries in Mammoth's SQLite dead letter queue.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(sqlite_store) ⇒ DeadLetterStore

Returns a new instance of DeadLetterStore.

Parameters:



12
13
14
 
# File 'lib/mammoth/dead_letter_store.rb', line 12

def initialize(sqlite_store)
  @sqlite_store = sqlite_store
end

Instance Attribute Details

#sqlite_store ⇒ Object (readonly)

Returns the value of attribute sqlite_store.



9
10
11
 
# File 'lib/mammoth/dead_letter_store.rb', line 9

def sqlite_store
  @sqlite_store
end

Instance Method Details

#count(status: nil, destination: nil) ⇒ Integer

Count dead letters by status.

Parameters:

  • status (String, nil) (defaults to: nil) —

    optional status

Returns:

  • (Integer) —

    dead letter count



98
99
100
101
 
# File 'lib/mammoth/dead_letter_store.rb', line 98

def count(status: nil, destination: nil)
  where, values = row_filters(status:, destination:)
  database.get_first_value("SELECT COUNT(*) FROM dead_letters#{where}", values)
end

#counts_by_destination(status: nil) ⇒ Array<Hash>

Count dead letters grouped by destination.

Parameters:

  • status (String, nil) (defaults to: nil) —

    optional status filter

Returns:

  • (Array<Hash>) —

    rows with destination_name and count



107
108
109
110
111
112
113
 
# File 'lib/mammoth/dead_letter_store.rb', line 107

def counts_by_destination(status: nil)
  where, values = row_filters(status:)
  database.execute(
    "SELECT destination_name, COUNT(*) AS count FROM dead_letters#{where} GROUP BY destination_name",
    values
  )
end

#fetch(id) ⇒ Hash?

Fetch one dead letter by id.

Parameters:

  • id (Integer) —

    dead letter id

Returns:

  • (Hash, nil) —

    dead letter row



90
91
92
 
# File 'lib/mammoth/dead_letter_store.rb', line 90

def fetch(id)
  database.get_first_row("SELECT * FROM dead_letters WHERE id = ?", [id])
end

#ignore(id) ⇒ void

This method returns an undefined value.

Mark a dead letter as ignored.

Parameters:

  • id (Integer) —

    dead letter id



127
128
129
 
# File 'lib/mammoth/dead_letter_store.rb', line 127

def ignore(id)
  update_status(id, "ignored")
end

#pending(limit: 100, destination: nil, failed_after: nil, failed_before: nil) ⇒ Array<Hash>

Fetch pending dead letters.

Parameters:

  • limit (Integer) (defaults to: 100) —

    maximum number of rows

Returns:

  • (Array<Hash>) —

    pending dead letter rows



68
69
70
71
 
# File 'lib/mammoth/dead_letter_store.rb', line 68

def pending(limit: 100, destination: nil, failed_after: nil, failed_before: nil)
  rows(status: "pending", limit: limit, destination: destination, failed_after: failed_after,
       failed_before: failed_before)
end

#resolve(id) ⇒ void

This method returns an undefined value.

Mark a dead letter as resolved.

Parameters:

  • id (Integer) —

    dead letter id



119
120
121
 
# File 'lib/mammoth/dead_letter_store.rb', line 119

def resolve(id)
  update_status(id, "resolved")
end

#rows(status: nil, limit: 100, destination: nil, failed_after: nil, failed_before: nil) ⇒ Array<Hash>

Fetch dead letters, optionally filtered by status.

Parameters:

  • status (String, nil) (defaults to: nil) —

    optional dead-letter status filter

  • limit (Integer) (defaults to: 100) —

    maximum number of rows

Returns:

  • (Array<Hash>) —

    dead letter rows



78
79
80
81
82
83
84
 
# File 'lib/mammoth/dead_letter_store.rb', line 78

def rows(status: nil, limit: 100, destination: nil, failed_after: nil, failed_before: nil)
  where, values = row_filters(status:, destination:, failed_after:, failed_before:)
  database.execute(
    "SELECT * FROM dead_letters#{where} ORDER BY failed_at ASC LIMIT ?",
    values + [limit]
  )
end

#write(event:, destination_name:, error: nil, retry_count: 0, serializer: EventSerializer) ⇒ Integer

Store a failed delivery.

Parameters:

  • event (Hash) —

    normalized event payload

  • destination_name (String) —

    destination name

  • error (Exception, nil) (defaults to: nil) —

    delivery failure

  • retry_count (Integer) (defaults to: 0) —

    number of delivery attempts

Returns:

  • (Integer) —

    inserted dead letter id



23
24
25
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
 
# File 'lib/mammoth/dead_letter_store.rb', line 23

def write(event:, destination_name:, error: nil, retry_count: 0, serializer: EventSerializer) # rubocop:disable Metrics/MethodLength
  now = Time.now.utc.iso8601
  payload = serializer.call(event)
  database.execute(
    <<~SQL,
      INSERT INTO dead_letters(
        event_id,
        source_name,
        destination_name,
        operation,
        namespace,
        entity,
        source_position,
        payload_json,
        error_class,
        error_message,
        retry_count,
        status,
        failed_at,
        updated_at
      ) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, 'pending', ?, ?)
    SQL
    [
      payload.fetch("event_id"),
      payload.fetch("source"),
      destination_name,
      payload["operation"] || payload["type"],
      payload["namespace"],
      payload["entity"],
      payload["source_position"],
      JSON.generate(payload),
      error&.class&.name,
      error&.message,
      retry_count,
      now,
      now
    ]
  )
  database.last_insert_row_id
end