Merge pull request #250 from laravel/debug-info-for-errors

Include debug info when copying error

Author: joetannenbaum

src/extension.ts

@@ -16,6 +16,7 @@ import { updateDiagnostics } from "./diagnostic/diagnostic";
 import { hoverProviders } from "./hover/HoverProvider";
 import { linkProviders } from "./link/LinkProvider";
 import { configAffected } from "./support/config";
+import { collectDebugInfo } from "./support/debug";
 import { disposeWatchers } from "./support/fileWatcher";
 import { info } from "./support/logger";
 import { setParserBinaryPath } from "./support/parser";
@@ -134,6 +135,8 @@ export function activate(context: vscode.ExtensionContext) {
         vscode.commands.registerCommand("laravel.open", openFileCommand),
     );
 
+    collectDebugInfo();
+
     vscode.workspace.onDidChangeConfiguration((event) => {
         if (configAffected(event, "phpCommand", "phpEnvironment")) {
             clearDefaultPhpCommand();

src/support/debug.ts

@@ -0,0 +1,25 @@
+import os from "os";
+import { getCommandTemplate, runInLaravel } from "./php";
+
+export const debugInfo: Record<string, string> = {};
+
+export const collectDebugInfo = () => {
+    debugInfo["os"] = os.platform();
+    debugInfo["arch"] = os.arch();
+
+    runInLaravel(`
+        echo json_encode([
+            'php_version' => phpversion(),
+            'laravel_version' => app()->version(),
+        ]);
+    `).then((output) => {
+        if (output) {
+            for (const key in output as Record<string, string>) {
+                // @ts-ignore
+                debugInfo[key] = output[key];
+            }
+        }
+
+        debugInfo["php_command"] = getCommandTemplate();
+    });
+};

src/support/php.ts

@@ -273,6 +273,10 @@ const getHashedFile = (code: string) => {
     return fixFilePath(hashedFile);
 };
 
+export const getCommandTemplate = (): string => {
+    return config<string>("phpCommand", "") || getDefaultPhpCommand();
+};
+
 export const runPhp = (
     code: string,
     description: string | null = null,
@@ -282,8 +286,7 @@ export const runPhp = (
         code = "<?php\n\n" + code;
     }
 
-    const commandTemplate =
-        config<string>("phpCommand", "") || getDefaultPhpCommand();
+    const commandTemplate = getCommandTemplate();
 
     const hashedFile = getHashedFile(code);
 

src/support/popup.ts

@@ -1,5 +1,6 @@
 import * as vscode from "vscode";
 import { config } from "./config";
+import { debugInfo } from "./debug";
 import { channel, error } from "./logger";
 
 let showErrorPopups = config<boolean>("showErrorPopups", false);
@@ -28,7 +29,17 @@ export const showErrorPopup = (...errors: string[]) => {
         {
             title: "Copy Error to Clipboard",
             command: () => {
-                vscode.env.clipboard.writeText(errors.join("\n"));
+                const finalMessage = [
+                    "Debug Info",
+                    "",
+                    JSON.stringify(debugInfo, null, 2),
+                    "",
+                    "-".repeat(40),
+                    "",
+                    ...errors,
+                ];
+
+                vscode.env.clipboard.writeText(finalMessage.join("\n"));
             },
         },
         {