Merge branch 'main' of github.com:rafael-pissardo/mission_control-jobs into jobs-count-on-index

Author: rafael-pissardo

Gemfile.lock

@@ -15,7 +15,7 @@ GIT
 PATH
   remote: .
   specs:
-    mission_control-jobs (1.0.2)
+    mission_control-jobs (1.1.0)
       actioncable (>= 7.1)
       actionpack (>= 7.1)
       activejob (>= 7.1)

README.md

@@ -54,8 +54,6 @@ For example, if you're using the Dockerfile generated by Rails with an API-only
 RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile
 ```
 
-*Note: Legacy CSS bundlers `sass-rails` and `sassc-rails` may fail to compile some of the CSS vendored into this library from [Bulma](https://github.com/jgthms/bulma), which was created in [Dart SASS](https://sass-lang.com/dart-sass/). You will therefore need to upgrade to `dartsass-rails` or some library that relies on it, like `cssbundling-rails`.*
-
 ### Authentication
 
 Mission Control comes with **HTTP basic authentication enabled and closed** by default. Credentials are stored in [Rails's credentials](https://edgeguides.rubyonrails.org/security.html#custom-credentials) like this:
@@ -76,6 +74,15 @@ To set them up for different environments you can use the `RAILS_ENV` environmen
 RAILS_ENV=production bin/rails mission_control:jobs:authentication:configure
 ```
 
+User and password can also be configured by hand like this:
+
+```ruby
+Rails.application.configure do
+  MissionControl::Jobs.http_basic_auth_user = "dev"
+  MissionControl::Jobs.http_basic_auth_password = "secret"
+end
+```
+
 #### Custom authentication
 
 You can provide your own authentication mechanism, for example, if you have a certain type of admin user in your app that can access Mission Control. To make this easier, you can specify a different controller as the base class for Mission Control's controllers. By default, Mission Control's controllers will extend the host app's `ApplicationController`, but you can change this easily:
@@ -107,6 +114,7 @@ Besides `base_controller_class`, you can also set the following for `MissionCont
 - `scheduled_job_delay_threshold`: the time duration before a scheduled job is considered delayed. Defaults to `1.minute` (a job is considered delayed if it hasn't transitioned from the `scheduled` status 1 minute after the scheduled time).
 - `show_console_help`: whether to show the console help. If you don't want the console help message, set this to `false`—defaults to `true`.
 - `backtrace_cleaner`: a backtrace cleaner used for optionally filtering backtraces on the Failed Jobs detail page. Defaults to `Rails::BacktraceCleaner.new`. See the [Advanced configuration](#advanced-configuration) section for how to configure/override this setting on a per application/server basis.
+- `filter_arguments`: an array of strings representing the job argument keys you want to filter out in the UI. This is useful for hiding sensitive user data. Currently, only root-level hash keys are supported.
 
 This library extends Active Job with a querying interface and the following setting:
 - `config.active_job.default_page_size`: the internal batch size that Active Job will use when sending queries to the underlying adapter and the batch size for the bulk operations defined above—defaults to `1000`.
@@ -158,19 +166,19 @@ SERVERS_BY_APP.each do |app, servers|
     end
 
     # Default:
-    # 
+    #
     # @return Array<String, ActiveJob::QueueAdapters::Base)
     # An array where:
     # * the String represents the symbolic name for this server within the UI
     # * ActiveJob::QueueAdapters::Base adapter instance used to access this Application Server/Service
-    [ server, queue_adapter ] 
-    
+    [ server, queue_adapter ]
+
     # Optional return formats:
-    # 
+    #
     # @return Array<String, Array<ActiveJob::QueueAdapters::Base>>
-    # * This is equivalent, and behaves identically to, the format the default format above. 
+    # * This is equivalent, and behaves identically to, the format the default format above.
     # [ server, [ queue_adapter ]]  # without optional backtrace cleaner
-    # 
+    #
     # @return Array<String, Array<ActiveJob::QueueAdapters::Base, ActiveSupport::BacktraceCleaner>>
     # * This format adds an optional ActiveSupport::BacktraceCleaner to override the system wide
     #   backtrace cleaner for *this* Application Server/Service.
@@ -246,7 +254,7 @@ Available job servers:
 
 And then:
 ```
