Add label as pausable

app/controllers/good_job/pauses_controller.rb

@@ -7,14 +7,14 @@ def index
     end
 
     def create
-      return redirect_to({ action: :index }) unless params[:type].in?(%w[queue job_class]) && params[:value].present?
+      return redirect_to({ action: :index }) unless params[:type].in?(%w[queue job_class label]) && params[:value].present?
 
       GoodJob::Setting.pause(params[:type].to_sym => params[:value])
       redirect_to(good_job.pauses_path, notice: "Successfully paused #{params[:type]} '#{params[:value]}'")
     end
 
     def destroy
-      return redirect_to({ action: :index }) unless params[:type].in?(%w[queue job_class]) && params[:value].present?
+      return redirect_to({ action: :index }) unless params[:type].in?(%w[queue job_class label]) && params[:value].present?
 
       GoodJob::Setting.unpause(params[:type].to_sym => params[:value].to_s)
       redirect_to(good_job.pauses_path, notice: "Successfully unpaused #{params[:type]} '#{params[:value]}'")

app/models/good_job/job.rb

@@ -107,7 +107,20 @@ class Job < BaseRecord
       paused_query = GoodJob::Setting.where(key: GoodJob::Setting::PAUSES)
       paused_queues_query = paused_query.select("jsonb_array_elements_text(value->'queues')")
       paused_job_classes_query = paused_query.select("jsonb_array_elements_text(value->'job_classes')")
-      where.not(queue_name: paused_queues_query).where.not(job_class: paused_job_classes_query)
+      paused_labels_query = paused_query.select("jsonb_array_elements_text(value->'labels')")
+
+      where.not(queue_name: paused_queues_query)
+           .where.not(job_class: paused_job_classes_query)
+           .where(
+             Arel::Nodes::Not.new(
+               Arel::Nodes::NamedFunction.new(
+                 "COALESCE", [
+                   Arel::Nodes::InfixOperation.new('&&', arel_table['labels'], Arel::Nodes::NamedFunction.new('ARRAY', [paused_labels_query.arel])),
+                   Arel::Nodes::SqlLiteral.new('FALSE'),
+                 ]
+               )
+             )
+           )
     }
 
     # Order jobs by priority (highest priority first).

app/models/good_job/setting.rb

@@ -49,25 +49,28 @@ def self.cron_key_disable(key)
       disabled_setting.save!
     end
 
-    def self.pause(queue: nil, job_class: nil)
-      raise ArgumentError, "Must provide either queue or job_class, but not both" if queue.nil? == job_class.nil?
+    def self.pause(queue: nil, job_class: nil, label: nil)
+      raise ArgumentError, "Must provide exactly one of queue, job_class, or label" unless [queue, job_class, label].count(&:present?) == 1
 
       setting = find_or_initialize_by(key: PAUSES) do |record|
-        record.value = { "queues" => [], "job_classes" => [] }
+        record.value = { "queues" => [], "job_classes" => [], "labels" => [] }
       end
 
       if queue
         setting.value["queues"] ||= []
         setting.value["queues"] << queue.to_s unless setting.value["queues"].include?(queue.to_s)
-      else
+      elsif job_class
         setting.value["job_classes"] ||= []
         setting.value["job_classes"] << job_class.to_s unless setting.value["job_classes"].include?(job_class.to_s)
+      else
+        setting.value["labels"] ||= []
+        setting.value["labels"] << label.to_s unless setting.value["labels"].include?(label.to_s)
       end
       setting.save!
     end
 
-    def self.unpause(queue: nil, job_class: nil)
-      raise ArgumentError, "Must provide either queue or job_class, but not both" if queue.nil? == job_class.nil?
+    def self.unpause(queue: nil, job_class: nil, label: nil)
+      raise ArgumentError, "Must provide exactly one of queue, job_class, or label" unless [queue, job_class, label].count(&:present?) == 1
 
       setting = find_by(key: PAUSES)
       return unless setting
@@ -76,39 +79,49 @@ def self.unpause(queue: nil, job_class: nil)
         return unless setting.value["queues"]&.include?(queue.to_s)
 
         setting.value["queues"].delete(queue.to_s)
-      else
+      elsif job_class
         return unless setting.value["job_classes"]&.include?(job_class.to_s)
 
         setting.value["job_classes"].delete(job_class.to_s)
