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, RuleMetadata, 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    metadata: RuleMetadata,
19    preserve_args_side_effects: bool,
20}
21
22impl Default for RemoveDebugProfiling {
23    fn default() -> Self {
24        Self {
25            metadata: RuleMetadata::default(),
26            preserve_args_side_effects: true,
27        }
28    }
29}
30
31fn should_remove_call(identifiers: &IdentifierTracker, prefix: &Prefix) -> bool {
32    if identifiers.is_identifier_used(DEBUG_LIBRARY_NAME) {
33        return false;
34    }
35
36    match prefix {
37        Prefix::Field(field_expression)
38            if field_expression.get_field().get_name() == START_PROFILE_FUNFCTION
39                || field_expression.get_field().get_name() == STOP_PROFILE_FUNCTION =>
40        {
41            matches!(field_expression.get_prefix(), Prefix::Identifier(identifier) if identifier.get_name() == DEBUG_LIBRARY_NAME)
42        }
43        _ => false,
44    }
45}
46
47impl FlawlessRule for RemoveDebugProfiling {
48    fn flawless_process(&self, block: &mut Block, _: &Context) {
49        let mut processor =
50            RemoveFunctionCallProcessor::new(self.preserve_args_side_effects, should_remove_call);
51        ScopeVisitor::visit_block(block, &mut processor);
52
53        if let Some(statement) = processor.extract_reserved_globals() {
54            block.insert_statement(0, statement);
55        }
56    }
57}
58
59impl RuleConfiguration for RemoveDebugProfiling {
60    fn configure(&mut self, properties: RuleProperties) -> Result<(), RuleConfigurationError> {
61        for (key, value) in properties {
62            match key.as_str() {
63                "preserve_arguments_side_effects" => {
64                    self.preserve_args_side_effects = value.expect_bool(&key)?;
65                }
66                _ => return Err(RuleConfigurationError::UnexpectedProperty(key)),
67            }
68        }
69
70        Ok(())
71    }
72
73    fn get_name(&self) -> &'static str {
74        REMOVE_DEBUG_PROFILING_RULE_NAME
75    }
76
77    fn serialize_to_properties(&self) -> RuleProperties {
78        let mut properties = RuleProperties::new();
79
80        if !self.preserve_args_side_effects {
81            properties.insert("preserve_arguments_side_effects".to_owned(), false.into());
82        }
83
84        properties
85    }
86
87    fn set_metadata(&mut self, metadata: RuleMetadata) {
88        self.metadata = metadata;
89    }
90
91    fn metadata(&self) -> &RuleMetadata {
92        &self.metadata
93    }
94}
95
96#[cfg(test)]
97mod test {
98    use super::*;
99    use crate::rules::Rule;
100
101    use insta::assert_json_snapshot;
102
103    fn new_rule() -> RemoveDebugProfiling {
104        RemoveDebugProfiling::default()
105    }
106
107    #[test]
108    fn serialize_default_rule() {
109        let rule: Box<dyn Rule> = Box::new(new_rule());
110
111        assert_json_snapshot!(rule, @r###""remove_debug_profiling""###);
112    }
113
114    #[test]
115    fn serialize_rule_without_side_effects() {
116        let rule: Box<dyn Rule> = Box::new(RemoveDebugProfiling {
117            metadata: RuleMetadata::default(),
118            preserve_args_side_effects: false,
119        });
120
121        assert_json_snapshot!(rule, @r###"
122        {
123          "rule": "remove_debug_profiling",
124          "preserve_arguments_side_effects": false
125        }
126        "###);
127    }
128
129    #[test]
130    fn configure_with_extra_field_error() {
131        let result = json5::from_str::<Box<dyn Rule>>(
132            r#"{
133            rule: 'remove_debug_profiling',
134            prop: "something",
135        }"#,
136        );
137        insta::assert_snapshot!(result.unwrap_err().to_string(), @"unexpected field 'prop' at line 1 column 1");
138    }
139}
darklua_core/rules/remove_debug_profiling.rs

darklua_core/rules/
remove_debug_profiling.rs
