File: beta-cut.py

package info (click to toggle)
firefox 147.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,683,484 kB
  • sloc: cpp: 7,607,246; javascript: 6,533,185; ansic: 3,775,227; python: 1,415,393; xml: 634,561; asm: 438,951; java: 186,241; sh: 62,752; makefile: 18,079; objc: 13,092; perl: 12,808; yacc: 4,583; cs: 3,846; pascal: 3,448; lex: 1,720; ruby: 1,003; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10; exp: 6
file content (240 lines) | stat: -rwxr-xr-x 8,499 bytes parent folder | download | duplicates (12)
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
#!/usr/bin/python3
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.

import os
import re
import subprocess
import sys

# Constants
MOBILE_ANDROID_DIR = os.path.abspath(os.path.dirname(__file__))
CHANGELOG_FILE = os.path.join(
    MOBILE_ANDROID_DIR, "android-components/docs/changelog.md"
)
SOURCE_JSON = os.path.join(
    MOBILE_ANDROID_DIR, "../../services/settings/dumps/main/search-telemetry-v2.json"
)
TARGET_JSON = os.path.join(
    MOBILE_ANDROID_DIR,
    "android-components/components/feature/search/src/main/assets/search/search_telemetry_v2.json",
)
EXPIRED_STRING_VERSION_OFFSET = 3


def check_ripgrep_installed():
    """Check if ripgrep (rg) is installed."""
    try:
        subprocess.run(["rg", "--version"], capture_output=True, check=True)
    except FileNotFoundError:
        print(
            "ERROR: ripgrep (rg) is not installed. Please install ripgrep and try again."
        )
        print(
            "See installation instructions here: https://github.com/BurntSushi/ripgrep?tab=readme-ov-file#installation"
        )
        sys.exit(1)


def check_uncommitted_changes():
    """Check for uncommitted changes in the git repository."""
    result = subprocess.run(
        ["git", "status", "--porcelain", "--untracked-files=no"],
        capture_output=True,
        text=True,
        check=False,
    )
    if result.stdout.strip():
        print("ERROR: Please commit changes before continuing.")
        sys.exit(1)


def get_bug_id():
    """Get BUG_ID from script arguments."""
    if len(sys.argv) < 2:
        print("Usage: python script.py BUG_ID")
        sys.exit(1)
    return sys.argv[1]


def get_previous_version():
    """Extract the previous version number from the changelog."""
    with open(CHANGELOG_FILE) as file:
        content = file.read()
    match = re.search(r"# (\d+)\.0 \(In Development\)", content)
    if not match:
        print(
            "ERROR: Unable to extract the previous version number from the changelog file."
        )
        sys.exit(1)
    return int(match.group(1))


def update_changelog(previous_version, new_version):
    """Update the changelog with the new version number."""
    with open(CHANGELOG_FILE) as file:
        content = file.read()
    updated_content = content.replace(
        f"# {previous_version}.0 (In Development)",
        f"# {new_version}.0 (In Development)\n\n# {previous_version}.0",
    )
    with open(CHANGELOG_FILE, "w") as file:
        file.write(updated_content)


def find_expired_strings(expired_string_version):
    """Find strings to be removed."""
    rg_command = [
        "rg",
        "-g",
        "**/values/**",
        "-U",
        f'(<!--.*-->[\\r\\n\\s]*)?<string[^>]*moz:removedIn="{expired_string_version}"[^>]*>.*?</string>',
        MOBILE_ANDROID_DIR,
    ]
    result = subprocess.run(rg_command, capture_output=True, text=True, check=False)
    expired_strings = []
    if result.stdout.strip():
        for line in result.stdout.splitlines():
            match = re.search(r'<string name="([^"]+)"', line)
            if match:
                expired_strings.append(match.group(1))
    return expired_strings


def remove_expired_strings(expired_string_version):
    """Remove expired strings in string.xml files using the original ripgrep."""
    rg_command = [
        "rg",
        "-g",
        "**/values/**",
        "-l",
        f'moz:removedIn="{expired_string_version}"',
        MOBILE_ANDROID_DIR,
    ]
    result = subprocess.run(rg_command, capture_output=True, text=True, check=False)
    if result.stdout.strip():
        files = result.stdout.strip().splitlines()
        bash_command = (
            f"echo {' '.join(files)} | xargs perl -0777 -pi -e "
            f'"s/(\\s*<!--(?:(?!<!--)[\\s\\S])*?-->\\s*)?<string[^>]*moz:removedIn=\\"{expired_string_version}\\"[^>]*>[^<]*<\\/string>//g"'
        )
        subprocess.run(bash_command, shell=True, check=True, executable="/bin/bash")
        return True
    return False


