darklua_core/rules/
remove_debug_profiling.rs

1use crate::nodes::{Block, Prefix};
2use crate::process::{IdentifierTracker, NodeVisitor, ScopeVisitor};
3use crate::rules::{
4    Context, FlawlessRule, RuleConfiguration, RuleConfigurationError, RuleProperties,
5};
6
7use super::remove_call_match::RemoveFunctionCallProcessor;
8
9const DEBUG_LIBRARY_NAME: &str = "debug";
10const START_PROFILE_FUNFCTION: &str = "profilebegin";
11const STOP_PROFILE_FUNCTION: &str = "profileend";
12
13pub const REMOVE_DEBUG_PROFILING_RULE_NAME: &str = "remove_debug_profiling";
14
15/// A rule that removes `debug.profilebegin` and `debug.profileend` calls.
16#[derive(Debug, PartialEq, Eq)]
17pub struct RemoveDebugProfiling {
18    preserve_args_side_effects: bool,
19}
20
21impl Default for RemoveDebugProfiling {
22    fn default() -> Self {
23        Self {
24            preserve_args_side_effects: true,
25        }
26    }
27}
28
29fn should_remove_call(identifiers: &IdentifierTracker, prefix: &Prefix) -> bool {
30    if identifiers.is_identifier_used(DEBUG_LIBRARY_NAME) {
31        return false;
32    }
33
34    match prefix {
35        Prefix::Field(field_expression)
36            if field_expression.get_field().get_name() == START_PROFILE_FUNFCTION
37                || field_expression.get_field().get_name() == STOP_PROFILE_FUNCTION =>
38        {
39            matches!(field_expression.get_prefix(), Prefix::Identifier(identifier) if identifier.get_name() == DEBUG_LIBRARY_NAME)
40        }
41        _ => false,
42    }
43}
44
45impl FlawlessRule for RemoveDebugProfiling {
46    fn flawless_process(&self, block: &mut Block, _: &Context) {
47        let mut processor =
48            RemoveFunctionCallProcessor::new(self.preserve_args_side_effects, should_remove_call);
49        ScopeVisitor::visit_block(block, &mut processor);
50
51        if let Some(statement) = processor.extract_reserved_globals() {
52            block.insert_statement(0, statement);
53        }
54    }
55}
56
57impl RuleConfiguration for RemoveDebugProfiling {
58    fn configure(&mut self, properties: RuleProperties) -> Result<(), RuleConfigurationError> {
59        for (key, value) in properties {
60            match key.as_str() {
61                "preserve_arguments_side_effects" => {
62                    self.preserve_args_side_effects = value.expect_bool(&key)?;
63                }
64                _ => return Err(RuleConfigurationError::UnexpectedProperty(key)),
65            }
66        }
67
68        Ok(())
69    }
70
71    fn get_name(&self) -> &'static str {
72        REMOVE_DEBUG_PROFILING_RULE_NAME
73    }
74
75    fn serialize_to_properties(&self) -> RuleProperties {
76        let mut properties = RuleProperties::new();
77
78        if !self.preserve_args_side_effects {
79            properties.insert("preserve_arguments_side_effects".to_owned(), false.into());
80        }
81
82        properties
83    }
84}
85
86#[cfg(test)]
87mod test {
88    use super::*;
89    use crate::rules::Rule;
90
91    use insta::assert_json_snapshot;
92
93    fn new_rule() -> RemoveDebugProfiling {
94        RemoveDebugProfiling::default()
95    }
96
97    #[test]
98    fn serialize_default_rule() {
99        let rule: Box<dyn Rule> = Box::new(new_rule());
100
101        assert_json_snapshot!("default_remove_debug_profiling", rule);
102    }
103
104    #[test]
105    fn serialize_rule_without_side_effects() {
106        let rule: Box<dyn Rule> = Box::new(RemoveDebugProfiling {
107            preserve_args_side_effects: false,
108        });
109
110        assert_json_snapshot!("remove_debug_profiling_without_side_effects", rule);
111    }
112
113    #[test]
114    fn configure_with_extra_field_error() {
115        let result = json5::from_str::<Box<dyn Rule>>(
116            r#"{
117            rule: 'remove_debug_profiling',
118            prop: "something",
119        }"#,
120        );
121        pretty_assertions::assert_eq!(result.unwrap_err().to_string(), "unexpected field 'prop'");
122    }
123}
darklua_core/rules/remove_debug_profiling.rs

darklua_core/rules/
remove_debug_profiling.rs
