fix: Allow guarded usage of node.js APIs from edge runtime

crates/next-custom-transforms/src/transforms/warn_for_edge_runtime.rs

@@ -1,10 +1,13 @@
 use std::sync::Arc;
 
+use rustc_hash::FxHashSet;
 use swc_core::{
+    atoms::Atom,
     common::{errors::HANDLER, SourceMap, Span},
     ecma::{
         ast::{
-            CallExpr, Callee, Expr, IdentName, ImportDecl, Lit, MemberExpr, MemberProp, NamedExport,
+            op, BinExpr, CallExpr, Callee, CondExpr, Expr, IdentName, IfStmt, ImportDecl, Lit,
+            MemberExpr, MemberProp, NamedExport, UnaryExpr,
         },
         utils::{ExprCtx, ExprExt},
         visit::{Visit, VisitWith},
@@ -20,13 +23,22 @@ pub fn warn_for_edge_runtime(
         cm,
         ctx,
         should_error_for_node_apis,
+        should_add_guards: false,
+        guarded_symbols: Default::default(),
+        guarded_process_props: Default::default(),
     }
 }
 
 struct WarnForEdgeRuntime {
     cm: Arc<SourceMap>,
     ctx: ExprCtx,
     should_error_for_node_apis: bool,
+
+    should_add_guards: bool,
+    /// We don't drop guards because a user may write a code like
+    /// `if(typeof clearImmediate !== "function") clearImmediate();`
+    guarded_symbols: FxHashSet<Atom>,
+    guarded_process_props: FxHashSet<Atom>,
 }
 
 const EDGE_UNSUPPORTED_NODE_APIS: &[&str] = &[
@@ -142,6 +154,14 @@ Learn More: https://nextjs.org/docs/messages/node-module-in-edge-runtime",
     }
 
     fn emit_unsupported_api_error(&self, span: Span, api_name: &str) -> Option<()> {
+        if self
+            .guarded_symbols
+            .iter()
+            .any(|guarded| guarded == api_name)
+        {
+            return None;
+        }
+
         let loc = self.cm.lookup_line(span.lo).ok()?;
 
         let msg = format!(
@@ -170,9 +190,48 @@ Learn more: https://nextjs.org/docs/api-reference/edge-runtime",
         if !self.is_in_middleware_layer() || prop.sym == "env" {
             return;
         }
+        if self.guarded_process_props.contains(&prop.sym) {
+            return;
+        }
 
         self.emit_unsupported_api_error(span, &format!("process.{}", prop.sym));
     }
+
+    fn add_guards(&mut self, test: &Expr) {
+        let old = self.should_add_guards;
+        self.should_add_guards = true;
+        test.visit_children_with(self);
+        self.should_add_guards = old;
+    }
+
+    fn add_guard_for_test(&mut self, test: &Expr) {
+        if !self.should_add_guards {
+            return;
+        }
+
+        match test {
+            Expr::Ident(ident) => {
+                self.guarded_symbols.insert(ident.sym.clone());
+            }
+            Expr::Member(member) => {
+                if member.obj.is_global_ref_to(&self.ctx, "process") {
+                    if let MemberProp::Ident(prop) = &member.prop {
+                        self.guarded_process_props.insert(prop.sym.clone());
+                    }
+                }
+            }
+            Expr::Bin(BinExpr {
+                left,
+                right,
+                op: op!("===") | op!("==") | op!("!==") | op!("!="),
+                ..
+            }) => {
+                self.add_guard_for_test(left);
+                self.add_guard_for_test(right);
+            }
+            _ => (),
+        }
+    }
 }
 
 impl Visit for WarnForEdgeRuntime {
@@ -186,6 +245,13 @@ impl Visit for WarnForEdgeRuntime {
         }
     }
 
+    fn visit_cond_expr(&mut self, node: &CondExpr) {
+        self.add_guards(&node.test);
+
+        node.cons.visit_with(self);
+        node.alt.visit_with(self);
+    }
+
     fn visit_expr(&mut self, n: &Expr) {
         if let Expr::Ident(ident) = n {
             if ident.ctxt == self.ctx.unresolved_ctxt {
@@ -201,6 +267,13 @@ impl Visit for WarnForEdgeRuntime {
         n.visit_children_with(self);
     }
 
+    fn visit_if_stmt(&mut self, node: &IfStmt) {
+        self.add_guards(&node.test);
+
+        node.cons.visit_with(self);
+        node.alt.visit_with(self);
+    }
+
     fn visit_import_decl(&mut self, n: &ImportDecl) {
         n.visit_children_with(self);
 
@@ -225,4 +298,13 @@ impl Visit for WarnForEdgeRuntime {
             self.warn_if_nodejs_module(n.span, &module_specifier.value);
         }
     }
+
+    fn visit_unary_expr(&mut self, node: &UnaryExpr) {
+        if node.op == op!("typeof") {
+            self.add_guard_for_test(&node.arg);
+            return;
+        }
+
+        node.visit_children_with(self);
+    }
 }

crates/next-custom-transforms/tests/fixture/edge-assert/guarded-nodejs/input.js

@@ -0,0 +1,9 @@
+if (typeof clearImmediate === 'function') {
+  console.log(clearImmediate())
+}
+
+// We allow this.
+const scheduleTimeoutA =
+  typeof setImmediate === 'function' ? setImmediate : setTimeout
+const scheduleTimeoutB =
+  typeof setImmediate !== 'function' ? setTimeout : setImmediate

crates/next-custom-transforms/tests/fixture/edge-assert/guarded-nodejs/output.js

@@ -0,0 +1,6 @@
+if (typeof clearImmediate === 'function') {
+    console.log(clearImmediate());
+}
+// We allow this.
+const scheduleTimeoutA = typeof setImmediate === 'function' ? setImmediate : setTimeout;
+const scheduleTimeoutB = typeof setImmediate !== 'function' ? setTimeout : setImmediate;

crates/next-custom-transforms/tests/fixture/edge-assert/guarded-process/input.js

@@ -0,0 +1,3 @@
+if (typeof process.loadEnvFile === 'function') {
+  console.log(process.loadEnvFile())
+}

crates/next-custom-transforms/tests/fixture/edge-assert/guarded-process/output.js

@@ -0,0 +1,3 @@
+if (typeof process.loadEnvFile === 'function') {
+    console.log(process.loadEnvFile());
+}