->> connect_to "hey:solid_queue"
+>> connect_to hey:solid_queue
 Connected to hey:solid_queue
 ```
 

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

@@ -4,7 +4,7 @@ module MissionControl::Jobs::JobFilters
   included do
     before_action :set_filters
 
-    helper_method :active_filters?
+    helper_method :active_filters?, :jobs_filter_param
   end
 
   private
@@ -20,6 +20,14 @@ def active_filters?
       @job_filters.any?
     end
 
+    def jobs_filter_param
+      if @job_filters&.any?
+        { filter: @job_filters }
+      else
+        {}
+      end
+    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
@@ -28,6 +36,6 @@ def finished_at_range_params
     end
 
     def parse_with_time_zone(date)
-      DateTime.parse(date).in_time_zone if date.present?
+      Time.zone.parse(date) if date.present?
     end
 end

app/controllers/mission_control/jobs/application_controller.rb

@@ -12,6 +12,7 @@ class MissionControl::Jobs::ApplicationController < MissionControl::Jobs.base_co
   include MissionControl::Jobs::BasicAuthentication
   include MissionControl::Jobs::ApplicationScoped, MissionControl::Jobs::NotFoundRedirections
   include MissionControl::Jobs::AdapterFeatures
+  include MissionControl::Jobs::JobFilters
 
   around_action :set_current_locale
 

app/controllers/mission_control/jobs/discards_controller.rb

@@ -13,6 +13,6 @@ def jobs_relation
 
     def redirect_location
       status = @job.status.presence_in(supported_job_statuses) || :failed
-      application_jobs_url(@application, status)
+      application_jobs_url(@application, status, **jobs_filter_param)
     end
 end

app/controllers/mission_control/jobs/jobs_controller.rb

@@ -1,5 +1,5 @@
 class MissionControl::Jobs::JobsController < MissionControl::Jobs::ApplicationController
-  include MissionControl::Jobs::JobScoped, MissionControl::Jobs::JobFilters
+  include MissionControl::Jobs::JobScoped
 
   skip_before_action :set_job, only: :index
 

app/controllers/mission_control/jobs/retries_controller.rb

@@ -3,7 +3,7 @@ class MissionControl::Jobs::RetriesController < MissionControl::Jobs::Applicatio
 
   def create
     @job.retry
-    redirect_to application_jobs_url(@application, :failed), notice: "Retried job with id #{@job.job_id}"
+    redirect_to application_jobs_url(@application, :failed, **jobs_filter_param), notice: "Retried job with id #{@job.job_id}"
   end
 
   private

app/helpers/mission_control/jobs/jobs_helper.rb

@@ -67,7 +67,8 @@ def as_renderable_hash(argument)
       elsif argument["_aj_serialized"]
         ActiveJob::Arguments.deserialize([ argument ]).first
       else
-        argument.without("_aj_symbol_keys", "_aj_ruby2_keywords")
+        MissionControl::Jobs.job_arguments_filter.apply_to(argument)
+          .without("_aj_symbol_keys", "_aj_ruby2_keywords")
           .transform_values { |v| as_renderable_argument(v) }
           .map { |k, v| "#{k}: #{v}" }
           .join(", ")

app/helpers/mission_control/jobs/navigation_helper.rb

@@ -37,14 +37,6 @@ def selected_server?(server)
     MissionControl::Jobs::Current.server.name == server.name
   end
 
-  def jobs_filter_param
-    if @job_filters&.any?
-      { filter: @job_filters }
-    else
-      {}
-    end
-  end
-
   def jobs_count_with_status(status)
     count = ActiveJob.jobs.with_status(status).count
     if count.infinite?

app/views/layouts/mission_control/jobs/_application_selection.html.erb

@@ -1,6 +1,9 @@
 <nav class="navbar" role="navigation" aria-label="main navigation">
   <div class="navbar-menu is-active mb-4">
     <div class="navbar-start">
+      <% if defined?(main_app.root_path) %>
+        <%= link_to "Back to main app", main_app.root_path %>
+      <% end %>
     </div>
 
     <div class="navbar-end">