Turbopack: FreeVarReference::Warning

Author: mischnic

turbopack/crates/turbopack-core/src/compile_time_info.rs

@@ -314,6 +314,12 @@ pub enum FreeVarReference {
     Value(CompileTimeDefineValue),
     InputRelative(InputRelativeConstant),
     Error(RcStr),
+    /// Emits a warning when the free variable is inlined, then processes the inner reference.
+    /// Unlike `Error`, this will still perform the replacement after emitting the warning.
+    Warning {
+        message: RcStr,
+        inner: Box<FreeVarReference>,
+    },
 }
 
 impl From<bool> for FreeVarReference {

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

@@ -659,6 +659,7 @@ impl TryFrom<&FreeVarReference> for JsValue {
                     },
                 ))
             }
+            FreeVarReference::Warning { inner, .. } => inner.as_ref().try_into(),
         }
     }
 }

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

@@ -2998,6 +2998,19 @@ async fn handle_free_var_reference(
                 ast_path.to_vec().into(),
             ));
         }
+        FreeVarReference::Warning { message, inner } => {
+            state.handler.span_warn_with_code(
+                span,
+                message,
+                DiagnosticId::Error(
+                    errors::failed_to_analyze::ecmascript::FREE_VAR_REFERENCE.to_string(),
+                ),
+            );
+            return Box::pin(handle_free_var_reference(
+                ast_path, inner, span, state, analysis,
+            ))
+            .await;
+        }
     }
     Ok(true)
 }

turbopack/crates/turbopack-tests/tests/snapshot.rs

@@ -33,7 +33,9 @@ use turbopack_core::{
         EvaluatableAssets, MinifyType, SourceMapSourceType, availability_info::AvailabilityInfo,
     },
     compile_time_defines,
-    compile_time_info::{CompileTimeDefineValue, CompileTimeInfo, DefinableNameSegment},
+    compile_time_info::{
+        CompileTimeDefineValue, CompileTimeInfo, DefinableNameSegment, FreeVarReference,
+    },
     condition::ContextCondition,
     context::AssetContext,
     environment::{BrowserEnvironment, Environment, ExecutionEnvironment, NodeJsEnvironment},
@@ -321,7 +323,18 @@ async fn run_test_operation(resource: RcStr) -> Result<Vc<FileSystemPath>> {
 
     let compile_time_info = CompileTimeInfo::builder(env)
         .defines(defines.clone().resolved_cell())
-        .free_var_references(free_var_references!(..defines.into_iter()).resolved_cell())
+        .free_var_references(
+            free_var_references!(
+                ..defines.into_iter(),
+                WARNED_VALUE = FreeVarReference::Warning {
+                    message: rcstr!("WARNED_VALUE is deprecated, use REPLACEMENT_VALUE instead"),
+                    inner: Box::new(FreeVarReference::Value(CompileTimeDefineValue::String(
+                        rcstr!("replacement")
+                    ),)),
+                },
+            )
+            .resolved_cell(),
+        )
         .cell()
         .await?;
 

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

@@ -61,3 +61,9 @@ p.env.NODE_ENV != 'production' && console.log('development')
 p.env.NODE_ENV == 'production' && console.log('production')
 
 console.log(__dirname)
+
+// Test that WARNED_VALUE triggers a warning but still gets replaced
+console.log(WARNED_VALUE)
+if (WARNED_VALUE === 'replacement') {
+  console.log('warning replacement works')
+}

turbopack/crates/turbopack-tests/tests/snapshot/comptime/define/issues/__l___error TP1202__ WARNED_VALUE is deprecated, u-1d10ef.txt

@@ -0,0 +1,13 @@
+warning - [analysis] /turbopack/crates/turbopack-tests/tests/snapshot/comptime/define/input/index.js:66:12  error TP1202 WARNED_VALUE is deprecated, use REPLACEMENT_VALUE instead
+  
+      62 | 
+      63 | console.log(__dirname)
+      64 | 
+      65 | // Test that WARNED_VALUE triggers a warning but still gets replaced
+         +             v----------v
+      66 + console.log(WARNED_VALUE)
+         +             ^----------^
+      67 | if (WARNED_VALUE === 'replacement') {
+      68 |   console.log('warning replacement works')
+      69 | }
+      70 |

turbopack/crates/turbopack-tests/tests/snapshot/comptime/define/issues/__l___error TP1202__ WARNED_VALUE is deprecated, u-464a4e.txt

@@ -0,0 +1,12 @@
+warning - [analysis] /turbopack/crates/turbopack-tests/tests/snapshot/comptime/define/input/index.js:67:4  error TP1202 WARNED_VALUE is deprecated, use REPLACEMENT_VALUE instead
+  
+      63 | console.log(__dirname)
+      64 | 
+      65 | // Test that WARNED_VALUE triggers a warning but still gets replaced
+      66 | console.log(WARNED_VALUE)
+         +     v----------v
+      67 + if (WARNED_VALUE === 'replacement') {
+         +     ^----------^
+      68 |   console.log('warning replacement works')
+      69 | }
+      70 |