Stage rl/standard debug sockets

README.md

@@ -51,12 +51,13 @@ documentation](https://shopify.github.io/ruby-lsp/RubyLsp/Requests.html).
 Available commands are listed below and can always be found by searching for the `Ruby LSP` prefix in the command
 palette (Default hotkey: CMD + SHIFT + P).
 
-| Command                              | Description                                             |
-| ------------------------------------ | ------------------------------------------------------- |
-| Ruby LSP: Start                      | Start the Ruby LSP server                               |
-| Ruby LSP: Restart                    | Restart the Ruby LSP server                             |
-| Ruby LSP: Stop                       | Stop the Ruby LSP server                                |
-| Ruby LSP: Update language server gem | Updates the `ruby-lsp` server gem to the latest version |
+
+| Command                              | Description                                            |
+| -------------------------------------- | -------------------------------------------------------- |
+| Ruby LSP: Start                      | Start the Ruby LSP server                              |
+| Ruby LSP: Restart                    | Restart the Ruby LSP server                            |
+| Ruby LSP: Stop                       | Stop the Ruby LSP server                               |
+| Ruby LSP: Update language server gem | Updates the`ruby-lsp` server gem to the latest version |
 
 ### Snippets
 
@@ -203,6 +204,16 @@ This command would generate the following configuration:
 }
 ```
 
+### Debugging rails applications
+
+Install `debug` gem. Verify by running `bundle exec rdbg -v`
+
+Make sure you're running your application with rdbg, e.g. `bundle exec rdbg -O -n -c -- bin/rails server -p 3000`
+
+You should be able to use vscode debugger attach configuration to connect to your running app
+
+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
@@ -340,12 +351,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";
 
@@ -121,41 +121,44 @@ export class Debugger
     this.subscriptions.forEach((subscription) => subscription.dispose());
   }
 
+  private getSockets(): string[] {
+    const cmd = "bundle exec rdbg --util=list-socks";
+    let sockets: string[] = [];
+    try {
+      sockets = execSync(cmd)
+        .toString()
+        .split("\n")
+        .filter((socket) => socket.length > 0);
+    } catch (error: any) {
+      this.console.append(error.message);
+    }
+    return sockets;
+  }
+
   private attachDebuggee(): Promise<vscode.DebugAdapterDescriptor | undefined> {
     // 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"));
 
     // eslint-disable-next-line @typescript-eslint/no-misused-promises
     return new Promise((resolve, reject) => {
+      const sockets = this.getSockets();
       if (sockets.length === 0) {
-        reject(
-          new Error(
-            `No debuggee processes found. Was a socket created in ${socketsDir}?`,
-          ),
-        );
-      }
-
-      return vscode.window
-        .showQuickPick(sockets, {
-          placeHolder: "Select a debuggee",
-          ignoreFocusOut: true,
-        })
-        .then((selectedSocket) => {
-          if (selectedSocket === undefined) {
-            reject(new Error("No debuggee selected"));
-          } else {
-            resolve(
-              new vscode.DebugAdapterNamedPipeServer(
-                path.join(socketsDir, selectedSocket),
-              ),
-            );
-          }
-        });
+        reject(new Error(`No debuggee processes found.`));
+      } else if (sockets.length === 1)
+        resolve(new vscode.DebugAdapterNamedPipeServer(sockets[0]));
+      else
+        return vscode.window
+          .showQuickPick(sockets, {
+            placeHolder: "Select a debuggee",
+            ignoreFocusOut: true,
+          })
+          .then((selectedSocket) => {
+            if (selectedSocket === undefined) {
+              reject(new Error("No debuggee selected"));
+            } else {
+              resolve(new vscode.DebugAdapterNamedPipeServer(selectedSocket));
+            }
+          });
     });
   }
 
@@ -164,7 +167,6 @@ export class Debugger
   ): Promise<vscode.DebugAdapterDescriptor | undefined> {
     let initialMessage = "";
     let initialized = false;
-    const sockPath = this.socketPath();
     const configuration = session.configuration;
 
     return new Promise((resolve, reject) => {
@@ -173,7 +175,6 @@ export class Debugger
         "rdbg",
         "--open",
         "--command",
-        `--sock-path=${sockPath}`,
         "--",
         configuration.program,
       ];
@@ -209,7 +210,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"));
+          }
         }
       });
 
@@ -237,30 +245,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() {
-    const socketsDir = path.join("/", "tmp", "ruby-lsp-debug-sockets");
-    if (!fs.existsSync(socketsDir)) {
-      fs.mkdirSync(socketsDir);
-    }
-
-    let socketIndex = 0;
-    const prefix = `ruby-debug-${path.basename(this.workingFolder)}`;
-    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`;
-  }
 }