Stage rl/standard debug sockets

README.md

@@ -225,6 +225,20 @@ This command would generate the following configuration:
 }
 ```
 
+### Debugging live processes
+
+Instead of launching a process to debug every time, you may want to attach the VS Code debugger to an existing process, such as a Rails server. Follow these instructions to do so.
+
+Install `debug` gem. Verify by running `bundle exec rdbg -v`
+
+Run your application with the debugger attached, so that the extension can connect to it.
+
+```shell
+bundle exec rdbg -O -n -c -- bin/rails server -p 3000
+```
+
+For better integrated rails tests support also install `ruby-lsp-rails` gem.
+
 #### VS Code configurations
 
 In addition to the Ruby LSP's own configuration, there are some VS Code settings that may need to be changed to get the
@@ -362,12 +376,12 @@ Possible values are:
 The `launch.json` contains a 'Minitest - current file' configuration for the debugger.
 
 1. Add a breakpoint using the VS Code UI.
-1. Open the relevant test file.
-1. Open the **Run and Debug** panel on the sidebar.
-1. Ensure `Minitest - current file` is selected in the top dropdown.
-1. Press `F5` OR click the green triangle next to the top dropdown. VS Code will then run the test file with debugger activated.
-1. When the breakpoint is triggered, the process will pause and VS Code will connect to the debugger and activate the debugger UI.
-1. Open the Debug Console view to use the debugger's REPL.
+2. Open the relevant test file.
+3. Open the **Run and Debug** panel on the sidebar.
+4. Ensure `Minitest - current file` is selected in the top dropdown.
+5. Press `F5` OR click the green triangle next to the top dropdown. VS Code will then run the test file with debugger activated.
+6. When the breakpoint is triggered, the process will pause and VS Code will connect to the debugger and activate the debugger UI.
+7. Open the Debug Console view to use the debugger's REPL.
 
 ## License
 

src/debugger.ts

@@ -1,6 +1,6 @@
 import path from "path";
 import fs from "fs";
-import { ChildProcessWithoutNullStreams, spawn } from "child_process";
+import { ChildProcessWithoutNullStreams, spawn, execSync } from "child_process";
 
 import * as vscode from "vscode";
 
@@ -39,7 +39,7 @@ export class Debugger
     if (session.configuration.request === "launch") {
       return this.spawnDebuggeeForLaunch(session);
     } else if (session.configuration.request === "attach") {
-      return this.attachDebuggee();
+      return this.attachDebuggee(session);
     } else {
       return new Promise((_resolve, reject) =>
         reject(
@@ -129,19 +129,40 @@ export class Debugger
     }
   }
 
-  private async attachDebuggee(): Promise<vscode.DebugAdapterDescriptor> {
+  private getSockets(session: vscode.DebugSession): string[] {
+    const cmd = "bundle exec rdbg --util=list-socks";
+    const workspaceFolder = session.workspaceFolder;
+    if (!workspaceFolder) {
+      throw new Error("Debugging requires a workspace folder to be opened");
+    }
+    const configuration = session.configuration;
+    let sockets: string[] = [];
+    try {
+      sockets = execSync(cmd, {
+        cwd: workspaceFolder.uri.fsPath,
+        env: configuration.env,
+      })
+        .toString()
+        .split("\n")
+        .filter((socket) => socket.length > 0);
+    } catch (error: any) {
+      this.console.append(`Error listing sockets: ${error.message}`);
+    }
+    return sockets;
+  }
+
+  private async attachDebuggee(
+    session: vscode.DebugSession,
+  ): Promise<vscode.DebugAdapterDescriptor> {
     // When using attach, a process will be launched using Ruby debug and it will create a socket automatically. We have
     // to find the available sockets and ask the user which one they want to attach to
-    const socketsDir = path.join("/", "tmp", "ruby-lsp-debug-sockets");
-    const sockets = fs
-      .readdirSync(socketsDir)
-      .map((file) => file)
-      .filter((file) => file.endsWith(".sock"));
-
+    const sockets = this.getSockets(session);
     if (sockets.length === 0) {
-      throw new Error(
-        `No debuggee processes found. Was a socket created in ${socketsDir}?`,
-      );
+      throw new Error(`No debuggee processes found. Is the process running?`);
+    }
+
+    if (sockets.length === 1) {
+      return new vscode.DebugAdapterNamedPipeServer(sockets[0]);
     }
 
     const selectedSocketPath = await vscode.window
@@ -153,7 +174,7 @@ export class Debugger
         if (value === undefined) {
           throw new Error("No debuggee selected");
         }
-        return path.join(socketsDir, value);
+        return value;
       });
 
     return new vscode.DebugAdapterNamedPipeServer(selectedSocketPath);
@@ -168,15 +189,13 @@ export class Debugger
     const configuration = session.configuration;
     const workspaceFolder: vscode.WorkspaceFolder = configuration.targetFolder;
     const cwd = workspaceFolder.uri.fsPath;
-    const sockPath = this.socketPath(workspaceFolder.name);
 
     return new Promise((resolve, reject) => {
       const args = [
         "exec",
         "rdbg",
         "--open",
         "--command",
-        `--sock-path=${sockPath}`,
         "--",
         configuration.program,
       ];
@@ -206,7 +225,14 @@ export class Debugger
           initialMessage.includes("DEBUGGER: wait for debugger connection...")
         ) {
           initialized = true;
-          resolve(new vscode.DebugAdapterNamedPipeServer(sockPath));
+          const regex =
+            /DEBUGGER: Debugger can attach via UNIX domain socket \((.*)\)/;
+          const sockPath = RegExp(regex).exec(initialMessage);
+          if (sockPath && sockPath.length === 2) {
+            resolve(new vscode.DebugAdapterNamedPipeServer(sockPath[1]));
+          } else {
+            reject(new Error("Debugger not found on UNIX socket"));
+          }
         }
       });
 
@@ -234,30 +260,4 @@ export class Debugger
       });
     });
   }
-
-  // Generate a socket path so that Ruby debug doesn't have to create one for us. This makes coordination easier since
-  // we always know the path to the socket
-  private socketPath(workspaceName: string) {
-    const socketsDir = path.join("/", "tmp", "ruby-lsp-debug-sockets");
-    if (!fs.existsSync(socketsDir)) {
-      fs.mkdirSync(socketsDir);
-    }
-
-    let socketIndex = 0;
-    const prefix = `ruby-debug-${workspaceName}`;
-    const existingSockets = fs
-      .readdirSync(socketsDir)
-      .map((file) => file)
-      .filter((file) => file.startsWith(prefix))
-      .sort();
-
-    if (existingSockets.length > 0) {
-      socketIndex =
-        Number(
-          /-(\d+).sock$/.exec(existingSockets[existingSockets.length - 1])![1],
-        ) + 1;
-    }
-
-    return `${socketsDir}/${prefix}-${socketIndex}.sock`;
-  }
 }