Try to sanitize paths on Windows

Author: vinistock

.github/workflows/ci.yml

@@ -86,6 +86,8 @@ jobs:
       # We need some Ruby installed for the environment activation tests
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
 
       - name: Download shadowenv
         if: matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest'

vscode/src/ruby/chruby.ts

@@ -70,6 +70,41 @@ export class Chruby extends VersionManager {
     };
   }
 
+  // Run the activation script using the Ruby installation we found so that we can discover gem paths
+  protected async runActivationScript(rubyExecutableUri: vscode.Uri): Promise<{
+    defaultGems: string;
+    gemHome: string;
+    yjit: boolean;
+    version: string;
+  }> {
+    // Typically, GEM_HOME points to $HOME/.gem/ruby/version_without_patch. For example, for Ruby 3.2.2, it would be
+    // $HOME/.gem/ruby/3.2.0. However, chruby overrides GEM_HOME to use the patch part of the version, resulting in
+    // $HOME/.gem/ruby/3.2.2. In our activation script, we check if a directory using the patch exists and then prefer
+    // that over the default one.
+    const script = [
+      "user_dir = Gem.user_dir",
+      "paths = Gem.path",
+      "if paths.length > 2",
+      "  paths.delete(Gem.default_dir)",
+      "  paths.delete(Gem.user_dir)",
+      "  if paths[0]",
+      "    user_dir = paths[0] if Dir.exist?(paths[0])",
+      "  end",
+      "end",
+      "newer_gem_home = File.join(File.dirname(user_dir), RUBY_VERSION)",
+      "gems = (Dir.exist?(newer_gem_home) ? newer_gem_home : user_dir)",
+      "data = { defaultGems: Gem.default_dir, gemHome: gems, yjit: !!defined?(RubyVM::YJIT), version: RUBY_VERSION }",
+      "STDERR.print(JSON.dump(data))",
+    ].join(";");
+
+    const result = await asyncExec(
+      `${rubyExecutableUri.fsPath} -W0 -rjson -e '${script}'`,
+      { cwd: this.bundleUri.fsPath },
+    );
+
+    return this.parseWithErrorHandling(result.stderr);
+  }
+
   // Returns the full URI to the Ruby executable
   protected async findRubyUri(rubyVersion: RubyVersion): Promise<vscode.Uri> {
     if (/\d+\.\d+\.\d+/.exec(rubyVersion.version)) {
@@ -179,39 +214,4 @@ export class Chruby extends VersionManager {
 
     throw new Error("No .ruby-version file was found");
   }
-
-  // Run the activation script using the Ruby installation we found so that we can discover gem paths
-  private async runActivationScript(rubyExecutableUri: vscode.Uri): Promise<{
-    defaultGems: string;
-    gemHome: string;
-    yjit: boolean;
-    version: string;
-  }> {
-    // Typically, GEM_HOME points to $HOME/.gem/ruby/version_without_patch. For example, for Ruby 3.2.2, it would be
-    // $HOME/.gem/ruby/3.2.0. However, chruby overrides GEM_HOME to use the patch part of the version, resulting in
-    // $HOME/.gem/ruby/3.2.2. In our activation script, we check if a directory using the patch exists and then prefer
-    // that over the default one.
-    const script = [
-      "user_dir = Gem.user_dir",
-      "paths = Gem.path",
-      "if paths.length > 2",
-      "  paths.delete(Gem.default_dir)",
-      "  paths.delete(Gem.user_dir)",
-      "  if paths[0]",
-      "    user_dir = paths[0] if Dir.exist?(paths[0])",
-      "  end",
-      "end",
-      "newer_gem_home = File.join(File.dirname(user_dir), RUBY_VERSION)",
-      "gems = (Dir.exist?(newer_gem_home) ? newer_gem_home : user_dir)",
-      "data = { defaultGems: Gem.default_dir, gemHome: gems, yjit: !!defined?(RubyVM::YJIT), version: RUBY_VERSION }",
-      "STDERR.print(JSON.dump(data))",
-    ].join(";");
-
-    const result = await asyncExec(
-      `${rubyExecutableUri.fsPath} -W0 -rjson -e '${script}'`,
-      { cwd: this.bundleUri.fsPath },
-    );
-
-    return this.parseWithErrorHandling(result.stderr);
-  }
 }

vscode/src/ruby/rubyInstaller.ts

@@ -45,4 +45,27 @@ export class RubyInstaller extends Chruby {
          Searched in ${possibleInstallationUris.map((uri) => uri.fsPath).join(", ")}`,
     );
   }
+
+  protected async runActivationScript(rubyExecutableUri: vscode.Uri): Promise<{
+    defaultGems: string;
+    gemHome: string;
+    yjit: boolean;
+    version: string;
+  }> {
+    const { defaultGems, gemHome, yjit, version } =
+      await super.runActivationScript(rubyExecutableUri);
+
+    return {
+      defaultGems: this.standardizePath(defaultGems),
+      gemHome: this.standardizePath(gemHome),
+      yjit,
+      version,
+    };
+  }
+
+  // Sometimes Windows paths are prefixed by `//?/` and use forward slashes as separators. We need to both remove the
+  // prefix and convert the path to use backslashes before we insert anything into the environment PATH.
+  private standardizePath(path: string): string {
+    return path.replace("//?/", "").replace(/\//g, "\\");
+  }
 }

vscode/src/test/suite/client.test.ts

@@ -29,7 +29,6 @@ import { Telemetry, TelemetryApi, TelemetryEvent } from "../../telemetry";
 import Client from "../../client";
 import { WorkspaceChannel } from "../../workspaceChannel";
 import { RUBY_VERSION } from "../rubyVersion";
-import { asyncExec } from "../../common";
 
 const [major, minor, _patch] = RUBY_VERSION.split(".");
 
@@ -153,17 +152,6 @@ async function launchClient(workspaceUri: vscode.Uri) {
   await ruby.activateRuby();
   ruby.env.RUBY_LSP_BYPASS_TYPECHECKER = "true";
 
-  try {
-    await asyncExec("gem install ruby-lsp", {
-      env: ruby.env,
-      cwd: workspaceUri.fsPath,
-    });
-  } catch (error: any) {
-    assert.fail(
-      `Failed to install Ruby LSP: ${error.message}\n${fakeLogger.receivedMessages}`,
-    );
-  }
-
   const telemetry = new Telemetry(context, new FakeApi());
   const client = new Client(
     context,