Release 1.0.1

jellesiderius · jellesiderius · commit d60fa13ba6cf · 2026-01-28T12:24:53.000+01:00
diff --git a/README.md b/README.md
@@ -210,7 +210,7 @@ bin/console sidworks:db:sync production
 
 | Option | Description |
 |--------|-------------|
-| `--keep-dump, -k` | Keep the dump file in `var/dumps/` after import |
+| `--keep-dump, -k` | Keep the dump file in the project root after import |
 | `--skip-import` | Only download the dump, don't import |
 | `--no-gzip` | Don't compress the dump (faster for small databases) |
 | `--skip-overrides` | Skip applying local environment overrides |
@@ -264,7 +264,7 @@ ddev exec bin/console sidworks:db:sync staging
 ### Execution Flow
 
 1. **Validate configuration** — Check required SSH and environment settings
-2. **Fetch remote `.env`** — Read database credentials from the remote server via SSH
+2. **Fetch remote environment** — Read database credentials from the remote server via SSH (supports `.env.local.php`, `.env.local`, and `.env`)
 3. **Create remote dump** — Two-step mysqldump (structure + data) on the remote server
 4. **Download dump** — Transfer the compressed dump via rsync
 5. **Cleanup remote** — Delete the dump file from the remote server
@@ -321,12 +321,20 @@ The import pipeline applies several optimizations:
 Your SSH user needs:
 - Read access to the remote `.env` file
 - Execute permissions for `mysqldump`
-- Write permissions to `/tmp` on the remote server
+- Write permissions to the remote project directory (for temporary dump file)
 
 ### Remote .env Not Found
 
 Verify that `SW_DB_SYNC_[ENV]_PROJECT_PATH` points to the Shopware root directory containing the `.env` file.
 
+The plugin reads remote environment files in this priority order:
+
+1. **`.env.local.php`** — Cached PHP array (takes full precedence if exists)
+2. **`.env.local`** — Local overrides (merged on top of `.env`)
+3. **`.env`** — Base environment file
+
+This matches Symfony's environment loading behavior.
+
 ### Import Fails with DEFINER Errors
 
 This is handled automatically. Both the remote dump and local import pipeline strip DEFINER clauses. If you still encounter errors, check that your MySQL user has `SUPER` or `PROXY` privileges, or verify the dump file isn't corrupted.
diff --git a/composer.json b/composer.json
@@ -2,7 +2,7 @@
     "name": "sidworks/sw-plugin-database-sync",
     "description": "Sidworks Plugin Database Sync",
     "type": "shopware-platform-plugin",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "require": {
         "shopware/core": "~6.6.0 || ~6.7.0"
     },
diff --git a/src/Command/DatabaseSyncCommand.php b/src/Command/DatabaseSyncCommand.php
@@ -141,19 +141,10 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             return Command::SUCCESS;
         }
 
-        // Create dumps directory
-        $dumpDir = $this->syncService->getProjectDir() . '/var/dumps';
-        if (!is_dir($dumpDir)) {
-            if (!@mkdir($dumpDir, 0775, true) && !is_dir($dumpDir)) {
-                $io->error('Could not create dumps directory: ' . $dumpDir);
-                $io->text('Please create it manually: mkdir -p var/dumps && chmod 775 var/dumps');
-                return Command::FAILURE;
-            }
-        }
-
         $timestamp = date('Y-m-d_His');
-        $remoteDumpFile = '/tmp/shopware_sync_' . $timestamp . '.sql' . ($useGzip ? '.gz' : '');
-        $localDumpFile = $dumpDir . '/sync_' . $environment . '_' . $timestamp . '.sql' . ($useGzip ? '.gz' : '');
+        $dumpFileName = 'sync_' . $environment . '_' . $timestamp . '.sql' . ($useGzip ? '.gz' : '');
+        $remoteDumpFile = rtrim($sshConfig['project_path'], '/') . '/' . $dumpFileName;
+        $localDumpFile = $this->syncService->getProjectDir() . '/' . $dumpFileName;
 
         // Step 1: Create dump on remote server
         $io->section('Step 1/4: Creating remote dump');
