Add finished_at_start/end job filters (#111)

* jobs_relation finished_at_start and finished_at_end filters

* natively_supported finished_at_* filters for solid_queue

* added filters to _filters partial and params

* added timezone

* show finished_at filters if jobs_status is 'finished'

* added comments to jobs_relation where method

* clean finished_at_* filter values when clear button clicked

* double instead of single quoted strings (rubocop)

* enhacements set filters

* finished_at range enhacement

* enhace date_with_time_zone method

* back to @job_filters in _filters

* god bye presence

* bye collect arguments with to_s for values

* fix tests

* bringed back .to_s for queue_name parameters (JobsRelation#where)

* queue_name back to symbol

* bye finished_at from FILTERS

* bye comment

* added finished_at in supported_job_filters (SolidQueue)

* Update app/views/mission_control/jobs/jobs/_filters.html.erb

* Update lib/active_job/jobs_relation.rb

* finished_at_range_params method

* double quotes

Author: Xeitor

app/controllers/concerns/mission_control/jobs/job_filters.rb

@@ -9,10 +9,24 @@ module MissionControl::Jobs::JobFilters
 
   private
     def set_filters
-      @job_filters = { job_class_name: params.dig(:filter, :job_class_name).presence, queue_name: params.dig(:filter, :queue_name).presence }.compact
+      @job_filters = { job_class_name: params.dig(:filter, :job_class_name).presence, queue_name: params.dig(:filter, :queue_name).presence,
+                       finished_at: finished_at_range_params }.compact
     end
 
     def active_filters?
       @job_filters.any?
     end
+
+    def finished_at_range_params
+      range_start, range_end = params.dig(:filter, :finished_at_start), params.dig(:filter, :finished_at_end)
+      if range_start || range_end
+        (parse_with_time_zone(range_start)..parse_with_time_zone(range_end))
+      end
+    end
+
+    def date_with_time_zone(date)
+      if date.present?
+        DateTime.parse(date).in_time_zone
+      end
+    end
 end

app/views/mission_control/jobs/jobs/_filters.html.erb

@@ -12,6 +12,16 @@
           <%= form.text_field :queue_name, value: @job_filters[:queue_name], class: "input", list: "queue-names", placeholder: "Filter by queue name..." %>
         </div>
 
+        <% if jobs_status == "finished" %>
+          <div class="select is-rounded">
+            <%= form.datetime_field :finished_at_start, value: @job_filters[:finished_at]&.begin, class: "input", placeholder: "Finished from" %>
+          </div>
+
+          <div class="select is-rounded">
+            <%= form.datetime_field :finished_at_end, value: @job_filters[:finished_at]&.end, class: "input", placeholder: "Finished to" %>
+          </div>
+        <% end %>
+
         <%= hidden_field_tag :server_id, MissionControl::Jobs::Current.server.id %>
 
         <datalist id="job-classes" class="is-hidden">
@@ -29,7 +39,7 @@
     </div>
 
     <div class="control">
-      <%= link_to "Clear", application_jobs_path(MissionControl::Jobs::Current.application, jobs_status, job_class_name: nil, queue_name: nil), class: "button" %>
+      <%= link_to "Clear", application_jobs_path(MissionControl::Jobs::Current.application, jobs_status, job_class_name: nil, queue_name: nil, finished_at: nil..nil), class: "button" %>
     </div>
   </div>
 </div>

lib/active_job/jobs_relation.rb

@@ -25,7 +25,7 @@ class ActiveJob::JobsRelation
   STATUSES = %i[ pending failed in_progress blocked scheduled finished ]
   FILTERS = %i[ queue_name job_class_name ]
 
-  PROPERTIES = %i[ queue_name status offset_value limit_value job_class_name worker_id recurring_task_id ]
+  PROPERTIES = %i[ queue_name status offset_value limit_value job_class_name worker_id recurring_task_id finished_at ]
   attr_reader *PROPERTIES, :default_page_size
 
   delegate :last, :[], :reverse, to: :to_a
@@ -51,13 +51,15 @@ def initialize(queue_adapter: ActiveJob::Base.queue_adapter, default_page_size:
   # * <tt>:queue_name</tt> - To only include the jobs in the provided queue.
   # * <tt>:worker_id</tt> - To only include the jobs processed by the provided worker.
   # * <tt>:recurring_task_id</tt> - To only include the jobs corresponding to runs of a recurring task.
-  def where(job_class_name: nil, queue_name: nil, worker_id: nil, recurring_task_id: nil)
+  # * <tt>:finished_at</tt> - (Range) To only include the jobs finished between the provided range
+  def where(job_class_name: nil, queue_name: nil, worker_id: nil, recurring_task_id: nil, finished_at: nil)
     # Remove nil arguments to avoid overriding parameters when concatenating +where+ clauses
     arguments = { job_class_name: job_class_name,
-      queue_name: queue_name,
+      queue_name: queue_name&.to_s,
       worker_id: worker_id,
-      recurring_task_id: recurring_task_id
-    }.compact.collect { |key, value| [ key, value.to_s ] }.to_h
+      recurring_task_id: recurring_task_id,
+      finished_at: finished_at
+    }.compact
 
     clone_with **arguments
   end

lib/active_job/queue_adapters/solid_queue_ext.rb

@@ -40,7 +40,7 @@ def supported_job_statuses
   end
 
   def supported_job_filters(*)
-    [ :queue_name, :job_class_name ]
+    [ :queue_name, :job_class_name, :finished_at ]
   end
 
   def jobs_count(jobs_relation)
@@ -173,7 +173,7 @@ def retry_all
         attr_reader :jobs_relation
 
         delegate :queue_name, :limit_value, :limit_value_provided?, :offset_value, :job_class_name,
-          :default_page_size, :worker_id, :recurring_task_id, to: :jobs_relation
+          :default_page_size, :worker_id, :recurring_task_id, :finished_at, to: :jobs_relation
 
         def executions
           execution_class_by_status
@@ -190,6 +190,7 @@ def finished_jobs
           SolidQueue::Job.finished
             .then { |jobs| filter_jobs_by_queue(jobs) }
             .then { |jobs| filter_jobs_by_class(jobs) }
+            .then { |jobs| filter_jobs_by_finished_at(jobs) }
             .then { |jobs| limit(jobs) }
             .then { |jobs| offset(jobs) }
         end
@@ -271,6 +272,10 @@ def filter_jobs_by_class(jobs)
           job_class_name.present? ? jobs.where(class_name: job_class_name) : jobs
         end
 
+        def filter_jobs_by_finished_at(jobs)
+          finished_at.present? ? jobs.where(finished_at: finished_at) : jobs
+        end
+
         def limit(executions_or_jobs)
           limit_value.present? ? executions_or_jobs.limit(limit_value) : executions_or_jobs
         end

test/active_job/queue_adapters/adapter_testing/query_jobs.rb

@@ -112,7 +112,7 @@ module ActiveJob::QueueAdapters::AdapterTesting::QueryJobs
     10.times { |index| WithPaginationDummyJob.perform_later(index) }
     4.times { |index| WithPaginationFailingJob.perform_later(index) }
 
-    jobs = ActiveJob.jobs.pending.where(queue_name: :default, job_class_name: WithPaginationDummyJob).to_a
+    jobs = ActiveJob.jobs.pending.where(queue_name: :default, job_class_name: "WithPaginationDummyJob").to_a
     assert_equal 10, jobs.size
   end