pgbus 0.14.1 → 0.15.0

data/config/locales/en.yml

@@ -19,10 +19,10 @@ en:
         completed: Completed
         created_at: Created At
         details: Details
-        discarded: Discarded
+        failed: Failed
         finished_at: Finished At
         not_found: Batch not found
-        on_discard: On Discard
+        on_failure: On Failure
         on_finish: On Finish
         on_success: On Success
         progress: Progress
@@ -131,6 +131,7 @@ en:
         total_label: messages in dead letter queue
       show:
         back: Back to DLQ
+        context: Context
         discard: Discard
         discard_confirm: Permanently discard?
         headers: Headers
@@ -194,6 +195,7 @@ en:
         title: Events
       pending_table:
         arguments: Payload
+        context: Context
         discard: Discard
         discard_confirm: Discard this event? It will be archived.
         edit_payload: Edit & Retry
@@ -372,6 +374,7 @@ en:
       show:
         back: Back to Jobs
         backtrace: Backtrace
+        context: Context
         discard: Discard
         discard_confirm: Discard this job permanently?
         error_message: Error Message

data/config/locales/es.yml

@@ -19,10 +19,10 @@ es:
         completed: Completados
         created_at: Creado el
         details: Detalles
-        discarded: Descartados
+        failed: Fallados
         finished_at: Finalizado el
         not_found: Lote no encontrado
-        on_discard: Al descartar
+        on_failure: Al fallar
         on_finish: Al finalizar
         on_success: Al tener éxito
         progress: Progreso
@@ -131,6 +131,7 @@ es:
         total_label: mensajes en la cola de mensajes fallidos
       show:
         back: Volver a DLQ
+        context: Contexto
         discard: Descartar
         discard_confirm: "¿Descartar permanentemente?"
         headers: Encabezados
@@ -194,6 +195,7 @@ es:
         title: Eventos
       pending_table:
         arguments: Carga útil
+        context: Contexto
         discard: Descartar
         discard_confirm: "¿Descartar este evento? Será archivado."
         edit_payload: Editar y reintentar
@@ -372,6 +374,7 @@ es:
       show:
         back: Volver a Trabajos
         backtrace: Rastreo de pila
+        context: Contexto
         discard: Descartar
         discard_confirm: "¿Descartar este trabajo permanentemente?"
         error_message: Mensaje de error

data/config/locales/fi.yml

@@ -19,10 +19,10 @@ fi:
         completed: Valmiit
         created_at: Luotu
         details: Tiedot
-        discarded: Hylätyt
+        failed: Epäonnistuneet
         finished_at: Valmistunut
         not_found: Erää ei löytynyt
-        on_discard: Hylkäyksessä
+        on_failure: Epäonnistumisessa
         on_finish: Valmistumisessa
         on_success: Onnistumisessa
         progress: Edistyminen
@@ -131,6 +131,7 @@ fi:
         total_label: viestiä dead letter -jonossa
       show:
         back: Takaisin DLQ:hon
+        context: Konteksti
         discard: Hylkää
         discard_confirm: Hylätään pysyvästi?
         headers: Otsikot
@@ -194,6 +195,7 @@ fi:
         title: Tapahtumat
       pending_table:
         arguments: Kuorma
+        context: Konteksti
         discard: Hylkää
         discard_confirm: Hylätäänkö tämä tapahtuma? Se arkistoidaan.
         edit_payload: Muokkaa ja yritä uudelleen
@@ -372,6 +374,7 @@ fi:
       show:
         back: Takaisin töihin
         backtrace: Takautumisketju
+        context: Konteksti
         discard: Hylkää
         discard_confirm: Hylkää tämä työ pysyvästi?
         error_message: Virheilmoitus

data/config/locales/fr.yml

@@ -19,10 +19,10 @@ fr:
         completed: Terminées
         created_at: Créé le
         details: Détails
-        discarded: Rejetées
+        failed: Échouées
         finished_at: Terminé le
         not_found: Lot non trouvé
-        on_discard: Au rejet
+        on_failure: En cas d'échec
         on_finish: À la fin
         on_success: Au succès
         progress: Progression
@@ -131,6 +131,7 @@ fr:
         total_label: messages dans la file de lettres mortes
       show:
         back: Retour à la DLQ
+        context: Contexte
         discard: Ignorer
         discard_confirm: Ignorer définitivement ?
         headers: En-têtes
