swc_ecma_compiler 0.1.1

Compatibility layer for the ECMAScript standard
Documentation
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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
#![allow(clippy::vec_box)]

use std::mem::take;

use rustc_hash::FxHashSet;
use swc_common::{util::take::Take, Mark, Spanned, DUMMY_SP};
use swc_ecma_ast::*;
use swc_ecma_utils::{
    default_constructor_with_span, prepend_stmt, private_ident, quote_ident, ExprFactory,
};
use swc_ecma_visit::{noop_visit_mut_type, VisitMut, VisitMutWith, VisitWith};
use swc_trace_macro::swc_trace;

use crate::es2022::{
    private_in_object::{ClassAnalyzer, ClassData, Mode},
    static_blocks::generate_uid,
};
pub use crate::features::Features;

pub mod es2022;
mod features;

#[derive(Debug)]
pub struct Compiler {
    config: Config,
}

impl Compiler {
    pub fn new(config: Config) -> Self {
        Self { config }
    }
}

#[derive(Debug)]
pub struct Config {
    /// Always compile these syntaxes.
    pub includes: Features,
    /// Always preserve these syntaxes.
    pub excludes: Features,
}

impl Pass for Compiler {
    fn process(&mut self, program: &mut swc_ecma_ast::Program) {
        program.visit_mut_with(&mut CompilerImpl::new(&self.config));
    }
}

struct CompilerImpl<'a> {
    config: &'a Config,

    // ES2022: Private in object transformation state
    es2022_private_field_helper_vars: Vec<VarDeclarator>,
    es2022_private_field_init_exprs: Vec<Box<Expr>>,
    es2022_injected_weakset_vars: FxHashSet<Id>,
    es2022_current_class_data: ClassData,
}

#[swc_trace]
impl<'a> CompilerImpl<'a> {
    fn new(config: &'a Config) -> Self {
        Self {
            config,
            es2022_private_field_helper_vars: Vec::new(),
            es2022_private_field_init_exprs: Vec::new(),
            es2022_injected_weakset_vars: FxHashSet::default(),
            es2022_current_class_data: ClassData::default(),
        }
    }

    /// ES2022: Transform static blocks to static private fields
    fn es2022_static_blocks_to_private_fields(&mut self, class: &mut Class) {
        if !self.config.includes.contains(Features::STATIC_BLOCKS) {
            return;
        }

        let mut private_names = FxHashSet::default();
        for member in &class.body {
            if let ClassMember::PrivateProp(private_property) = member {
                private_names.insert(private_property.key.name.clone());
            }
        }

        let mut count = 0;
        for member in class.body.iter_mut() {
            if let ClassMember::StaticBlock(static_block) = member {
                if static_block.body.stmts.is_empty() {
                    *member = ClassMember::dummy();
                    continue;
                }

                let static_block_private_id = generate_uid(&private_names, &mut count);
                *member = self
                    .transform_static_block(static_block.take(), static_block_private_id)
                    .into();
            };
        }
    }

    /// ES2022: Analyze class private fields for 'private in object'
    /// transformation
    fn es2022_analyze_private_fields_for_in_operator(&mut self, class: &Class) {
        class.visit_children_with(&mut ClassAnalyzer {
            brand_check_names: &mut self.es2022_current_class_data.names_used_for_brand_checks,
            ignore_class: true,
        });

        for m in &class.body {
            match m {
                ClassMember::PrivateMethod(m) => {
                    self.es2022_current_class_data
                        .privates
                        .insert(m.key.name.clone());
                    self.es2022_current_class_data
                        .methods
                        .push(m.key.name.clone());

                    if m.is_static {
                        self.es2022_current_class_data
                            .statics
                            .push(m.key.name.clone());
                    }
                }

                ClassMember::PrivateProp(m) => {
                    self.es2022_current_class_data
                        .privates
                        .insert(m.key.name.clone());

                    if m.is_static {
                        self.es2022_current_class_data
                            .statics
                            .push(m.key.name.clone());
                    }
                }

                _ => {}
            }
        }
    }

