Implement Debug Command

src/Commands/DebugCommand.php

@@ -0,0 +1,203 @@
+<?php
+
+namespace Native\Laravel\Commands;
+
+use Composer\InstalledVersions;
+use Illuminate\Console\Command;
+use Illuminate\Contracts\Console\PromptsForMissingInput;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\File;
+use Illuminate\Support\Facades\Process;
+
+use function Laravel\Prompts\error;
+use function Laravel\Prompts\info;
+use function Laravel\Prompts\intro;
+use function Laravel\Prompts\note;
+use function Laravel\Prompts\outro;
+use function Laravel\Prompts\select;
+
+class DebugCommand extends Command implements PromptsForMissingInput
+{
+    protected $signature = 'native:debug {output}';
+
+    protected $description = 'Generate debug information required for opening an issue.';
+
+    private Collection $debugInfo;
+
+    public function handle(): void
+    {
+        $this->debugInfo = collect();
+        intro('Generating Debug Information...');
+
+        $this->processEnvironment()
+            ->processNativePHP()
+            ->processErrorLog();
+
+        switch ($this->argument('output')) {
+            case 'File':
+                $this->outputToFile();
+                break;
+            case 'Clipboard':
+                $this->outputToClipboard();
+                break;
+            case 'Console':
+                $this->outputToConsole();
+                break;
+            default:
+                error('Invalid output option specified.');
+        }
+
+        outro('Debug Information Generated.');
+    }
+
+    private function processEnvironment(): static
+    {
+        $locationCommand = 'which';
+
+        if (PHP_OS_FAMILY === 'Windows') {
+            $locationCommand = 'where';
+        }
+
+        info('Generating Environment Data...');
+        $environment = [
+            'PHP' => [
+                'Version' => phpversion(),
+                'Path' => PHP_BINARY,
+            ],
+            'Laravel' => [
+                'Version' => app()->version(),
+                'ConfigCached' => file_exists($this->laravel->getCachedConfigPath()),
+                'DebugEnabled' => $this->laravel->hasDebugModeEnabled(),
+            ],
+            'Node' => [
+                'Version' => trim(Process::run('node -v')->output()),
+                'Path' => trim(Process::run("$locationCommand node")->output()),
+            ],
+            'NPM' => [
+                'Version' => trim(Process::run('npm -v')->output()),
+                'Path' => trim(Process::run("$locationCommand npm")->output()),
+            ],
+            'OperatingSystem' => PHP_OS,
+        ];
+
+        $this->debugInfo->put('Environment', $environment);
+
+        return $this;
+    }
+
+    private function processNativePHP(): static
+    {
+        info('Processing NativePHP Data...');
+        // Get composer versions
+        $versions = collect([
+            'nativephp/electron' => null,
+            'nativephp/laravel' => null,
+            'nativephp/php-bin' => null,
+        ])->mapWithKeys(function ($version, $key) {
+            try {
+                $version = InstalledVersions::getVersion($key);
+            } catch (\OutOfBoundsException) {
+                $version = 'Not Installed';
+            }
+
+            return [$key => $version];
+        });
+
+        $isNotarisationConfigured = env('NATIVEPHP_APPLE_ID')
+            && env('NATIVEPHP_APPLE_ID_PASS')
+            && env('NATIVEPHP_APPLE_TEAM_ID');
+
+        $this->debugInfo->put(
+            'NativePHP',
+            [
+                'Versions' => $versions,
+                'Configuration' => [
+                    'Provider' => config('nativephp.provider'),
+                    'BuildHooks' => [
+                        'Pre' => config('nativephp.prebuild'),
+                        'Post' => config('nativephp.postbuild'),
+                    ],
+                    'NotarizationEnabled' => $isNotarisationConfigured,
+                    'CustomPHPBinary' => env('NATIVEPHP_PHP_BINARY_PATH') ?: false,
+                ],
+            ]
+        );
+
+        return $this;
+    }
+
+    private function processErrorLog(): void
+    {
+        info('Processing Error Log Data...');
+        $errorLog = file_exists($logPath = storage_path('logs/laravel.log'))
+            ? file_get_contents($logPath)
+            : 'No logs found.';
+
+        // Process each line as a single array element
+        $errorLog = explode(PHP_EOL, $errorLog);
+        $errorCount = 0;
+        $errors = [];
+
+        $currentLine = '';
+        foreach ($errorLog as $line) {
+            if ($errorCount === 5) {
+                break;
+            }
+
+            // Check if string starts with date format Y-m-d H:i:s in square brackets
+            if (preg_match('/^\[\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\]/', $line)) {
+                if (! empty($currentLine)) {
+                    $errors[] = $currentLine;
+                    $currentLine = '';
+                    $errorCount++;
+                }
+            }
+
+            $currentLine .= $line.PHP_EOL;
+        }
+
+        if (! empty($currentLine)) {
+            $errors[] = $currentLine;
+        }
+
+        $this->debugInfo->put('ErrorLog', $errors);
+    }
+
+    protected function promptForMissingArgumentsUsing(): array
+    {
+        return [
+            'output' => fn () => select(
+                'Where would you like to output the debug information?',
+                ['File', 'Clipboard', 'Console'],
+                'File'
+            ),
+        ];
+    }
+
+    private function outputToFile(): void
+    {
+        File::put(base_path('nativephp_debug.json'), json_encode($this->debugInfo->toArray(), JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
+        note('Debug information saved to '.base_path('nativephp_debug.json'));
+    }
+
+    private function outputToConsole(): void
+    {
+        $this->output->writeln(
+            print_r($this->debugInfo->toArray(), true)
+        );
+    }
+
+    private function outputToClipboard(): void
+    {
+        $json = json_encode($this->debugInfo->toArray(), JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
+
+        // Copy json to clipboard
+        if (PHP_OS_FAMILY === 'Windows') {
+            Process::run('echo '.escapeshellarg($json).' | clip');
+        } elseif (PHP_OS_FAMILY === 'Linux') {
+            Process::run('echo '.escapeshellarg($json).' | xclip -selection clipboard');
+        } else {
+            Process::run('echo '.escapeshellarg($json).' | pbcopy');
+        }
+    }
+}

src/NativeServiceProvider.php

@@ -8,6 +8,7 @@
 use Illuminate\Support\Facades\Artisan;
 use Illuminate\Support\Facades\DB;
 use Native\Laravel\ChildProcess as ChildProcessImplementation;
+use Native\Laravel\Commands\DebugCommand;
 use Native\Laravel\Commands\FreshCommand;
 use Native\Laravel\Commands\LoadPHPConfigurationCommand;
 use Native\Laravel\Commands\LoadStartupConfigurationCommand;
@@ -35,8 +36,9 @@ public function configurePackage(Package $package): void
         $package
             ->name('nativephp')
             ->hasCommands([
-                MigrateCommand::class,
+                DebugCommand::class,
                 FreshCommand::class,
+                MigrateCommand::class,
                 SeedDatabaseCommand::class,
             ])
             ->hasConfigFile()