feat: add tracking

.github/workflows/integration.yml

@@ -11,6 +11,8 @@ env:
   APP_ENV: prod
   SALES_CHANNEL_URL: http://localhost:8000
   DATABASE_URL: mysql://root@127.0.0.1/shopware
+  # Disable our own telemetry to not fill test runs
+  DO_NOT_TRACK: 1
 
 jobs:
   installation:
@@ -37,10 +39,10 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
         with:
-         path: ./custom/plugins/deployment-helper
+         path: ./custom/static-plugins/deployment-helper
 
       - name: Set fake version into deployment helper
-        run: composer -d custom/plugins/deployment-helper config version 999.9.9
+        run: composer -d custom/static-plugins/deployment-helper config version 999.9.9
 
       - name: Install Deployment Helper
         run: composer require --dev 'shopware/deployment-helper:*'
@@ -86,10 +88,10 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
         with:
-          path: ./custom/plugins/deployment-helper
+          path: ./custom/static-plugins/deployment-helper
 
       - name: Set fake version into deployment helper
-        run: composer -d custom/plugins/deployment-helper config version 999.9.9
+        run: composer -d custom/static-plugins/deployment-helper config version 999.9.9
 
       - name: Install Deployment Helper
         run: composer require --dev 'shopware/deployment-helper:*'
@@ -146,10 +148,10 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
         with:
-          path: ./custom/plugins/deployment-helper
+          path: ./custom/static-plugins/deployment-helper
 
       - name: Set fake version into deployment helper
-        run: composer -d custom/plugins/deployment-helper config version 999.9.9
+        run: composer -d custom/static-plugins/deployment-helper config version 999.9.9
 
       - name: Install Deployment Helper
         run: composer require --dev 'shopware/deployment-helper:*'

.gitignore

@@ -1,5 +1,8 @@
 /.idea
+/.claude
 /vendor
 /composer.lock
 /var/cache
 /build/coverage
+/coverage
+/.junie

bin/shopware-deployment-helper

@@ -17,7 +17,7 @@ $includables = [
     __DIR__ . '/vendor/autoload.php',
 ];
 