diff --git a/src/Service/DatabaseSyncService.php b/src/Service/DatabaseSyncService.php
@@ -138,55 +138,195 @@ public function getSshOptions(array $config): string
 
     public function fetchRemoteDbConfig(array $sshConfig, string $sshOptions, SymfonyStyle $io): bool
     {
-        $io->text('Reading remote .env file...');
+        $io->text('Reading remote environment configuration...');
 
-        $envPath = rtrim($sshConfig['project_path'], '/') . '/.env';
+        $projectPath = rtrim($sshConfig['project_path'], '/');
         
+        // Priority: .env.local.php > .env.local > .env
+        // .env.local.php is a cached PHP array that takes full precedence
+        // Otherwise, .env is loaded first, then .env.local overrides it
+        
+        $envLocalPhpPath = $projectPath . '/.env.local.php';
+        $envLocalPath = $projectPath . '/.env.local';
+        $envPath = $projectPath . '/.env';
+
+        // First, check if .env.local.php exists (cached env)
+        $checkCommand = sprintf(
+            'if [ -f %s ]; then echo "env.local.php"; elif [ -f %s ]; then echo "env.local"; elif [ -f %s ]; then echo "env"; else echo "none"; fi',
+            escapeshellarg($envLocalPhpPath),
+            escapeshellarg($envLocalPath),
+            escapeshellarg($envPath)
+        );
+
         $sshCommand = sprintf(
             'ssh %s %s@%s %s',
             $sshOptions,
             escapeshellarg($sshConfig['user']),
             escapeshellarg($sshConfig['host']),
-            escapeshellarg('cat ' . escapeshellarg($envPath))
+            escapeshellarg($checkCommand)
         );
 
         $process = Process::fromShellCommandline($sshCommand);
         $process->setTimeout(30);
         $process->run();
 
         if (!$process->isSuccessful()) {
-            $errorOutput = $process->getErrorOutput();
-            
-            if (str_contains($errorOutput, 'Permission denied') || 
-                str_contains($errorOutput, 'Host key verification failed') || 
-                str_contains($errorOutput, 'Connection refused')) {
-                $io->error('SSH connection failed!');
-                $io->text('');
-                $io->text('If running inside DDEV, first run: <comment>ddev auth ssh</comment>');
-                $io->text('This forwards your SSH agent to the container.');
-                $io->text('');
-                $io->text('Other options:');
-                $io->text('  - Configure SSH key in plugin settings');
-                $io->text('  - Ensure SSH key is loaded in your SSH agent');
-            } else {
-                $io->error('Failed to read remote .env file!');
-                $io->text($errorOutput);
-            }
+            $this->handleSshError($process->getErrorOutput(), $io);
+            return false;
+        }
+
+        $availableEnvFile = trim($process->getOutput());
+
+        if ($availableEnvFile === 'none') {
+            $io->error('No .env file found on remote server.');
+            $io->text('Checked: .env.local.php, .env.local, .env');
+            return false;
+        }
+
+        // Handle .env.local.php (PHP array format)
+        if ($availableEnvFile === 'env.local.php') {
+            $io->text('  Found .env.local.php (cached environment)');
+            return $this->fetchRemoteEnvFromPhp($sshConfig, $sshOptions, $envLocalPhpPath, $io);
+        }
+
+        // For .env and .env.local, we need to merge them
+        // First read .env as base
+        $io->text('  Reading .env...');
+        $envContent = $this->fetchRemoteFile($sshConfig, $sshOptions, $envPath, $io);
+        
+        if ($envContent === null) {
             return false;
         }
 
-        // Parse the .env content
-        $envContent = $process->getOutput();
         $this->remoteDbConfig = $this->parseEnvContent($envContent);
 
+        // Then check if .env.local exists and override
+        $checkLocalCommand = sprintf('[ -f %s ] && echo "exists"', escapeshellarg($envLocalPath));
+        $sshCommand = sprintf(
+            'ssh %s %s@%s %s',
+            $sshOptions,
+            escapeshellarg($sshConfig['user']),
+            escapeshellarg($sshConfig['host']),
+            escapeshellarg($checkLocalCommand)
+        );
+
+        $process = Process::fromShellCommandline($sshCommand);
+        $process->setTimeout(30);
+        $process->run();
+
+        if (trim($process->getOutput()) === 'exists') {
+            $io->text('  Reading .env.local (overrides)...');
+            $envLocalContent = $this->fetchRemoteFile($sshConfig, $sshOptions, $envLocalPath, $io);
+            
+            if ($envLocalContent !== null) {
+                // Parse .env.local and merge (override) into base config
+                $localConfig = $this->parseEnvContent($envLocalContent);
+                $this->remoteDbConfig = array_merge($this->remoteDbConfig, array_filter($localConfig));
+            }
+        }
+
         if (empty($this->remoteDbConfig['name'])) {
-            $io->error('Could not find DATABASE_NAME or DATABASE_URL in remote .env file.');
+            $io->error('Could not find DATABASE_NAME or DATABASE_URL in remote environment files.');
             return false;
         }
 
         return true;
     }
 
