Skip to content
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
4 changes: 4 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
],
"require": {
"php": "~8.2.0 || ~8.3.0 || ~8.4.0 || ~8.5.0",
"psr/log": "^1.1 || ^2.0 || ^3.0",
"symfony/event-dispatcher": "^5.4.26 || ^6.4.0 || ^7.0.0 || ^8.0.0"
},
"require-dev": {
Expand All @@ -33,6 +34,9 @@
"symfony/var-dumper": "^5.4.29 || ^6.4.0 || ^7.0.0 || ^8.0.0",
"wnx/commonmark-markdown-renderer": "^1.6"
},
"suggest": {
"ext-pcntl": "Required to stop the worker gracefully on SIGTERM"
},
"config": {
"preferred-install": {
"*": "dist"
Expand Down
102 changes: 51 additions & 51 deletions composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/Listener/StopWorkerOnMemoryLimitListener.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public function onWorkerRunning(WorkerRunningEvent $event): void
}

$this->logger?->info(
'Worker stopped due to memory limit of {limit} bytes exceeded ({memory} bytes used)',
'Worker stopped due to memory limit of {limit} exceeded ({memory} used)',
['limit' => $this->memoryLimit->formatted(), 'memory' => $usedMemory->formatted()],
);

Expand Down
3 changes: 3 additions & 0 deletions src/Listener/StopWorkerOnSigtermSignalListener.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

use function function_exists;
use function pcntl_async_signals;
use function pcntl_signal;

use const SIGTERM;
Expand All @@ -22,6 +23,8 @@ public function __construct(

public function onWorkerStarted(WorkerStartedEvent $event): void
{
pcntl_async_signals(true);

pcntl_signal(SIGTERM, function () use ($event): void {
$this->logger?->info('Received SIGTERM signal.');
$event->worker->stop();
Expand Down
2 changes: 1 addition & 1 deletion src/Worker.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

interface Worker
{
/** @param 0|positive-int $sleepTimer sleepTimer in microseconds */
/** @param 0|positive-int $sleepTimer sleepTimer in milliseconds */
public function run(int $sleepTimer = 1000): void;

public function stop(): void;
Expand Down
66 changes: 66 additions & 0 deletions tests/Unit/Listener/StopWorkerOnSigtermSignalListenerTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
<?php

declare(strict_types=1);

namespace Patchlevel\Worker\Tests\Unit\Listener;

use Patchlevel\Worker\DefaultWorker;
use Patchlevel\Worker\Listener\StopWorkerOnSigtermSignalListener;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\RequiresFunction;
use PHPUnit\Framework\TestCase;
use Psr\Log\LoggerInterface;
use Symfony\Component\EventDispatcher\EventDispatcher;

use function getmypid;
use function pcntl_signal;
use function posix_kill;

use const SIG_DFL;
use const SIGTERM;

#[CoversClass(StopWorkerOnSigtermSignalListener::class)]
#[RequiresFunction('pcntl_signal')]
#[RequiresFunction('posix_kill')]
final class StopWorkerOnSigtermSignalListenerTest extends TestCase
{
protected function tearDown(): void
{
pcntl_signal(SIGTERM, SIG_DFL);
}

public function testStopOnSigterm(): void
{
$logger = $this->createMock(LoggerInterface::class);
$logger
->expects($this->once())
->method('info')
->with('Received SIGTERM signal.');

$eventDispatcher = new EventDispatcher();
$eventDispatcher->addSubscriber(new StopWorkerOnSigtermSignalListener($logger));

$calls = 0;

$worker = new DefaultWorker(
static function (callable $stop) use (&$calls): void {
$calls++;

if ($calls === 1) {
posix_kill((int)getmypid(), SIGTERM);
}

if ($calls < 5) {
return;
}

$stop();
},
$eventDispatcher,
);

$worker->run(0);

self::assertSame(1, $calls);
}
}
Loading