使用Piranha处理基于枚举的特性标志清理

在软件开发过程中，特性标志（Feature Flags）是一种常见的渐进式发布和功能切换技术。当特性标志变得过时（stale）时，我们需要从代码库中彻底清理它们。本文将介绍如何使用Uber的Piranha工具高效清理基于枚举的特性标志。

问题背景

假设我们有一个基于枚举实现的特性标志系统：

enum class FeatureFlags(val featureName: String) {
    FEATURE_A("FEATURE-A-ENABLED"),
    FEATURE_B("FEATURE-B-ENABLED")
}

fun isFeatureEnabled() = featureService.isEnabled(FeatureFlags.FEATURE_A)

fun main() {
    if (isFeatureEnabled()) {
        println("Hello world!")
    } else {
        println("Hi world!")
    }
}

我们的目标是完全移除FEATURE_A相关的所有代码，包括：

1. 枚举条目
2. 检查特性的函数声明
3. 函数调用点

解决方案

第一步：删除枚举条目

我们可以使用Piranha的种子规则来匹配并删除特定的枚举条目：

[[rules]]
name = "delete_enum_declaration"
query = """
(
(enum_entry
    (simple_identifier) @flag_enum_name
    (value_arguments
        (value_argument [
            (string_literal) @flag_name
        ]))
) @enum_entry
(#eq? @flag_name "\"@stale_flag_name\"")
)
"""
replace_node = "enum_entry"
replace = ""
groups = ["delete_property_declaration"]
holes = ["stale_flag_name"]

这个规则会：

1. 查找所有枚举条目
2. 匹配具有特定字符串值（通过stale_flag_name参数指定）的条目
3. 完全删除匹配的枚举条目

第二步：删除特性检查函数

接下来，我们需要删除使用该枚举条目的函数声明。这里的关键是使用前一步匹配到的flag_enum_name：

[[rules]]
name = "replace_flag_method_declaration"
query = """
(
(function_declaration
    (simple_identifier) @func_name
    (function_body
        (call_expression
            (navigation_expression (_))
            (call_suffix
                (value_arguments
                    (value_argument
                        (navigation_expression
                            (navigation_suffix
                                (simple_identifier) @enum_item
                            )))))))) @function_declaration
(#eq? @enum_item "@flag_enum_name")
)
"""
replace_node = "func_name"
replace = ""
groups = ["delete_method_declaration"]
holes = ["flag_enum_name"]
is_seed_rule = false

注意这个规则设置了is_seed_rule = false，因为它依赖于前一个种子规则提供的flag_enum_name。

第三步：处理函数调用点

最后，我们需要处理所有调用该函数的地方，将其替换为适当的布尔值。这里的关键技巧是使用Piranha的规则依赖（edges）机制：

1. 首先，在第二个规则中添加一个边（edge）指向第三个规则
2. 然后，第三个规则可以使用第二个规则匹配到的func_name

[[rules]]
name = "replace_flag_invocation"
query = """
(
(call_expression
    (simple_identifier) @invocation_name
) @call_expr
(#eq? @invocation_name "@func_name")
"""
replace_node = "call_expr"
replace = "false"  # 或true，取决于默认行为
groups = ["replace_invocation"]
holes = ["func_name"]
is_seed_rule = false

最终效果

应用这些规则后，代码将被清理为：

enum class FeatureFlags(val featureName: String) {
    FEATURE_B("FEATURE_B")
}

fun main() {
    println("Hi world!")
}

最佳实践

1. 渐进式清理：先确保所有调用点都被处理，再删除函数声明和枚举条目
2. 测试验证：在应用这些规则前，确保有充分的测试覆盖
3. 代码审查：自动化清理后仍需人工审查，确保没有意外影响
4. 参数化规则：使用holes使规则更通用，可复用于其他特性标志

通过这种系统化的方法，我们可以安全、高效地清理过时的特性标志，保持代码库的整洁。Piranha的规则链和依赖机制为这类复杂重构提供了强大支持。