def update_json_if_necessary():
    """Check if JSON files differ and copy if necessary."""
    if os.path.exists(SOURCE_JSON) and os.path.exists(TARGET_JSON):
        result = subprocess.run(["cmp", "-s", SOURCE_JSON, TARGET_JSON], check=False)
        if result.returncode != 0:  # Files differ
            subprocess.run(["cp", SOURCE_JSON, TARGET_JSON], check=False)
            return True
    return False


def search_remaining_occurrences(removed_strings):
    """Search for remaining occurrences of each removed string."""
    remaining_use_message = ""
    for name in removed_strings:
        rg_command = [
            "rg",
            "-n",
            "--pcre2",
            f"{name}(?![a-zA-Z0-9_-])",
            MOBILE_ANDROID_DIR,
            "-g",
            "!**/strings.xml",
        ]
        result = subprocess.run(rg_command, capture_output=True, text=True, check=False)
        if result.stdout.strip():
            lines = result.stdout.strip().splitlines()
            remaining_use_message += (
                f"\n- \033[31m\033[1m{name}\033[0m ({len(lines)}):\n"
            )
            for line in lines:
                remaining_use_message += f"\t· {line}\n"
    return remaining_use_message


def commit_changes(bug_id, new_version_number, strings_removed, json_updated):
    """Commit all changes with a constructed commit message."""
    commit_message = (
        f"Bug {bug_id} - Start the nightly {new_version_number} development cycle.\n\n"
    )
    if strings_removed:
        commit_message += f"Strings expiring in version {new_version_number - EXPIRED_STRING_VERSION_OFFSET} have been removed\n"
    if json_updated:
        commit_message += (
            "search_telemetry_v2.json was updated in Android Components, based on the "
            "content of services/settings/dumps/main/search-telemetry-v2.json\n"
        )
    subprocess.run(["git", "add", "-u"], check=False)
    subprocess.run(["git", "commit", "--quiet", "-m", commit_message], check=False)


def main():
    check_ripgrep_installed()
    check_uncommitted_changes()
    bug_id = get_bug_id()
    previous_version = get_previous_version()
    new_version = previous_version + 1
    expired_string_version = new_version - EXPIRED_STRING_VERSION_OFFSET

    # Update changelog
    update_changelog(previous_version, new_version)

    # Find and remove expired strings
    expired_strings = find_expired_strings(expired_string_version)
    if expired_strings:
        strings_removed = remove_expired_strings(expired_string_version)
        remaining_use_message = search_remaining_occurrences(expired_strings)
    else:
        strings_removed = False
        remaining_use_message = ""

    # Check JSON update
    json_updated = update_json_if_necessary()

    # Commit changes
    commit_changes(bug_id, new_version, strings_removed, json_updated)

    # Output final message
    print(f"✅ Changelog updated to version {new_version}")
    if strings_removed:
        print(f"✅ Removed 'moz:removedIn=\"{expired_string_version}\"' entries")
    else:
        print(f"ℹ️  No 'moz:removedIn=\"{expired_string_version}\"' entries found")

    if json_updated:
        print("✅ search_telemetry_v2.json was updated in Android Components")
    else:
        print("ℹ️  search_telemetry_v2.json was already up to date and was not modified")
    print(f"✅ Changes committed with Bug ID {bug_id}.")

    if remaining_use_message:
        print(
            "\n⚠️  Some of the strings that were removed might still be used in the codebase."
        )
        print(
            "These are the potential remaining usages. Keep in mind that it is purely indicative and might show false positives."
        )
        print("Please remove the real remaining usages and amend the commit.")
        print(remaining_use_message)

    print("\n\033[1mPlease make sure you complete the following steps:\033[0m")
    if remaining_use_message:
        print(
            "☐ Remove the remaining uses of the removed strings and amend the commit."
        )
    print("☐ Review the changes and make sure they are correct")
    print("☐ Run `moz-phab submit --no-wip`")
    print(
        "☐ Run `mach try --preset firefox-android` and add a comment with the try link on the patch"
    )


if __name__ == "__main__":
    main()