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.

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

feat(oxc_transformer): replace_global_define ThisExpression #7443

Merged
merged 1 commit into from
Nov 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions crates/oxc_transformer/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ cow-utils = { workspace = true }
dashmap = { workspace = true }
indexmap = { workspace = true }
itoa = { workspace = true }
lazy_static = { workspace = true }
ropey = { workspace = true }
rustc-hash = { workspace = true }
serde = { workspace = true, features = ["derive"] }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ impl<'a> InjectGlobalVariables<'a> {
if let Expression::StaticMemberExpression(member) = expr {
for DotDefineState { dot_define, value_atom } in &mut self.dot_defines {
if ReplaceGlobalDefines::is_dot_define(
ctx.symbols(),
ctx,
dot_define,
DotDefineMemberExpression::StaticMemberExpression(member),
) {
Expand Down
72 changes: 55 additions & 17 deletions crates/oxc_transformer/src/plugins/replace_global_defines.rs
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
use std::{cmp::Ordering, sync::Arc};

use lazy_static::lazy_static;
use oxc_allocator::Allocator;
use oxc_ast::ast::*;
use oxc_diagnostics::OxcDiagnostic;
use oxc_parser::Parser;
use oxc_semantic::{IsGlobalReference, ScopeTree, SymbolTable};
use oxc_semantic::{IsGlobalReference, ScopeFlags, ScopeTree, SymbolTable};
use oxc_span::{CompactStr, SourceType};
use oxc_syntax::identifier::is_identifier_name;
use oxc_traverse::{traverse_mut, Ancestor, Traverse, TraverseCtx};
Expand All @@ -19,9 +20,19 @@ use rustc_hash::FxHashSet;
#[derive(Debug, Clone)]
pub struct ReplaceGlobalDefinesConfig(Arc<ReplaceGlobalDefinesConfigImpl>);

lazy_static! {
static ref THIS_ATOM: Atom<'static> = Atom::from("this");
Boshen marked this conversation as resolved.
Show resolved Hide resolved
}

#[derive(Debug)]
struct IdentifierDefine {
identifier_defines: Vec<(/* key */ CompactStr, /* value */ CompactStr)>,
/// Whether user want to replace `ThisExpression`, avoid linear scan for each `ThisExpression`
has_this_expr_define: bool,
}
#[derive(Debug)]
struct ReplaceGlobalDefinesConfigImpl {
identifier: Vec<(/* key */ CompactStr, /* value */ CompactStr)>,
identifier: IdentifierDefine,
dot: Vec<DotDefine>,
meta_property: Vec<MetaPropertyDefine>,
/// extra field to avoid linear scan `meta_property` to check if it has `import.meta` every
Expand Down Expand Up @@ -78,6 +89,7 @@ impl ReplaceGlobalDefinesConfig {
let mut dot_defines = vec![];
let mut meta_properties_defines = vec![];
let mut import_meta = None;
let mut has_this_expr_define = false;
for (key, value) in defines {
let key = key.as_ref();

Expand All @@ -86,6 +98,7 @@ impl ReplaceGlobalDefinesConfig {

match Self::check_key(key)? {
IdentifierType::Identifier => {
has_this_expr_define |= key == "this";
identifier_defines.push((CompactStr::new(key), CompactStr::new(value)));
}
IdentifierType::DotDefines { parts } => {
Expand Down Expand Up @@ -124,7 +137,7 @@ impl ReplaceGlobalDefinesConfig {
}
});
Ok(Self(Arc::new(ReplaceGlobalDefinesConfigImpl {
identifier: identifier_defines,
identifier: IdentifierDefine { identifier_defines, has_this_expr_define },
dot: dot_defines,
meta_property: meta_properties_defines,
import_meta,
Expand Down Expand Up @@ -240,16 +253,33 @@ impl<'a> ReplaceGlobalDefines<'a> {
}

fn replace_identifier_defines(&self, expr: &mut Expression<'a>, ctx: &mut TraverseCtx<'a>) {
let Expression::Identifier(ident) = expr else { return };
if !ident.is_global_reference(ctx.symbols()) {
return;
}
for (key, value) in &self.config.0.identifier {
if ident.name.as_str() == key {
let value = self.parse_value(value);
*expr = value;
break;
match expr {
Expression::Identifier(ident) => {
if !ident.is_global_reference(ctx.symbols()) {
return;
}

for (key, value) in &self.config.0.identifier.identifier_defines {
if ident.name.as_str() == key {
let value = self.parse_value(value);
*expr = value;
break;
}
}
}
Expression::ThisExpression(_)
if self.config.0.identifier.has_this_expr_define
&& should_replace_this_expr(ctx.current_scope_flags()) =>
{
for (key, value) in &self.config.0.identifier.identifier_defines {
if key.as_str() == "this" {
let value = self.parse_value(value);
*expr = value;
break;
}
}
}
_ => {}
}
}

Expand Down Expand Up @@ -301,7 +331,7 @@ impl<'a> ReplaceGlobalDefines<'a> {
) -> Option<Expression<'a>> {
for dot_define in &self.config.0.dot {
if Self::is_dot_define(
ctx.symbols(),
ctx,
dot_define,
DotDefineMemberExpression::ComputedMemberExpression(member),
) {
Expand All @@ -320,7 +350,7 @@ impl<'a> ReplaceGlobalDefines<'a> {
) -> Option<Expression<'a>> {
for dot_define in &self.config.0.dot {
if Self::is_dot_define(
ctx.symbols(),
ctx,
dot_define,
DotDefineMemberExpression::StaticMemberExpression(member),
) {
Expand Down Expand Up @@ -415,12 +445,12 @@ impl<'a> ReplaceGlobalDefines<'a> {
}

pub fn is_dot_define<'b>(
symbols: &SymbolTable,
ctx: &mut TraverseCtx<'a>,
dot_define: &DotDefine,
member: DotDefineMemberExpression<'b, 'a>,
) -> bool {
debug_assert!(dot_define.parts.len() > 1);

let should_replace_this_expr = should_replace_this_expr(ctx.current_scope_flags());
let Some(mut cur_part_name) = member.name() else {
return false;
};
Expand All @@ -447,12 +477,16 @@ impl<'a> ReplaceGlobalDefines<'a> {
})
}
Expression::Identifier(ident) => {
if !ident.is_global_reference(symbols) {
if !ident.is_global_reference(ctx.symbols()) {
return false;
}
cur_part_name = &ident.name;
None
}
Expression::ThisExpression(_) if should_replace_this_expr => {
cur_part_name = &THIS_ATOM;
Boshen marked this conversation as resolved.
Show resolved Hide resolved
None
}
_ => None,
}
} else {
Expand Down Expand Up @@ -557,3 +591,7 @@ fn destructing_dot_define_optimizer<'ast>(
obj.properties.retain(|_| *iter.next().unwrap());
expr
}

const fn should_replace_this_expr(scope_flags: ScopeFlags) -> bool {
!scope_flags.contains(ScopeFlags::Function) || scope_flags.contains(ScopeFlags::Arrow)
}
Original file line number Diff line number Diff line change
Expand Up @@ -137,3 +137,48 @@ fn dot_define_with_destruct() {
config.clone(),
);
}

#[test]
fn this_expr() {
let config =
ReplaceGlobalDefinesConfig::new(&[("this", "1"), ("this.foo", "2"), ("this.foo.bar", "3")])
.unwrap();
test(
"this, this.foo, this.foo.bar, this.foo.baz, this.bar",
"1, 2, 3, 2 .baz, 1 .bar;\n",
config.clone(),
);

test(
r"
// This code should be the same as above
(() => {
ok(
this,
this.foo,
this.foo.bar,
this.foo.baz,
this.bar,
);
})();
",
"(() => {\n\tok(1, 2, 3, 2 .baz, 1 .bar);\n})();\n",
config.clone(),
);

test_same(
r"
// Nothing should be substituted in this code
(function() {
doNotSubstitute(
this,
this.foo,
this.foo.bar,
this.foo.baz,
this.bar,
);
})();
",
config,
);
}
Loading