Refactor Ruby and output channel (#874)

* Refactor Ruby * Turn output channel into a log channel and move it into a constant * Accept workspace folder in Ruby's constructor
Shopify · Nov 6, 2023 · 1ba7b0d · 1ba7b0d
1 parent a0b3380
commit 1ba7b0d
Show file tree

Hide file tree

Showing 8 changed files with 95 additions and 95 deletions.
diff --git a/src/client.ts b/src/client.ts
@@ -22,6 +22,7 @@ import { Telemetry, RequestEvent } from "./telemetry";
 import { Ruby } from "./ruby";
 import { StatusItems, Command, ServerState, ClientInterface } from "./status";
 import { TestController } from "./testController";
+import { LOG_CHANNEL } from "./common";
 
 const LSP_NAME = "Ruby LSP";
 const asyncExec = promisify(exec);
@@ -37,7 +38,6 @@ export default class Client implements ClientInterface {
   private readonly workingFolder: string;
   private readonly telemetry: Telemetry;
   private readonly statusItems: StatusItems;
-  private readonly outputChannel: vscode.OutputChannel;
   private readonly testController: TestController;
   private readonly customBundleGemfile: string = vscode.workspace
     .getConfiguration("rubyLsp")
@@ -56,7 +56,6 @@ export default class Client implements ClientInterface {
     telemetry: Telemetry,
     ruby: Ruby,
     testController: TestController,
-    outputChannel: vscode.OutputChannel,
     workingFolder = vscode.workspace.workspaceFolders![0].uri.fsPath,
   ) {
     this.workingFolder = workingFolder;
@@ -65,7 +64,6 @@ export default class Client implements ClientInterface {
     this.testController = testController;
     this.#context = context;
     this.#ruby = ruby;
-    this.outputChannel = outputChannel;
     this.#formatter = "";
     this.statusItems = new StatusItems(this);
     this.registerCommands();
@@ -111,7 +109,7 @@ export default class Client implements ClientInterface {
     const clientOptions: LanguageClientOptions = {
       documentSelector: [{ language: "ruby" }],
       diagnosticCollectionName: LSP_NAME,
-      outputChannel: this.outputChannel,
+      outputChannel: LOG_CHANNEL,
       revealOutputChannelOn: RevealOutputChannelOn.Never,
       diagnosticPullOptions: this.diagnosticPullOptions(),
       initializationOptions: {
@@ -231,9 +229,7 @@ export default class Client implements ClientInterface {
       await this.client.start();
     } catch (error: any) {
       this.state = ServerState.Error;
-      this.outputChannel.appendLine(
-        `Error restarting the server: ${error.message}`,
-      );
+      LOG_CHANNEL.error(`Error restarting the server: ${error.message}`);
       return;
     }
 
@@ -274,16 +270,12 @@ export default class Client implements ClientInterface {
       }
     } catch (error: any) {
       this.state = ServerState.Error;
-
-      this.outputChannel.appendLine(
-        `Error restarting the server: ${error.message}`,
-      );
+      LOG_CHANNEL.error(`Error restarting the server: ${error.message}`);
     }
   }
 
   dispose() {
     this.client?.dispose();
-    this.outputChannel.dispose();
   }
 
   get ruby(): Ruby {
@@ -461,9 +453,7 @@ export default class Client implements ClientInterface {
         this.context.workspaceState.update("rubyLsp.lastGemUpdate", Date.now());
       } catch (error) {
         // If we fail to update the global installation of `ruby-lsp`, we don't want to prevent the server from starting
-        this.outputChannel.appendLine(
-          `Failed to update global ruby-lsp gem: ${error}`,
-        );
+        LOG_CHANNEL.error(`Failed to update global ruby-lsp gem: ${error}`);
       }
     }
   }

diff --git a/src/common.ts b/src/common.ts
@@ -0,0 +1,22 @@
+import fs from "fs/promises";
+import { exec } from "child_process";
+import { promisify } from "util";
+
+import * as vscode from "vscode";
+
+export const asyncExec = promisify(exec);
+export const LOG_CHANNEL = vscode.window.createOutputChannel("Ruby LSP", {
+  log: true,
+});
+
+export async function pathExists(
+  path: string,
+  mode = fs.constants.R_OK,
+): Promise<boolean> {
+  try {
+    await fs.access(path, mode);
+    return true;
+  } catch (error: any) {
+    return false;
+  }
+}
diff --git a/src/debugger.ts b/src/debugger.ts
@@ -5,6 +5,7 @@ import { ChildProcessWithoutNullStreams, spawn } from "child_process";
 import * as vscode from "vscode";
 
 import { Ruby } from "./ruby";
+import { LOG_CHANNEL } from "./common";
 
 export class Debugger
   implements
@@ -16,16 +17,13 @@ export class Debugger
   private debugProcess?: ChildProcessWithoutNullStreams;
   private readonly console = vscode.debug.activeDebugConsole;
   private readonly subscriptions: vscode.Disposable[];
-  private readonly outputChannel: vscode.OutputChannel;
 
   constructor(
     context: vscode.ExtensionContext,
     ruby: Ruby,
-    outputChannel: vscode.OutputChannel,
     workingFolder = vscode.workspace.workspaceFolders![0].uri.fsPath,
   ) {
     this.ruby = ruby;
-    this.outputChannel = outputChannel;
     this.subscriptions = [
       vscode.debug.registerDebugConfigurationProvider("ruby_lsp", this),
       vscode.debug.registerDebugAdapterDescriptorFactory("ruby_lsp", this),
@@ -183,15 +181,9 @@ export class Debugger
         configuration.program,
       ];
 
-      this.outputChannel.appendLine(
-        `Ruby LSP> Spawning debugger in directory ${this.workingFolder}`,
-      );
-      this.outputChannel.appendLine(
-        `Ruby LSP>   Command bundle ${args.join(" ")}`,
-      );
-      this.outputChannel.appendLine(
-        `Ruby LSP>   Environment ${JSON.stringify(configuration.env)}`,
-      );
+      LOG_CHANNEL.info(`Spawning debugger in directory ${this.workingFolder}`);
+      LOG_CHANNEL.info(`   Command bundle ${args.join(" ")}`);
+      LOG_CHANNEL.info(`   Environment ${JSON.stringify(configuration.env)}`);
 
       this.debugProcess = spawn("bundle", args, {
         shell: true,
@@ -236,7 +228,7 @@ export class Debugger
         if (code) {
           const message = `Debugger exited with status ${code}. Check the output channel for more information.`;
           this.console.append(message);
-          this.outputChannel.show();
+          LOG_CHANNEL.show();
           reject(new Error(message));
         }
       });

diff --git a/src/extension.ts b/src/extension.ts
@@ -12,8 +12,7 @@ let debug: Debugger | undefined;
 let testController: TestController | undefined;
 
 export async function activate(context: vscode.ExtensionContext) {
-  const outputChannel = vscode.window.createOutputChannel("Ruby LSP");
-  const ruby = new Ruby(context, outputChannel);
+  const ruby = new Ruby(context, vscode.workspace.workspaceFolders![0]);
   await ruby.activateRuby();
 
   const telemetry = new Telemetry(context);
@@ -26,10 +25,10 @@ export async function activate(context: vscode.ExtensionContext) {
     telemetry,
   );
 
-  client = new Client(context, telemetry, ruby, testController, outputChannel);
+  client = new Client(context, telemetry, ruby, testController);
 
   await client.start();
-  debug = new Debugger(context, ruby, outputChannel);
+  debug = new Debugger(context, ruby);
 
   vscode.workspace.registerTextDocumentContentProvider(
     "ruby-lsp",