Puma plugin in async mode: jobs that finish while Puma stops go back to the queue
Les mainteneurs répondent en général sous 4 jours
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Accessibilité débutants
- 72/100
- Type d'issue
- Bug
- Clarté
- Clairement spécifiée
- Activité
- Active
- Domaine
- backend, distributed-systems
Piste de recherche
Lisez le cycle de vie du plugin Puma dans test/integration/puma/plugin_testing.rb et les callbacks d’arrêt de AsyncSupervisor décrits dans l’issue. Exécutez la reproduction fournie avec TARGET_DB=sqlite bin/rails test test/integration/puma/plugin_stop_repro_test.rb ; elle devrait réussir avec le mode async. L’issue mentionne également test/integration/async_processes_lifecycle_test.rb et les tests du plugin Puma comme tests de régression.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
With solid_queue_mode :async, stopping Puma while a job runs lets the job finish. But the job isn't recorded as finished: it goes back to its queue and runs again, either on the next start or, sometimes, right away before the process exits. This happens even when the job finishes well within shutdown_timeout, so it isn't the timeout case that #815 handles.
Reproduction
On main (b9c646a, 1.7.2, which includes #815). This is a test in the style of the existing plugin tests (test/integration/puma/plugin_testing.rb):
# test/integration/puma/plugin_stop_repro_test.rb
require "test_helper"
require_relative "plugin_testing"
ENV["SOLID_QUEUE_SKIP_RECURRING"] = "true"
class PluginAsyncStopReproTest < ActiveSupport::TestCase
include PluginTesting
test "a job finishing within the shutdown timeout while puma stops is recorded as finished" do
active_job = StoreResultJob.perform_later(:stop, pause: 1.second)
job = SolidQueue::Job.find_by!(active_job_id: active_job.job_id)
wait_while_with_timeout(5.seconds) { skip_active_record_query_cache { job.reload.claimed_execution.nil? } }
terminate_process(@pid, signal: :TERM)
skip_active_record_query_cache do
assert_equal 1, JobResult.where(value: :stop, status: "completed").count
assert job.reload.finished?
assert_nil job.ready_execution
end
end
private
def solid_queue_mode = :async
end
TARGET_DB=sqlite bin/rails test test/integration/puma/plugin_stop_repro_test.rb fails in 5 of 5 runs, and the same with TARGET_DB=mysql and TARGET_DB=postgres. Each run ends one of two ways:
finished=0 ready=1: the job ran once but is back in the queue; or- two completed
JobResults: it ran twice before Puma exited.
The same test with solid_queue_mode :fork passes every time. The test dummy's shutdown_timeout is 2 seconds; the job takes 1.
Cause
When Puma stops, the plugin calls stop on the embedded AsyncSupervisor, whose run loop then runs the shutdown callbacks. after_shutdown callbacks run in the order they were defined:
Registrable's:deregistercomes first. Deregistering the supervisor also deregisters its supervisees, which releases the workers' claimed executions while their jobs are still running.AsyncSupervisor'safter_shutdown :terminate_gracefully, unless: :standalone?comes after it, and only then waits for the threads.
By the time a job finishes, its claimed execution is gone. So the job's finished transaction doesn't record it, and the job is already back in the ready list, where a worker thread that hasn't stopped polling yet can claim it again.
The standalone async supervisor (bin/jobs --mode async) isn't affected: on TERM or INT, its signal handling calls terminate_gracefully before shutdown.
Possible fix
Wait for the threads before deregistering. One line:
- after_shutdown :terminate_gracefully, unless: :standalone?
+ before_shutdown :terminate_gracefully, unless: :standalone?
With that change, the reproduction passes 5 of 5 times on each of the three databases. test/integration/async_processes_lifecycle_test.rb and the Puma plugin tests pass too, locally. Happy to open a PR with the test.
- Langage dominant
- Ruby
- Étoiles
- 2.5k
- Forks
- 271
- Merge moyen
- 5 j 6 h
- PR mergées (30 j)
- 5
Préparer son environnement
Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.
- Fournit un Dockerfile ou un fichier Docker Compose
- Aucun modèle de pull request
- Aucun guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de rails/solid_queue
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 45/100
rails/solid_queue#836 ·
Les mainteneurs répondent en général sous 4 jours
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
rails/solid_queue#834 · 1 commentaire ·
Les mainteneurs répondent en général sous 4 jours
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
rails/solid_queue#824 · 1 réaction ·
Les mainteneurs répondent en général sous 4 jours
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 42/100
rails/solid_queue#808 · 3 commentaires ·
Les mainteneurs répondent en général sous 4 jours
-
Difficulté 4/5 3-5 jours Accessibilité débutants 45/100
rails/solid_queue#806 ·
Les mainteneurs répondent en général sous 4 jours
Toutes les issues de rails/solid_queue
Issues similaires
-
開発用DockerイメージにPlaywrightのシステム依存を追加するPeut-être pris @momocus l’a pris aujourd’hui. Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 85/100
sakazuki-org/sakazuki#1453 ·
Les mainteneurs répondent en général sous 3 jours
-
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
jenkins-infra/jenkins.io#9615 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
fix(ocr): compile the Tesseract-free pipeline with Tokio runtimePeut-être pris @Goldziher l’a pris aujourd’hui. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
Les mainteneurs répondent en général sous 1 jour
-
Metric tooltips that contradict how the metric is calculatedPeut-être pris @aniadeadu l’a pris aujourd’hui. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
WikiEducationFoundation/WikiEduDashboard#7303 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
WhatsApp Cloud template sync saves a partial template list when one page of the Graph API response failsPeut-être pris Une pull request liée à cette issue est ouverte ou déjà fusionnée. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
Les mainteneurs répondent en général sous 2 jours