Change the result of detect methods to return DetectionResult objects

rafaelfranca · rafaelfranca · commit f6e4f8131389 · 2026-01-22T16:47:47.000-05:00
diff --git a/vscode/src/ruby.ts b/vscode/src/ruby.ts
@@ -6,7 +6,7 @@ import { RubyInterface } from "./common";
 import { WorkspaceChannel } from "./workspaceChannel";
 import { Shadowenv, UntrustedWorkspaceError } from "./ruby/shadowenv";
 import { Chruby } from "./ruby/chruby";
-import { VersionManager } from "./ruby/versionManager";
+import { VersionManager, DetectionResult } from "./ruby/versionManager";
 import { Mise } from "./ruby/mise";
 import { RubyInstaller } from "./ruby/rubyInstaller";
 import { Rbenv } from "./ruby/rbenv";
@@ -42,7 +42,7 @@ interface ManagerClass {
     manuallySelectRuby: () => Promise<void>,
     ...args: any[]
   ): VersionManager;
-  detect: (workspaceFolder: vscode.WorkspaceFolder, outputChannel: WorkspaceChannel) => Promise<vscode.Uri | undefined>;
+  detect: (workspaceFolder: vscode.WorkspaceFolder, outputChannel: WorkspaceChannel) => Promise<DetectionResult>;
 }
 
 const VERSION_MANAGERS: Record<ManagerIdentifier, ManagerClass> = {
@@ -326,7 +326,8 @@ export class Ruby implements RubyInterface {
         continue;
       }
 
-      if (await ManagerClass.detect(this.workspaceFolder, this.outputChannel)) {
+      const result = await ManagerClass.detect(this.workspaceFolder, this.outputChannel);
+      if (result.type !== "none") {
         this.versionManager = identifier;
         return;
       }
diff --git a/vscode/src/ruby/asdf.ts b/vscode/src/ruby/asdf.ts
@@ -3,7 +3,7 @@ import path from "path";
 
 import * as vscode from "vscode";
 
-import { VersionManager, ActivationResult } from "./versionManager";
+import { VersionManager, ActivationResult, DetectionResult } from "./versionManager";
 import { WorkspaceChannel } from "../workspaceChannel";
 import { pathToUri } from "../common";
 
@@ -36,28 +36,28 @@ export class Asdf extends VersionManager {
   static async detect(
     workspaceFolder: vscode.WorkspaceFolder,
     outputChannel: WorkspaceChannel,
-  ): Promise<vscode.Uri | undefined> {
+  ): Promise<DetectionResult> {
     // Check for v0.16+ executables first
     const executablePaths = Asdf.getPossibleExecutablePaths();
     const asdfExecPaths = executablePaths.map((dir) => vscode.Uri.joinPath(dir, "asdf"));
     const execResult = await VersionManager.findFirst(asdfExecPaths);
     if (execResult) {
-      return execResult;
+      return { type: "path", uri: execResult };
     }
 
     // Check for < v0.16 scripts
     const scriptResult = await VersionManager.findFirst(Asdf.getPossibleScriptPaths());
     if (scriptResult) {
-      return scriptResult;
+      return { type: "path", uri: scriptResult };
     }
 
     // check on PATH
     const toolExists = await VersionManager.toolExists("asdf", workspaceFolder, outputChannel);
     if (toolExists) {
-      return vscode.Uri.file("asdf");
+      return { type: "semantic", marker: "asdf" };
     }
 
-    return undefined;
+    return { type: "none" };
   }
 
   async activate(): Promise<ActivationResult> {
@@ -68,9 +68,13 @@ export class Asdf extends VersionManager {
     if (configuredPath) {
       asdfUri = vscode.Uri.file(configuredPath);
     } else {
-      asdfUri = await Asdf.detect(this.workspaceFolder, this.outputChannel);
+      const result = await Asdf.detect(this.workspaceFolder, this.outputChannel);
 
-      if (!asdfUri) {
+      if (result.type === "path") {
+        asdfUri = result.uri;
+      } else if (result.type === "semantic") {
+        // Use ASDF from PATH
+      } else {
         throw new Error(
           `Could not find ASDF installation. Searched in ${[
             ...Asdf.getPossibleExecutablePaths(),
@@ -82,7 +86,7 @@ export class Asdf extends VersionManager {
 
     let baseCommand: string;
 
-    if (asdfUri.fsPath !== "/asdf") {
+    if (asdfUri) {
       const asdfPath = asdfUri.fsPath;
       // If there's no extension name, then we are using the ASDF executable directly. If there is an extension, then it's
       // a shell script and we have to source it first
diff --git a/vscode/src/ruby/chruby.ts b/vscode/src/ruby/chruby.ts
@@ -6,7 +6,7 @@ import * as vscode from "vscode";
 import { WorkspaceChannel } from "../workspaceChannel";
 import { pathToUri } from "../common";
 
-import { ActivationResult, VersionManager, ACTIVATION_SEPARATOR } from "./versionManager";
+import { ActivationResult, VersionManager, ACTIVATION_SEPARATOR, DetectionResult } from "./versionManager";
 
 interface RubyVersion {
   engine?: string;
@@ -21,9 +21,9 @@ export class Chruby extends VersionManager {
   static async detect(
     workspaceFolder: vscode.WorkspaceFolder,
     outputChannel: WorkspaceChannel,
-  ): Promise<vscode.Uri | undefined> {
+  ): Promise<DetectionResult> {
     const exists = await VersionManager.toolExists("chruby", workspaceFolder, outputChannel);
-    return exists ? vscode.Uri.file("chruby") : undefined;
+    return exists ? { type: "semantic", marker: "chruby" } : { type: "none" };
   }
 
   // Only public so that we can point to a different directory in tests
diff --git a/vscode/src/ruby/custom.ts b/vscode/src/ruby/custom.ts
@@ -1,6 +1,6 @@
 import * as vscode from "vscode";
 
-import { VersionManager, ActivationResult } from "./versionManager";
+import { VersionManager, ActivationResult, DetectionResult } from "./versionManager";
 
 // Custom
 //
@@ -12,8 +12,8 @@ export class Custom extends VersionManager {
   static async detect(
     _workspaceFolder: vscode.WorkspaceFolder,
     _outputChannel: vscode.LogOutputChannel,
-  ): Promise<vscode.Uri | undefined> {
-    return undefined;
+  ): Promise<DetectionResult> {
+    return { type: "none" };
   }
 
   async activate(): Promise<ActivationResult> {
diff --git a/vscode/src/ruby/mise.ts b/vscode/src/ruby/mise.ts
@@ -2,7 +2,7 @@ import os from "os";
 
 import * as vscode from "vscode";
 
-import { VersionManager, ActivationResult } from "./versionManager";
+import { VersionManager, ActivationResult, DetectionResult } from "./versionManager";
 import { WorkspaceChannel } from "../workspaceChannel";
 import { pathToUri } from "../common";
 
@@ -13,8 +13,9 @@ export class Mise extends VersionManager {
   static async detect(
     _workspaceFolder: vscode.WorkspaceFolder,
     _outputChannel: WorkspaceChannel,
-  ): Promise<vscode.Uri | undefined> {
-    return this.findFirst(this.getPossiblePaths());
+  ): Promise<DetectionResult> {
+    const result = await this.findFirst(this.getPossiblePaths());
+    return result ? { type: "path", uri: result } : { type: "none" };
   }
 
   async activate(): Promise<ActivationResult> {
@@ -75,10 +76,10 @@ export class Mise extends VersionManager {
       }
     }
 
-    const detectedPath = await constructor.detect(this.workspaceFolder, this.outputChannel);
+    const result = await constructor.detect(this.workspaceFolder, this.outputChannel);
 
-    if (detectedPath) {
-      return detectedPath;
+    if (result.type === "path") {
+      return result.uri;
     }
 
     const possiblePaths = constructor.getPossiblePaths();
diff --git a/vscode/src/ruby/none.ts b/vscode/src/ruby/none.ts
@@ -2,7 +2,7 @@ import * as vscode from "vscode";
 
 import { WorkspaceChannel } from "../workspaceChannel";
 
-import { VersionManager, ActivationResult } from "./versionManager";
+import { VersionManager, ActivationResult, DetectionResult } from "./versionManager";
 
 // None
 //
@@ -17,9 +17,9 @@ export class None extends VersionManager {
   static async detect(
     _workspaceFolder: vscode.WorkspaceFolder,
     _outputChannel: vscode.LogOutputChannel,
-  ): Promise<vscode.Uri | undefined> {
+  ): Promise<DetectionResult> {
     // None always matches as the final fallback
-    return vscode.Uri.file("none");
+    return { type: "semantic", marker: "none" };
   }
 
   private readonly rubyPath: string;
diff --git a/vscode/src/ruby/rbenv.ts b/vscode/src/ruby/rbenv.ts
@@ -1,6 +1,6 @@
 import * as vscode from "vscode";
 
-import { VersionManager, ActivationResult } from "./versionManager";
+import { VersionManager, ActivationResult, DetectionResult } from "./versionManager";
 import { WorkspaceChannel } from "../workspaceChannel";
 
 // Seamlessly manage your app’s Ruby environment with rbenv.
@@ -10,9 +10,9 @@ export class Rbenv extends VersionManager {
   static async detect(
     workspaceFolder: vscode.WorkspaceFolder,
     outputChannel: WorkspaceChannel,
-  ): Promise<vscode.Uri | undefined> {
+  ): Promise<DetectionResult> {
     const exists = await VersionManager.toolExists("rbenv", workspaceFolder, outputChannel);
-    return exists ? vscode.Uri.file("rbenv") : undefined;
+    return exists ? { type: "semantic", marker: "rbenv" } : { type: "none" };
   }
 
   async activate(): Promise<ActivationResult> {
diff --git a/vscode/src/ruby/rubyInstaller.ts b/vscode/src/ruby/rubyInstaller.ts
@@ -4,6 +4,7 @@ import * as vscode from "vscode";
 
 import { Chruby } from "./chruby";
 import { pathToUri } from "../common";
+import { DetectionResult } from "./versionManager";
 
 interface RubyVersion {
   engine?: string;
@@ -21,8 +22,8 @@ export class RubyInstaller extends Chruby {
   static async detect(
     _workspaceFolder: vscode.WorkspaceFolder,
     _outputChannel: vscode.LogOutputChannel,
-  ): Promise<vscode.Uri | undefined> {
-    return os.platform() === "win32" ? vscode.Uri.file("RubyInstaller") : undefined;
+  ): Promise<DetectionResult> {
+    return os.platform() === "win32" ? { type: "semantic", marker: "RubyInstaller" } : { type: "none" };
   }
 
   // Environment variables are case sensitive on Windows when we access them through NodeJS. We need to ensure that
diff --git a/vscode/src/ruby/rvm.ts b/vscode/src/ruby/rvm.ts
@@ -2,7 +2,7 @@ import os from "os";
 
 import * as vscode from "vscode";
 
-import { ActivationResult, VersionManager } from "./versionManager";
+import { ActivationResult, VersionManager, DetectionResult } from "./versionManager";
 import { WorkspaceChannel } from "../workspaceChannel";
 import { pathToUri } from "../common";
 
@@ -14,9 +14,9 @@ export class Rvm extends VersionManager {
   static async detect(
     workspaceFolder: vscode.WorkspaceFolder,
     outputChannel: WorkspaceChannel,
-  ): Promise<vscode.Uri | undefined> {
+  ): Promise<DetectionResult> {
     const exists = await VersionManager.toolExists("rvm", workspaceFolder, outputChannel);
-    return exists ? vscode.Uri.file("rvm") : undefined;
+    return exists ? { type: "semantic", marker: "rvm" } : { type: "none" };
   }
 
   async activate(): Promise<ActivationResult> {
diff --git a/vscode/src/ruby/shadowenv.ts b/vscode/src/ruby/shadowenv.ts
@@ -2,7 +2,7 @@ import * as vscode from "vscode";
 
 import { asyncExec } from "../common";
 
-import { VersionManager, ActivationResult } from "./versionManager";
+import { VersionManager, ActivationResult, DetectionResult } from "./versionManager";
 
 // Shadowenv is a tool that allows managing environment variables upon entering a directory. It allows users to manage
 // which Ruby version should be used for each project, in addition to other customizations such as GEM_HOME.
@@ -23,9 +23,12 @@ export class Shadowenv extends VersionManager {
   static async detect(
     workspaceFolder: vscode.WorkspaceFolder,
     _outputChannel: vscode.LogOutputChannel,
-  ): Promise<vscode.Uri | undefined> {
+  ): Promise<DetectionResult> {
     const exists = await Shadowenv.shadowenvDirExists(workspaceFolder.uri);
-    return exists ? vscode.Uri.joinPath(workspaceFolder.uri, ".shadowenv.d") : undefined;
+    if (exists) {
+      return { type: "path", uri: vscode.Uri.joinPath(workspaceFolder.uri, ".shadowenv.d") };
+    }
+    return { type: "none" };
   }
 
   async activate(): Promise<ActivationResult> {
diff --git a/vscode/src/ruby/versionManager.ts b/vscode/src/ruby/versionManager.ts
@@ -13,6 +13,12 @@ export interface ActivationResult {
   gemPath: string[];
 }
 
+// Detection result types for version managers
+export type DetectionResult =
+  | { type: "semantic"; marker: string } // Detected by semantic markers (e.g., "chruby", "rbenv")
+  | { type: "path"; uri: vscode.Uri } // Detected with actual file/directory path
+  | { type: "none" }; // No detection (not found or not applicable)
+
 // Changes to either one of these values have to be synchronized with a corresponding update in `activation.rb`
 export const ACTIVATION_SEPARATOR = "RUBY_LSP_ACTIVATION_SEPARATOR";
 export const VALUE_SEPARATOR = "RUBY_LSP_VS";
diff --git a/vscode/src/test/suite/ruby/asdf.test.ts b/vscode/src/test/suite/ruby/asdf.test.ts
@@ -50,7 +50,7 @@ suite("Asdf", () => {
       stderr: `${ACTIVATION_SEPARATOR}${envStub}${ACTIVATION_SEPARATOR}`,
     });
 
-    sandbox.stub(Asdf, "detect").resolves(vscode.Uri.file(`${os.homedir()}/.asdf/asdf.sh`));
+    sandbox.stub(Asdf, "detect").resolves({ type: "path", uri: vscode.Uri.file(`${os.homedir()}/.asdf/asdf.sh`) });
     sandbox.stub(vscode.env, "shell").get(() => "/bin/bash");
 
     const { env, version, yjit } = await asdf.activate();
@@ -82,7 +82,7 @@ suite("Asdf", () => {
       stderr: `${ACTIVATION_SEPARATOR}${envStub}${ACTIVATION_SEPARATOR}`,
     });
 
-    sandbox.stub(Asdf, "detect").resolves(vscode.Uri.file(`${os.homedir()}/.asdf/asdf.fish`));
+    sandbox.stub(Asdf, "detect").resolves({ type: "path", uri: vscode.Uri.file(`${os.homedir()}/.asdf/asdf.fish`) });
     sandbox.stub(vscode.env, "shell").get(() => "/opt/homebrew/bin/fish");
 
     const { env, version, yjit } = await asdf.activate();
@@ -114,7 +114,7 @@ suite("Asdf", () => {
       stderr: `${ACTIVATION_SEPARATOR}${envStub}${ACTIVATION_SEPARATOR}`,
     });
 
-    sandbox.stub(Asdf, "detect").resolves(vscode.Uri.file("/opt/homebrew/bin/asdf"));
+    sandbox.stub(Asdf, "detect").resolves({ type: "path", uri: vscode.Uri.file("/opt/homebrew/bin/asdf") });
 
     sandbox.stub(vscode.workspace, "fs").value({
       stat: () => Promise.resolve(undefined),
diff --git a/vscode/src/test/suite/ruby/mise.test.ts b/vscode/src/test/suite/ruby/mise.test.ts
@@ -146,7 +146,7 @@ suite("Mise", () => {
 
     const result = await Mise.detect(workspaceFolder, outputChannel);
 
-    assert.strictEqual(result?.fsPath, vscode.Uri.file(misePath).fsPath);
+    assert.strictEqual(result.type === "path" ? result.uri.fsPath : undefined, vscode.Uri.file(misePath).fsPath);
 
     getPossiblePathsStub.restore();
     fs.rmSync(tempDir, { recursive: true, force: true });
@@ -171,7 +171,7 @@ suite("Mise", () => {
 
     const result = await Mise.detect(workspaceFolder, outputChannel);
 
-    assert.strictEqual(result, undefined);
+    assert.strictEqual(result.type, "none");
 
     getPossiblePathsStub.restore();
     fs.rmSync(tempDir, { recursive: true, force: true });
@@ -200,7 +200,7 @@ suite("Mise", () => {
 
     const result = await Mise.detect(workspaceFolder, outputChannel);
 
-    assert.strictEqual(result?.fsPath, vscode.Uri.file(secondPath).fsPath);
+    assert.strictEqual(result.type === "path" ? result.uri.fsPath : undefined, vscode.Uri.file(secondPath).fsPath);
 
     getPossiblePathsStub.restore();
     fs.rmSync(tempDir, { recursive: true, force: true });
