1import os
2from collections import defaultdict
3from datetime import datetime, timedelta
4from typing import Optional
5
6from github import Github
7from github.Issue import Issue
8from github.Repository import Repository
9from pytz import timezone
10
11import typer
12from typer import Typer
13
14app: Typer = typer.Typer()
15
16DATETIME_FORMAT: str = "%m/%d/%Y %I:%M %p"
17CORE_LABELS: set[str] = {
18 "defect",
19 "design",
20 "documentation",
21 "enhancement",
22 "panic / crash",
23}
24# A set of labels for adding in labels that we want present in the final
25# report, but that we don't want being defined as a core label, since issues
26# with without core labels are flagged as errors.
27ADDITIONAL_LABELS: set[str] = {
28 "ai",
29 "linux",
30 "vim",
31 "windows",
32}
33IGNORED_LABELS: set[str] = {
34 "ignore top-ranking issues",
35}
36ISSUES_PER_LABEL: int = 20
37
38
39class IssueData:
40 def __init__(self, issue: Issue) -> None:
41 self.url: str = issue.html_url
42 self.like_count: int = issue._rawData["reactions"]["+1"] # type: ignore [attr-defined]
43 self.creation_datetime: str = issue.created_at.strftime(DATETIME_FORMAT)
44 # TODO: Change script to support storing labels here, rather than directly in the script
45 self.labels: set[str] = {label["name"] for label in issue._rawData["labels"]} # type: ignore [attr-defined]
46
47
48@app.command()
49def main(
50 github_token: Optional[str] = None,
51 issue_reference_number: Optional[int] = None,
52 query_day_interval: Optional[int] = None,
53) -> None:
54 start_time: datetime = datetime.now()
55
56 start_date: datetime | None = None
57
58 if query_day_interval:
59 tz = timezone("america/new_york")
60 current_time = datetime.now(tz).replace(
61 hour=0, minute=0, second=0, microsecond=0
62 )
63 start_date = current_time - timedelta(days=query_day_interval)
64
65 # GitHub Workflow will pass in the token as an environment variable,
66 # but we can place it in our env when running the script locally, for convenience
67 github_token = github_token or os.getenv("GITHUB_ACCESS_TOKEN")
68 github = Github(github_token)
69
70 remaining_requests_before: int = github.rate_limiting[0]
71 print(f"Remaining requests before: {remaining_requests_before}")
72
73 repo_name: str = "zed-industries/zed"
74 repository: Repository = github.get_repo(repo_name)
75
76 # There has to be a nice way of adding types to tuple unpacking
77 label_to_issue_data: dict[str, list[IssueData]]
78 error_message_to_erroneous_issue_data: dict[str, list[IssueData]]
79 (
80 label_to_issue_data,
81 error_message_to_erroneous_issue_data,
82 ) = get_issue_maps(github, repository, start_date)
83
84 issue_text: str = get_issue_text(
85 label_to_issue_data,
86 error_message_to_erroneous_issue_data,
87 )
88
89 if issue_reference_number:
90 top_ranking_issues_issue: Issue = repository.get_issue(issue_reference_number)
91 top_ranking_issues_issue.edit(body=issue_text)
92 else:
93 print(issue_text)
94
95 remaining_requests_after: int = github.rate_limiting[0]
96 print(f"Remaining requests after: {remaining_requests_after}")
97 print(f"Requests used: {remaining_requests_before - remaining_requests_after}")
98
99 run_duration: timedelta = datetime.now() - start_time
100 print(run_duration)
101
102
103def get_issue_maps(
104 github: Github,
105 repository: Repository,
106 start_date: datetime | None = None,
107) -> tuple[dict[str, list[IssueData]], dict[str, list[IssueData]]]:
108 label_to_issues: defaultdict[str, list[Issue]] = get_label_to_issues(
109 github,
110 repository,
111 start_date,
112 )
113 label_to_issue_data: dict[str, list[IssueData]] = get_label_to_issue_data(
114 label_to_issues
115 )
116
117 error_message_to_erroneous_issues: defaultdict[str, list[Issue]] = (
118 get_error_message_to_erroneous_issues(github, repository)
119 )
120 error_message_to_erroneous_issue_data: dict[str, list[IssueData]] = (
121 get_error_message_to_erroneous_issue_data(error_message_to_erroneous_issues)
122 )
123
124 # Create a new dictionary with labels ordered by the summation the of likes on the associated issues
125 labels = list(label_to_issue_data.keys())
126
127 labels.sort(
128 key=lambda label: sum(
129 issue_data.like_count for issue_data in label_to_issue_data[label]
130 ),
131 reverse=True,
132 )
133
134 label_to_issue_data = {label: label_to_issue_data[label] for label in labels}
135
136 return (
137 label_to_issue_data,
138 error_message_to_erroneous_issue_data,
139 )
140
141
142def get_label_to_issues(
143 github: Github,
144 repository: Repository,
145 start_date: datetime | None = None,
146) -> defaultdict[str, list[Issue]]:
147 label_to_issues: defaultdict[str, list[Issue]] = defaultdict(list)
148
149 labels: set[str] = CORE_LABELS | ADDITIONAL_LABELS
150 ignored_labels_text: str = " ".join(
151 [f'-label:"{label}"' for label in IGNORED_LABELS]
152 )
153
154 date_query: str = (
155 f"created:>={start_date.strftime('%Y-%m-%d')}" if start_date else ""
156 )
157
158 for label in labels:
159 query: str = f'repo:{repository.full_name} is:open is:issue {date_query} label:"{label}" {ignored_labels_text} sort:reactions-+1-desc'
160
161 issues = github.search_issues(query)
162
163 if issues.totalCount > 0:
164 for issue in issues[0:ISSUES_PER_LABEL]:
165 label_to_issues[label].append(issue)
166
167 return label_to_issues
168
169
170def get_label_to_issue_data(
171 label_to_issues: defaultdict[str, list[Issue]],
172) -> dict[str, list[IssueData]]:
173 label_to_issue_data: dict[str, list[IssueData]] = {}
174
175 for label in label_to_issues:
176 issues: list[Issue] = label_to_issues[label]
177 issue_data: list[IssueData] = [IssueData(issue) for issue in issues]
178 issue_data.sort(
179 key=lambda issue_data: (
180 -issue_data.like_count,
181 issue_data.creation_datetime,
182 )
183 )
184
185 if issue_data:
186 label_to_issue_data[label] = issue_data
187
188 return label_to_issue_data
189
190
191def get_error_message_to_erroneous_issues(
192 github: Github, repository: Repository
193) -> defaultdict[str, list[Issue]]:
194 error_message_to_erroneous_issues: defaultdict[str, list[Issue]] = defaultdict(list)
195
196 # Query for all open issues that don't have either a core or ignored label and mark those as erroneous
197 filter_labels: set[str] = CORE_LABELS | IGNORED_LABELS
198 filter_labels_text: str = " ".join([f'-label:"{label}"' for label in filter_labels])
199 query: str = f"repo:{repository.full_name} is:open is:issue {filter_labels_text}"
200
201 for issue in github.search_issues(query):
202 error_message_to_erroneous_issues["missing core label"].append(issue)
203
204 return error_message_to_erroneous_issues
205
206
207def get_error_message_to_erroneous_issue_data(
208 error_message_to_erroneous_issues: defaultdict[str, list[Issue]],
209) -> dict[str, list[IssueData]]:
210 error_message_to_erroneous_issue_data: dict[str, list[IssueData]] = {}
211
212 for label in error_message_to_erroneous_issues:
213 issues: list[Issue] = error_message_to_erroneous_issues[label]
214 issue_data: list[IssueData] = [IssueData(issue) for issue in issues]
215 error_message_to_erroneous_issue_data[label] = issue_data
216
217 return error_message_to_erroneous_issue_data
218
219
220def get_issue_text(
221 label_to_issue_data: dict[str, list[IssueData]],
222 error_message_to_erroneous_issue_data: dict[str, list[IssueData]],
223) -> str:
224 tz = timezone("america/new_york")
225 current_datetime: str = datetime.now(tz).strftime(f"{DATETIME_FORMAT} (%Z)")
226
227 highest_ranking_issues_lines: list[str] = get_highest_ranking_issues_lines(
228 label_to_issue_data
229 )
230
231 issue_text_lines: list[str] = [
232 f"*Updated on {current_datetime}*",
233 *highest_ranking_issues_lines,
234 "",
235 "---\n",
236 ]
237
238 erroneous_issues_lines: list[str] = get_erroneous_issues_lines(
239 error_message_to_erroneous_issue_data
240 )
241
242 if erroneous_issues_lines:
243 core_labels_text: str = ", ".join(
244 f'"{core_label}"' for core_label in CORE_LABELS
245 )
246 ignored_labels_text: str = ", ".join(
247 f'"{ignored_label}"' for ignored_label in IGNORED_LABELS
248 )
249
250 issue_text_lines.extend(
251 [
252 "## errors with issues (this section only shows when there are errors with issues)\n",
253 f"This script expects every issue to have at least one of the following core labels: {core_labels_text}",
254 f"This script currently ignores issues that have one of the following labels: {ignored_labels_text}\n",
255 "### what to do?\n",
256 "- Adjust the core labels on an issue to put it into a correct state or add a currently-ignored label to the issue",
257 "- Adjust the core and ignored labels registered in this script",
258 *erroneous_issues_lines,
259 "",
260 "---\n",
261 ]
262 )
263
264 issue_text_lines.extend(
265 [
266 "*For details on how this issue is generated, [see the script](https://github.com/zed-industries/zed/blob/main/script/update_top_ranking_issues/main.py)*",
267 ]
268 )
269
270 return "\n".join(issue_text_lines)
271
272
273def get_highest_ranking_issues_lines(
274 label_to_issue_data: dict[str, list[IssueData]],
275) -> list[str]:
276 highest_ranking_issues_lines: list[str] = []
277
278 if label_to_issue_data:
279 for label, issue_data in label_to_issue_data.items():
280 highest_ranking_issues_lines.append(f"\n## {label}\n")
281
282 for i, issue_data in enumerate(issue_data):
283 markdown_bullet_point: str = (
284 f"{issue_data.url} ({issue_data.like_count} :thumbsup:)"
285 )
286
287 markdown_bullet_point = f"{i + 1}. {markdown_bullet_point}"
288 highest_ranking_issues_lines.append(markdown_bullet_point)
289
290 return highest_ranking_issues_lines
291
292
293def get_erroneous_issues_lines(
294 error_message_to_erroneous_issue_data,
295) -> list[str]:
296 erroneous_issues_lines: list[str] = []
297
298 if error_message_to_erroneous_issue_data:
299 for (
300 error_message,
301 erroneous_issue_data,
302 ) in error_message_to_erroneous_issue_data.items():
303 erroneous_issues_lines.append(f"\n#### {error_message}\n")
304
305 for erroneous_issue_data in erroneous_issue_data:
306 erroneous_issues_lines.append(f"- {erroneous_issue_data.url}")
307
308 return erroneous_issues_lines
309
310
311if __name__ == "__main__":
312 app()
313
314# TODO: Sort label output into core and non core sections