+      else
+        return unless setting.value["labels"]&.include?(label.to_s)
+
+        setting.value["labels"].delete(label.to_s)
       end
       setting.save!
     end
 
-    def self.paused?(queue: nil, job_class: nil)
-      raise ArgumentError, "Must provide either queue or job_class, or neither" if queue && job_class
+    def self.paused?(queue: nil, job_class: nil, label: nil)
+      raise ArgumentError, "Must provide at most one of queue, job_class, or label" if [queue, job_class, label].count(&:present?) > 1
 
       if queue
         queue.in? paused(:queues)
       elsif job_class
         job_class.in? paused(:job_classes)
+      elsif label
+        label.in? paused(:labels)
       else
         paused.values.any?(&:any?)
       end
     end
 
     def self.paused(type = nil)
       setting = find_by(key: PAUSES)
-      pauses = setting&.value&.deep_dup || { "queues" => [], "job_classes" => [] }
+      pauses = setting&.value&.deep_dup || { "queues" => [], "job_classes" => [], "labels" => [] }
       pauses = pauses.with_indifferent_access
 
-      if type == :queues
+      case type
+      when :queues
         pauses["queues"]
-      elsif type == :job_classes
+      when :job_classes
         pauses["job_classes"]
+      when :labels
+        pauses["labels"]
       else
         {
           queues: pauses["queues"] || [],
           job_classes: pauses["job_classes"] || [],
+          labels: pauses["labels"] || [],
         }
       end
     end

app/views/good_job/pauses/index.html.erb

@@ -14,6 +14,7 @@
           options_for_select([
                                [t('good_job.pauses.index.queue'), 'queue'],
                                [t('good_job.pauses.index.job_class'), 'job_class'],
+                               [t('good_job.pauses.index.label'), 'label'],
                              ]),
           class: 'form-select',
           required: true %>
@@ -31,3 +32,4 @@
 
 <%= render 'group', paused: @paused, type: :queue %>
 <%= render 'group', paused: @paused, type: :job_class %>
+<%= render 'group', paused: @paused, type: :label %>

config/locales/de.yml

@@ -219,6 +219,7 @@ de:
         confirm_pause: Sind Sie sicher, dass Sie %{value} pausieren möchten?
         confirm_unpause: Sind Sie sicher, dass Sie %{value} fortsetzen möchten?
         job_class: Job-Klasse
+        label: Label
         pause: Pausieren
         queue: Warteschlange
         title: Pausen

config/locales/en.yml

@@ -219,6 +219,7 @@ en:
         confirm_pause: Are you sure you want to pause %{value}?
         confirm_unpause: Are you sure you want to resume %{value}?
         job_class: Job Class
+        label: Label
         pause: Pause
         queue: Queue
         title: Pauses

config/locales/es.yml

@@ -218,7 +218,8 @@ es:
       index:
         confirm_pause: "¿Está seguro de que desea pausar %{value}?"
         confirm_unpause: "¿Está seguro de que desea reanudar %{value}?"
-        job_class: Clase de Trabajo
+        job_class: Clase de trabajo
+        label: Etiqueta
         pause: Pausar
         queue: Cola
         title: Pausas

config/locales/fr.yml

@@ -216,10 +216,11 @@ fr:
             unit: ''
     pauses:
       index:
-        confirm_pause: Êtes-vous sûr de vouloir mettre en pause %{value}     ?
+        confirm_pause: Êtes-vous sûr de vouloir mettre en pause %{value} ?
         confirm_unpause: Êtes-vous sûr de vouloir reprendre %{value} ?
-        job_class: Classe de Tâche
-        pause: Mettre en Pause
+        job_class: Classe de tâche
+        label: Étiquette
+        pause: Pause
         queue: File d'attente
         title: Pauses
         type: Type de Pause

config/locales/it.yml

@@ -218,8 +218,9 @@ it:
       index:
         confirm_pause: Sei sicuro di voler mettere in pausa %{value}?
         confirm_unpause: Sei sicuro di voler riprendere %{value}?
-        job_class: Classe del Job
-        pause: Metti in Pausa
+        job_class: Classe del job
+        label: Etichetta
+        pause: Pausa
         queue: Coda
         title: Pause
         type: Tipo di Pausa

