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}
52
53impl RuleConfiguration for RemoveDebugProfiling {
54    fn configure(&mut self, properties: RuleProperties) -> Result<(), RuleConfigurationError> {
55        for (key, value) in properties {
56            match key.as_str() {
57                "preserve_arguments_side_effects" => {
58                    self.preserve_args_side_effects = value.expect_bool(&key)?;
59                }
60                _ => return Err(RuleConfigurationError::UnexpectedProperty(key)),
61            }
62        }
63
64        Ok(())
65    }
66
67    fn get_name(&self) -> &'static str {
68        REMOVE_DEBUG_PROFILING_RULE_NAME
69    }
70
71    fn serialize_to_properties(&self) -> RuleProperties {
72        let mut properties = RuleProperties::new();
73
74        if !self.preserve_args_side_effects {
75            properties.insert("preserve_arguments_side_effects".to_owned(), false.into());
76        }
77
78        properties
79    }
80}
81
82#[cfg(test)]
83mod test {
84    use super::*;
85    use crate::rules::Rule;
86
87    use insta::assert_json_snapshot;
88
89    fn new_rule() -> RemoveDebugProfiling {
90        RemoveDebugProfiling::default()
91    }
92
93    #[test]
94    fn serialize_default_rule() {
95        let rule: Box<dyn Rule> = Box::new(new_rule());
96
97        assert_json_snapshot!("default_remove_debug_profiling", rule);
98    }
99
100    #[test]
101    fn serialize_rule_without_side_effects() {
102        let rule: Box<dyn Rule> = Box::new(RemoveDebugProfiling {
103            preserve_args_side_effects: false,
104        });
105
106        assert_json_snapshot!("remove_debug_profiling_without_side_effects", rule);
107    }
108
109    #[test]
110    fn configure_with_extra_field_error() {
111        let result = json5::from_str::<Box<dyn Rule>>(
112            r#"{
113            rule: 'remove_debug_profiling',
114            prop: "something",
115        }"#,
116        );
117        pretty_assertions::assert_eq!(result.unwrap_err().to_string(), "unexpected field 'prop'");
118    }
119}
darklua_core/rules/remove_debug_profiling.rs

darklua_core/rules/
remove_debug_profiling.rs
