Class: SolidQueueMonitor::BaseController

Inherits:
ApplicationController show all
Defined in:
app/controllers/solid_queue_monitor/base_controller.rb

Instance Method Summary collapse

Methods inherited from ApplicationController

#set_flash_message

Instance Method Details

#apply_execution_sorting(relation, allowed_columns, default_column, default_direction = :desc) ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'app/controllers/solid_queue_monitor/base_controller.rb', line 206

def apply_execution_sorting(relation, allowed_columns, default_column, default_direction = :desc)
  column = sort_params[:sort_by]
  direction = sort_params[:sort_direction]
  column = default_column unless allowed_columns.include?(column)
  direction = %w[asc desc].include?(direction) ? direction.to_sym : default_direction

  # Columns that exist on the jobs table, not on execution tables
  job_table_columns = %w[class_name queue_name]

  if job_table_columns.include?(column)
    relation.joins(:job).order("solid_queue_jobs.#{column}" => direction)
  else
    relation.order(column => direction)
  end
end

#apply_sorting(relation, allowed_columns, default_column, default_direction = :desc) ⇒ Object 



198
199
200
201
202
203
204
 
# File 'app/controllers/solid_queue_monitor/base_controller.rb', line 198

def apply_sorting(relation, allowed_columns, default_column, default_direction = :desc)
  column = sort_params[:sort_by]
  direction = sort_params[:sort_direction]
  column = default_column unless allowed_columns.include?(column)
  direction = %w[asc desc].include?(direction) ? direction.to_sym : default_direction
  relation.order(column => direction)
end

#current_page ⇒ Object 



38
39
40
 
# File 'app/controllers/solid_queue_monitor/base_controller.rb', line 38

def current_page
  (params[:page] || 1).to_i
end

#filter_by_arguments(relation) ⇒ Object 



108
109
110
111
 
# File 'app/controllers/solid_queue_monitor/base_controller.rb', line 108

def filter_by_arguments(relation)
  # Use ILIKE for case-insensitive search in PostgreSQL
  relation.where('arguments::text ILIKE ?', "%#{params[:arguments]}%")
end

#filter_failed_jobs(relation) ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'app/controllers/solid_queue_monitor/base_controller.rb', line 160

def filter_failed_jobs(relation)
  return relation unless params[:class_name].present? || params[:queue_name].present? || params[:arguments].present?

  if params[:class_name].present?
    relation = relation.where(job_id: SolidQueue::Job.where('class_name LIKE ?', "%#{params[:class_name]}%").select(:id))
  end

  if params[:queue_name].present?
    relation = if relation.column_names.include?('queue_name')
                 relation.where('queue_name LIKE ?', "%#{params[:queue_name]}%")
               else
                 relation.where(job_id: SolidQueue::Job.where('queue_name LIKE ?', "%#{params[:queue_name]}%").select(:id))
               end
  end

  if params[:arguments].present?
    relation = relation.where(job_id: SolidQueue::Job.where('arguments::text ILIKE ?', "%#{params[:arguments]}%").select(:id))
  end

  relation
end

#filter_jobs(relation) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'app/controllers/solid_queue_monitor/base_controller.rb', line 85

def filter_jobs(relation)
  relation = relation.where('class_name LIKE ?', "%#{params[:class_name]}%") if params[:class_name].present?
  relation = relation.where('queue_name LIKE ?', "%#{params[:queue_name]}%") if params[:queue_name].present?
  relation = filter_by_arguments(relation) if params[:arguments].present?

  if params[:status].present?
    case params[:status]
    when 'completed'
      relation = relation.where.not(finished_at: nil)
    when 'failed'
      relation = relation.where(id: SolidQueue::FailedExecution.select(:job_id))
    when 'scheduled'
      relation = relation.where(id: SolidQueue::ScheduledExecution.select(:job_id))
    when 'pending'
      relation = relation.where(finished_at: nil)
                         .where.not(id: SolidQueue::FailedExecution.select(:job_id))
                         .where.not(id: SolidQueue::ScheduledExecution.select(:job_id))
    end
  end

  relation
end

#filter_params ⇒ Object 



182
183
184
185
186
187
188
189
 
# File 'app/controllers/solid_queue_monitor/base_controller.rb', line 182

def filter_params
  {
    class_name: params[:class_name],
    queue_name: params[:queue_name],
    arguments: params[:arguments],
    status: params[:status]
  }
end

#filter_ready_jobs(relation) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'app/controllers/solid_queue_monitor/base_controller.rb', line 113

