Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(cjs): analyze exports for chained assignments in module.exports #150

Merged
merged 2 commits into from
Jul 20, 2023
Merged

fix(cjs): analyze exports for chained assignments in module.exports #150

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0754d85
fix(cjs): analyze exports for chained assignments in module.exports
await-ovo Jul 20, 2023
7b6465f
fix(cjs): remove unnecessary self.in_module_exports
await-ovo Jul 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 85 additions & 32 deletions src/cjs_parse.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ struct CjsVisitor {
reexports: HashSet<String>,
unsafe_getters: HashSet<String>,
var_assignments: HashMap<String, String>,
in_module_exports: bool,
}

impl CjsVisitor {
Expand Down Expand Up @@ -131,6 +132,44 @@ impl CjsVisitor {
_ => {}
}
}

fn visit_exports_right_expr(&mut self, right_expr: &Expr) {
match right_expr {
Expr::Object(object_lit) => {
for prop in &object_lit.props {
match prop {
PropOrSpread::Prop(prop) => {
if let Some(prop_name) = get_prop_name(prop) {
if is_supported_object_prop(prop) {
self.add_export(prop_name);
} else {
self.add_unsafe_getter(prop_name);
}
}
}
PropOrSpread::Spread(spread) => {
if let Some(require_value) = get_expr_require_value(&spread.expr)
{
self.add_reexport(require_value);
}
}
}
}
}
Expr::Call(call_expr) => {
// module.exports = require(...);
if let Some(require_value) = get_call_expr_require_value(call_expr) {
self.set_reexport_assignment_value(require_value);
}
}
Expr::Assign(right_assign_expr) => {
self.in_module_exports = true;
self.visit_assign_expr(right_assign_expr);
self.in_module_exports = false;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like we can remove this extra state and just do?

Suggested change
self.in_module_exports = true;
self.visit_assign_expr(right_assign_expr);
self.in_module_exports = false;
self.visit_exports_right_expr(&right_assign_expr.right);

That seems to pass all the current tests, but is there a scenario where self.in_module_exports is necessary? It would be best to not introduce more state if possible.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your suggestion, indeed in_module_exports is redundant ~

}
_ => {}
};
}
}

impl Visit for CjsVisitor {
Expand Down Expand Up @@ -218,45 +257,25 @@ impl Visit for CjsVisitor {
return;
}

if self.in_module_exports {
self.visit_exports_right_expr(&assign_expr.right);
return;
}

let left_expr =
match assign_expr.left.as_pat().and_then(|pat| pat.as_expr()) {
Some(expr) => expr,
_ => return,
_ => {
if let Some(right_expr) = assign_expr.right.as_assign() {
self.visit_assign_expr(right_expr);
}
return;
}
};

// check if left hand side is "module.exports = " or "exports ="
if is_module_exports_or_exports(left_expr) {
match &*assign_expr.right {
Expr::Object(object_lit) => {
for prop in &object_lit.props {
match prop {
PropOrSpread::Prop(prop) => {
if let Some(prop_name) = get_prop_name(prop) {
if is_supported_object_prop(prop) {
self.add_export(prop_name);
} else {
self.add_unsafe_getter(prop_name);
}
}
}
PropOrSpread::Spread(spread) => {
if let Some(require_value) =
get_expr_require_value(&spread.expr)
{
self.add_reexport(require_value);
}
}
}
}
}
Expr::Call(call_expr) => {
// module.exports = require(...);
if let Some(require_value) = get_call_expr_require_value(call_expr) {
self.set_reexport_assignment_value(require_value);
}
}
_ => {}
};
self.visit_exports_right_expr(&assign_expr.right);
} else if let Some(left_member) = left_expr.as_member() {
if is_module_exports_or_exports(&left_member.obj) {
// check for:
Expand Down Expand Up @@ -1249,4 +1268,38 @@ mod test {

tester.assert_exports(vec!["x", "extract"]);
}

#[test]
fn multiple_assigns_before_module_exports() {
let tester = parse_cjs(
r#"
(function(){
const BigInteger = 1;
const SecureRandom = 2;
if (typeof exports !== 'undefined') {
a= exports = module.exports = {
default: BigInteger,
BigInteger: BigInteger,
SecureRandom: SecureRandom,
};
}
}).call(this)
"#,
);
tester.assert_exports(vec!["BigInteger", "SecureRandom", "default"]);
}

#[test]
fn chain_assigns_after_module_exports() {
let tester = parse_cjs(
r#"
module.exports = a = b = exports = {
a: 1,
b: 2,
c,
}
"#,
);
tester.assert_exports(vec!["a", "b", "c"]);
}
}