1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
use itertools::Itertools;
#[allow(clippy::wildcard_imports)]
use oxc_hir::hir::*;
use oxc_hir::Visit;
use oxc_index::{index_vec, IndexVec};
use oxc_semantic::{Reference, ReferenceFlag, ReferenceId, SemanticBuilder, SymbolId, SymbolTable};
use oxc_span::{Atom, SourceType};
use oxc_syntax::{scope::ScopeFlags, symbol::SymbolFlags};
type Slot = usize;
pub struct Mangler {
symbol_table: SymbolTable,
}
impl Mangler {
pub fn get_symbol_name(&self, symbol_id: SymbolId) -> &Atom {
self.symbol_table.get_name(symbol_id)
}
pub fn get_reference_name(&self, reference_id: ReferenceId) -> Option<&Atom> {
let symbol_id = self.symbol_table.get_reference(reference_id).symbol_id()?;
Some(self.symbol_table.get_name(symbol_id))
}
}
/// # Name Mangler / Symbol Minification
///
/// See:
/// * [esbuild](https://github.com/evanw/esbuild/blob/main/docs/architecture.md#symbol-minification)
///
/// This algorithm is targeted for better gzip compression.
///
/// Visually, a slot is the index position for binding identifiers:
///
/// ```javascript
/// function slot0(slot2, slot3, slot4) {
/// slot2 = 1;
/// }
/// function slot1(slot2, slot3) {
/// function slot4() {
/// slot2 = 1;
/// }
/// }
/// ```
///
/// The slot number for a new scope starts after the maximum slot of the parent scope.
///
/// Occurrences of slots and their corresponding newly assigned short identifiers are:
/// - slot2: 4 - a
/// - slot3: 2 - b
/// - slot4: 2 - c
/// - slot0: 1 - d
/// - slot1: 1 - e
///
/// After swapping out the mangled names:
///
/// ```javascript
/// function d(a, b, c) {
/// a = 1;
/// }
/// function e(a, b) {
/// function c() {
/// a = 1;
/// }
/// }
/// ```
pub struct ManglerBuilder<'a> {
semantic: SemanticBuilder<'a>,
}
impl<'a> Visit<'a> for ManglerBuilder<'a> {
fn enter_scope(&mut self, flags: ScopeFlags) {
self.semantic.enter_scope(flags);
}
fn leave_scope(&mut self) {
self.semantic.leave_scope();
}
fn visit_binding_identifier(
&mut self,
ident: &'a BindingIdentifier,
includes: SymbolFlags,
excludes: SymbolFlags,
) {
let symbol_id =
self.semantic.declare_symbol_for_mangler(ident.span, &ident.name, includes, excludes);
ident.symbol_id.replace(symbol_id);
}
fn visit_identifier_reference(&mut self, ident: &'a IdentifierReference) {
let reference = Reference::new(ident.span, ident.name.clone(), ReferenceFlag::read());
let reference_id = self.semantic.declare_reference(reference);
ident.reference_id.replace(reference_id);
}
}
impl<'a> ManglerBuilder<'a> {
pub fn new(source_text: &'a str, source_type: SourceType) -> Self {
Self { semantic: SemanticBuilder::new(source_text, source_type) }
}
#[must_use]
pub fn build(mut self, program: &'a Program<'a>) -> Mangler {
self.visit_program(program);
self.mangle()
}
/// Mangle the symbol table by computing slots from the scope tree.
/// A slot is the occurrence index of a binding identifier inside a scope.
pub fn mangle(self) -> Mangler {
let semantic = self.semantic.build2();
let (mut symbol_table, scope_tree) = semantic.into_symbol_table_and_scope_tree();
// Total number of slots for all scopes
let mut total_number_of_slots: Slot = 0;
// All symbols with their assigned slots
let mut slots: IndexVec<SymbolId, Slot> = index_vec![0; symbol_table.len()];
// Keep track of the maximum slot number for each scope
let mut max_slot_for_scope = vec![0; scope_tree.len()];
// Walk the scope tree and compute the slot number for each scope
for scope_id in scope_tree.descendants() {
let bindings = scope_tree.get_bindings(scope_id);
// The current slot number is continued by the maximum slot from the parent scope
let parent_max_slot = scope_tree
.get_parent_id(scope_id)
.map_or(0, |parent_scope_id| max_slot_for_scope[parent_scope_id.index()]);
let mut slot = parent_max_slot;
// `bindings` are stored in order, traverse and increment slot
for symbol_id in bindings.values() {
slots[*symbol_id] = slot;
slot += 1;
}
max_slot_for_scope[scope_id.index()] = slot;
if slot > total_number_of_slots {
total_number_of_slots = slot;
}
}
let frequencies =
Self::tally_slot_frequencies(&symbol_table, total_number_of_slots, &slots);
let unresolved_references = scope_tree
.root_unresolved_references()
.keys()
// It is unlike to get a 5 letter mangled identifier, which is a lot of slots.
// .filter(|name| name.len() < 5)
.collect::<Vec<_>>();
let mut names = Vec::with_capacity(total_number_of_slots);
let mut count = 0;
for _ in 0..total_number_of_slots {
names.push(loop {
let name = Atom::base54(count);
count += 1;
// Do not mangle keywords and unresolved references
if !is_keyword(&name) && !unresolved_references.iter().any(|n| **n == name) {
break name;
}
});
}
// Group similar symbols for smaller gzipped file
// <https://github.com/google/closure-compiler/blob/c383a3a1d2fce33b6c778ef76b5a626e07abca41/src/com/google/javascript/jscomp/RenameVars.java#L475-L483>
// Original Comment:
// 1) The most frequent vars get the shorter names.
// 2) If N number of vars are going to be assigned names of the same
// length, we assign the N names based on the order at which the vars
// first appear in the source. This makes the output somewhat less
// random, because symbols declared close together are assigned names
// that are quite similar. With this heuristic, the output is more
// compressible.
// For instance, the output may look like:
// var da = "..", ea = "..";
// function fa() { .. } function ga() { .. }
let mut freq_iter = frequencies.iter();
// 2. "N number of vars are going to be assigned names of the same length"
for (_, slice_of_same_len_strings_group) in &names.into_iter().group_by(|a| a.len()) {
// 1. "The most frequent vars get the shorter names"
// (freq_iter is sorted by frequency from highest to lowest,
// so taking means take the N most frequent symbols remaining)
let slice_of_same_len_strings = slice_of_same_len_strings_group.collect_vec();
let mut symbols_renamed_in_this_batch =
freq_iter.by_ref().take(slice_of_same_len_strings.len()).collect::<Vec<_>>();
debug_assert!(symbols_renamed_in_this_batch.len() == slice_of_same_len_strings.len());
// 2. "we assign the N names based on the order at which the vars first appear in the source."
// sorting by slot enables us to sort by the order at which the vars first appear in the source
// (this is possible because the slots are discovered currently in a DFS method which is the same order
// as variables appear in the source code)
symbols_renamed_in_this_batch.sort_by(|a, b| a.slot.cmp(&b.slot.clone()));
// here we just zip the iterator of symbols to rename with the iterator of new names for the next for loop
let symbols_to_rename_with_new_names =
symbols_renamed_in_this_batch.iter().zip(slice_of_same_len_strings.iter());
// rename the variables
for (symbol_to_rename, new_name) in symbols_to_rename_with_new_names {
for symbol_id in &symbol_to_rename.symbol_ids {
symbol_table.set_name(*symbol_id, new_name.clone());
}
}
}
Mangler { symbol_table }
}
fn tally_slot_frequencies(
symbol_table: &SymbolTable,
total_number_of_slots: usize,
slots: &IndexVec<SymbolId, Slot>,
) -> Vec<SlotFrequency> {
let mut frequencies = vec![SlotFrequency::default(); total_number_of_slots];
for (symbol_id, slot) in slots.iter_enumerated() {
if !symbol_table.get_flag(symbol_id).is_variable() {
continue;
}
let index = *slot;
frequencies[index].slot = *slot;
frequencies[index].frequency +=
symbol_table.get_resolved_reference_ids(symbol_id).len();
frequencies[index].symbol_ids.push(symbol_id);
}
frequencies.sort_by_key(|x| (std::cmp::Reverse(x.frequency)));
frequencies
}
}
#[derive(Debug, Default, Clone)]
struct SlotFrequency {
pub slot: Slot,
pub frequency: usize,
pub symbol_ids: Vec<SymbolId>,
}
#[rustfmt::skip]
fn is_keyword(s: &str) -> bool {
matches!(s, "as" | "do" | "if" | "in" | "is" | "of" | "any" | "for" | "get"
| "let" | "new" | "out" | "set" | "try" | "var" | "case" | "else"
| "enum" | "from" | "meta" | "null" | "this" | "true" | "type"
| "void" | "with")
}