-if (str_contains(__DIR__, 'custom/plugins')) {
+if (str_contains(__DIR__, 'custom/plugins') || str_contains(__DIR__, 'custom/static-plugins')) {
     $includables[] = __DIR__ . '/../../../../vendor/autoload.php';
 }
 

composer.json

@@ -14,6 +14,7 @@
     "php": ">=8.2",
     "ext-dom": "*",
     "ext-pdo": "*",
+    "ext-sockets": "*",
     "digilist/dependency-graph": ">=0.4.1",
     "doctrine/dbal": "^3.0 || ^4.0",
     "symfony/config": "^7.0 || ^6.0",

src/Command/RunCommand.php

@@ -9,6 +9,7 @@
 use Shopware\Deployment\Services\HookExecutor;
 use Shopware\Deployment\Services\InstallationManager;
 use Shopware\Deployment\Services\ShopwareState;
+use Shopware\Deployment\Services\TrackingService;
 use Shopware\Deployment\Services\UpgradeManager;
 use Shopware\Deployment\Struct\RunConfiguration;
 use Symfony\Component\Console\Attribute\AsCommand;
@@ -27,6 +28,7 @@ public function __construct(
         private readonly UpgradeManager $upgradeManager,
         private readonly HookExecutor $hookExecutor,
         private readonly EventDispatcherInterface $eventDispatcher,
+        private readonly TrackingService $trackingService,
     ) {
         parent::__construct();
     }
@@ -41,6 +43,7 @@ protected function configure(): void
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
+        $installed = $this->state->isInstalled();
         $timeout = $input->getOption('timeout');
 
         $config = new RunConfiguration(
@@ -50,18 +53,26 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             forceReinstallation: EnvironmentHelper::getVariable('SHOPWARE_DEPLOYMENT_FORCE_REINSTALL', '0') === '1',
         );
 
-        $installed = $this->state->isInstalled();
-
         if ($config->forceReinstallation && $this->state->getPreviousVersion() === 'unknown') {
             $installed = false;
         }
 
         $this->hookExecutor->execute(HookExecutor::HOOK_PRE);
 
-        if ($installed) {
-            $this->upgradeManager->run($config, $output);
-        } else {
-            $this->installationManager->run($config, $output);
+        try {
+            if ($installed) {
+                $this->upgradeManager->run($config, $output);
+            } else {
+                $this->installationManager->run($config, $output);
+            }
+        } finally {
+            $this->trackingService->track('php_version', [
+                'php_version' => \PHP_MAJOR_VERSION . '.' . \PHP_MINOR_VERSION,
+            ]);
+
+            $this->trackingService->track('mysql_version', [
+                'mysql_version' => $this->state->getMySqlVersion(),
+            ]);
         }
 
         $this->eventDispatcher->dispatch(new PostDeploy($config, $output));

src/Helper/ConsoleOutputInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopware\Deployment\Helper;
+
+interface ConsoleOutputInterface
+{
+    public function writeStdout(string $message): void;
+
+    public function writeStderr(string $message): void;
+}

src/Helper/DefaultConsoleOutput.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopware\Deployment\Helper;
+
+class DefaultConsoleOutput implements ConsoleOutputInterface
+{
+    public function writeStdout(string $message): void
+    {
+        fwrite(\STDOUT, $message);
+    }
+
+    public function writeStderr(string $message): void
+    {
+        fwrite(\STDERR, $message);
+    }
+}

src/Helper/ProcessHelper.php

@@ -18,6 +18,7 @@ public function __construct(
         #[Autowire('%kernel.project_dir%')]
         private readonly string $projectDir,
         private ?float $timeout = null,
+        private readonly ConsoleOutputInterface $output = new DefaultConsoleOutput(),
     ) {
         $this->timeout = $this->validateTimeout($timeout ?? (float) EnvironmentHelper::getVariable('SHOPWARE_DEPLOYMENT_TIMEOUT', '60'));
     }
@@ -32,17 +33,11 @@ public function shell(array $command): void
 
         $startTime = $this->printPreStart($command);
 
-        if (\function_exists('stream_isatty') && stream_isatty(\STDOUT)) {
+        if ($this->output instanceof DefaultConsoleOutput && \function_exists('stream_isatty') && stream_isatty(\STDOUT)) {
             $process->setTty(true);
         }
 
-        $process->run(function (string $type, string $buffer): void {
-            if ($type === Process::ERR) {
-                fwrite(\STDERR, $buffer);
-            } else {
-                fwrite(\STDOUT, $buffer);
-            }
-        });
+        $process->run($this->output(...));
 
         if (!$process->isSuccessful()) {
             throw new \RuntimeException('Execution of ' . implode(' ', $command) . ' failed');
@@ -63,17 +58,11 @@ public function run(array $args): void
 
         $startTime = $this->printPreStart($completeCmd);
 
-        if (\function_exists('stream_isatty') && stream_isatty(\STDOUT)) {
+        if ($this->output instanceof DefaultConsoleOutput && \function_exists('stream_isatty') && stream_isatty(\STDOUT)) {
             $process->setTty(true);
         }
 
-        $process->run(function (string $type, string $buffer): void {
-            if ($type === Process::ERR) {
-                fwrite(\STDERR, $buffer);
-            } else {
-                fwrite(\STDOUT, $buffer);
-            }
-        });
+        $process->run($this->output(...));
 
         if (!$process->isSuccessful()) {
             throw new \RuntimeException('Execution of ' . implode(' ', $args) . ' failed');
@@ -100,17 +89,11 @@ public function runAndTail(string $code): void
         $process = new Process(['sh', '-c', $code], $this->projectDir);
         $process->setTimeout($this->timeout);
 
-        if (\function_exists('stream_isatty') && stream_isatty(\STDOUT)) {
+        if ($this->output instanceof DefaultConsoleOutput && \function_exists('stream_isatty') && stream_isatty(\STDOUT)) {
             $process->setTty(true);
         }
 
-        $process->run(function (string $type, string $buffer): void {
-            if ($type === Process::ERR) {
-                fwrite(\STDERR, $buffer);
-            } else {
-                fwrite(\STDOUT, $buffer);
-            }
-        });
+        $process->run($this->output(...));
 
         if (!$process->isSuccessful()) {
             throw new \RuntimeException('Execution of ' . $originalCode . ' failed');
@@ -140,6 +123,15 @@ public function setTimeout(?float $timeout): static
         return $this;
     }
 
+    private function output(string $type, string $buffer): void
+    {
+        if ($type === Process::ERR) {
+            $this->output->writeStderr($buffer);
+        } else {
+            $this->output->writeStdout($buffer);
+        }
+    }
+
     /**
      * @param array<string> $cmd
      */
@@ -148,14 +140,14 @@ private function printPreStart(array $cmd): float
         $cmdString = implode(' ', $cmd);
         $startTime = microtime(true);
 
-        fwrite(\STDOUT, \PHP_EOL);
-        fwrite(\STDOUT, "=================================================\n");
-        fwrite(\STDOUT, "============== [deployment-helper] ==============\n");
-        fwrite(\STDOUT, "=================================================\n");
-        fwrite(\STDOUT, \sprintf("Start: %s\n", $cmdString));
-        fwrite(\STDOUT, \sprintf("Time limit: %s seconds\n", $this->timeout));
-        fwrite(\STDOUT, "=================================================\n");
-        fwrite(\STDOUT, \PHP_EOL);
+        $this->output->writeStdout(\PHP_EOL);
+        $this->output->writeStdout("=================================================\n");
+        $this->output->writeStdout("============== [deployment-helper] ==============\n");
+        $this->output->writeStdout("=================================================\n");
+        $this->output->writeStdout(\sprintf("Start: %s\n", $cmdString));
+        $this->output->writeStdout(\sprintf("Time limit: %s seconds\n", $this->timeout));
+        $this->output->writeStdout("=================================================\n");
+        $this->output->writeStdout(\PHP_EOL);
 
         return $startTime;
     }
@@ -165,17 +157,17 @@ private function printPreStart(array $cmd): float
      */
     private function printPostStart(array $cmd, float $startTime): void
     {
-        fwrite(\STDOUT, "=================================================\n");
-        fwrite(\STDOUT, "============== [deployment-helper] ==============\n");
-        fwrite(\STDOUT, "=================================================\n");
-        fwrite(\STDOUT, \sprintf("End: %s\n", implode(' ', $cmd)));
-        fwrite(\STDOUT, \sprintf(
+        $this->output->writeStdout("=================================================\n");
+        $this->output->writeStdout("============== [deployment-helper] ==============\n");
+        $this->output->writeStdout("=================================================\n");
+        $this->output->writeStdout(\sprintf("End: %s\n", implode(' ', $cmd)));
+        $this->output->writeStdout(\sprintf(
             "> Time: %sms\n",
             number_format((microtime(true) - $startTime) * 1000, 2, '.', ''),
         ));
 
-        fwrite(\STDOUT, "=================================================\n");
-        fwrite(\STDOUT, \PHP_EOL);
+        $this->output->writeStdout("=================================================\n");
+        $this->output->writeStdout(\PHP_EOL);
     }
 
     /**

src/Services/InstallationManager.php

@@ -24,6 +24,7 @@ public function __construct(
         private readonly HookExecutor $hookExecutor,
         private readonly ProjectConfiguration $configuration,
         private readonly AccountService $accountService,
+        private readonly TrackingService $trackingService,
     ) {
     }
 
@@ -56,7 +57,12 @@ public function run(RunConfiguration $configuration, OutputInterface $output): v
             $additionalInstallParameters[] = '--drop-database';
         }
 
+        $took = microtime(true);
         $this->processHelper->console(['system:install', '--create-database', '--shop-locale=' . $shopLocale, '--shop-currency=' . $shopCurrency, '--force', ...$additionalInstallParameters]);
+
+        $this->trackingService->persistId();
+        $this->trackingService->track('installed', ['took' => microtime(true) - $took, 'shopware_version' => $this->state->getCurrentVersion()]);
+
         $this->processHelper->console(['user:create', $adminUser, '--password=' . $adminPassword]);
 
         $this->processHelper->console(['messenger:setup-transports']);

src/Services/ShopwareState.php

@@ -100,4 +100,50 @@ public function disableMaintenanceMode(): void
             $this->connection->executeStatement('UPDATE sales_channel SET maintenance = ? WHERE id = UNHEX(?)', [$maintenance, $id]);
         }
     }
+
+    public function getMySqlVersion(): string
+    {
+        $version = $this->extractMySQLVersion($this->connection->fetchOne('SELECT VERSION()'));
+
+        if (isset($version['mariadb'])) {
+            return 'mariadb-' . $version['mariadb'];
+        }
+
+        if (isset($version['mysql'])) {
+            return 'mysql-' . $version['mysql'];
+        }
+
+        return 'unknown';
+    }
+
+    /**
+     * @return array{mysql?: string, mariadb?: string}
+     */
+    private function extractMySQLVersion(string $versionString): array
+    {
+        if (stripos($versionString, 'mariadb') === false) {
+            $pos = strpos($versionString, '-');
+            if (\is_int($pos)) {
+                $versionString = substr($versionString, 0, $pos);
+            }
+
+            return ['mysql' => $versionString];
+        }
+
+        return ['mariadb' => self::getVersionNumber($versionString)];
+    }
+
+    private static function getVersionNumber(string $versionString): string
+    {
+        $match = preg_match(
+            '/^(?:5\.5\.5-)?(mariadb-)?(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)/i',
+            $versionString,
+            $versionParts,
+        );
+        if ($match === 0 || \is_bool($match)) {
+            throw new \RuntimeException(\sprintf('Invalid version string: %s', $versionString));
+        }
+
+        return $versionParts['major'] . '.' . $versionParts['minor'];
+    }
 }