Use bundled environment activation script file

Shopify · Jan 27, 2025 · 8c37f81 · 8c37f81
1 parent 0ee2ba7
commit 8c37f81
Show file tree

Hide file tree

Showing 18 changed files with 300 additions and 51 deletions.
diff --git a/vscode/activation.rb b/vscode/activation.rb
@@ -0,0 +1,2 @@
+env = { env: ENV.to_h, yjit: !!defined?(RubyVM::YJIT), version: RUBY_VERSION, gemPath: Gem.path }.to_json
+STDERR.print("RUBY_LSP_ACTIVATION_SEPARATOR#{env}RUBY_LSP_ACTIVATION_SEPARATOR")
diff --git a/vscode/package.json b/vscode/package.json
@@ -720,7 +720,7 @@
     }
   },
   "scripts": {
-    "vscode:prepublish": "yarn run esbuild-base --minify",
+    "vscode:prepublish": "yarn run esbuild-base --minify && cp activation.rb out/activation.rb",
     "package": "vsce package --out vscode-ruby-lsp.vsix --baseImagesUrl https://github.com/Shopify/ruby-lsp/raw/HEAD/vscode",
     "package_prerelease": "vsce package --pre-release --out vscode-ruby-lsp.vsix --baseImagesUrl https://github.com/Shopify/ruby-lsp/raw/HEAD/vscode",
     "esbuild-base": "esbuild ./src/extension.ts --bundle --outfile=out/extension.js --external:vscode --format=cjs --platform=node",

diff --git a/vscode/src/ruby.ts b/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,
         ),
@@ -165,6 +166,7 @@ export class Ruby implements RubyInterface {
             new None(
               this.workspaceFolder,
               this.outputChannel,
+              this.context,
               this.manuallySelectRuby.bind(this),
               globalRubyPath,
             ),
@@ -318,6 +320,7 @@ export class Ruby implements RubyInterface {
           new Asdf(
             this.workspaceFolder,
             this.outputChannel,
+            this.context,
             this.manuallySelectRuby.bind(this),
           ),
         );
@@ -327,6 +330,7 @@ export class Ruby implements RubyInterface {
           new Chruby(
             this.workspaceFolder,
             this.outputChannel,
+            this.context,
             this.manuallySelectRuby.bind(this),
           ),
         );
@@ -336,6 +340,7 @@ export class Ruby implements RubyInterface {
           new Rbenv(
             this.workspaceFolder,
             this.outputChannel,
+            this.context,
             this.manuallySelectRuby.bind(this),
           ),
         );
@@ -345,6 +350,7 @@ export class Ruby implements RubyInterface {
           new Rvm(
             this.workspaceFolder,
             this.outputChannel,
+            this.context,
             this.manuallySelectRuby.bind(this),
           ),
         );
@@ -354,6 +360,7 @@ export class Ruby implements RubyInterface {
           new Mise(
             this.workspaceFolder,
             this.outputChannel,
+            this.context,
             this.manuallySelectRuby.bind(this),
           ),
         );
@@ -363,6 +370,7 @@ export class Ruby implements RubyInterface {
           new RubyInstaller(
             this.workspaceFolder,
             this.outputChannel,
+            this.context,
             this.manuallySelectRuby.bind(this),
           ),
         );
@@ -372,6 +380,7 @@ export class Ruby implements RubyInterface {
           new Custom(
             this.workspaceFolder,
             this.outputChannel,
+            this.context,
             this.manuallySelectRuby.bind(this),
           ),
         );
@@ -381,6 +390,7 @@ export class Ruby implements RubyInterface {
           new None(
             this.workspaceFolder,
             this.outputChannel,
+            this.context,
             this.manuallySelectRuby.bind(this),
           ),
         );
@@ -390,6 +400,7 @@ export class Ruby implements RubyInterface {
           new Shadowenv(
             this.workspaceFolder,
             this.outputChannel,
+            this.context,
             this.manuallySelectRuby.bind(this),
           ),
         );

diff --git a/vscode/src/ruby/chruby.ts b/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")

diff --git a/vscode/src/ruby/none.ts b/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";
   }
 

