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
#[cfg(not(feature = "plugin"))]
use swc_common::{util::take::Take, Span, DUMMY_SP};
#[cfg(not(feature = "plugin"))]
use swc_ecma_ast::*;
#[cfg(not(feature = "plugin"))]
use swc_ecma_visit::*;

#[cfg(feature = "plugin")]
use swc_plugin::{
    ast::*,
    syntax_pos::{Span, DUMMY_SP},
    utils::take::Take,
};
use tracing::instrument;

use crate::{
    create_instrumentation_visitor, instrumentation_counter_helper,
    instrumentation_stmt_counter_helper, instrumentation_visitor, InstrumentOptions,
};

create_instrumentation_visitor!(CoverageVisitor { file_path: String });

/// Public interface to create a visitor performs transform to inject
/// coverage instrumentation counter.
pub fn create_coverage_instrumentation_visitor<C: Clone + Comments>(
    source_map: std::sync::Arc<SourceMapImpl>,
    comments: C,
    instrument_options: InstrumentOptions,
    filename: String,
) -> CoverageVisitor<C> {
    // create a function name ident for the injected coverage instrumentation counters.
    crate::create_coverage_fn_ident(&filename);

    let mut cov = crate::SourceCoverage::new(filename.to_string(), instrument_options.report_logic);
    cov.set_input_source_map(&instrument_options.input_source_map);

    CoverageVisitor::new(
        source_map,
        comments.clone(),
        std::rc::Rc::new(std::cell::RefCell::new(cov)),
        instrument_options,
        vec![],
        None,
        filename,
    )
}

impl<C: Clone + Comments> CoverageVisitor<C> {
    instrumentation_counter_helper!();
    instrumentation_stmt_counter_helper!();

    /// Not implemented.
    /// TODO: is this required?
    fn is_instrumented_already(&self) -> bool {
        return false;
    }

    /// Create coverage instrumentation template exprs to be injected into the top of the transformed output.
    fn get_coverage_templates(&mut self) -> (Stmt, Stmt) {
        self.cov.borrow_mut().freeze();

        //TODO: option: global coverage variable scope. (optional, default `this`)
        let coverage_global_scope = "this";
        //TODO: option: use an evaluated function to find coverageGlobalScope.
        let coverage_global_scope_func = true;

        let gv_template = if coverage_global_scope_func {
            // TODO: path.scope.getBinding('Function')
            let is_function_binding_scope = false;

            if is_function_binding_scope {
                /*
                gvTemplate = globalTemplateAlteredFunction({
                    GLOBAL_COVERAGE_SCOPE: T.stringLiteral(
                        'return ' + opts.coverageGlobalScope
                    )
                });
                 */
                unimplemented!("");
            } else {
                crate::create_global_stmt_template(coverage_global_scope)
            }
        } else {
            unimplemented!("");
            /*
            gvTemplate = globalTemplateVariable({
                GLOBAL_COVERAGE_SCOPE: opts.coverageGlobalScope
            });
            */
        };

        let coverage_template = crate::create_coverage_fn_decl(
            &self.instrument_options.coverage_variable,
            gv_template,
            &self.cov_fn_ident,
            &self.file_path,
            self.cov.borrow().as_ref(),
            &self.comments,
            self.instrument_options.debug_initial_coverage_comment,
        );

        // explicitly call this.varName to ensure coverage is always initialized
        let call_coverage_template_stmt = Stmt::Expr(ExprStmt {
            span: DUMMY_SP,
            expr: Box::new(Expr::Call(CallExpr {
                callee: Callee::Expr(Box::new(Expr::Ident(self.cov_fn_ident.clone()))),
                ..CallExpr::dummy()
            })),
        });

        (coverage_template, call_coverage_template_stmt)
    }
}

impl<C: Clone + Comments> VisitMut for CoverageVisitor<C> {
    instrumentation_visitor!();

    #[instrument(skip_all, fields(node = %self.print_node()))]
    fn visit_mut_program(&mut self, program: &mut Program) {
        self.nodes.push(crate::Node::Program);
        if crate::hint_comments::should_ignore_file(&self.comments, program) {
            return;
        }

        if self.is_instrumented_already() {
            return;
        }

        program.visit_mut_children_with(self);
        self.nodes.pop();
    }