    /// ES2022: Inject WeakSet initialization into constructor for private field
    /// brand checks
    fn es2022_inject_weakset_init_for_private_fields(&mut self, class: &mut Class) {
        if self.es2022_current_class_data.constructor_exprs.is_empty() {
            return;
        }

        let has_constructor = class
            .body
            .iter()
            .any(|m| matches!(m, ClassMember::Constructor(_)));

        if !has_constructor {
            let has_super = class.super_class.is_some();
            class
                .body
                .push(ClassMember::Constructor(default_constructor_with_span(
                    has_super, class.span,
                )));
        }

        for m in &mut class.body {
            if let ClassMember::Constructor(Constructor {
                body: Some(body), ..
            }) = m
            {
                for expr in take(&mut self.es2022_current_class_data.constructor_exprs) {
                    body.stmts.push(
                        ExprStmt {
                            span: DUMMY_SP,
                            expr,
                        }
                        .into(),
                    );
                }
            }
        }
    }

    /// ES2022: Transform 'private in object' expressions to WeakSet.has() calls
    fn es2022_transform_private_in_to_weakset_has(&mut self, e: &mut Expr) -> bool {
        if let Expr::Bin(BinExpr {
            span,
            op: op!("in"),
            left,
            right,
        }) = e
        {
            if left.is_private_name() {
                let left = left.take().expect_private_name();

                let is_static = self.es2022_current_class_data.statics.contains(&left.name);
                let is_method = self.es2022_current_class_data.methods.contains(&left.name);

                if let Some(cls_ident) = self.es2022_current_class_data.ident.clone() {
                    if is_static && is_method {
                        *e = BinExpr {
                            span: *span,
                            op: op!("==="),
                            left: cls_ident.into(),
                            right: right.take(),
                        }
                        .into();
                        return true;
                    }
                }

                let var_name =
                    self.var_name_for_brand_check(&left, &self.es2022_current_class_data);

                if self.es2022_current_class_data.privates.contains(&left.name)
                    && self.es2022_injected_weakset_vars.insert(var_name.to_id())
                {
                    self.es2022_current_class_data.vars.push_var(
                        var_name.clone(),
                        Some(
                            NewExpr {
                                span: DUMMY_SP,
                                callee: Box::new(quote_ident!("WeakSet").into()),
                                args: Some(Default::default()),
                                ..Default::default()
                            }
                            .into(),
                        ),
                    );

                    if is_method {
                        self.es2022_current_class_data.constructor_exprs.push(
                            CallExpr {
                                span: DUMMY_SP,
                                callee: var_name
                                    .clone()
                                    .make_member(IdentName::new("add".into(), DUMMY_SP))
                                    .as_callee(),
                                args: vec![ExprOrSpread {
                                    spread: None,
                                    expr: Box::new(ThisExpr { span: DUMMY_SP }.into()),
                                }],
                                ..Default::default()
                            }
                            .into(),
                        );
                    }
                }

                *e = CallExpr {
                    span: *span,
                    callee: var_name
                        .make_member(IdentName::new("has".into(), DUMMY_SP))
                        .as_callee(),
                    args: vec![ExprOrSpread {
                        spread: None,
                        expr: right.take(),
                    }],
                    ..Default::default()
                }
                .into();
                return true;
            }
        }
        false
    }

    /// ES2022: Prepend private field helper variables to statements
    fn es2022_prepend_private_field_vars(&mut self, stmts: &mut Vec<Stmt>) {
        if !self.config.includes.contains(Features::PRIVATE_IN_OBJECT)
            || self.es2022_private_field_helper_vars.is_empty()
        {
            return;
        }

        prepend_stmt(
            stmts,
            VarDecl {
                span: DUMMY_SP,
                kind: VarDeclKind::Var,
                declare: Default::default(),
                decls: take(&mut self.es2022_private_field_helper_vars),
                ..Default::default()
            }
            .into(),
        );
    }