config/locales/ja.yml

@@ -219,6 +219,7 @@ ja:
         confirm_pause: "%{value}を一時停止してもよろしいですか？"
         confirm_unpause: "%{value}を再開してもよろしいですか？"
         job_class: ジョブクラス
+        label: ラベル
         pause: 一時停止
         queue: キュー
         title: 一時停止

config/locales/ko.yml

@@ -219,8 +219,9 @@ ko:
         confirm_pause: "%{value}를 일시 중지하시겠습니까?"
         confirm_unpause: "%{value}를 재개하시겠습니까?"
         job_class: 작업 클래스
+        label: 라벨
         pause: 일시 중지
-        queue: 큐
+        queue: 대기열
         title: 일시 중지
         type: 중지 유형
         unpause: 재개

config/locales/nl.yml

@@ -218,7 +218,8 @@ nl:
       index:
         confirm_pause: Weet u zeker dat u %{value} wilt pauzeren?
         confirm_unpause: Weet u zeker dat u %{value} wilt hervatten?
-        job_class: Taak Klasse
+        job_class: Taakklasse
+        label: Label
         pause: Pauzeren
         queue: Wachtrij
         title: Pauzes

config/locales/pt-BR.yml

@@ -218,7 +218,8 @@ pt-BR:
       index:
         confirm_pause: Tem certeza que deseja pausar %{value}?
         confirm_unpause: Tem certeza que deseja retomar %{value}?
-        job_class: Classe do Job
+        job_class: Classe do trabalho
+        label: Rótulo
         pause: Pausar
         queue: Fila
         title: Pausas

config/locales/ru.yml

@@ -244,9 +244,10 @@ ru:
       index:
         confirm_pause: Вы уверены, что хотите приостановить %{value}?
         confirm_unpause: Вы уверены, что хотите возобновить %{value}?
-        job_class: Класс Задачи
+        job_class: Класс задачи
+        label: Метка
         pause: Приостановить
-        queue: Имя Очереди
+        queue: Очередь
         title: Паузы
         type: Тип Паузы
         unpause: Возобновить

config/locales/tr.yml

@@ -218,7 +218,8 @@ tr:
       index:
         confirm_pause: "%{value} duraklatmak istediğinizden emin misiniz?"
         confirm_unpause: "%{value} devam ettirmek istediğinizden emin misiniz?"
-        job_class: İş Sınıfı
+        job_class: İş sınıfı
+        label: Etiket
         pause: Duraklat
         queue: Kuyruk
         title: Duraklatmalar

config/locales/uk.yml

@@ -244,9 +244,10 @@ uk:
       index:
         confirm_pause: Ви впевнені, що хочете призупинити %{value}?
         confirm_unpause: Ви впевнені, що хочете відновити %{value}?
-        job_class: Клас Завдання
+        job_class: Клас завдання
+        label: Мітка
         pause: Призупинити
-        queue: Назва Черги
+        queue: Черга
         title: Паузи
         type: Тип Паузи
         unpause: Відновити

lib/good_job.rb

@@ -304,21 +304,23 @@ def self.pause(queue: nil, job_class: nil)
   # Unpause job execution for a given queue or job class.
   # @param queue [String, nil] Queue name to unpause
   # @param job_class [String, nil] Job class name to unpause
+  # @param label [String, nil] Label to unpause
   # @return [void]
-  def self.unpause(queue: nil, job_class: nil)
-    GoodJob::Setting.unpause(queue: queue, job_class: job_class)
+  def self.unpause(queue: nil, job_class: nil, label: nil)
+    GoodJob::Setting.unpause(queue: queue, job_class: job_class, label: label)
   end
 
   # Check if job execution is paused for a given queue or job class.
   # @param queue [String, nil] Queue name to check
   # @param job_class [String, nil] Job class name to check
+  # @param label [String, nil] Label to check
   # @return [Boolean]
-  def self.paused?(queue: nil, job_class: nil)
-    GoodJob::Setting.paused?(queue: queue, job_class: job_class)
+  def self.paused?(queue: nil, job_class: nil, label: nil)
+    GoodJob::Setting.paused?(queue: queue, job_class: job_class, label: label)
   end
 
   # Get a list of all paused queues and job classes
