Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[5.x] Add commands to pause and continue supervisors #914

Merged
merged 2 commits into from
Oct 23, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions src/Console/ContinueSupervisorCommand.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?php

namespace Laravel\Horizon\Console;

use Illuminate\Console\Command;
use Illuminate\Support\Str;
use Laravel\Horizon\Contracts\SupervisorRepository;
use Laravel\Horizon\MasterSupervisor;

class ContinueSupervisorCommand extends Command
{
/**
* The name and signature of the console command.
*
* @var string
*/
protected $signature = 'horizon:continue-supervisor
{name : The name of the supervisor to resume}';

/**
* The console command description.
*
* @var string
*/
protected $description = 'Instruct the supervisor to continue processing jobs';

/**
* Execute the console command.
*
* @param \Laravel\Horizon\Contracts\SupervisorRepository $supervisors
* @return void
*/
public function handle(SupervisorRepository $supervisors)
{
$processId = optional(collect($supervisors->all())->first(function ($supervisor) {
return Str::startsWith($supervisor->name, MasterSupervisor::basename())
&& Str::endsWith($supervisor->name, $this->argument('name'));
}))->pid;

if (is_null($processId)) {
$this->error('Failed to find a supervisor with this name');

return 1;
}

$this->info("Sending CONT Signal To Process: {$processId}");

if (! posix_kill($processId, SIGCONT)) {
$this->error("Failed to kill process: {$processId} (".posix_strerror(posix_get_last_error()).')');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Failed to kill process

Just a small feedback that this is not what's happening from the user perspective: we're not trying to send SIGKILL or SIGTERM here, maybe it should be rephrased to "Cant send signal SIGCONT to…" or so?

}
}
}
52 changes: 52 additions & 0 deletions src/Console/PauseSupervisorCommand.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?php

namespace Laravel\Horizon\Console;

use Illuminate\Console\Command;
use Illuminate\Support\Str;
use Laravel\Horizon\Contracts\SupervisorRepository;
use Laravel\Horizon\MasterSupervisor;

class PauseSupervisorCommand extends Command
{
/**
* The name and signature of the console command.
*
* @var string
*/
protected $signature = 'horizon:pause-supervisor
{name : The name of the supervisor to pause}';

/**
* The console command description.
*
* @var string
*/
protected $description = 'Pause a supervisor';

/**
* Execute the console command.
*
* @param \Laravel\Horizon\Contracts\SupervisorRepository $supervisors
* @return void
*/
public function handle(SupervisorRepository $supervisors)
{
$processId = optional(collect($supervisors->all())->first(function ($supervisor) {
return Str::startsWith($supervisor->name, MasterSupervisor::basename())
&& Str::endsWith($supervisor->name, $this->argument('name'));
}))->pid;

if (is_null($processId)) {
$this->error('Failed to find a supervisor with this name');

return 1;
}

$this->info("Sending USR2 Signal To Process: {$processId}");

if (! posix_kill($processId, SIGUSR2)) {
$this->error("Failed to kill process: {$processId} (".posix_strerror(posix_get_last_error()).')');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Failed to kill process

Basically the same feedback, something like "Cant send signal SIGUSR2 to…" 🤔

}
}
}
2 changes: 2 additions & 0 deletions src/HorizonServiceProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -173,11 +173,13 @@ protected function registerCommands()
$this->commands([
Console\ClearCommand::class,
Console\ContinueCommand::class,
Console\ContinueSupervisorCommand::class,
Console\ForgetFailedCommand::class,
Console\HorizonCommand::class,
Console\InstallCommand::class,
Console\ListCommand::class,
Console\PauseCommand::class,
Console\PauseSupervisorCommand::class,
Console\PublishCommand::class,
Console\PurgeCommand::class,
Console\StatusCommand::class,
Expand Down