    /// ES2022: Prepend private field helper variables to module items
    fn es2022_prepend_private_field_vars_module(&mut self, items: &mut Vec<ModuleItem>) {
        if !self.config.includes.contains(Features::PRIVATE_IN_OBJECT)
            || self.es2022_private_field_helper_vars.is_empty()
        {
            return;
        }

        prepend_stmt(
            items,
            VarDecl {
                span: DUMMY_SP,
                kind: VarDeclKind::Var,
                declare: Default::default(),
                decls: take(&mut self.es2022_private_field_helper_vars),
                ..Default::default()
            }
            .into(),
        );
    }

    /// ES2022: Add WeakSet.add() calls to private properties for brand checking
    fn es2022_add_weakset_to_private_props(&mut self, n: &mut PrivateProp) {
        if !self
            .es2022_current_class_data
            .names_used_for_brand_checks
            .contains(&n.key.name)
        {
            return;
        }

        let var_name = self.var_name_for_brand_check(&n.key, &self.es2022_current_class_data);

        match &mut n.value {
            Some(init) => {
                let init_span = init.span();

                let tmp = private_ident!("_tmp");

                self.es2022_current_class_data
                    .vars
                    .push_var(tmp.clone(), None);

                let assign = AssignExpr {
                    span: DUMMY_SP,
                    op: op!("="),
                    left: tmp.clone().into(),
                    right: init.take(),
                }
                .into();

                let add_to_checker = CallExpr {
                    span: DUMMY_SP,
                    callee: var_name
                        .make_member(IdentName::new("add".into(), DUMMY_SP))
                        .as_callee(),
                    args: vec![ExprOrSpread {
                        spread: None,
                        expr: Box::new(ThisExpr { span: DUMMY_SP }.into()),
                    }],
                    ..Default::default()
                }
                .into();

                *init = SeqExpr {
                    span: init_span,
                    exprs: vec![assign, add_to_checker, Box::new(tmp.into())],
                }
                .into();
            }
            None => {
                n.value = Some(
                    UnaryExpr {
                        span: DUMMY_SP,
                        op: op!("void"),
                        arg: Box::new(
                            CallExpr {
                                span: DUMMY_SP,
                                callee: var_name
                                    .make_member(IdentName::new("add".into(), DUMMY_SP))
                                    .as_callee(),
                                args: vec![ExprOrSpread {
                                    spread: None,
                                    expr: Box::new(ThisExpr { span: DUMMY_SP }.into()),
                                }],
                                ..Default::default()
                            }
                            .into(),
                        ),
                    }
                    .into(),
                )
            }
        }
    }
}

#[swc_trace]
impl<'a> VisitMut for CompilerImpl<'a> {
    noop_visit_mut_type!(fail);

    fn visit_mut_class(&mut self, class: &mut Class) {
        // ES2022: Static blocks transformation
        self.es2022_static_blocks_to_private_fields(class);

        // ES2022: Private in object transformation
        if self.config.includes.contains(Features::PRIVATE_IN_OBJECT) {
            self.es2022_analyze_private_fields_for_in_operator(class);
        }

        class.visit_mut_children_with(self);

        if self.config.includes.contains(Features::PRIVATE_IN_OBJECT) {
            self.es2022_inject_weakset_init_for_private_fields(class);
        }
    }

    fn visit_mut_class_decl(&mut self, n: &mut ClassDecl) {
        if self.config.includes.contains(Features::PRIVATE_IN_OBJECT) {
            let old_cls = take(&mut self.es2022_current_class_data);

            self.es2022_current_class_data.mark = Mark::fresh(Mark::root());
            self.es2022_current_class_data.ident = Some(n.ident.clone());
            self.es2022_current_class_data.vars = Mode::ClassDecl {
                vars: Default::default(),
            };

            n.visit_mut_children_with(self);

            match &mut self.es2022_current_class_data.vars {
                Mode::ClassDecl { vars } => {
                    self.es2022_private_field_helper_vars.extend(take(vars));
                }
                _ => {
                    unreachable!()
                }
            }

            self.es2022_current_class_data = old_cls;
        } else {
            n.visit_mut_children_with(self);
        }
    }

