Change the result of detect methods to return DetectionResult objects

Author: rafaelfranca

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;
       }

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,25 +36,37 @@ 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
-    return VersionManager.findFirst(Asdf.getPossibleScriptPaths());
+    const scriptResult = await VersionManager.findFirst(Asdf.getPossibleScriptPaths());
+    if (scriptResult) {
+      return { type: "path", uri: scriptResult };
+    }
+
+    return { type: "none" };
   }
 
   async activate(): Promise<ActivationResult> {
     // Prefer the path configured by the user, then use detect() to find ASDF
     const configuredPath = await this.getConfiguredAsdfPath();
-    const asdfUri = configuredPath
-      ? vscode.Uri.file(configuredPath)
-      : await Asdf.detect(this.workspaceFolder, this.outputChannel);
+    let asdfUri: vscode.Uri | undefined;
+
+    if (configuredPath) {
+      asdfUri = vscode.Uri.file(configuredPath);
+    } else {
+      const result = await Asdf.detect(this.workspaceFolder, this.outputChannel);
+      if (result.type === "path") {
+        asdfUri = result.uri;
+      }
+    }
 
     if (!asdfUri) {
       throw new Error(

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

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> {

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();

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;

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> {

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

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> {

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> {