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

[Console] Add ability to schedule alarm signals and a ConsoleAlarmEvent #53533

Merged
merged 1 commit into from
Oct 6, 2024

Conversation

HypeMC
Copy link
Contributor

@HypeMC HypeMC commented Jan 13, 2024

Q A
Branch? 7.2
Bug fix? no
New feature? yes
Deprecations? no
Issues Fix #47920
License MIT

Part of #53508

This PR introduces the ability to schedule alarm signals and a console.alarm event. A command using this feature will automatically dispatch an alarm at the specified interval:

#[AsCommand('app:alarm')]
class AlarmCommand extends Command implements SignalableCommandInterface
{
    private bool $run = true;
    private int $count = 0;
    private OutputInterface $output;

    protected function initialize(InputInterface $input, OutputInterface $output): void
    {
        $this->getApplication()->setAlarmInterval(10);
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $this->output = $output;

        while ($this->run) {
            $this->count++;
            $output->writeln('execute '.$this->count);
            sleep(1);
        }

        $output->writeln('Done');

        return Command::SUCCESS;
    }

    public function getSubscribedSignals(): array
    {
        return [\SIGINT, \SIGALRM];
    }

    public function handleSignal(int $signal, false|int $previousExitCode = 0): int|false
    {
        if (\SIGINT === $signal) {
            $this->run = false;
            $this->output->writeln('Bye');
        } elseif (\SIGALRM === $signal) {
            $this->count = 0;
            $this->output->writeln('handleAlarm');
        }

        return false;
    }
}

The console.alarm event is dispatched on every SIGALRM signal:

#[AsEventListener(event: ConsoleAlarmEvent::class)]
final class ConsoleAlarmListener
{
    public function __invoke(ConsoleAlarmEvent $event): void
    {
        $event->getOutput()->writeln('ConsoleAlarmListener');
    }
}

src/Symfony/Component/Console/Command/TraceableCommand.php Outdated Show resolved Hide resolved
src/Symfony/Component/Console/Application.php Outdated Show resolved Hide resolved
src/Symfony/Component/Console/Application.php Outdated Show resolved Hide resolved
src/Symfony/Component/Console/Application.php Outdated Show resolved Hide resolved
@HypeMC HypeMC force-pushed the add-alarmable-command branch 2 times, most recently from 3496c6f to 26d9c59 Compare February 25, 2024 13:45
@valtzu
Copy link
Contributor

valtzu commented May 7, 2024

Btw, SIGALRM has the same effect as any other signal – it interrupts sleep & usleep. According to docs, one should check based on return code if the sleep was interrupted but I doubt many do that – and usleep returns void so for that it's impossible.

So if a command logic f.e. includes sleep(30); or $clock->sleep(30);, it will only sleep until next alarm, potentially causing unexpected behavior.


Another (old) thing I found that using SIGALRM to provide timer functionality may result in deadlock – not sure if it's still relevant (or if it ever was, for php).

@xabbuh xabbuh modified the milestones: 7.1, 7.2 May 15, 2024
Copy link
Contributor

@ro0NL ro0NL left a comment

Choose a reason for hiding this comment

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

cc @chalasr

we're running a userland implementation in prod, it works fine

@HypeMC HypeMC force-pushed the add-alarmable-command branch 2 times, most recently from d0507cd to 5c32d9c Compare September 17, 2024 23:14
@HypeMC HypeMC changed the title [Console] Add AlarmableCommandInterface and console.alarm event [Console] Add ability to schedule alarm signals and a console.alarm event Sep 17, 2024
Comment on lines -978 to +1002
if (!$this->signalRegistry) {
throw new RuntimeException('Unable to subscribe to signal events. Make sure that the "pcntl" extension is installed and that "pcntl_*" functions are not disabled by your php.ini\'s "disable_functions" directive.');
}
$signalRegistry = $this->getSignalRegistry();
Copy link
Contributor Author

Choose a reason for hiding this comment

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

getSignalRegistry throws a nearly identical exception, so it made sense to me to have it centralized.

Copy link
Member

@chalasr chalasr left a comment

Choose a reason for hiding this comment

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

The implementation is now much simpler, looks good to me 👍

@HypeMC HypeMC force-pushed the add-alarmable-command branch 3 times, most recently from 33fb7b7 to 5541f00 Compare September 26, 2024 14:58
@HypeMC HypeMC changed the title [Console] Add ability to schedule alarm signals and a console.alarm event [Console] Add ability to schedule alarm signals and a ConsoleAlarmEvent Sep 26, 2024
@fabpot
Copy link
Member

fabpot commented Oct 6, 2024

Thank you @HypeMC.

@fabpot fabpot merged commit 85380cf into symfony:7.2 Oct 6, 2024
8 of 10 checks passed
@HypeMC HypeMC deleted the add-alarmable-command branch October 6, 2024 10:12
chalasr added a commit that referenced this pull request Oct 7, 2024
…which messages are still being processed (HypeMC)

This PR was merged into the 7.2 branch.

Discussion
----------

[Console][Messenger] Asynchronously notify transports which messages are still being processed

| Q             | A
| ------------- | ---
| Branch?       | 7.2
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Issues        | -
| License       | MIT

Certain transports, such as Beanstalkd, have a timeout that determines how long a certain message is considered as "in progress". If the message is not acknowledged or rejected within that time period, it is returned to the "ready" queue.

This could cause potential issues when it takes a handler longer to finish processing the message. In those instances, the message being processed could be returned to the ready queue and taken by another instance of the receiver. This would result in the message being processed multiple times, or even worse, in an infinite loop.

Usually, transports that have a timeout also have the option to be notified that the message is still being processed, so the timeout can be postponed.

The idea of this PR is to utilize the `SignalableCommandInterface` and `pcntl_alarm()` to notify transports which messages are still being processed. Since the `SignalRegistry` has [asynchronous signals enabled](https://github.com/symfony/symfony/blob/34915f6e16f04537eb18d9d2c303ec375e63cc4b/src/Symfony/Component/Console/SignalRegistry/SignalRegistry.php#L21) by default, the whole process would happen asynchronously. I've named this feature "keepalive" for lack of a better name.

Currently, I've added this option only to the Beanstalkd transport since that's the one I'm familiar with and use, but as far as I was able to gather, at least one other transport supports this feature. Amazon SQS has a visibility timeout which can be [increased](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html#changing-message-visibility-timeout). This visibility timeout seems to be the same thing as Beanstalkd's TTR. (Disclaimer: I've never used Amazon SQS, so if I got something wrong, please let me know.)

I've split the PR into two commits so it would (hopefully) be easier to review:

1. I've extracted the first commit into a separate PR: #53533
2. The second commit adds the keepalive feature to the Messenger component.

Commits
-------

57b556a [Messenger] Notify transports which messages are still being processed, using `pcntl_alarm()`
@dkarlovi
Copy link
Contributor

Thanks for working on this @HypeMC!

@fabpot fabpot mentioned this pull request Oct 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Console] add console.alarm event
9 participants