    fn visit_mut_class_expr(&mut self, n: &mut ClassExpr) {
        if self.config.includes.contains(Features::PRIVATE_IN_OBJECT) {
            let old_cls = take(&mut self.es2022_current_class_data);

            self.es2022_current_class_data.mark = Mark::fresh(Mark::root());
            self.es2022_current_class_data.ident.clone_from(&n.ident);
            self.es2022_current_class_data.vars = Mode::ClassExpr {
                vars: Default::default(),
                init_exprs: Default::default(),
            };

            n.visit_mut_children_with(self);

            match &mut self.es2022_current_class_data.vars {
                Mode::ClassExpr { vars, init_exprs } => {
                    self.es2022_private_field_helper_vars.extend(take(vars));
                    self.es2022_private_field_init_exprs
                        .extend(take(init_exprs));
                }
                _ => {
                    unreachable!()
                }
            }

            self.es2022_current_class_data = old_cls;
        } else {
            n.visit_mut_children_with(self);
        }
    }

    fn visit_mut_assign_pat(&mut self, p: &mut AssignPat) {
        if self.config.includes.contains(Features::PRIVATE_IN_OBJECT) {
            p.left.visit_mut_with(self);

            {
                let mut buf = FxHashSet::default();
                let mut v = ClassAnalyzer {
                    brand_check_names: &mut buf,
                    ignore_class: false,
                };
                p.right.visit_with(&mut v);

                if buf.is_empty() {
                    p.right.visit_mut_with(self);
                } else {
                    let mut bs = BlockStmt {
                        span: DUMMY_SP,
                        stmts: Vec::new(),
                        ..Default::default()
                    };
                    bs.stmts.push(
                        ReturnStmt {
                            span: DUMMY_SP,
                            arg: Some(p.right.take()),
                        }
                        .into(),
                    );
                    bs.visit_mut_with(self);

                    p.right = CallExpr {
                        span: DUMMY_SP,
                        callee: ArrowExpr {
                            span: DUMMY_SP,
                            params: Default::default(),
                            body: Box::new(BlockStmtOrExpr::BlockStmt(bs)),
                            is_async: false,
                            is_generator: false,
                            ..Default::default()
                        }
                        .as_callee(),
                        args: Default::default(),
                        ..Default::default()
                    }
                    .into();
                }
            }
        } else {
            p.visit_mut_children_with(self);
        }
    }

    fn visit_mut_expr(&mut self, e: &mut Expr) {
        if self.config.includes.contains(Features::PRIVATE_IN_OBJECT) {
            let prev_prepend_exprs = take(&mut self.es2022_private_field_init_exprs);

            e.visit_mut_children_with(self);

            let mut prepend_exprs = std::mem::replace(
                &mut self.es2022_private_field_init_exprs,
                prev_prepend_exprs,
            );

            if !prepend_exprs.is_empty() {
                match e {
                    Expr::Seq(e) => {
                        e.exprs = prepend_exprs.into_iter().chain(e.exprs.take()).collect();
                    }
                    _ => {
                        prepend_exprs.push(Box::new(e.take()));
                        *e = SeqExpr {
                            span: DUMMY_SP,
                            exprs: prepend_exprs,
                        }
                        .into();
                    }
                }
                return;
            }

            self.es2022_transform_private_in_to_weakset_has(e);
        } else {
            e.visit_mut_children_with(self);
        }
    }

    fn visit_mut_module_items(&mut self, ns: &mut Vec<ModuleItem>) {
        ns.visit_mut_children_with(self);
        self.es2022_prepend_private_field_vars_module(ns);
    }

    fn visit_mut_private_prop(&mut self, n: &mut PrivateProp) {
        if self.config.includes.contains(Features::PRIVATE_IN_OBJECT) {
            n.visit_mut_children_with(self);
            self.es2022_add_weakset_to_private_props(n);
        } else {
            n.visit_mut_children_with(self);
        }
    }

    fn visit_mut_prop_name(&mut self, n: &mut PropName) {
        if let PropName::Computed(_) = n {
            n.visit_mut_children_with(self);
        }
    }

    fn visit_mut_stmts(&mut self, s: &mut Vec<Stmt>) {
        s.visit_mut_children_with(self);
        self.es2022_prepend_private_field_vars(s);
    }
}