From 65428ad3f4c9f2c6dd5a14d6882351e55ca4e016 Mon Sep 17 00:00:00 2001
From: Markus Klein <markus.klein@typo3.org>
Date: Thu, 23 Feb 2023 13:07:10 +0100
Subject: [PATCH] [BUGFIX] Output errors to CLI in scheduler:run command
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Whenever a scheduler task fails during execution
via CLI `scheduler:run`, the error message is
now always written to stderr.
This gives the task executor (e.g. cron) a chance
to identify any failures, if even stdout is
redirected to /dev/null.
The task-loop is adapted to avoid (ab)using
exceptions for control-flow (for loop-abortion).
It instead now uses nullables to signal that
not finding a next-task is expected behavior,
not an exception.
Also the exit code of the command is adapted
to switch to 1 in case at least one error
occured. (This is important in case the cronjob
is executed as systemd-timer)
Resolves: #87806
Releases: main, 11.5
Change-Id: I0b55bab7fcd916209114d9e3e07f54c7243ce9a5
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/77936
Reviewed-by: Stephan Großberndt <stephan.grossberndt@typo3.org>
Reviewed-by: Markus Klein <markus.klein@typo3.org>
Tested-by: Benjamin Franzke <benjaminfranzke@gmail.com>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: core-ci <typo3@b13.com>
Reviewed-by: Christoph Lehmann <christoph.lehmann@networkteam.com>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Reviewed-by: Benjamin Franzke <benjaminfranzke@gmail.com>
---
.../Classes/Command/SchedulerCommand.php | 38 ++++++++-----------
.../Repository/SchedulerTaskRepository.php | 6 +--
typo3/sysext/scheduler/Classes/Scheduler.php | 4 +-
3 files changed, 19 insertions(+), 29 deletions(-)
diff --git a/typo3/sysext/scheduler/Classes/Command/SchedulerCommand.php b/typo3/sysext/scheduler/Classes/Command/SchedulerCommand.php
index 7c5cee004a76..13264842d22b 100644
--- a/typo3/sysext/scheduler/Classes/Command/SchedulerCommand.php
+++ b/typo3/sysext/scheduler/Classes/Command/SchedulerCommand.php
@@ -32,11 +32,6 @@ use TYPO3\CMS\Scheduler\Validation\Validator\TaskValidator;
*/
class SchedulerCommand extends Command
{
- /**
- * @var bool
- */
- protected $hasTask = true;
-
/**
* @var SymfonyStyle
*/
@@ -118,8 +113,7 @@ Call it like this: typo3/sysext/core/bin/typo3 scheduler:run --task=13 -f')
$this->forceExecution = (bool)$input->getOption('force');
$this->stopTasks = $this->shouldStopTasks((bool)$input->getOption('stop'));
- $this->loopTasks();
- return Command::SUCCESS;
+ return $this->loopTasks() ? Command::SUCCESS : Command::FAILURE;
}
/**
@@ -172,38 +166,37 @@ Call it like this: typo3/sysext/core/bin/typo3 scheduler:run --task=13 -f')
/**
* Execute tasks in loop that are ready to execute
*/
- protected function loopTasks()
+ protected function loopTasks(): bool
{
+ $hasError = false;
do {
+ $task = null;
// Try getting the next task and execute it
// If there are no more tasks to execute, an exception is thrown by \TYPO3\CMS\Scheduler\Scheduler::fetchTask()
try {
$task = $this->fetchNextTask();
+ if ($task === null) {
+ break;
+ }
try {
$this->executeOrStopTask($task);
} catch (\Exception $e) {
- if ($this->io->isVerbose()) {
- $this->io->warning($e->getMessage());
- }
+ $this->io->getErrorStyle()->error($e->getMessage());
+ $hasError = true;
// We ignore any exception that may have been thrown during execution,
// as this is a background process.
// The exception message has been recorded to the database anyway
continue;
}
- } catch (\OutOfBoundsException $e) {
- if ($this->io->isVeryVerbose()) {
- $this->io->writeln($e->getMessage());
- }
- $this->hasTask = !empty($this->overwrittenTaskList);
} catch (\UnexpectedValueException $e) {
- if ($this->io->isVerbose()) {
- $this->io->warning($e->getMessage());
- }
+ $this->io->getErrorStyle()->error($e->getMessage());
+ $hasError = true;
continue;
}
- } while ($this->hasTask);
+ } while ($task !== null);
// Record the run in the system registry
$this->scheduler->recordLastRun();
+ return !$hasError;
}
/**
@@ -212,17 +205,16 @@ Call it like this: typo3/sysext/core/bin/typo3 scheduler:run --task=13 -f')
*
* Without the --task option we ask the scheduler for the next task with pending execution.
*
- * @throws \OutOfBoundsException When there are no more tasks to execute.
* @throws \UnexpectedValueException When no task is found by the provided UID or the task is not marked for execution.
*/
- protected function fetchNextTask(): AbstractTask
+ protected function fetchNextTask(): ?AbstractTask
{
if ($this->overwrittenTaskList === null) {
return $this->taskRepository->findNextExecutableTask();
}
if (count($this->overwrittenTaskList) === 0) {
- throw new \OutOfBoundsException('No more tasks to execute', 1547675594);
+ return null;
}
$taskUid = (int)array_shift($this->overwrittenTaskList);
diff --git a/typo3/sysext/scheduler/Classes/Domain/Repository/SchedulerTaskRepository.php b/typo3/sysext/scheduler/Classes/Domain/Repository/SchedulerTaskRepository.php
index 359361990337..1d7db9b46d1d 100644
--- a/typo3/sysext/scheduler/Classes/Domain/Repository/SchedulerTaskRepository.php
+++ b/typo3/sysext/scheduler/Classes/Domain/Repository/SchedulerTaskRepository.php
@@ -201,10 +201,9 @@ class SchedulerTaskRepository
* next due task is returned. If there are no due tasks the method throws an exception.
*
* @return AbstractTask The fetched task object
- * @throws \OutOfBoundsException
* @throws \UnexpectedValueException
*/
- public function findNextExecutableTask(): AbstractTask
+ public function findNextExecutableTask(): ?AbstractTask
{
// If no uid is given, take any non-disabled task which has a next execution time in the past
$connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);
@@ -241,8 +240,7 @@ class SchedulerTaskRepository
$row = $queryBuilder->executeQuery()->fetchAssociative();
if (empty($row)) {
- // No uid was passed and no overdue task was found
- throw new \OutOfBoundsException('No (more) tasks available for execution', 1247827244);
+ return null;
}
return $this->createValidTaskObjectOrDisableTask($row);
diff --git a/typo3/sysext/scheduler/Classes/Scheduler.php b/typo3/sysext/scheduler/Classes/Scheduler.php
index 84656a6a2495..e756c46714e6 100644
--- a/typo3/sysext/scheduler/Classes/Scheduler.php
+++ b/typo3/sysext/scheduler/Classes/Scheduler.php
@@ -256,12 +256,12 @@ class Scheduler implements SingletonInterface
* If there are no due tasks the method throws an exception.
*
* @param int $uid Primary key of a task
- * @return Task\AbstractTask The fetched task object
+ * @return Task\AbstractTask|null The fetched task object
* @throws \OutOfBoundsException
* @throws \UnexpectedValueException
* @deprecated will be removed in TYPO3 v13.0. Use SchedulerTaskRepository instead.
*/
- public function fetchTask($uid = 0): AbstractTask
+ public function fetchTask($uid = 0): ?AbstractTask
{
trigger_error('Scheduler->' . __METHOD__ . ' will be removed in TYPO3 v13.0. Use SchedulerTaskRepository instead.', E_USER_DEPRECATED);
if ($uid > 0) {
--
GitLab