+    private function fetchRemoteFile(array $sshConfig, string $sshOptions, string $filePath, SymfonyStyle $io): ?string
+    {
+        $sshCommand = sprintf(
+            'ssh %s %s@%s %s',
+            $sshOptions,
+            escapeshellarg($sshConfig['user']),
+            escapeshellarg($sshConfig['host']),
+            escapeshellarg('cat ' . escapeshellarg($filePath))
+        );
+
+        $process = Process::fromShellCommandline($sshCommand);
+        $process->setTimeout(30);
+        $process->run();
+
+        if (!$process->isSuccessful()) {
+            $this->handleSshError($process->getErrorOutput(), $io);
+            return null;
+        }
+
+        return $process->getOutput();
+    }
+
+    private function fetchRemoteEnvFromPhp(array $sshConfig, string $sshOptions, string $filePath, SymfonyStyle $io): bool
+    {
+        // .env.local.php returns a PHP array, we need to execute it and extract DATABASE_URL
+        $phpCommand = sprintf(
+            'php -r %s',
+            escapeshellarg(sprintf(
+                '$env = require %s; echo $env["DATABASE_URL"] ?? "";',
+                escapeshellarg($filePath)
+            ))
+        );
+
+        $sshCommand = sprintf(
+            'ssh %s %s@%s %s',
+            $sshOptions,
+            escapeshellarg($sshConfig['user']),
+            escapeshellarg($sshConfig['host']),
+            escapeshellarg($phpCommand)
+        );
+
+        $process = Process::fromShellCommandline($sshCommand);
+        $process->setTimeout(30);
+        $process->run();
+
+        if (!$process->isSuccessful()) {
+            $this->handleSshError($process->getErrorOutput(), $io);
+            return false;
+        }
+
+        $databaseUrl = trim($process->getOutput());
+
+        if (empty($databaseUrl)) {
+            $io->error('Could not find DATABASE_URL in .env.local.php');
+            return false;
+        }
+
+        $parsed = $this->parseDatabaseUrl($databaseUrl);
+
+        if (!$parsed) {
+            $io->error('Could not parse DATABASE_URL from .env.local.php');
+            return false;
+        }
+
+        $this->remoteDbConfig = [
+            'host' => $parsed['host'] ?? 'localhost',
+            'port' => $parsed['port'] ?? 3306,
+            'name' => $parsed['name'] ?? '',
+            'user' => $parsed['user'] ?? '',
+            'pass' => $parsed['pass'] ?? '',
+        ];
+
+        return true;
+    }
+
+    private function handleSshError(string $errorOutput, SymfonyStyle $io): void
+    {
+        if (str_contains($errorOutput, 'Permission denied') || 
+            str_contains($errorOutput, 'Host key verification failed') || 
+            str_contains($errorOutput, 'Connection refused')) {
+            $io->error('SSH connection failed!');
+            $io->text('');
+            $io->text('If running inside DDEV, first run: <comment>ddev auth ssh</comment>');
+            $io->text('This forwards your SSH agent to the container.');
+            $io->text('');
+            $io->text('Other options:');
+            $io->text('  - Configure SSH key in plugin settings');
+            $io->text('  - Ensure SSH key is loaded in your SSH agent');
+        } else {
+            $io->error('Failed to read remote file!');
+            $io->text($errorOutput);
+        }
+    }
+
     public function getRemoteDbConfig(): ?array
     {
         return $this->remoteDbConfig;
@@ -336,7 +476,7 @@ public function createRemoteDump(
             $baseDumpFileEsc
         );
 
-        // Combine both commands
+        // Combine both commands: structure dump, then data dump
         $combinedCommand = sprintf('%s && %s', $structureCommand, $dataCommand);
         
         // Add gzip if requested
@@ -435,7 +575,6 @@ public function importDump(
         SymfonyStyle $io
     ): bool {
         $io->text('Importing database into local environment...');
-        $io->text('Stripping DEFINER statements...');
 
         $mysqlArgs = [
             'mysql',
@@ -450,29 +589,25 @@ public function importDump(
         // This prevents deadlocks and speeds up the import significantly
         $initCommands = 'SET FOREIGN_KEY_CHECKS=0; SET UNIQUE_CHECKS=0; SET SQL_MODE="NO_AUTO_VALUE_ON_ZERO";';
 
-        // Strip DEFINER statements locally before import to avoid privilege errors
-        // This handles views, stored procedures, triggers, and events in all MySQL comment formats
+        // DEFINER statements are already stripped during remote dump creation
+        // so we just need to decompress (if gzip) and pipe to mysql
         if ($useGzip) {
             $importCommand = sprintf(
-                '(echo %s; gunzip -c %s | LANG=C LC_CTYPE=C LC_ALL=C sed -e %s; echo "SET FOREIGN_KEY_CHECKS=1; SET UNIQUE_CHECKS=1;") | %s',
+                '(echo %s; gunzip -c %s; echo "SET FOREIGN_KEY_CHECKS=1; SET UNIQUE_CHECKS=1;") | %s',
                 escapeshellarg($initCommands),
                 escapeshellarg($localDumpFile),
-                escapeshellarg('s/\/\*![0-9]*\s*DEFINER=[^*]*\*\///g'),
                 implode(' ', array_map('escapeshellarg', $mysqlArgs))
             );
-            $process = Process::fromShellCommandline($importCommand);
         } else {
-            // For non-gzipped files, use sed to strip DEFINER before piping to mysql
             $importCommand = sprintf(
-                '(echo %s; LANG=C LC_CTYPE=C LC_ALL=C sed -e %s %s; echo "SET FOREIGN_KEY_CHECKS=1; SET UNIQUE_CHECKS=1;") | %s',
+                '(echo %s; cat %s; echo "SET FOREIGN_KEY_CHECKS=1; SET UNIQUE_CHECKS=1;") | %s',
                 escapeshellarg($initCommands),
-                escapeshellarg('s/\/\*![0-9]*\s*DEFINER=[^*]*\*\///g'),
                 escapeshellarg($localDumpFile),
                 implode(' ', array_map('escapeshellarg', $mysqlArgs))
             );
-            $process = Process::fromShellCommandline($importCommand);
         }
 
+        $process = Process::fromShellCommandline($importCommand);
         $process->setTimeout(600); // 10 minutes
         $process->run();
 