def filter_ready_jobs(relation)
  return relation unless params[:class_name].present? || params[:queue_name].present? || params[:arguments].present?

  if params[:class_name].present?
    relation = relation.where(job_id: SolidQueue::Job.where('class_name LIKE ?', "%#{params[:class_name]}%").select(:id))
  end

  relation = relation.where('queue_name LIKE ?', "%#{params[:queue_name]}%") if params[:queue_name].present?

  if params[:arguments].present?
    relation = relation.where(job_id: SolidQueue::Job.where('arguments::text ILIKE ?', "%#{params[:arguments]}%").select(:id))
  end

  relation
end

#filter_recurring_jobs(relation) ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'app/controllers/solid_queue_monitor/base_controller.rb', line 145

def filter_recurring_jobs(relation)
  return relation unless params[:class_name].present? || params[:queue_name].present? || params[:arguments].present?

  relation = relation.where('class_name LIKE ?', "%#{params[:class_name]}%") if params[:class_name].present?
  relation = relation.where('queue_name LIKE ?', "%#{params[:queue_name]}%") if params[:queue_name].present?

  # Add arguments filtering if the model has arguments column
  if params[:arguments].present? && relation.column_names.include?('arguments')
    relation = relation.where('arguments::text ILIKE ?',
                              "%#{params[:arguments]}%")
  end

  relation
end

#filter_scheduled_jobs(relation) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'app/controllers/solid_queue_monitor/base_controller.rb', line 129

def filter_scheduled_jobs(relation)
  return relation unless params[:class_name].present? || params[:queue_name].present? || params[:arguments].present?

  if params[:class_name].present?
    relation = relation.where(job_id: SolidQueue::Job.where('class_name LIKE ?', "%#{params[:class_name]}%").select(:id))
  end

  relation = relation.where('queue_name LIKE ?', "%#{params[:queue_name]}%") if params[:queue_name].present?

  if params[:arguments].present?
    relation = relation.where(job_id: SolidQueue::Job.where('arguments::text ILIKE ?', "%#{params[:arguments]}%").select(:id))
  end

  relation
end

#paginate(relation) ⇒ Object 



5
6
7
 
# File 'app/controllers/solid_queue_monitor/base_controller.rb', line 5

def paginate(relation)
  PaginationService.new(relation, current_page, per_page).paginate
end

#per_page ⇒ Object 



42
43
44
 
# File 'app/controllers/solid_queue_monitor/base_controller.rb', line 42

def per_page
  SolidQueueMonitor.jobs_per_page
end

#preload_job_statuses(jobs) ⇒ Object

Preload job statuses to avoid N+1 queries



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'app/controllers/solid_queue_monitor/base_controller.rb', line 47

def preload_job_statuses(jobs)
  return if jobs.empty?

  # Get all job IDs
  job_ids = jobs.map(&:id)

  # Find all failed jobs in a single query
  failed_job_ids = SolidQueue::FailedExecution.where(job_id: job_ids).pluck(:job_id)

  # Find all scheduled jobs in a single query
  scheduled_job_ids = SolidQueue::ScheduledExecution.where(job_id: job_ids).pluck(:job_id)

  # Attach the status information to each job
  jobs.each do |job|
    job.instance_variable_set(:@failed, failed_job_ids.include?(job.id))
    job.instance_variable_set(:@scheduled, scheduled_job_ids.include?(job.id))
  end

  # Define the method to check if a job is failed
  SolidQueue::Job.class_eval do
    def failed?
      if instance_variable_defined?(:@failed)
        @failed
      else
        SolidQueue::FailedExecution.exists?(job_id: id)
      end
    end

    def scheduled?
      if instance_variable_defined?(:@scheduled)
        @scheduled
      else
        SolidQueue::ScheduledExecution.exists?(job_id: id)
      end
    end
  end
end

#render_page(title, content, search_query: nil) ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'app/controllers/solid_queue_monitor/base_controller.rb', line 9

def render_page(title, content, search_query: nil)
  # Get flash message from instance variable (set by set_flash_message) or session
  message = @flash_message
  message_type = @flash_type

  # Try to get from session as fallback, but don't fail if session unavailable
  begin
    message ||= session[:flash_message]
    message_type ||= session[:flash_type]

    # Clear the flash message from session after using it
    session.delete(:flash_message) if message
    session.delete(:flash_type) if message_type
  rescue StandardError
    # Session not available (e.g., no session middleware in tests)
  end

  html = SolidQueueMonitor::HtmlGenerator.new(
    title: title,
    content: content,
    message: message,
    message_type: message_type,
    search_query: search_query,
    nonce: content_security_policy_nonce
  ).generate

  render html: html.html_safe
end

#sort_params ⇒ Object 



191
192
193
194
195
196
 
# File 'app/controllers/solid_queue_monitor/base_controller.rb', line 191

def sort_params
  {
    sort_by: params[:sort_by],
    sort_direction: params[:sort_direction]
  }
end