    #[instrument(skip_all, fields(node = %self.print_node()))]
    fn visit_mut_module_items(&mut self, items: &mut Vec<ModuleItem>) {
        if self.is_instrumented_already() {
            return;
        }

        let root_exists = match self.nodes.get(0) {
            Some(node) => node == &crate::Node::Program,
            _ => false,
        };

        // Articulate root by injecting Program node if visut_mut_program is not called.
        // TODO: Need to figure out why custom_js_pass doesn't hit visit_mut_program
        // instead of manually injecting node here
        if !root_exists {
            let mut new_nodes = vec![crate::Node::Program];
            new_nodes.extend(self.nodes.drain(..));
            self.nodes = new_nodes;
        }

        // TODO: Should module_items need to be added in self.nodes?
        let mut new_items = vec![];
        for mut item in items.drain(..) {
            let (old, _ignore_current) = match &mut item {
                ModuleItem::ModuleDecl(decl) => self.on_enter(decl),
                ModuleItem::Stmt(stmt) => self.on_enter(stmt),
            };
            item.visit_mut_children_with(self);

            new_items.extend(self.before.drain(..).map(|v| ModuleItem::Stmt(v)));
            new_items.push(item);
            self.on_exit(old);
        }
        *items = new_items;

        let (coverage_template, call_coverage_template_stmt) = self.get_coverage_templates();

        // prepend template to the top of the code
        items.insert(0, ModuleItem::Stmt(coverage_template));
        items.insert(1, ModuleItem::Stmt(call_coverage_template_stmt));

        if !root_exists {
            self.nodes.pop();
        }
    }

    #[instrument(skip_all, fields(node = %self.print_node()))]
    fn visit_mut_script(&mut self, items: &mut Script) {
        if self.is_instrumented_already() {
            return;
        }

        let mut new_items = vec![];
        for mut item in items.body.drain(..) {
            item.visit_mut_children_with(self);
            new_items.extend(self.before.drain(..));
            new_items.push(item);
        }
        items.body = new_items;

        let (coverage_template, call_coverage_template_stmt) = self.get_coverage_templates();

        // prepend template to the top of the code
        items.body.insert(0, coverage_template);
        items.body.insert(1, call_coverage_template_stmt);
    }

    // ExportDefaultDeclaration: entries(), // ignore processing only
    #[instrument(skip_all, fields(node = %self.print_node()))]
    fn visit_mut_export_default_decl(&mut self, export_default_decl: &mut ExportDefaultDecl) {
        let (old, ignore_current) = self.on_enter(export_default_decl);
        match ignore_current {
            Some(crate::hint_comments::IgnoreScope::Next) => {}
            _ => {
                // noop
                export_default_decl.visit_mut_children_with(self);
            }
        }
        self.on_exit(old);
    }

    // ExportNamedDeclaration: entries(), // ignore processing only
    #[instrument(skip_all, fields(node = %self.print_node()))]
    fn visit_mut_export_decl(&mut self, export_named_decl: &mut ExportDecl) {
        let (old, ignore_current) = self.on_enter(export_named_decl);
        match ignore_current {
            Some(crate::hint_comments::IgnoreScope::Next) => {}
            _ => {
                // noop
                export_named_decl.visit_mut_children_with(self);
            }
        }
        self.on_exit(old);
    }

    // DebuggerStatement: entries(coverStatement),
    #[instrument(skip_all, fields(node = %self.print_node()))]
    fn visit_mut_debugger_stmt(&mut self, debugger_stmt: &mut DebuggerStmt) {
        let (old, ignore_current) = self.on_enter(debugger_stmt);
        match ignore_current {
            Some(crate::hint_comments::IgnoreScope::Next) => {}
            _ => {
                debugger_stmt.visit_mut_children_with(self);
            }
        }
        self.on_exit(old);
    }

    // ConditionalExpression: entries(coverTernary),
    #[instrument(skip_all, fields(node = %self.print_node()))]
    fn visit_mut_cond_expr(&mut self, cond_expr: &mut CondExpr) {
        let (old, ignore_current) = self.on_enter(cond_expr);

        match ignore_current {
            Some(crate::hint_comments::IgnoreScope::Next) => {}
            _ => {
                let range =
                    crate::lookup_range::get_range_from_span(&self.source_map, &cond_expr.span);
                let branch = self.cov.borrow_mut().new_branch(
                    istanbul_oxide::BranchType::CondExpr,
                    &range,
                    false,
                );

                let c_hint = crate::hint_comments::lookup_hint_comments(
                    &self.comments,
                    crate::lookup_range::get_expr_span(&*cond_expr.cons),
                );
                let a_hint = crate::hint_comments::lookup_hint_comments(
                    &self.comments,
                    crate::lookup_range::get_expr_span(&*cond_expr.alt),
                );

                if c_hint.as_deref() != Some("next") {
                    // TODO: do we need this?
                    // cond_expr.cons.visit_mut_children_with(self);

                    // replace consequence to the paren for increase expr + expr itself
                    self.replace_expr_with_branch_counter(&mut *cond_expr.cons, branch);
                }

                if a_hint.as_deref() != Some("next") {
                    // TODO: do we need this?
                    // cond_expr.alt.visit_mut_children_with(self);

                    // replace consequence to the paren for increase expr + expr itself
                    self.replace_expr_with_branch_counter(&mut *cond_expr.alt, branch);
                }
            }
        };

        cond_expr.visit_mut_children_with(self);
        self.on_exit(old);
    }
}