Repository navigation
Expand file tree
/
Copy pathgithub.js
More file actions
103 lines (92 loc) · 4.51 KB
/
Copy pathgithub.js
File metadata and controls
103 lines (92 loc) · 4.51 KB
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
// Pure GitHub lookup logic. No chrome.* here so it can run under Node for tests.
const API = 'https://api.github.com';
async function get(path, token, fetchImpl) {
const headers = {
Accept: 'application/vnd.github+json',
'X-GitHub-Api-Version': '2022-11-28',
};
if (token) headers.Authorization = `Bearer ${token}`;
const res = await fetchImpl(`${API}${path}`, { headers });
if (!res.ok) {
const err = new Error(`GitHub ${res.status}`);
err.status = res.status;
// GitHub also answers 403 for SSO enforcement and missing token permissions.
err.rateLimited = res.status === 429 || res.headers.get('x-ratelimit-remaining') === '0';
const reset = Number(res.headers.get('x-ratelimit-reset'));
if (reset) err.resetAt = reset * 1000;
throw err;
}
return res.json();
}
const BADGES = {
open: { key: 'open', icon: 'open-pr', label: 'Open' },
draft: { key: 'draft', icon: 'draft', label: 'Draft' },
approved: { key: 'approved', icon: 'approved', label: 'Approved' },
changes: { key: 'changes', icon: 'changes', label: 'Changes requested' },
conflicts: { key: 'conflicts', icon: 'conflicts', label: 'Conflicts' },
merged: { key: 'merged', icon: 'merged', label: 'Merged' },
closed: { key: 'closed', icon: 'closed', label: 'Closed' },
issueOpen: { key: 'open', icon: 'open-issue', label: 'Open' },
issueDone: { key: 'done', icon: 'done', label: 'Closed' },
notPlanned: { key: 'notplanned', icon: 'notplanned', label: 'Not planned' },
};
// Latest non-comment review per reviewer decides the overall review state.
export function reviewDecision(reviews) {
const latest = new Map();
for (const r of reviews) {
if (r.state === 'COMMENTED' || r.state === 'PENDING') continue;
latest.set(r.user?.login, r.state);
}
const states = [...latest.values()];
if (states.includes('CHANGES_REQUESTED')) return 'changes';
if (states.includes('APPROVED')) return 'approved';
return null;
}
// Conflicts block a merge whatever the draft or review state, so they win for an open PR.
export function prBadges(pr, reviews) {
if (pr.merged || pr.merged_at) return [BADGES.merged];
if (pr.state === 'closed') return [BADGES.closed];
if (pr.mergeable_state === 'dirty') return [BADGES.conflicts];
if (pr.draft) return [BADGES.draft];
return [BADGES[reviewDecision(reviews) ?? 'open']];
}
export function issueBadges(issue) {
if (issue.state === 'open') return [BADGES.issueOpen];
if (issue.state_reason === 'not_planned') return [BADGES.notPlanned];
return [BADGES.issueDone];
}
export async function lookup({ owner, repo, kind, number }, token, fetchImpl = fetch) {
const base = `/repos/${owner}/${repo}`;
// An /issues/N URL can point at a PR; the issue payload tells us.
let isPR = kind === 'pull';
let issue;
if (!isPR) {
issue = await get(`${base}/issues/${number}`, token, fetchImpl);
isPR = Boolean(issue.pull_request);
}
if (!isPR) return { badges: issueBadges(issue), title: issue.title };
const [pr, reviews] = await Promise.all([
get(`${base}/pulls/${number}`, token, fetchImpl),
get(`${base}/pulls/${number}/reviews?per_page=100`, token, fetchImpl),
]);
// GitHub computes mergeability lazily, so the first answer for an open PR can be "unknown".
const provisional = pr.state === 'open' && (pr.mergeable === null || pr.mergeable_state === 'unknown');
return { badges: prBadges(pr, reviews), title: pr.title, provisional };
}
function errorBadge(label, title) {
return { error: true, badges: [{ key: 'error', icon: 'error', label }], title };
}
export function errorState(err) {
if (err.rateLimited || err.status === 429) return errorBadge('Rate limited', 'GitHub rate limit hit. Add a token or wait.');
if (err.status === 401) return errorBadge('Bad token', 'GitHub rejected the token. Update it in the extension options.');
if (err.status === 403) return errorBadge('No access', "GitHub denied access. Check the token's repository permissions, or authorize it for SSO.");
if (err.status === 404) return errorBadge('No access', 'Not found, or the token cannot read this repo.');
return errorBadge('?', String(err.message || err));
}
// How long to cache a failed lookup: until the rate limit resets, `defaultTtl` for
// answers that will not change soon, or null (do not cache) for transient failures.
export function errorTtl(err, defaultTtl, now = Date.now()) {
if (err.rateLimited || err.status === 429) return Math.max((err.resetAt ?? 0) - now, 60 * 1000);
if (err.status === 401 || err.status === 403 || err.status === 404) return defaultTtl;
return null;
}