@@ -194,6 +195,7 @@ fr:
         title: Événements
       pending_table:
         arguments: Charge utile
+        context: Contexte
         discard: Jeter
         discard_confirm: Jeter cet événement ? Il sera archivé.
         edit_payload: Modifier & Réessayer
@@ -372,6 +374,7 @@ fr:
       show:
         back: Retour aux travaux
         backtrace: Trace de la pile
+        context: Contexte
         discard: Ignorer
         discard_confirm: Supprimer ce travail définitivement ?
         error_message: Message d'erreur

data/config/locales/it.yml

@@ -19,10 +19,10 @@ it:
         completed: Completati
         created_at: Creato il
         details: Dettagli
-        discarded: Scartati
+        failed: Falliti
         finished_at: Terminato il
         not_found: Lotto non trovato
-        on_discard: Allo scarto
+        on_failure: Al fallimento
         on_finish: Al termine
         on_success: Al successo
         progress: Progresso
@@ -131,6 +131,7 @@ it:
         total_label: messaggi nella coda dei messaggi non recapitati
       show:
         back: Torna a DLQ
+        context: Contesto
         discard: Scarta
         discard_confirm: Scartare definitivamente?
         headers: Intestazioni
@@ -194,6 +195,7 @@ it:
         title: Eventi
       pending_table:
         arguments: Payload
+        context: Contesto
         discard: Scarta
         discard_confirm: Scartare questo evento? Verrà archiviato.
         edit_payload: Modifica e riprova
@@ -372,6 +374,7 @@ it:
       show:
         back: Torna ai Lavori
         backtrace: Traccia dello stack
+        context: Contesto
         discard: Scarta
         discard_confirm: Scartare definitivamente questo lavoro?
         error_message: Messaggio di errore

data/config/locales/ja.yml

@@ -19,10 +19,10 @@ ja:
         completed: 完了
         created_at: 作成日時
         details: 詳細
-        discarded: 破棄済み
+        failed: 失敗
         finished_at: 完了日時
         not_found: バッチが見つかりません
-        on_discard: 破棄時
+        on_failure: 失敗時
         on_finish: 完了時
         on_success: 成功時
         progress: 進捗
@@ -131,6 +131,7 @@ ja:
         total_label: デッドレターキュー内のメッセージ
       show:
         back: DLQに戻る
+        context: コンテキスト
         discard: 破棄
         discard_confirm: 完全に破棄しますか？
         headers: ヘッダー
@@ -194,6 +195,7 @@ ja:
         title: イベント
       pending_table:
         arguments: ペイロード
+        context: コンテキスト
         discard: 破棄
         discard_confirm: このイベントを破棄しますか？アーカイブされます。
         edit_payload: 編集して再試行
@@ -372,6 +374,7 @@ ja:
       show:
         back: ジョブに戻る
         backtrace: バックトレース
+        context: コンテキスト
         discard: 破棄
         discard_confirm: このジョブを完全に破棄しますか？
         error_message: エラーメッセージ

data/config/locales/nb.yml

@@ -19,10 +19,10 @@ nb:
         completed: Fullført
         created_at: Opprettet den
         details: Detaljer
-        discarded: Forkastet
+        failed: Mislyktes
         finished_at: Avsluttet den
         not_found: Gruppe ikke funnet
-        on_discard: Ved forkastning
+        on_failure: Ved feil
         on_finish: Ved avslutning
         on_success: Ved suksess
         progress: Fremdrift
@@ -131,6 +131,7 @@ nb:
         total_label: meldinger i dead letter-kø
       show:
         back: Tilbake til DLQ
+        context: Kontekst
         discard: Forkast
         discard_confirm: Forkaste permanent?
         headers: Overskrifter
@@ -194,6 +195,7 @@ nb:
         title: Hendelser
       pending_table:
         arguments: Nyttelast
+        context: Kontekst
         discard: Forkast
         discard_confirm: Forkast denne hendelsen? Den vil bli arkivert.
         edit_payload: Rediger & prøv på nytt
@@ -372,6 +374,7 @@ nb:
       show:
         back: Tilbake til jobber
         backtrace: Tilbakekalling
+        context: Kontekst
         discard: Forkast
         discard_confirm: Slett denne jobben permanent?
         error_message: Feilmelding

