Use bundled environment activation script file

project-words

@@ -26,6 +26,7 @@ dont
 eglot
 Eglot
 eruby
+EUTF
 exitstatus
 EXTGLOB
 fakehome

vscode/activation.rb

@@ -0,0 +1,3 @@
+env = ENV.map { |k, v| "#{k}RUBY_LSP_VS#{v}" }
+env.unshift(RUBY_VERSION, Gem.path.join(","), !!defined?(RubyVM::YJIT))
+STDERR.print("RUBY_LSP_ACTIVATION_SEPARATOR#{env.join("RUBY_LSP_FS")}RUBY_LSP_ACTIVATION_SEPARATOR")

vscode/package.json

@@ -2,7 +2,7 @@
   "name": "ruby-lsp",
   "displayName": "Ruby LSP",
   "description": "VS Code plugin for connecting with the Ruby LSP",
-  "version": "0.8.20",
+  "version": "0.9.1",
   "publisher": "Shopify",
   "repository": {
     "type": "git",

vscode/src/debugger.ts

@@ -258,9 +258,6 @@ export class Debugger
 
       this.logDebuggerMessage(`Spawning debugger in directory ${cwd}`);
       this.logDebuggerMessage(`   Command bundle ${args.join(" ")}`);
-      this.logDebuggerMessage(
-        `   Environment ${JSON.stringify(configuration.env)}`,
-      );
 
       this.debugProcess = spawn("bundle", args, {
         shell: true,

vscode/src/ruby.ts

@@ -135,6 +135,7 @@ export class Ruby implements RubyInterface {
         new None(
           this.workspaceFolder,
           this.outputChannel,
+          this.context,
           this.manuallySelectRuby.bind(this),
           workspaceRubyPath,
         ),
@@ -170,6 +171,7 @@ export class Ruby implements RubyInterface {
             new None(
               this.workspaceFolder,
               this.outputChannel,
+              this.context,
               this.manuallySelectRuby.bind(this),
               globalRubyPath,
             ),
@@ -323,6 +325,7 @@ export class Ruby implements RubyInterface {
           new Asdf(
             this.workspaceFolder,
             this.outputChannel,
+            this.context,
             this.manuallySelectRuby.bind(this),
           ),
         );
@@ -332,6 +335,7 @@ export class Ruby implements RubyInterface {
           new Chruby(
             this.workspaceFolder,
             this.outputChannel,
+            this.context,
             this.manuallySelectRuby.bind(this),
           ),
         );
@@ -341,6 +345,7 @@ export class Ruby implements RubyInterface {
           new Rbenv(
             this.workspaceFolder,
             this.outputChannel,
+            this.context,
             this.manuallySelectRuby.bind(this),
           ),
         );
@@ -350,6 +355,7 @@ export class Ruby implements RubyInterface {
           new Rvm(
             this.workspaceFolder,
             this.outputChannel,
+            this.context,
             this.manuallySelectRuby.bind(this),
           ),
         );
@@ -359,6 +365,7 @@ export class Ruby implements RubyInterface {
           new Mise(
             this.workspaceFolder,
             this.outputChannel,
+            this.context,
             this.manuallySelectRuby.bind(this),
           ),
         );
@@ -368,6 +375,7 @@ export class Ruby implements RubyInterface {
           new RubyInstaller(
             this.workspaceFolder,
             this.outputChannel,
+            this.context,
             this.manuallySelectRuby.bind(this),
           ),
         );
@@ -377,6 +385,7 @@ export class Ruby implements RubyInterface {
           new Custom(
             this.workspaceFolder,
             this.outputChannel,
+            this.context,
             this.manuallySelectRuby.bind(this),
           ),
         );
@@ -386,6 +395,7 @@ export class Ruby implements RubyInterface {
           new None(
             this.workspaceFolder,
             this.outputChannel,
+            this.context,
             this.manuallySelectRuby.bind(this),
           ),
         );
@@ -395,6 +405,7 @@ export class Ruby implements RubyInterface {
           new Shadowenv(
             this.workspaceFolder,
             this.outputChannel,
+            this.context,
             this.manuallySelectRuby.bind(this),
           ),
         );

vscode/src/ruby/chruby.ts

@@ -31,9 +31,10 @@ export class Chruby extends VersionManager {
   constructor(
     workspaceFolder: vscode.WorkspaceFolder,
     outputChannel: WorkspaceChannel,
+    context: vscode.ExtensionContext,
     manuallySelectRuby: () => Promise<void>,
   ) {
-    super(workspaceFolder, outputChannel, manuallySelectRuby);
+    super(workspaceFolder, outputChannel, context, manuallySelectRuby);
 
     const configuredRubies = vscode.workspace
       .getConfiguration("rubyLsp")
@@ -199,7 +200,7 @@ export class Chruby extends VersionManager {
     ].join(";");
 
     const result = await this.runScript(
-      `${rubyExecutableUri.fsPath} -W0 -e '${script}'`,
+      `${rubyExecutableUri.fsPath} -EUTF-8:UTF-8 -e '${script}'`,
     );
 
     const [defaultGems, gemHome, yjit, version] =

vscode/src/ruby/none.ts

@@ -19,10 +19,11 @@ export class None extends VersionManager {
   constructor(
     workspaceFolder: vscode.WorkspaceFolder,
     outputChannel: WorkspaceChannel,
+    context: vscode.ExtensionContext,
     manuallySelectRuby: () => Promise<void>,
     rubyPath?: string,
   ) {
-    super(workspaceFolder, outputChannel, manuallySelectRuby);
+    super(workspaceFolder, outputChannel, context, manuallySelectRuby);
     this.rubyPath = rubyPath ?? "ruby";
   }
 

vscode/src/ruby/versionManager.ts

@@ -14,29 +14,29 @@ export interface ActivationResult {
   gemPath: string[];
 }
 
+// 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";
+export const FIELD_SEPARATOR = "RUBY_LSP_FS";
 
 export abstract class VersionManager {
-  public activationScript = [
-    `STDERR.print("${ACTIVATION_SEPARATOR}" + `,
-    "{ env: ENV.to_h, yjit: !!defined?(RubyVM::YJIT), version: RUBY_VERSION, gemPath: Gem.path }.to_json + ",
-    `"${ACTIVATION_SEPARATOR}")`,
-  ].join("");
-
   protected readonly outputChannel: WorkspaceChannel;
   protected readonly workspaceFolder: vscode.WorkspaceFolder;
   protected readonly bundleUri: vscode.Uri;
   protected readonly manuallySelectRuby: () => Promise<void>;
 
+  private readonly context: vscode.ExtensionContext;
   private readonly customBundleGemfile?: string;
 
   constructor(
     workspaceFolder: vscode.WorkspaceFolder,
     outputChannel: WorkspaceChannel,
+    context: vscode.ExtensionContext,
     manuallySelectRuby: () => Promise<void>,
   ) {
     this.workspaceFolder = workspaceFolder;
     this.outputChannel = outputChannel;
+    this.context = context;
     this.manuallySelectRuby = manuallySelectRuby;
     const customBundleGemfile: string = vscode.workspace
       .getConfiguration("rubyLsp")
@@ -59,28 +59,33 @@ export abstract class VersionManager {
   // language server
   abstract activate(): Promise<ActivationResult>;
 
-  protected async runEnvActivationScript(activatedRuby: string) {
+  protected async runEnvActivationScript(
+    activatedRuby: string,
+  ): Promise<ActivationResult> {
+    const activationUri = vscode.Uri.joinPath(
+      this.context.extensionUri,
+      "activation.rb",
+    );
+
     const result = await this.runScript(
-      `${activatedRuby} -W0 -rjson -e '${this.activationScript}'`,
+      `${activatedRuby} -EUTF-8:UTF-8 '${activationUri.fsPath}'`,
     );
 
     const activationContent = new RegExp(
-      `${ACTIVATION_SEPARATOR}(.*)${ACTIVATION_SEPARATOR}`,
+      `${ACTIVATION_SEPARATOR}([^]*)${ACTIVATION_SEPARATOR}`,
     ).exec(result.stderr);
 
-    return this.parseWithErrorHandling(activationContent![1]);
-  }
-
-  protected parseWithErrorHandling(json: string) {
-    try {
-      return JSON.parse(json);
-    } catch (error: any) {
-      this.outputChannel.error(
-        `Tried parsing invalid JSON environment: ${json}`,
-      );
-
-      throw error;
-    }
+    const [version, gemPath, yjit, ...envEntries] =
+      activationContent![1].split(FIELD_SEPARATOR);
+
+    return {
+      version,
+      gemPath: gemPath.split(","),
+      yjit: yjit === "true",
+      env: Object.fromEntries(
+        envEntries.map((entry) => entry.split(VALUE_SEPARATOR)),
+      ),
+    };
   }
 
   // Runs the given command in the directory for the Bundle, using the user's preferred shell and inheriting the current
@@ -98,14 +103,12 @@ export abstract class VersionManager {
     this.outputChannel.info(
       `Running command: \`${command}\` in ${this.bundleUri.fsPath} using shell: ${shell}`,
     );
-    this.outputChannel.debug(
-      `Environment used for command: ${JSON.stringify(process.env)}`,
-    );
 
     return asyncExec(command, {
       cwd: this.bundleUri.fsPath,
       shell,
       env: process.env,
+      encoding: "utf-8",
     });
   }
 

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

@@ -50,6 +50,7 @@ async function launchClient(workspaceUri: vscode.Uri) {
       get: (_name: string) => undefined,
       update: (_name: string, _value: any) => Promise.resolve(),
     },
+    extensionUri: vscode.Uri.file(path.join(workspaceUri.fsPath, "vscode")),
   } as unknown as vscode.ExtensionContext;
   const fakeLogger = new FakeLogger();
   const outputChannel = new WorkspaceChannel("fake", fakeLogger as any);

vscode/src/test/suite/debugger.test.ts

@@ -198,12 +198,14 @@ suite("Debugger", () => {
       'source "https://rubygems.org"\ngem "debug"',
     );
 
+    const extensionPath = path.dirname(path.dirname(path.dirname(__dirname)));
     const context = {
       subscriptions: [],
       workspaceState: {
         get: () => undefined,
         update: () => undefined,
       },
+      extensionUri: vscode.Uri.file(extensionPath),
     } as unknown as vscode.ExtensionContext;
     const outputChannel = new WorkspaceChannel("fake", LOG_CHANNEL);
     const workspaceFolder: vscode.WorkspaceFolder = {

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

@@ -10,8 +10,12 @@ import { Ruby, ManagerIdentifier } from "../../ruby";
 import { WorkspaceChannel } from "../../workspaceChannel";
 import { LOG_CHANNEL } from "../../common";
 import * as common from "../../common";
-import { ACTIVATION_SEPARATOR } from "../../ruby/versionManager";
 import { Shadowenv, UntrustedWorkspaceError } from "../../ruby/shadowenv";
+import {
+  ACTIVATION_SEPARATOR,
+  FIELD_SEPARATOR,
+  VALUE_SEPARATOR,
+} from "../../ruby/versionManager";
 
 import { FAKE_TELEMETRY } from "./fakeTelemetry";
 
@@ -30,6 +34,7 @@ suite("Ruby environment activation", () => {
       get: () => undefined,
       update: () => undefined,
     },
+    extensionUri: vscode.Uri.file(path.join(workspacePath, "vscode")),
   } as unknown as vscode.ExtensionContext;
   const outputChannel = new WorkspaceChannel("fake", LOG_CHANNEL);
 
@@ -125,16 +130,16 @@ suite("Ruby environment activation", () => {
         },
       } as unknown as vscode.WorkspaceConfiguration);
 
-    const envStub = {
-      env: { ANY: "true" },
-      yjit: true,
-      version: "3.3.5",
-      gemPath: ["~/.gem/ruby/3.3.5", "/opt/rubies/3.3.5/lib/ruby/gems/3.3.0"],
-    };
+    const envStub = [
+      "3.3.5",
+      "~/.gem/ruby/3.3.5,/opt/rubies/3.3.5/lib/ruby/gems/3.3.0",
+      "true",
+      `ANY${VALUE_SEPARATOR}true`,
+    ].join(FIELD_SEPARATOR);
 
     const execStub = sinon.stub(common, "asyncExec").resolves({
       stdout: "",
-      stderr: `${ACTIVATION_SEPARATOR}${JSON.stringify(envStub)}${ACTIVATION_SEPARATOR}`,
+      stderr: `${ACTIVATION_SEPARATOR}${envStub}${ACTIVATION_SEPARATOR}`,
     });
 
     const ruby = new Ruby(