fix(turbopack-ecmascript): make free var replacements (compile time defines) work for member expressions and allow JSON values (vercel/turborepo#6000)

Author: ForsakenHarmony

crates/turbopack-core/src/compile_time_info.rs

@@ -72,11 +72,14 @@ macro_rules! free_var_references {
     };
 }
 
+// TODO: replace with just a `serde_json::Value`
+// https://linear.app/vercel/issue/WEB-1641/compiletimedefinevalue-should-just-use-serde-jsonvalue
 #[turbo_tasks::value(serialization = "auto_for_input")]
 #[derive(Debug, Clone, Hash, PartialOrd, Ord)]
 pub enum CompileTimeDefineValue {
     Bool(bool),
     String(String),
+    JSON(String),
 }
 
 impl From<bool> for CompileTimeDefineValue {
@@ -97,7 +100,14 @@ impl From<&str> for CompileTimeDefineValue {
     }
 }
 
+impl From<serde_json::Value> for CompileTimeDefineValue {
+    fn from(value: serde_json::Value) -> Self {
+        Self::JSON(value.to_string())
+    }
+}
+
 #[turbo_tasks::value(transparent)]
+#[derive(Debug, Clone)]
 pub struct CompileTimeDefines(pub IndexMap<Vec<String>, CompileTimeDefineValue>);
 
 impl IntoIterator for CompileTimeDefines {
@@ -118,7 +128,7 @@ impl CompileTimeDefines {
 }
 
 #[turbo_tasks::value]
-#[derive(Debug)]
+#[derive(Debug, Clone)]
 pub enum FreeVarReference {
     EcmaScriptModule {
         request: String,
@@ -153,6 +163,7 @@ impl From<CompileTimeDefineValue> for FreeVarReference {
 }
 
 #[turbo_tasks::value(transparent)]
+#[derive(Debug, Clone)]
 pub struct FreeVarReferences(pub IndexMap<Vec<String>, FreeVarReference>);
 
 #[turbo_tasks::value_impl]
@@ -164,6 +175,7 @@ impl FreeVarReferences {
 }
 
 #[turbo_tasks::value(shared)]
+#[derive(Debug, Clone)]
 pub struct CompileTimeInfo {
     pub environment: Vc<Environment>,
     pub defines: Vc<CompileTimeDefines>,

crates/turbopack-ecmascript/src/analyzer/mod.rs

@@ -502,6 +502,7 @@ impl From<&CompileTimeDefineValue> for JsValue {
         match v {
             CompileTimeDefineValue::String(s) => JsValue::Constant(s.as_str().into()),
             CompileTimeDefineValue::Bool(b) => JsValue::Constant((*b).into()),
+            CompileTimeDefineValue::JSON(_) => JsValue::unknown_empty("compile time injected JSON"),
         }
     }
 }

crates/turbopack-ecmascript/src/path_visitor.rs

@@ -144,6 +144,7 @@ impl VisitMutAstPath for ApplyVisitors<'_, '_> {
     // TODO: we need a macro to apply that for all methods
     method!(visit_mut_prop, Prop);
     method!(visit_mut_expr, Expr);
+    method!(visit_mut_member_expr, MemberExpr);
     method!(visit_mut_pat, Pat);
     method!(visit_mut_stmt, Stmt);
     method!(visit_mut_module_decl, ModuleDecl);

crates/turbopack-ecmascript/src/references/constant_value.rs

@@ -35,17 +35,20 @@ impl CodeGenerateable for ConstantValue {
         _context: Vc<Box<dyn EcmascriptChunkingContext>>,
     ) -> Result<Vc<CodeGeneration>> {
         let value = self.value.clone();
-        let visitors = [
-            create_visitor!(exact &self.path.await?, visit_mut_expr(expr: &mut Expr) {
-                *expr = match value {
-                    CompileTimeDefineValue::Bool(true) => quote!("(\"TURBOPACK compile-time value\", true)" as Expr),
-                    CompileTimeDefineValue::Bool(false) => quote!("(\"TURBOPACK compile-time value\", false)" as Expr),
-                    CompileTimeDefineValue::String(ref s) => quote!("(\"TURBOPACK compile-time value\", $e)" as Expr, e: Expr = s.to_string().into()),
-                };
-            }),
-        ]
-        .into();
+        let path = &self.path.await?;
 
-        Ok(CodeGeneration { visitors }.cell())
+        let visitor = create_visitor!(path, visit_mut_expr(expr: &mut Expr) {
+            *expr = match value {
+                CompileTimeDefineValue::Bool(true) => quote!("(\"TURBOPACK compile-time value\", true)" as Expr),
+                CompileTimeDefineValue::Bool(false) => quote!("(\"TURBOPACK compile-time value\", false)" as Expr),
+                CompileTimeDefineValue::String(ref s) => quote!("(\"TURBOPACK compile-time value\", $e)" as Expr, e: Expr = s.to_string().into()),
+                CompileTimeDefineValue::JSON(ref s) => quote!("(\"TURBOPACK compile-time value\", JSON.parse($e))" as Expr, e: Expr = s.to_string().into()),
+            };
+        });
+
+        Ok(CodeGeneration {
+            visitors: vec![visitor],
+        }
+        .cell())
     }
 }

crates/turbopack-tests/tests/snapshot.rs

@@ -11,6 +11,7 @@ use std::{
 use anyhow::{bail, Context, Result};
 use dunce::canonicalize;
 use serde::Deserialize;
+use serde_json::json;
 use turbo_tasks::{ReadRef, TryJoinIterExt, TurboTasks, Value, ValueToString, Vc};
 use turbo_tasks_env::DotenvProcessEnv;
 use turbo_tasks_fs::{
@@ -34,6 +35,7 @@ use turbopack_core::{
     context::AssetContext,
     environment::{BrowserEnvironment, Environment, ExecutionEnvironment, NodeJsEnvironment},
     file_source::FileSource,
+    free_var_references,
     issue::{Issue, IssueDescriptionExt},
     module::Module,
     output::OutputAsset,
@@ -209,17 +211,18 @@ async fn run_test(resource: String) -> Result<Vc<FileSystemPath>> {
             )
         }
     }));
+
+    let defines = compile_time_defines!(
+        process.turbopack = true,
+        process.env.NODE_ENV = "development",
+        DEFINED_VALUE = "value",
+        DEFINED_TRUE = true,
+        A.VERY.LONG.DEFINED.VALUE = json!({ "test": true }),
+    );
+
     let compile_time_info = CompileTimeInfo::builder(env)
-        .defines(
-            compile_time_defines!(
-                process.turbopack = true,
-                process.env.NODE_ENV = "development",
-                DEFINED_VALUE = "value",
-                DEFINED_TRUE = true,
-                A.VERY.LONG.DEFINED.VALUE = "value",
-            )
-            .cell(),
-        )
+        .defines(defines.clone().cell())
+        .free_var_references(free_var_references!(..defines.into_iter()).cell())
         .cell();
 
     let custom_ecma_transform_plugins = Some(CustomEcmascriptTransformPlugins::cell(

crates/turbopack-tests/tests/snapshot/comptime/define/input/index.js

@@ -20,7 +20,6 @@ if (process.env.NODE_ENV === 'production') {
 
 var p = process;
 
-// TODO: replacement is not implemented yet
 console.log(A.VERY.LONG.DEFINED.VALUE);
 console.log(DEFINED_VALUE);
 console.log(p.env.NODE_ENV);