data/config/locales/nl.yml

@@ -19,10 +19,10 @@ nl:
         completed: Voltooid
         created_at: Aangemaakt op
         details: Details
-        discarded: Verworpen
+        failed: Mislukt
         finished_at: Voltooid op
         not_found: Groep niet gevonden
-        on_discard: Bij verwerping
+        on_failure: Bij mislukking
         on_finish: Bij voltooiing
         on_success: Bij succes
         progress: Voortgang
@@ -131,6 +131,7 @@ nl:
         total_label: berichten in dead letter-wachtrij
       show:
         back: Terug naar DLQ
+        context: Context
         discard: Verwerpen
         discard_confirm: Permanent verwerpen?
         headers: Headers
@@ -194,6 +195,7 @@ nl:
         title: Gebeurtenissen
       pending_table:
         arguments: Payload
+        context: Context
         discard: Verwijderen
         discard_confirm: Deze gebeurtenis verwijderen? Deze wordt gearchiveerd.
         edit_payload: Bewerken & Opnieuw Proberen
@@ -372,6 +374,7 @@ nl:
       show:
         back: Terug naar Taken
         backtrace: Stacktrace
+        context: Context
         discard: Verwijderen
         discard_confirm: Deze taak permanent verwijderen?
         error_message: Foutmelding

data/config/locales/pt.yml

@@ -19,10 +19,10 @@ pt:
         completed: Concluídos
         created_at: Criado em
         details: Detalhes
-        discarded: Descartados
+        failed: Falhados
         finished_at: Finalizado em
         not_found: Lote não encontrado
-        on_discard: Ao descartar
+        on_failure: Ao falhar
         on_finish: Ao finalizar
         on_success: Ao ter sucesso
         progress: Progresso
@@ -131,6 +131,7 @@ pt:
         total_label: mensagens na fila de mensagens mortas
       show:
         back: Voltar para DLQ
+        context: Contexto
         discard: Descartar
         discard_confirm: Descartar permanentemente?
         headers: Cabeçalhos
@@ -194,6 +195,7 @@ pt:
         title: Eventos
       pending_table:
         arguments: Payload
+        context: Contexto
         discard: Descartar
         discard_confirm: Descartar este evento? Ele será arquivado.
         edit_payload: Editar e Tentar Novamente
@@ -372,6 +374,7 @@ pt:
       show:
         back: Voltar para Trabalhos
         backtrace: Rastreamento de Pilha
+        context: Contexto
         discard: Descartar
         discard_confirm: Descartar este trabalho permanentemente?
         error_message: Mensagem de Erro

data/config/locales/sv.yml

@@ -19,10 +19,10 @@ sv:
         completed: Slutförda
         created_at: Skapad den
         details: Detaljer
-        discarded: Kasserade
+        failed: Misslyckades
         finished_at: Avslutad den
         not_found: Grupp hittades inte
-        on_discard: Vid kassering
+        on_failure: Vid misslyckande
         on_finish: Vid avslut
         on_success: Vid framgång
         progress: Framsteg
@@ -131,6 +131,7 @@ sv:
         total_label: meddelanden i dead letter-kö
       show:
         back: Tillbaka till DLQ
+        context: Kontext
         discard: Kassera
         discard_confirm: Kassera permanent?
         headers: Rubriker
@@ -194,6 +195,7 @@ sv:
         title: Händelser
       pending_table:
         arguments: Payload
+        context: Kontext
         discard: Kassera
         discard_confirm: Kassera denna händelse? Den kommer att arkiveras.
         edit_payload: Redigera & Försök igen
@@ -372,6 +374,7 @@ sv:
       show:
         back: Tillbaka till jobb
         backtrace: Backtrace
+        context: Kontext
         discard: Kassera
         discard_confirm: Kassera detta jobb permanent?
         error_message: Felmeddelande