-  # @return [Hash] Hash with :queues and :job_classes arrays of paused items
+  # @return [Hash] Hash with :queues, :job_classes, :labels arrays of paused items
   def self.paused(type = nil)
     GoodJob::Setting.paused(type)
   end

spec/app/models/good_job/job_spec.rb

@@ -1075,6 +1075,8 @@ def job_params
       let!(:default_job) { described_class.create!(queue_name: "default", job_class: "DefaultJob") }
       let!(:mailers_job) { described_class.create!(queue_name: "mailers", job_class: "ActionMailer::MailDeliveryJob") }
       let!(:reports_job) { described_class.create!(queue_name: "reports", job_class: "ReportsJob") }
+      let!(:labeled_job) { described_class.create!(queue_name: "default", job_class: "DefaultJob", labels: %w[important urgent]) }
+      let!(:other_labeled_job) { described_class.create!(queue_name: "default", job_class: "DefaultJob", labels: ["low_priority"]) }
 
       before do
         allow(GoodJob.configuration).to receive(:enable_pause).and_return(enable_pause)
@@ -1084,15 +1086,16 @@ def job_params
         let(:enable_pause) { false }
 
         it 'returns all jobs' do
-          expect(described_class.exclude_paused).to contain_exactly(default_job, mailers_job, reports_job)
+          expect(described_class.exclude_paused).to contain_exactly(default_job, mailers_job, reports_job, labeled_job, other_labeled_job)
         end
       end
 
       context 'when enable_pause is true' do
         let(:enable_pause) { true }
 
         it 'returns all jobs when nothing is paused' do
-          expect(described_class.exclude_paused).to contain_exactly(default_job, mailers_job, reports_job)
+          expect(described_class.exclude_paused.count).to eq 5
+          expect(described_class.exclude_paused).to contain_exactly(default_job, mailers_job, reports_job, labeled_job, other_labeled_job)
         end
 
         it 'excludes jobs with paused queue_names' do
@@ -1104,18 +1107,43 @@ def job_params
         it 'excludes jobs with paused job_classes' do
           GoodJob::Setting.pause(job_class: "DefaultJob")
           GoodJob::Setting.pause(job_class: "ActionMailer::MailDeliveryJob")
+          expect(described_class.exclude_paused).to contain_exactly(reports_job)
+        end
 
-          puts described_class.exclude_paused.to_sql
+        it 'excludes jobs with paused labels' do
+          GoodJob::Setting.pause(label: "important")
+          expect(described_class.exclude_paused).to contain_exactly(default_job, mailers_job, reports_job, other_labeled_job)
+        end
 
-          expect(described_class.exclude_paused).to contain_exactly(reports_job)
+        it 'excludes jobs with any paused label when job has multiple labels' do
+          GoodJob::Setting.pause(label: "urgent")
+          expect(described_class.exclude_paused).to contain_exactly(default_job, mailers_job, reports_job, other_labeled_job)
         end
 
         it 'excludes jobs with both paused queue_names and job_classes' do
           GoodJob::Setting.pause(queue: "default")
           GoodJob::Setting.pause(job_class: "ActionMailer::MailDeliveryJob")
-
           expect(described_class.exclude_paused).to contain_exactly(reports_job)
         end
+
+        it 'excludes jobs with paused queue_names, job_classes, or labels' do
+          GoodJob::Setting.pause(queue: "reports")
+          GoodJob::Setting.pause(job_class: "ActionMailer::MailDeliveryJob")
+          GoodJob::Setting.pause(label: "important")
+          expect(described_class.exclude_paused).to contain_exactly(default_job, other_labeled_job)
+        end
+
+        it 'handles jobs with nil labels' do
+          GoodJob::Setting.pause(label: "important")
+          unlabeled_job = described_class.create!(queue_name: "default", job_class: "DefaultJob", labels: nil)
+          expect(described_class.exclude_paused).to include(unlabeled_job)
+        end
+
+        it 'handles jobs with empty labels array' do
+          GoodJob::Setting.pause(label: "important")
+          empty_labeled_job = described_class.create!(queue_name: "default", job_class: "DefaultJob", labels: [])
+          expect(described_class.exclude_paused).to include(empty_labeled_job)
+        end
       end
     end
   end