Debug

Author: vinistock

lib/core_ext/uri.rb

@@ -11,6 +11,9 @@ def from_path(path:, fragment: nil, scheme: "file")
         # On Windows, if the path begins with the disk name, we need to add a leading slash to make it a valid URI
         escaped_path = if /^[A-Z]:/i.match?(path)
           DEFAULT_PARSER.escape("/#{path}")
+        elsif path.start_with?("//?/")
+          # Some paths on Windows start with "//?/". This is a special prefix that allows for long file paths
+          DEFAULT_PARSER.escape(path.delete_prefix("//?"))
         else
           DEFAULT_PARSER.escape(path)
         end

lib/ruby_lsp/listeners/document_link.rb

@@ -30,7 +30,7 @@ def gem_paths
                 lookup[spec.name] = {}
                 lookup[spec.name][spec.version.to_s] = {}
 
-                Dir.glob("**/*.rb", base: "#{spec.full_gem_path}/").each do |path|
+                Dir.glob("**/*.rb", base: "#{spec.full_gem_path.delete_prefix("//?/")}/").each do |path|
                   lookup[spec.name][spec.version.to_s][path] = "#{spec.full_gem_path}/#{path}"
                 end
               end

test/requests/support/uri_test.rb

@@ -50,5 +50,10 @@ def test_from_path_with_fragment
       uri = URI::Generic.from_path(path: "/some/unix/path/to/file.rb", fragment: "L1,3-2,9")
       assert_equal("file:///some/unix/path/to/file.rb#L1,3-2,9", uri.to_s)
     end
+
+    def test_from_path_windows_long_file_paths
+      uri = URI::Generic.from_path(path: "//?/C:/hostedtoolcache/windows/Ruby/3.3.1/x64/lib/ruby/3.3.0/open-uri.rb")
+      assert_equal("C:/hostedtoolcache/windows/Ruby/3.3.1/x64/lib/ruby/3.3.0/open-uri.rb", uri.to_standardized_path)
+    end
   end
 end

vscode/src/ruby/chruby.ts

@@ -60,7 +60,7 @@ export class Chruby extends VersionManager {
       PATH: `${path.join(gemHome, "bin")}${path.delimiter}${path.join(
         defaultGems,
         "bin",
-      )}${path.delimiter}${path.dirname(rubyUri.fsPath)}${path.delimiter}${process.env.PATH}`,
+      )}${path.delimiter}${path.dirname(rubyUri.fsPath)}${path.delimiter}${this.getProcessPath()}`,
     };
 
     return {
@@ -70,6 +70,19 @@ export class Chruby extends VersionManager {
     };
   }
 
+  protected getProcessPath() {
+    return process.env.PATH;
+  }
+
+  // Returns the full URI to the Ruby executable
+  protected async findRubyUri(rubyVersion: RubyVersion): Promise<vscode.Uri> {
+    if (/\d+\.\d+\.\d+/.exec(rubyVersion.version)) {
+      return this.findRubyUriForCompleteVersion(rubyVersion);
+    }
+
+    return this.findRubyUriWithOmittedPatch(rubyVersion);
+  }
+
   // 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;
@@ -105,15 +118,6 @@ export class Chruby extends VersionManager {
     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)) {
-      return this.findRubyUriForCompleteVersion(rubyVersion);
-    }
-
-    return this.findRubyUriWithOmittedPatch(rubyVersion);
-  }
-
   private async findRubyUriWithOmittedPatch(
     rubyVersion: RubyVersion,
   ): Promise<vscode.Uri> {

vscode/src/ruby/rubyInstaller.ts

@@ -1,3 +1,4 @@
+/* eslint-disable no-process-env */
 import os from "os";
 
 import * as vscode from "vscode";
@@ -16,6 +17,12 @@ interface RubyVersion {
 //
 // If we can't find it there, then we throw an error and rely on the user to manually select where Ruby is installed.
 export class RubyInstaller extends Chruby {
+  // Environment variables are case sensitive on Windows when we access them through NodeJS. We need to ensure that
+  // we're searching through common variations, so that we don't accidentally miss the path we should inherit
+  protected getProcessPath() {
+    return process.env.Path ?? process.env.PATH ?? process.env.path;
+  }
+
   // Returns the full URI to the Ruby executable
   protected async findRubyUri(rubyVersion: RubyVersion): Promise<vscode.Uri> {
     const [major, minor, _patch] = rubyVersion.version.split(".").map(Number);

vscode/src/test/suite/ruby/rubyInstaller.test.ts

@@ -60,8 +60,7 @@ suite("RubyInstaller", () => {
     const windows = new RubyInstaller(workspaceFolder, outputChannel);
     const { env, version, yjit } = await windows.activate();
 
-    assert.match(env.GEM_PATH!, /ruby\/3\.3\.0/);
-    assert.match(env.GEM_PATH!, /lib\/ruby\/gems\/3\.3\.0/);
+    assert.match(env.GEM_PATH!, /lib\\ruby\\gems\\3\.3\.0/);
     assert.strictEqual(version, RUBY_VERSION);
     assert.notStrictEqual(yjit, undefined);
 
@@ -90,8 +89,7 @@ suite("RubyInstaller", () => {
     const windows = new RubyInstaller(workspaceFolder, outputChannel);
     const { env, version, yjit } = await windows.activate();
 
-    assert.match(env.GEM_PATH!, /ruby\/3\.3\.0/);
-    assert.match(env.GEM_PATH!, /lib\/ruby\/gems\/3\.3\.0/);
+    assert.match(env.GEM_PATH!, /lib\\ruby\\gems\\3\.3\.0/);
     assert.strictEqual(version, RUBY_VERSION);
     assert.notStrictEqual(yjit, undefined);