data/lib/generators/pgbus/add_batch_callback_jobs_generator.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record"
+require_relative "migration_path"
+
+module Pgbus
+  module Generators
+    class AddBatchCallbackJobsGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+      include MigrationPath
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Add jsonb callback-job columns to pgbus_batches (issue #415)"
+
+      class_option :database,
+                   type: :string,
+                   default: nil,
+                   desc: "Use a separate database for pgbus tables (e.g. --database=pgbus)"
+
+      def create_migration_file
+        migration_template "add_batch_callback_jobs.rb.erb",
+                           File.join(pgbus_migrate_path, "add_pgbus_batch_callback_jobs.rb")
+      end
+
+      def display_post_install
+        say ""
+        say "Pgbus configured batch callbacks installed!", :green
+        say ""
+        say "Next steps:"
+        say "  1. Run: rails db:migrate#{migrate_command_suffix}"
+        say "  2. Restart pgbus: bin/pgbus start"
+        say ""
+        say "You can now pass a configured ActiveJob instance to a batch:"
+        say "  Pgbus::Batch.new(on_finish: ReportJob.new.set(queue: :critical, wait: 5.minutes))"
+        say ""
+      end
+
+      private
+
+      def migration_version
+        "[#{ActiveRecord::Migration.current_version}]"
+      end
+    end
+  end
+end

data/lib/generators/pgbus/add_batch_executions_generator.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record"
+require_relative "migration_path"
+
+module Pgbus
+  module Generators
+    class AddBatchExecutionsGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+      include MigrationPath
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Add pgbus_batch_executions and rename batch failure columns (issue #414)"
+
+      class_option :database,
+                   type: :string,
+                   default: nil,
+                   desc: "Use a separate database for pgbus tables (e.g. --database=pgbus)"
+
+      def create_migration_file
+        migration_template "add_batch_executions.rb.erb",
+                           File.join(pgbus_migrate_path, "add_pgbus_batch_executions.rb")
+      end
+
+      def display_post_install
+        say ""
+        say "Pgbus batch execution-row tracking installed!", :green
+        say ""
+        say "Next steps:"
+        say "  1. Run: rails db:migrate#{migrate_command_suffix}"
+        say "  2. Restart pgbus: bin/pgbus start"
+        say ""
+      end
+
+      private
+
+      def migration_version
+        "[#{ActiveRecord::Migration.current_version}]"
+      end
+    end
+  end
+end

data/lib/generators/pgbus/templates/add_batch_callback_jobs.rb.erb

@@ -0,0 +1,13 @@
+class AddPgbusBatchCallbackJobs < ActiveRecord::Migration<%= migration_version %>
+  def up
+    add_column :pgbus_batches, :on_finish_job, :jsonb unless column_exists?(:pgbus_batches, :on_finish_job)
+    add_column :pgbus_batches, :on_success_job, :jsonb unless column_exists?(:pgbus_batches, :on_success_job)
+    add_column :pgbus_batches, :on_failure_job, :jsonb unless column_exists?(:pgbus_batches, :on_failure_job)
+  end
+
+  def down
+    remove_column :pgbus_batches, :on_finish_job if column_exists?(:pgbus_batches, :on_finish_job)
+    remove_column :pgbus_batches, :on_success_job if column_exists?(:pgbus_batches, :on_success_job)
+    remove_column :pgbus_batches, :on_failure_job if column_exists?(:pgbus_batches, :on_failure_job)
+  end
+end

data/lib/generators/pgbus/templates/add_batch_executions.rb.erb

@@ -0,0 +1,50 @@
+class AddPgbusBatchExecutions < ActiveRecord::Migration<%= migration_version %>
+  def up
+    create_table :pgbus_batch_executions do |t|
+      t.string :batch_id, null: false
+      t.string :job_id, null: false
+      t.bigint :msg_id
+      t.string :queue_name
+      t.datetime :created_at, null: false, default: -> { "CURRENT_TIMESTAMP" }
+    end
+
+    add_index :pgbus_batch_executions, :job_id,
+      unique: true, name: "idx_pgbus_batch_executions_job_id"
+    add_index :pgbus_batch_executions, :batch_id,
+      name: "idx_pgbus_batch_executions_batch_id"
+    add_index :pgbus_batch_executions, :created_at,
+      where: "msg_id IS NULL",
+      name: "idx_pgbus_batch_executions_orphans"
+    add_foreign_key :pgbus_batch_executions, :pgbus_batches,
+      column: :batch_id, primary_key: :batch_id, on_delete: :cascade
+
+    if column_exists?(:pgbus_batches, :on_discard_class) && !column_exists?(:pgbus_batches, :on_failure_class)
+      rename_column :pgbus_batches, :on_discard_class, :on_failure_class
+    end
+
+    # Drain/restart pgbus workers after this migration: a process that still
+    # writes discarded_jobs will error once the column is gone.
+    if column_exists?(:pgbus_batches, :discarded_jobs)
+      if column_exists?(:pgbus_batches, :failed_jobs)
+        execute "UPDATE pgbus_batches SET failed_jobs = failed_jobs + discarded_jobs"
+        remove_column :pgbus_batches, :discarded_jobs
+      else
+        rename_column :pgbus_batches, :discarded_jobs, :failed_jobs
+      end
+    end
+  end
+
+  def down
+    unless column_exists?(:pgbus_batches, :discarded_jobs)
+      add_column :pgbus_batches, :discarded_jobs, :integer, null: false, default: 0
+      if column_exists?(:pgbus_batches, :failed_jobs)
+        execute "UPDATE pgbus_batches SET discarded_jobs = failed_jobs"
+        execute "UPDATE pgbus_batches SET failed_jobs = 0"
+      end
+    end
+    if column_exists?(:pgbus_batches, :on_failure_class) && !column_exists?(:pgbus_batches, :on_discard_class)
+      rename_column :pgbus_batches, :on_failure_class, :on_discard_class
+    end
+    drop_table :pgbus_batch_executions if table_exists?(:pgbus_batch_executions)
+  end
+end

data/lib/generators/pgbus/templates/initializer.rb.erb

@@ -44,6 +44,8 @@ Pgbus.configure do |c|
 
   # --- Dispatcher (maintenance tasks) ------------------------------------
   # c.dispatch_interval = 1.0
+  # c.batch_retention = 7.days          # finished-batch cleanup; nil disables
+  # c.batch_sweep_interval = 5.minutes  # stalled-batch repair sweep
 
   # --- Realtime broadcast isolation (turbo-rails) ------------------------
   # Route turbo-rails' async render+broadcast jobs to a dedicated queue so a

data/lib/generators/pgbus/templates/migration.rb.erb

@@ -104,12 +104,14 @@ class CreatePgbusTables < ActiveRecord::Migration<%= migration_version %>
       t.string :description
       t.string :on_finish_class
       t.string :on_success_class
-      t.string :on_discard_class
+      t.string :on_failure_class
+      t.jsonb :on_finish_job
+      t.jsonb :on_success_job
+      t.jsonb :on_failure_job
       t.jsonb :properties, default: {}
       t.integer :total_jobs, null: false, default: 0
       t.integer :completed_jobs, null: false, default: 0
       t.integer :failed_jobs, null: false, default: 0
-      t.integer :discarded_jobs, null: false, default: 0
       t.string :status, null: false, default: "pending"
       t.datetime :created_at, null: false, default: -> { "CURRENT_TIMESTAMP" }
       t.datetime :finished_at
@@ -120,6 +122,24 @@ class CreatePgbusTables < ActiveRecord::Migration<%= migration_version %>
     add_index :pgbus_batches, :status,
       name: "idx_pgbus_batches_status"
 
+    create_table :pgbus_batch_executions do |t|
+      t.string :batch_id, null: false
+      t.string :job_id, null: false
+      t.bigint :msg_id
+      t.string :queue_name
+      t.datetime :created_at, null: false, default: -> { "CURRENT_TIMESTAMP" }
+    end
+
+    add_index :pgbus_batch_executions, :job_id,
+      unique: true, name: "idx_pgbus_batch_executions_job_id"
+    add_index :pgbus_batch_executions, :batch_id,
+      name: "idx_pgbus_batch_executions_batch_id"
+    add_index :pgbus_batch_executions, :created_at,
+      where: "msg_id IS NULL",
+      name: "idx_pgbus_batch_executions_orphans"
+    add_foreign_key :pgbus_batch_executions, :pgbus_batches,
+      column: :batch_id, primary_key: :batch_id, on_delete: :cascade
+
     # Recurring task definitions (synced from config/recurring.yml)
     create_table :pgbus_recurring_tasks do |t|
       t.string :key, null: false
@@ -186,6 +206,7 @@ class CreatePgbusTables < ActiveRecord::Migration<%= migration_version %>
     drop_table :pgbus_stream_queues
     drop_table :pgbus_recurring_executions
     drop_table :pgbus_recurring_tasks
+    drop_table :pgbus_batch_executions
     drop_table :pgbus_batches
     drop_table :pgbus_blocked_executions
     drop_table :pgbus_semaphores