Add GoodJob::Job#display_name to allow customizing dashboard job display

[paul]

Fixes #956

The Dashboard displays jobs by default using the name of the Job class. If you want to customize this name, for example you have a generic job and want to include some part of the job arguments within the name, you can override GoodJob::BaseExecution#job_display_name:

module GoodJobCustomDisplayName
  def job_display_name
    super + serialized_params.dig("arguments", 0, "my_specific_name")
  end
end
# In a Rails initializer:
Rails.application.configure do
  # :after_initialize, so GoodJob has had a chance to load its models
  ActiveSupport.on_load(:after_initialize) do
    GoodJob::BaseExecution.prepend(GoodJobCustomDisplayName)
  end
end

[bensheldon]

@paul thank you for opening this! I made a few tweaks:

• I narrowed it so the method is only on GoodJob::Job.display_name. I expect BaseExecution to become deprecated in the next major release, and removed in the following one, whereupon Job and Execution models will point at separate tables.
• I removed the documentation from the Readme. I don't want to imply that this is "officially supported", even if I want to make it possible.

For monkeypatching, I think the best option is this:

# config/initializers/good_job.rb

module GoodJobCustomDisplayName
  def display_name
    super + serialized_params.dig("arguments", 0, "my_specific_name")
  end
end

Rails.application.autoloaders.each do |zeitwerk|
  zeitwerk.on_load("GoodJob::Job") do
    GoodJob::Job.prepend(GoodJobCustomDisplayName)
  end
end

[bensheldon]

This has been released in https://github.com/bensheldon/good_job/releases/tag/v3.16.2

Let know how it works for you and I'm open to additional tweaks/improvements 👍🏻

[paul]

@bensheldon Thanks for the super quick turnaround! We're running it in production now, and its looking great!

[mroach]

I wanted to chime in and thank you guys for this! We also use the command pattern and had the same issue with the dashboard, so this is a great enhancement for us as well.

I took a pretty similar approach, except inverting control to let the job classes set their own display names.

GoodJob::Job.prepend(Module.new do
  def display_name
    klass = job_class.constantize

    return super unless klass.respond_to?(:good_job_display_name)

    super + "[" + klass.good_job_display_name(self).to_s + "]"
  end
end)

class RunCommandJob < ApplicationJob
  class << self
    def good_job_display_name(job)
      job.serialized_params.dig("arguments", 0, "command_class", "value")
    end
  end
end