feat(es/testing): Parse test code as a Program instead of a Module (

#9623) **Description:** This PR addresses the issue described in #8713 **BREAKING CHANGE:** Will break unit tests that use `fold_module`/`visit_module`/`visit_mut_module` if the visitor is intended to work for both modules and scripts instead of using `fold_program`/`visit_program`/`visit_mut_program`. When creating visitors, you should use `fold_program`/`visit_program`/`visit_mut_program` if you simply want to visit the top-level node. When creating tests, the input source code will be parsed using `parse_program` by default. If you need to parse it as a `Module`, you can use `module: Some(true)` in `FixtureTestConfig` (or with `test!(module, ..)`), which will parse it as a `Program::Module`, or `Some(false)` for `Program::Script`. `None` will use `parse_program` (`parse_program` will auto-detect the underlying type).
swc-project · Oct 8, 2024 · bfea322 · bfea322
1 parent f625035
commit bfea322
Show file tree

Hide file tree

Showing 21 changed files with 267 additions and 85 deletions.
diff --git a/.changeset/nine-trees-beam.md b/.changeset/nine-trees-beam.md
@@ -0,0 +1,6 @@
+---
+swc_ecma_transforms_testing: breaking
+swc_ecma_transforms_optimization: patch
+---
+
+feat(es/testing): Parse test code as a `Program` instead of a `Module`
diff --git a/crates/swc_ecma_transforms/tests/decorators.rs b/crates/swc_ecma_transforms/tests/decorators.rs
@@ -91,6 +91,7 @@ fn transformation(t: &Tester) -> impl Fold {
 
 // transformation_declaration
 test!(
+    module,
     syntax(false),
     |t| transformation(t),
     transformation_declaration,
@@ -101,6 +102,7 @@ class A {}
 );
 // transformation_initialize_after_super_multiple
 test!(
+    module,
     syntax(false),
     |t| transformation(t),
     transformation_initialize_after_super_multiple,
@@ -134,6 +136,7 @@ export default @dec() class {}
 );
 // transformation_initialize_after_super_statement
 test!(
+    module,
     syntax(false),
     |t| transformation(t),
     transformation_initialize_after_super_statement,
@@ -211,6 +214,7 @@ expect(A).toBe(C);
 );
 // misc_method_name_not_shadow
 test!(
+    module,
     syntax(false),
     |t| tr(t),
     misc_method_name_not_shadow,
@@ -320,6 +324,7 @@ expect(() => {
 );
 // duplicated_keys_computed_keys_same_value
 test!(
+    module,
     syntax(false),
     |t| tr(t),
     duplicated_keys_computed_keys_same_value,
@@ -395,6 +400,7 @@ expect(log).toEqual(numsFrom0to9);
 );
 // transformation_initializer_after_super_bug_8808
 test!(
+    module,
     syntax(false),
     |t| transformation(t),
     transformation_initiailzer_after_super_bug_8808,
@@ -434,6 +440,7 @@ expect(A.prototype.method()).toBe(2);
 );
 // transformation_arguments
 test!(
+    module,
     syntax(false),
     |t| transformation(t),
     transformation_arguments,
@@ -532,6 +539,7 @@ expect(calls).toBe(1);
 // ordering
 // transformation_initialize_after_super_expression
 test!(
+    module,
     syntax(false),
     |t| transformation(t),
     transformation_initialize_after_super_expression,
@@ -903,6 +911,7 @@ expect(Object.getOwnPropertyDescriptor(A.prototype, "foo")).toEqual({
 );
 // transformation_extends
 test!(
+    module,
     syntax(false),
     |t| transformation(t),
     transformation_extends,
@@ -914,6 +923,7 @@ test!(
 // finishers
 // transformation_extends_await
 test!(
+    module,
     syntax(false),
     |t| transformation(t),
     transformation_extends_await,
@@ -926,6 +936,7 @@ async function g() {
 );
 // transformation_extends_yield
 test!(
+    module,
     syntax(false),
     |t| transformation(t),
     transformation_extends_yield,
@@ -1092,6 +1103,7 @@ expect(i).toBe(2);
 );
 // transformation_initialize_after_super_bug_8931
 test!(
+    module,
     syntax(false),
     |t| transformation(t),
     transformation_initialize_after_super_bug_8931,
@@ -1318,6 +1330,7 @@ expect(Foo.prototype.bar).toBe(value2);
 );
 // transformation_expression
 test!(
+    module,
     syntax(false),
     |t| transformation(t),
     transformation_expression,
@@ -1354,6 +1367,7 @@ expect(A.method()).toBe(2);
 // element_descriptors
 // duplicated_keys_computed_keys_same_ast
 test!(
+    module,
     syntax(false),
     |t| tr(t),
     duplicated_keys_computed_keys_same_ast,
@@ -3882,6 +3896,7 @@ eval: function () {
 );
 
 test!(
+    module,
     ts(),
     |_| decorators(Default::default()),
     issue_846_1,

diff --git a/crates/swc_ecma_transforms_module/tests/amd.rs b/crates/swc_ecma_transforms_module/tests/amd.rs
@@ -5,7 +5,7 @@ use swc_ecma_parser::{Syntax, TsSyntax};
 use swc_ecma_transforms_base::{feature::FeatureFlag, resolver};
 use swc_ecma_transforms_compat::es2015::for_of;
 use swc_ecma_transforms_module::amd::{self, amd};
-use swc_ecma_transforms_testing::{test, test_fixture};
+use swc_ecma_transforms_testing::{test, test_fixture, FixtureTestConfig};
 use swc_ecma_transforms_typescript::typescript;
 use swc_ecma_visit::Fold;
 
@@ -65,11 +65,15 @@ fn esm_to_amd(input: PathBuf) {
         &|t| tr(config.clone(), is_ts, t.comments.clone()),
         &input,
         &output,
-        Default::default(),
+        FixtureTestConfig {
+            module: Some(true),
+            ..Default::default()
+        },
     );
 }
 
 test!(
+    module,
     syntax(),
     |t| chain!(
         for_of(for_of::Config {

diff --git a/crates/swc_ecma_transforms_module/tests/common_js.rs b/crates/swc_ecma_transforms_module/tests/common_js.rs
@@ -59,12 +59,14 @@ fn esm_to_cjs(input: PathBuf) {
         &output,
         FixtureTestConfig {
             sourcemap: false,
+            module: Some(true),
             ..Default::default()
         },
     );
 }
 
 test!(
+    module,
     syntax(),
     |_| chain!(
         for_of(for_of::Config {

diff --git a/crates/swc_ecma_transforms_module/tests/path_node.rs b/crates/swc_ecma_transforms_module/tests/path_node.rs
@@ -12,7 +12,7 @@ use swc_ecma_transforms_module::{
     path::{ImportResolver, NodeImportResolver},
     rewriter::import_rewriter,
 };
-use swc_ecma_transforms_testing::test_fixture;
+use swc_ecma_transforms_testing::{test_fixture, FixtureTestConfig};
 use testing::run_test2;
 
 type TestProvider = NodeImportResolver<NodeModulesResolver>;
@@ -81,7 +81,10 @@ fn issue_4730() {
         },
         &input_dir.join("src").join("index.js"),
         &output_dir.join("index.js"),
-        Default::default(),
+        FixtureTestConfig {
+            module: Some(true),
+            ..Default::default()
+        },
     );
 }
 
@@ -147,6 +150,9 @@ fn fixture(input_dir: PathBuf) {
         },
         &index_path,
         &output_dir.join("index.ts"),
-        Default::default(),
+        FixtureTestConfig {
+            module: Some(true),
+            ..Default::default()
+        },
     );
 }
diff --git a/crates/swc_ecma_transforms_module/tests/system_js.rs b/crates/swc_ecma_transforms_module/tests/system_js.rs
@@ -6,7 +6,7 @@ use swc_common::{chain, Mark};
 use swc_ecma_parser::Syntax;
 use swc_ecma_transforms_base::resolver;
 use swc_ecma_transforms_module::system_js::{system_js, Config};
-use swc_ecma_transforms_testing::{test, test_fixture, Tester};
+use swc_ecma_transforms_testing::{test, test_fixture, FixtureTestConfig, Tester};
 use swc_ecma_visit::Fold;
 
 fn syntax() -> Syntax {
@@ -23,13 +23,15 @@ fn tr(_tester: &mut Tester<'_>, config: Config) -> impl Fold {
 }
 
 test!(
+    module,
     syntax(),
     |tester| tr(tester, Default::default()),
     allow_continuous_assignment,
     r#"var e = {}; e.a = e.b = e.c = e.d = e.e = e.f = e.g = e.h = e.i = e.j = e.k = e.l = e.m = e.n = e.o = e.p = e.q = e.r = e.s = e.t = e.u = e.v = e.w = e.x = e.y = e.z = e.A = e.B = e.C = e.D = e.E = e.F = e.G = e.H = e.I = e.J = e.K = e.L = e.M = e.N = e.O = e.P = e.Q = e.R = e.S = void 0;"#
 );
 
 test!(
+    module,
     syntax(),
     |tester| tr(
         tester,
@@ -43,6 +45,7 @@ test!(
 );
 
 test!(
+    module,
     syntax(),
     |tester| tr(
         tester,
@@ -60,6 +63,7 @@ test!(
 );
 
 test!(
+    module,
     syntax(),
     |tester| tr(
         tester,
@@ -82,6 +86,7 @@ test!(
 );
 
 test!(
+    module,
     syntax(),
     |tester| tr(
         tester,
@@ -99,6 +104,7 @@ test!(
 );
 
 test!(
+    module,
     syntax(),
     |tester| tr(tester, Default::default()),
     imports,
@@ -122,6 +128,9 @@ fn fixture(input: PathBuf) {
         &|tester| tr(tester, Default::default()),
         &input,
         &output,
-        Default::default(),
+        FixtureTestConfig {
+            module: Some(true),
+            ..Default::default()
+        },
     );
 }
diff --git a/crates/swc_ecma_transforms_module/tests/umd.rs b/crates/swc_ecma_transforms_module/tests/umd.rs
@@ -4,7 +4,7 @@ use swc_common::{chain, Mark};
 use swc_ecma_parser::{Syntax, TsSyntax};
 use swc_ecma_transforms_base::{feature::FeatureFlag, resolver};
 use swc_ecma_transforms_module::umd::{umd, Config};
-use swc_ecma_transforms_testing::{test_fixture, Tester};
+use swc_ecma_transforms_testing::{test_fixture, FixtureTestConfig, Tester};
 use swc_ecma_transforms_typescript::typescript;
 use swc_ecma_visit::Fold;
 
@@ -63,6 +63,9 @@ fn esm_to_umd(input: PathBuf) {
         &|tester| tr(tester, config.clone(), is_ts),
         &input,
         &output,
-        Default::default(),
+        FixtureTestConfig {
+            module: Some(true),
+            ..Default::default()
+        },
     );
 }
diff --git a/crates/swc_ecma_transforms_optimization/src/inline_globals.rs b/crates/swc_ecma_transforms_optimization/src/inline_globals.rs
@@ -202,7 +202,7 @@ impl VisitMut for InlineGlobals {
 #[cfg(test)]
 mod tests {
     use swc_ecma_transforms_testing::{test, Tester};
-    use swc_ecma_utils::DropSpan;
+    use swc_ecma_utils::{DropSpan, StmtOrModuleItem};
 
     use super::*;
 
@@ -220,17 +220,23 @@ mod tests {
                 (*v).into()
             };
 
-            let mut v = tester
+            let v = tester
                 .apply_transform(
                     as_folder(DropSpan),
                     "global.js",
                     ::swc_ecma_parser::Syntax::default(),
+                    None,
                     &v,
                 )
                 .unwrap();
-            assert_eq!(v.body.len(), 1);
-            let v = match v.body.pop().unwrap() {
-                ModuleItem::Stmt(Stmt::Expr(ExprStmt { expr, .. })) => *expr,
+
+            let v = match v {
+                Program::Module(mut m) => m.body.pop().and_then(|x| x.into_stmt().ok()),
+                Program::Script(mut s) => s.body.pop(),
+            };
+            assert!(v.is_some());
+            let v = match v.unwrap() {
+                Stmt::Expr(ExprStmt { expr, .. }) => *expr,
                 _ => unreachable!(),
             };
 

diff --git a/crates/swc_ecma_transforms_optimization/src/simplify/branch/tests.rs b/crates/swc_ecma_transforms_optimization/src/simplify/branch/tests.rs
@@ -9,6 +9,7 @@ macro_rules! test_stmt {
     ($l:expr, $r:expr) => {
         swc_ecma_transforms_testing::test_transform(
             ::swc_ecma_parser::Syntax::default(),
+            None,
             |_| {
                 let unresolved_mark = Mark::new();
                 let top_level_mark = Mark::new();
@@ -30,7 +31,6 @@ macro_rules! test_stmt {
             },
             $l,
             $r,
-            true,
         )
     };
 }

diff --git a/crates/swc_ecma_transforms_optimization/src/simplify/expr/tests.rs b/crates/swc_ecma_transforms_optimization/src/simplify/expr/tests.rs
@@ -9,6 +9,7 @@ use super::SimplifyExpr;
 fn fold(src: &str, expected: &str) {
     test_transform(
         ::swc_ecma_parser::Syntax::default(),
+        None,
         |_| {
             let unresolved_mark = Mark::new();
             let top_level_mark = Mark::new();
@@ -32,7 +33,6 @@ fn fold(src: &str, expected: &str) {
         },
         src,
         expected,
-        true,
     )
 }
 

diff --git a/crates/swc_ecma_transforms_optimization/src/simplify/inlining/mod.rs b/crates/swc_ecma_transforms_optimization/src/simplify/inlining/mod.rs
@@ -468,19 +468,19 @@ impl VisitMut for Inlining<'_> {
         self.visit_with_child(ScopeKind::Cond, &mut stmt.alt);
     }
 
-    fn visit_mut_module_items(&mut self, items: &mut Vec<ModuleItem>) {
+    fn visit_mut_program(&mut self, program: &mut Program) {
         let _tracing = span!(Level::ERROR, "inlining", pass = self.pass).entered();
 
         let old_phase = self.phase;
 
         self.phase = Phase::Analysis;
-        items.visit_mut_children_with(self);
+        program.visit_mut_children_with(self);
 
         tracing::trace!("Switching to Inlining phase");
 
         // Inline
         self.phase = Phase::Inlining;
-        items.visit_mut_children_with(self);
+        program.visit_mut_children_with(self);
 
         self.phase = old_phase;
     }

diff --git a/crates/swc_ecma_transforms_optimization/tests/simplify.rs b/crates/swc_ecma_transforms_optimization/tests/simplify.rs
@@ -19,6 +19,7 @@ use swc_ecma_transforms_typescript::strip;
 fn test(src: &str, expected: &str) {
     test_transform(
         ::swc_ecma_parser::Syntax::default(),
+        None,
         |_| {
             let unresolved_mark = Mark::new();
             let top_level_mark = Mark::new();
@@ -35,7 +36,6 @@ fn test(src: &str, expected: &str) {
         },
         src,
         expected,
-        true,
     )
 }