Allow specifying environment variables to JavaScriptRewriteRpc.Builder (#6441)

* Allow specifying environment variables on `JavaScriptRewriteRpc.Builder`

Author: pdelagrave

rewrite-javascript/build.gradle.kts

@@ -195,6 +195,7 @@ testing {
                 implementation(project(":rewrite-test"))
                 implementation(project(":rewrite-json"))
                 implementation(project(":rewrite-java-tck"))
+                implementation(project(":rewrite-yaml"))
                 implementation("org.assertj:assertj-core:latest.release")
                 implementation("org.junit.platform:junit-platform-suite-api")
                 runtimeOnly("org.junit.platform:junit-platform-suite-engine")

rewrite-javascript/rewrite/fixtures/example-recipe.ts

@@ -26,6 +26,7 @@ import {MarkTypes} from "./mark-types";
 import {MarkPrimitiveTypes} from "./mark-primitive-types";
 import {MarkClassTypes} from "./mark-class-types";
 import {ScanningEditor} from "./scanning-editor";
+import {ReplaceAssignment} from "./replace-assignment";
 
 export function activate(registry: RecipeRegistry) {
     registry.register(ChangeText);
@@ -40,4 +41,5 @@ export function activate(registry: RecipeRegistry) {
     registry.register(MarkPrimitiveTypes);
     registry.register(MarkClassTypes);
     registry.register(ScanningEditor);
+    registry.register(ReplaceAssignment);
 }

rewrite-javascript/rewrite/fixtures/replace-assignment.ts

@@ -0,0 +1,62 @@
+/*
+ * Copyright 2025 the original author or authors.
+ * <p>
+ * Licensed under the Moderne Source Available License (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * https://docs.moderne.io/licensing/moderne-source-available-license
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import {createDraft, finishDraft} from "immer";
+import {emptyMarkers, ExecutionContext, Option, randomId, Recipe, TreeVisitor} from "@openrewrite/rewrite";
+import {JavaScriptVisitor} from "@openrewrite/rewrite/javascript";
+import {J, singleSpace, Type} from "@openrewrite/rewrite/java";
+
+export class ReplaceAssignment extends Recipe {
+    name = "org.openrewrite.example.javascript.replace-assignment"
+    displayName = "Replace assignment with env var value";
+    description = "Replaces the assignment of a variable with the value of an environment variable.";
+
+    @Option({
+        displayName: "Environment Variable Name",
+        description: "The name of the environment variable whose value will replace the variable assignment.",
+    })
+    variable!: string;
+
+    constructor(options: { variable: string }) {
+        super(options);
+    }
+
+    async editor(): Promise<TreeVisitor<any, ExecutionContext>> {
+        const envVar = this.variable;
+        const envVarValue = "'" + process.env[envVar] + "'";
+        return new class extends JavaScriptVisitor<ExecutionContext> {
+            protected async visitVariable(variable: J.VariableDeclarations.NamedVariable, c: ExecutionContext): Promise<J | undefined> {
+                if ((variable.initializer!.element as J.Literal).valueSource === envVarValue) {
+                    return super.visitVariable(variable, c);
+                }
+                let draft = createDraft(variable);
+                draft.initializer = {
+                    kind: J.Kind.LeftPadded,
+                    markers: emptyMarkers,
+                    element: {
+                        kind: J.Kind.Literal,
+                        id: randomId(),
+                        prefix: singleSpace,
+                        markers: emptyMarkers,
+                        valueSource: envVarValue,
+                        type: Type.Primitive.String,
+                    },
+                    before: singleSpace,
+                };
+                return finishDraft(draft);
+            }
+        }
+    }
+}

rewrite-javascript/src/integTest/java/org/openrewrite/javascript/rpc/JavaScriptRewriteRpcTest.java

@@ -45,9 +45,9 @@
 import static org.openrewrite.java.Assertions.java;
 import static org.openrewrite.javascript.Assertions.*;
 import static org.openrewrite.json.Assertions.json;
-import static org.openrewrite.yaml.Assertions.yaml;
 import static org.openrewrite.test.RewriteTest.toRecipe;
 import static org.openrewrite.test.SourceSpecs.text;
+import static org.openrewrite.yaml.Assertions.yaml;
 
 class JavaScriptRewriteRpcTest implements RewriteTest {
     @TempDir
@@ -56,10 +56,10 @@ class JavaScriptRewriteRpcTest implements RewriteTest {
     @BeforeEach
     void before() {
         JavaScriptRewriteRpc.setFactory(JavaScriptRewriteRpc.builder()
-          .recipeInstallDir(tempDir)
-          .metricsCsv(tempDir.resolve("rpc.csv"))
-          .log(tempDir.resolve("rpc.log"))
-          .traceRpcMessages()
+            .recipeInstallDir(tempDir)
+            .metricsCsv(tempDir.resolve("rpc.csv"))
+            .log(tempDir.resolve("rpc.log"))
+            .traceRpcMessages()
 //          .inspectBrk(Path.of("rewrite"))
 //          .timeout(Duration.ofHours(1))
         );
@@ -446,6 +446,24 @@ void runScanningRecipeThatEdits() {
         );
     }
 
+    @Test
+    void environmentVariableIsSetRemotely() {
+        JavaScriptRewriteRpc.setFactory(JavaScriptRewriteRpc.builder()
+          .recipeInstallDir(tempDir)
+          .environment(Map.of("HTTPS_PROXY", "http://unused:3128"))
+        );
+        installRecipes();
+
+        rewriteRun(spec -> spec
+            .recipe(client().prepareRecipe("org.openrewrite.example.javascript.replace-assignment",
+              Map.of("variable", "HTTPS_PROXY"))),
+          javascript(
+            "const v = 'value'",
+            "const v = 'http://unused:3128'"
+          )
+        );
+    }
+
     private void installRecipes() {
         File exampleRecipes = new File("rewrite/dist-fixtures/example-recipe.js");
         installRecipes(exampleRecipes);

rewrite-javascript/src/main/java/org/openrewrite/javascript/rpc/JavaScriptRewriteRpc.java

@@ -34,6 +34,7 @@
 import java.nio.file.Paths;
 import java.nio.file.StandardOpenOption;
 import java.time.Duration;
+import java.util.HashMap;
 import java.util.Map;
 import java.util.Objects;
 import java.util.function.Supplier;
@@ -109,6 +110,7 @@ public static Builder builder() {
 
     @RequiredArgsConstructor
     public static class Builder implements Supplier<JavaScriptRewriteRpc> {
+        private final Map<String, String> environment = new HashMap<>();
         private Environment marketplace = Environment.builder().build();
         private Path npxPath = Paths.get("npx");
         private @Nullable Path log;
@@ -163,6 +165,11 @@ public Builder metricsCsv(@Nullable Path metricsCsv) {
             return this;
         }
 
+        public Builder environment(Map<String, String> environment) {
+            this.environment.putAll(environment);
+            return this;
+        }
+
         /**
          * Enables info and debug level logging.
          *
@@ -283,6 +290,7 @@ public JavaScriptRewriteRpc get() {
                     nodeOptions.append(" --max-old-space-size=").append(maxHeapSize);
                 }
             }
+            process.environment().putAll(environment);
             process.environment().put("NODE_OPTIONS", nodeOptions.toString());
             if (npxPath.getParent() != null) {
                 // `npx` is typically a shebang script alongside the `node` executable