improved commands and logged processed message

SergiuBota1 · SergiuBota1 · commit 5c99c044b05f · 2025-07-28T15:58:34.000+03:00
Signed-off-by: bota &lt;Bota@dotkernel.com&gt;
diff --git a/config/autoload/cli.global.php b/config/autoload/cli.global.php
@@ -15,12 +15,12 @@
         'version'  => '1.0.0',
         'name'     => 'DotKernel CLI',
         'commands' => [
-            "swoole:start"        => StartCommand::class,
-            "swoole:stop"         => StopCommand::class,
-            "messenger:start"     => ConsumeMessagesCommand::class,
-            "messenger:debug"     => DebugCommand::class,
-            "processed"           => GetProcessedMessagesCommand::class,
-            "failed"              => GetFailedMessagesCommand::class,
+            "swoole:start"    => StartCommand::class,
+            "swoole:stop"     => StopCommand::class,
+            "messenger:start" => ConsumeMessagesCommand::class,
+            "messenger:debug" => DebugCommand::class,
+            "processed"       => GetProcessedMessagesCommand::class,
+            "failed"          => GetFailedMessagesCommand::class,
         ],
     ],
     FileLockerInterface::class => [
diff --git a/docs/book/v1/commands.md b/docs/book/v1/commands.md
@@ -11,16 +11,20 @@ Both commands are used to extract data that can be filtered by period from the l
 
 To run the commands via CLI, use the following syntax:
 
-`php bin/cli.php failed --start="yyy-mm-dd" --end="yyy-mm-dd" --limit=int`
+`php bin/cli.php failed --start="yyyy-mm-dd" --end="yyyy-mm-dd" --limit=int`
 
-`php bin/cli.php processed --start="yyy-mm-dd" --end="yyy-mm-dd" --limit=int`
+`php bin/cli.php processed --start="yyyy-mm-dd" --end="yyyy-mm-dd" --limit=int`
 
 ### TCP message
 
 To use commands using TCP messages the following messages can be used:
 
-`echo "failed --start=yyy-mm-dd --end=yyy-mm-dd --limit=days" | socat - TCP:host:port`
+`echo "failed --start=yyyy-mm-dd --end=yyyy-mm-dd --limit=days" | socat - TCP:host:port`
 
-`echo "processed --start=yyy-mm-dd --end=yyy-mm-dd --limit=days" | socat - TCP:host:port`
+`echo "processed --start=yyyy-mm-dd --end=yyyy-mm-dd --limit=days" | socat - TCP:host:port`
 
 In both cases the flags are optional. Keep in mind if both `start` and `end` are set, `limit` will not be applied, it's only used when one of `start` or `end` is missing.
+
+In order to be able to test the `processed` command, by default when processing the "control" message, it is logged as successfully processed with `"levelName":"info"` simulating that the message was processed successfully. To use it run the following message:
+
+`echo "control" | socat - TCP:host:port`
diff --git a/src/App/Message/ExampleMessageHandler.php b/src/App/Message/ExampleMessageHandler.php
@@ -26,11 +26,18 @@ public function __construct(
 
     public function __invoke(ExampleMessage $message): void
     {
+        $payload = $message->getPayload();
+
         try {
             // Throwing an exception to satisfy PHPStan (replace with own code)
-            throw new \Exception("Failed to execute");
+            // For proof of concept and testing purposes message "control" will automatically mark it as successfully
+            // processed and logged as info
+            if ($payload['foo'] === 'control') {
+                $this->logger->info($payload['foo'] . ': was processed successfully');
+            } else {
+                throw new \Exception("Failed to execute");
+            }
         } catch (\Throwable $exception) {
-            $payload = $message->getPayload();
             $this->logger->error($payload['foo'] . ' failed with message: '
                 . $exception->getMessage() . ' after ' . ($payload['retry'] ?? 0) . ' retries');
             $this->retry($payload);
diff --git a/src/Swoole/Command/GetFailedMessagesCommand.php b/src/Swoole/Command/GetFailedMessagesCommand.php
@@ -11,11 +11,11 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
-use function date;
+use function dirname;
 use function file;
+use function file_exists;
 use function is_numeric;
 use function json_decode;
-use function preg_match;
 use function strtolower;
 use function strtotime;
 
@@ -46,32 +46,42 @@ protected function configure(): void
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        $start = $input->getOption('start');
-        $end   = $input->getOption('end');
-        $limit = $input->getOption('limit');
+        try {
+            $startOption = $input->getOption('start');
+            $endOption   = $input->getOption('end');
+            $limit       = $input->getOption('limit');
+
+            $startDate = $startOption ? new \DateTimeImmutable($startOption) : null;
+            $endDate   = $endOption ? new \DateTimeImmutable($endOption) : null;
+        } catch (\Exception $e) {
+            $output->writeln('<error>Invalid date format provided.</error>');
+            return Command::FAILURE;
+        }
 
-        if ($start && !preg_match('/\d{2}:\d{2}:\d{2}/', $start)) {
-            $start .= ' 00:00:00';
+        if ($startDate && $startDate->format('H:i:s') === '00:00:00') {
+            $startDate = $startDate->setTime(0, 0, 0);
         }
 
-        if ($end && !preg_match('/\d{2}:\d{2}:\d{2}/', $end)) {
-            $end .= ' 23:59:59';
+        if ($endDate && $endDate->format('H:i:s') === '00:00:00') {
+            $endDate = $endDate->setTime(23, 59, 59);
         }
 
         if ($limit && is_numeric($limit)) {
-            if ($start && !$end) {
-                $end = date('Y-m-d H:i:s', strtotime("+{$limit} days", strtotime($start)));
-            } elseif (!$start && $end) {
-                $start = date('Y-m-d H:i:s', strtotime("-{$limit} days", strtotime($end)));
+            if ($startDate && ! $endDate) {
+                $endDate = $startDate->modify("+{$limit} days");
+            } elseif (! $startDate && $endDate) {
+                $startDate = $endDate->modify("-{$limit} days");
             }
         }
 
-        if (!$end) {
-            $end = date('Y-m-d H:i:s');
+        if (! $endDate) {
+            $endDate = new \DateTime();
         }
 
-        $startTimestamp = $start ? strtotime($start) : null;
-        $endTimestamp   = $end ? strtotime($end) : null;
+        if ($startDate > $endDate) {
+            $output->writeln('<error>The start date cannot be after the end date.</error>');
+            return Command::FAILURE;
+        }
 
         $logPath = dirname(__DIR__, 3) . '/log/queue-log.log';
 
@@ -80,7 +90,12 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             return Command::FAILURE;
         }
 
-        $lines   = file($logPath, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
+        $lines = file($logPath, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
+
+        $startTimestamp = $startDate?->getTimestamp();
+        $endTimestamp   = $endDate->getTimestamp();
+
+        $found = false;
 
         foreach ($lines as $line) {
             $entry = json_decode($line, true);
@@ -102,6 +117,11 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             }
 
             $output->writeln($line);
+            $found = true;
+        }
+
+        if (! $found) {
+            $output->writeln('<comment>No matching log entries found.</comment>');
         }
 
         return Command::SUCCESS;
diff --git a/src/Swoole/Command/GetProcessedMessagesCommand.php b/src/Swoole/Command/GetProcessedMessagesCommand.php
@@ -11,11 +11,11 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
-use function date;
+use function dirname;
 use function file;
+use function file_exists;
 use function is_numeric;
 use function json_decode;
-use function preg_match;
 use function strtolower;
 use function strtotime;
 
@@ -46,32 +46,42 @@ protected function configure(): void
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        $start = $input->getOption('start');
-        $end   = $input->getOption('end');
-        $limit = $input->getOption('limit');
+        try {
+            $startOption = $input->getOption('start');
+            $endOption   = $input->getOption('end');
+            $limit       = $input->getOption('limit');
+
+            $startDate = $startOption ? new \DateTimeImmutable($startOption) : null;
+            $endDate   = $endOption ? new \DateTimeImmutable($endOption) : null;
+        } catch (\Exception $e) {
+            $output->writeln('<error>Invalid date format provided.</error>');
+            return Command::FAILURE;
+        }
 
-        if ($start && !preg_match('/\d{2}:\d{2}:\d{2}/', $start)) {
-            $start .= ' 00:00:00';
+        if ($startDate && $startDate->format('H:i:s') === '00:00:00') {
+            $startDate = $startDate->setTime(0, 0, 0);
         }
 
-        if ($end && !preg_match('/\d{2}:\d{2}:\d{2}/', $end)) {
-            $end .= ' 23:59:59';
+        if ($endDate && $endDate->format('H:i:s') === '00:00:00') {
+            $endDate = $endDate->setTime(23, 59, 59);
         }
 
         if ($limit && is_numeric($limit)) {
-            if ($start && !$end) {
-                $end = date('Y-m-d H:i:s', strtotime("+{$limit} days", strtotime($start)));
-            } elseif (!$start && $end) {
-                $start = date('Y-m-d H:i:s', strtotime("-{$limit} days", strtotime($end)));
+            if ($startDate && ! $endDate) {
+                $endDate = $startDate->modify("+{$limit} days");
+            } elseif (! $startDate && $endDate) {
+                $startDate = $endDate->modify("-{$limit} days");
             }
         }
 
-        if (!$end) {
-            $end = date('Y-m-d H:i:s');
+        if (! $endDate) {
+            $endDate = new \DateTime();
         }
 
-        $startTimestamp = $start ? strtotime($start) : null;
-        $endTimestamp   = $end ? strtotime($end) : null;
+        if ($startDate > $endDate) {
+            $output->writeln('<error>The start date cannot be after the end date.</error>');
+            return Command::FAILURE;
+        }
 
         $logPath = dirname(__DIR__, 3) . '/log/queue-log.log';
 
@@ -80,7 +90,12 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             return Command::FAILURE;
         }
 
-        $lines   = file($logPath, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
+        $lines = file($logPath, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
+
+        $startTimestamp = $startDate?->getTimestamp();
+        $endTimestamp   = $endDate->getTimestamp();
+
+        $found = false;
 
         foreach ($lines as $line) {
             $entry = json_decode($line, true);
@@ -102,6 +117,11 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             }
 
             $output->writeln($line);
+            $found = true;
+        }
+
+        if (! $found) {
+            $output->writeln('<comment>No matching log entries found.</comment>');
         }
 
         return Command::SUCCESS;
diff --git a/src/Swoole/Delegators/TCPServerDelegator.php b/src/Swoole/Delegators/TCPServerDelegator.php
@@ -77,7 +77,7 @@ public function __invoke(ContainerInterface $container, string $serviceName, cal
                     $logger->error("Error running command: " . $e->getMessage());
                 }
             } else {
-                $bus->dispatch(new ExampleMessage(["foo" => $data]));
+                $bus->dispatch(new ExampleMessage(["foo" => $message]));
                 $bus->dispatch(new ExampleMessage(["foo" => "with 5 seconds delay"]), [
                     new DelayStamp(5000),
                 ]);

Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ public function __invoke(ContainerInterface $container, string $serviceName, cal`
`77`	`77`	`$logger->error("Error running command: " . $e->getMessage());`
`78`	`78`	`}`
`79`	`79`	`} else {`
`80`		`- $bus->dispatch(new ExampleMessage(["foo" => $data]));`
	`80`	`+ $bus->dispatch(new ExampleMessage(["foo" => $message]));`
`81`	`81`	`$bus->dispatch(new ExampleMessage(["foo" => "with 5 seconds delay"]), [`
`82`	`82`	`new DelayStamp(5000),`
`83`	`83`	`]);`