Merge pull request #3 from robjuz/main

allow to set execution timeout

src/Command/RunCommand.php

@@ -29,14 +29,18 @@ protected function configure(): void
     {
         $this->addOption('skip-theme-compile', null, InputOption::VALUE_OPTIONAL, 'Skip theme compile (should be used when the Theme has been compiled before in the CI/CD)', false);
         $this->addOption('skip-asset-install', null, InputOption::VALUE_OPTIONAL, 'Skip asset install (should be used when the Assets has been copied before in the CI/CD)', false);
+        $this->addOption('timeout', null, InputOption::VALUE_OPTIONAL, 'Set script execution timeout (is seconds). Set to null to disable timeout', 300);
     }
 
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
+        $timeout = $input->getOption('timeout');
+
         $config = new RunConfiguration(
             skipThemeCompile: (bool) $input->getOption('skip-theme-compile'),
             skipAssetInstall: (bool) $input->getOption('skip-asset-install'),
+            timeout: $timeout ? (float) $timeout : null,
         );
 
         $installed = $this->state->isInstalled();

src/Helper/ProcessHelper.php

@@ -3,6 +3,7 @@
 namespace Shopware\Deployment\Helper;
 
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
+use Symfony\Component\Process\Exception\InvalidArgumentException;
 use Symfony\Component\Process\PhpSubprocess;
 use Symfony\Component\Process\Process;
 
@@ -14,6 +15,7 @@ class ProcessHelper
     public function __construct(
         #[Autowire('%kernel.project_dir%')]
         private readonly string $projectDir,
+        private ?float $timeout = 60
     ) {}
 
     /**
@@ -24,6 +26,7 @@ public function run(array $args): void
         $completeCmd = ['php', ...$args];
 
         $process = new PhpSubprocess($args, $this->projectDir);
+        $process->setTimeout($this->timeout);
 
         $startTime = $this->printPreStart($completeCmd);
 
@@ -59,6 +62,7 @@ public function runAndTail(string $code): void
         $start = $this->printPreStart([$code]);
 
         $process = new Process(['sh', '-c', $code], $this->projectDir);
+        $process->setTimeout($this->timeout);
 
         if (function_exists('stream_isatty') && stream_isatty(\STDOUT)) {
             $process->setTty(true);
@@ -83,6 +87,21 @@ public function getPluginList(): string
     {
         return (new PhpSubprocess(['bin/console', 'plugin:list', '--json'], $this->projectDir))->mustRun()->getOutput();
     }
+    /**
+     * Sets the process timeout (max. runtime) in seconds.
+     *
+     * To disable the timeout, set this value to null.
+     *
+     * @return $this
+     *
+     * @throws InvalidArgumentException if the timeout is negative
+     */
+    public function setTimeout(?float $timeout): static
+    {
+        $this->timeout = $this->validateTimeout($timeout);
+
+        return $this;
+    }
 
     /**
      * @param array<string> $cmd
@@ -117,6 +136,22 @@ private function printPostStart(array $cmd, float $startTime): void
         fwrite(\STDOUT, PHP_EOL);
     }
 
+    /**
+     * Validates and returns the filtered timeout.
+     *
+     * @throws InvalidArgumentException if the given timeout is a negative number
+     */
+    private function validateTimeout(?float $timeout): ?float
+    {
+        $timeout = (float) $timeout;
 
+        if (0.0 === $timeout) {
+            $timeout = null;
+        } elseif ($timeout < 0) {
+            throw new InvalidArgumentException('The timeout value must be a valid positive integer or float number.');
+        }
+
+        return $timeout;
+    }
 
 }

src/Services/InstallationManager.php

@@ -21,6 +21,8 @@ public function __construct(
 
     public function run(RunConfiguration $configuration, OutputInterface $output): void
     {
+        $this->processHelper->setTimeout($configuration->timeout);
+
         $output->writeln('Shopware is not installed, starting installation');
 
         $this->hookExecutor->execute(HookExecutor::PRE_INSTALL);

src/Services/UpgradeManager.php

@@ -19,6 +19,8 @@ public function __construct(
 
     public function run(RunConfiguration $configuration, OutputInterface $output): void
     {
+        $this->processHelper->setTimeout($configuration->timeout);
+
         $this->hookExecutor->execute(HookExecutor::PRE_UPDATE);
 
         $output->writeln('Shopware is installed, running update tools');

src/Struct/RunConfiguration.php

@@ -4,5 +4,5 @@
 
 class RunConfiguration
 {
-    public function __construct(public readonly bool $skipThemeCompile = false, public readonly bool $skipAssetInstall = false) {}
+    public function __construct(public readonly bool $skipThemeCompile = false, public readonly bool $skipAssetInstall = false, public readonly ?float $timeout = 60) {}
 }