tga 10.3.4

Developer productivity analytics — git commit collection, classification, and reporting
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

//! Shared commit-message revert detection.
//!
//! Why: prior to issue #377 two independent revert heuristics existed — a
//! narrow byte-prefix check in `commands::backfill` (3 forms) and a broader
//! regex pair in `report::aggregator` (`^revert`, `^fix.*revert`). The two
//! disagreed, so the persisted `commits.is_revert` column and the
//! report-time revert rate were computed from different rules (the backfill
//! path missed ~87% of reverts the aggregator caught). This module is the
//! single source of truth both paths now call.
//!
//! What: a message is a revert when its **first line** (subject) matches any
//! of the recognized forms:
//!
//! - `Revert "<subject>"` — git's auto-generated revert subject
//!   (case-insensitive).
//! - `revert:` / `revert(scope):` — Conventional Commits revert type.
//! - `^revert` — any subject beginning with the word "revert"
//!   (case-insensitive), e.g. `Revert this change`.
//! - `^fix.*revert` — a fix commit that mentions a revert in its subject,
//!   e.g. `Fix botched revert of #42`. A `-`-prefixed CLI flag such as
//!   `--revert` does not count (#182).
//!
//! False-positive guard: matching is anchored to the start of the *first
//! line only* and requires the literal token `revert` at a word boundary.
//! Prose such as `Refactor revert handling` (subject starts with "Refactor")
//! or `reverting the decision` (no `^revert` word boundary — `reverting`
//! does not match `\brevert\b` followed by a non-word boundary... see below)
//! are deliberately NOT flagged as reverts: the issue defines the metric as
//! "share of commits that ARE reverts", so we only fire on subjects that
//! clearly announce a revert, not subjects that merely discuss one.

use std::sync::OnceLock;

use regex::Regex;

/// Compiled revert-detection patterns.
struct RevertPatterns {
    /// `^revert` — subject begins with the word "revert" (covers
    /// `Revert "..."`, `revert:`, `revert(scope):`, `Revert this change`).
    leading_revert: Regex,
    /// `^fix.*revert` — a fix subject that references a revert.
    fix_revert: Regex,
}

/// Global, lazily-initialized revert pattern set.
fn patterns() -> &'static RevertPatterns {
    static PATTERNS: OnceLock<RevertPatterns> = OnceLock::new();
    PATTERNS.get_or_init(|| {
        // SAFETY of expect: these literals are validated by the test
        // [`tests::patterns_compile`] — any regression is caught at test
        // time, not at runtime.
        RevertPatterns {
            // `(?i)` case-insensitive; `^\s*` tolerates leading whitespace;
            // `revert\b` requires a word boundary so `reverting` /
            // `reverted` (which continue the word) do NOT match.
            leading_revert: Regex::new(r"(?i)^\s*revert\b")
                .expect("leading_revert pattern compiles"),
            // `fix` (optionally `fix:` / `fixes` / `fixed`) followed on the
            // subject line by the word `revert`.
            // #182: `revert` must sit in the first token or in a later
            // whitespace-delimited token that does not start with `-`, so a
            // CLI flag such as `--revert` or `--no-revert` is not a revert.
            fix_revert: Regex::new(
                r"(?i)^\s*fix\w*\b(?:\S*?\brevert\b|.*\s(?:[^\s-]\S*?)?\brevert\b)",
            )
            .expect("fix_revert pattern compiles"),
        }
    })
}

/// Return `true` if `message` looks like a revert commit.
///
/// Why: the persisted `commits.is_revert` column and the report-time revert
/// rate must agree; routing both through this function guarantees parity
/// (issue #377).
/// What: tests the message's first line against the recognized revert forms
/// (`^revert`, `^fix.*revert`, case-insensitive). Multi-line bodies are
/// ignored — only the subject can declare a revert.
/// Test: `tests` below cover each accepted form and the false-positive
/// guards.
pub fn is_revert(message: &str) -> bool {
    let first_line = message.lines().next().unwrap_or(message);
    let p = patterns();
    p.leading_revert.is_match(first_line) || p.fix_revert.is_match(first_line)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn patterns_compile() {
        // Force lazy init; malformed patterns panic here.
        let _ = patterns();
    }

    #[test]
    fn matches_git_auto_revert() {
        assert!(is_revert("Revert \"feat: add login\""));
        assert!(is_revert("revert \"fix: thing\""));
    }

    #[test]
    fn matches_conventional_commit_revert() {
        assert!(is_revert("revert: bad merge"));
        assert!(is_revert("revert(auth): drop broken guard"));
        assert!(is_revert("Revert(scope): something"));
    }

    #[test]
    fn matches_leading_revert_word() {
        assert!(is_revert("Revert this change"));
        assert!(is_revert("REVERT everything"));
        assert!(is_revert("  revert with leading spaces"));
    }

    #[test]
    fn matches_fix_revert() {
        assert!(is_revert("Fix botched revert of #42"));
        assert!(is_revert("fix: re-apply after revert"));
        assert!(is_revert("fixes the revert that broke CI"));
    }

    /// #182: a `-`-prefixed CLI flag such as `--revert` is not a revert;
    /// every real `fix ... revert` form still matches.
    #[test]
    fn fix_revert_ignores_cli_flags() {
        assert!(!is_revert(
            "fix(deploy): pin the task definition on --revert scale-up"
        ));
        assert!(!is_revert("fix: pass --revert to the deploy script"));
        assert!(!is_revert("fix: add a --no-revert option"));
        assert!(!is_revert("fix: honour the -revert switch"));
        assert!(is_revert("fix: revert X"));
        assert!(is_revert("fix(scope): revert the cache change"));
        assert!(is_revert("fix:revert X"));
        assert!(is_revert("fix: (revert) the bad merge"));
        assert!(is_revert("fix: --revert flag, and revert the bad merge"));
        assert!(is_revert("Revert \"fix: pass --revert to deploy\""));
    }

    #[test]
    fn ignores_body_only_mentions() {
        // The subject does not announce a revert; a body mention must not
        // flip the flag.
        let msg = "feat: add caching\n\nThis effectively reverts the earlier approach.";
        assert!(!is_revert(msg));
    }

    #[test]
    fn rejects_prose_and_false_positives() {
        // Subject discusses reverts but does not begin with `revert` and is
        // not a `fix...revert`.
        assert!(!is_revert("Refactor revert handling"));
        assert!(!is_revert("Add tests for revert path"));
        // Word-boundary guard: `reverting` / `reverted` continue the word.
        assert!(!is_revert("reverting the decision later"));
        assert!(!is_revert("reverted earlier per discussion"));
        // Unrelated subjects.
        assert!(!is_revert("feat: add login"));
        assert!(!is_revert("Fix bug in feature"));
        assert!(!is_revert(""));
    }
}