diff --git a/vscode/src/ruby/versionManager.ts b/vscode/src/ruby/versionManager.ts
@@ -17,26 +17,23 @@ export interface ActivationResult {
 export const ACTIVATION_SEPARATOR = "RUBY_LSP_ACTIVATION_SEPARATOR";
 
 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")
@@ -60,8 +57,12 @@ export abstract class VersionManager {
   abstract activate(): Promise<ActivationResult>;
 
   protected async runEnvActivationScript(activatedRuby: string) {
+    const activationUri = vscode.Uri.joinPath(
+      this.context.extensionUri,
+      "activation.rb",
+    );
     const result = await this.runScript(
-      `${activatedRuby} -W0 -rjson -e '${this.activationScript}'`,
+      `${activatedRuby} -W0 -rjson '${activationUri.fsPath}'`,
     );
 
     const activationContent = new RegExp(

diff --git a/vscode/src/test/suite/client.test.ts b/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);

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

diff --git a/vscode/src/test/suite/ruby.test.ts b/vscode/src/test/suite/ruby.test.ts
@@ -29,6 +29,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);
 

diff --git a/vscode/src/test/suite/ruby/asdf.test.ts b/vscode/src/test/suite/ruby/asdf.test.ts
@@ -16,6 +16,15 @@ suite("Asdf", () => {
     console.log("Skipping Asdf tests on Windows");
     return;
   }
+  const context = {
+    extensionMode: vscode.ExtensionMode.Test,
+    subscriptions: [],
+    workspaceState: {
+      get: (_name: string) => undefined,
+      update: (_name: string, _value: any) => Promise.resolve(),
+    },
+    extensionUri: vscode.Uri.parse("file:///fake"),
+  } as unknown as vscode.ExtensionContext;
 
   test("Finds Ruby based on .tool-versions", async () => {
     // eslint-disable-next-line no-process-env
@@ -26,7 +35,12 @@ suite("Asdf", () => {
       index: 0,
     };
     const outputChannel = new WorkspaceChannel("fake", common.LOG_CHANNEL);
-    const asdf = new Asdf(workspaceFolder, outputChannel, async () => {});
+    const asdf = new Asdf(
+      workspaceFolder,
+      outputChannel,
+      context,
+      async () => {},
+    );
     const envStub = {
       env: { ANY: "true" },
       yjit: true,
@@ -47,7 +61,7 @@ suite("Asdf", () => {
 
     assert.ok(
       execStub.calledOnceWithExactly(
-        `. ${os.homedir()}/.asdf/asdf.sh && asdf exec ruby -W0 -rjson -e '${asdf.activationScript}'`,
+        `. ${os.homedir()}/.asdf/asdf.sh && asdf exec ruby -W0 -rjson '/fake/activation.rb'`,
         {
           cwd: workspacePath,
           shell: "/bin/bash",
@@ -75,7 +89,12 @@ suite("Asdf", () => {
       index: 0,
     };
     const outputChannel = new WorkspaceChannel("fake", common.LOG_CHANNEL);
-    const asdf = new Asdf(workspaceFolder, outputChannel, async () => {});
+    const asdf = new Asdf(
+      workspaceFolder,
+      outputChannel,
+      context,
+      async () => {},
+    );
     const envStub = {
       env: { ANY: "true" },
       yjit: true,
@@ -98,7 +117,7 @@ suite("Asdf", () => {
 
     assert.ok(
       execStub.calledOnceWithExactly(
-        `. ${os.homedir()}/.asdf/asdf.fish && asdf exec ruby -W0 -rjson -e '${asdf.activationScript}'`,
+        `. ${os.homedir()}/.asdf/asdf.fish && asdf exec ruby -W0 -rjson '/fake/activation.rb'`,
         {
           cwd: workspacePath,
           shell: "/opt/homebrew/bin/fish",
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		env = { env: ENV.to_h, yjit: !!defined?(RubyVM::YJIT), version: RUBY_VERSION, gemPath: Gem.path }.to_json
		STDERR.print("RUBY_LSP_ACTIVATION_SEPARATOR#{env}RUBY_LSP_ACTIVATION_SEPARATOR")